SynerGEE Electric 5.

0
User Guide

Edition
This edition applies to SynerGEE Electric 5.0 and to subsequent releases and modifications until otherwise
indicated in new editions.
Trademarks
SynerGEE is a registered trademark and Stoner Software is a trademark of GL Noble Denton, Inc. All brands
and product names are trademarks of the respective owner.
Restricted rights, warranties, and liabilities
The software discussed in this document is provided under a Software License Agreement and may be used
or copied only in accordance with the terms of that license.
All warranties given by GL Noble Denton, Inc. concerning GL Noble Denton asset software are set forth in the
Software License Agreement between GL Noble Denton, Inc. and the licensee.
GL Noble Denton assumes no responsibility for any errors that may appear in this document. We reserve the
right to change our software and documentation without notice.
Use, duplication, or disclosure by the U.S. Government is subject to the restrictions defined as Rights
specified in the license as set forth in subdivisions (a) and (b) of the DFARS clause 227.7202-3 entitled
Rights in Commercial Computer Software and Commercial Computer Software Documentation.
Copyright notice
2013 GL Noble Denton, Inc.
600 Bent Creek Blvd., Suite 100
Mechanicsburg, PA 17050 USA
+1 717 724 1900
www.gl-group.com/electric

Table of Contents

Table of Contents
Introduction
The SynerGEE Approach to Device Models ................................................................................... 51
SynerGEE Documentation .............................................................................................................. 52
Terms Cross-Reference .................................................................................................................. 53
SynerGEE Licensing ....................................................................................................................... 54
Multiple Sessions and Network Installations ................................................................................... 55
Viewing SynerGEE Version Information .......................................................................................... 55
Technical Support ........................................................................................................................... 56

Managing SynerGEE Data

Overview of Data Management ...................................................................................................... 58
Network intelligence and enterprise data flow ................................................................................ 58
SynerGEE Data Types .................................................................................................................... 59
Model data ................................................................................................................................ 61
To load (import) model data ................................................................................................. 61
To save (export) model data ................................................................................................ 61
Loading model data Conversion and merging .................................................................. 62
Saving model data merging versus replacing ................................................................... 62
Model data in Access .......................................................................................................... 63
References to equipment data ............................................................................................ 63
Comparing model data ........................................................................................................ 63
Sample model database ...................................................................................................... 64
Equipment data ......................................................................................................................... 64
Loading equipment data ...................................................................................................... 65
Saving equipment data ........................................................................................................ 65
Clearing equipment data from memory ............................................................................... 66
How equipment data is loaded and managed in memory ................................................... 66
Additional equipment data (zones and curves) ................................................................... 66
Merging equipment data ...................................................................................................... 66
Sample equipment database ............................................................................................... 67
Protection data .......................................................................................................................... 67
General information on protection data ............................................................................... 67
Protection database and the TCC ....................................................................................... 69
Mechanical response times and the protection database ................................................... 70
SynerGEE Data Formats ................................................................................................................ 70
Microsoft Access data format (personal database) ................................................................... 71
Data truncation when saving to an Access database .......................................................... 71

SynerGEE Electric 5.0

User Guide

Table of Contents
Microsoft Access data format (server/DBMS) ........................................................................... 72
Binary data format (EDM) ......................................................................................................... 72
MiddleLink data format .............................................................................................................. 72
History of the MiddleLink format .......................................................................................... 72
Architecture of MiddleLink data ........................................................................................... 73
Additional notes on the MiddleLink data format ................................................................... 73
MultiSpeak data format ............................................................................................................. 74
Oracle and SQL Server data format .......................................................................................... 74
PI Server ................................................................................................................................... 74
MySQL ...................................................................................................................................... 74
SynerGEE XML data format ...................................................................................................... 75
Data Source Aliases (DSAs) ........................................................................................................... 75
Why DSAs? ............................................................................................................................... 76
DSA data types ......................................................................................................................... 76
Managing DSAs ........................................................................................................................ 76
Editing a DSA ...................................................................................................................... 77
Creating DSAs .......................................................................................................................... 79
Creating DSAs with custom content .......................................................................................... 80
Validating DSAs ......................................................................................................................... 80
Sharing DSAs with other users ................................................................................................. 81
Saving DSAs ............................................................................................................................. 81
Deleting DSAs ........................................................................................................................... 81
Subsets ........................................................................................................................................... 82
Getting started with subsets ...................................................................................................... 82
Subset types ............................................................................................................................. 83
Saving a subset ......................................................................................................................... 84
Loading a subset ....................................................................................................................... 84
Creating and editing subsets outside of SynerGEE (schemas) ................................................ 85
About subset tables ................................................................................................................... 85
Subsets and multiple years ....................................................................................................... 85
Subsets with special functions ................................................................................................ 85
Source node flow subset ..................................................................................................... 86
Versions .......................................................................................................................................... 86
To manage (including delete) versions ..................................................................................... 86
Sample version workflow .......................................................................................................... 87
Version processing .................................................................................................................... 87
Partials ............................................................................................................................................ 89
Why partials are different than normal MiddleLink imports ..................................................... 89
How partials work ...................................................................................................................... 90
A word of caution when using partials ....................................................................................... 90

User Guide

SynerGEE Electric 5.0

Table of Contents

Cases .............................................................................................................................................. 91
Sample case file (text-based recipe format) .............................................................................. 91
Sample script file (Python format) ............................................................................................. 93
Specifying which script type to use with cases .......................................................................... 95
Creating a case ......................................................................................................................... 95
Editing a case ............................................................................................................................ 96
Running a case ......................................................................................................................... 97
Deleting a case ......................................................................................................................... 98
Data mart ........................................................................................................................................ 98
Gathering data mart data .......................................................................................................... 98
Unit Tests ........................................................................................................................................ 99
Importing GIS Data Using MiddleLink ........................................................................................... 100
Benefits of GIS extraction ....................................................................................................... 101
Note to MiddleLink 3.4 users Building models from GIS data .............................................. 101
General steps for a SynerGEE-MiddleLink import .................................................................. 102
Running a MiddleLink data import (model build) ..................................................................... 103
The MiddleLink data source Building a model from a GIS ................................................... 103
MiddleLink 3.4 data source ................................................................................................ 103
MiddleLink data source (new MiddleLink) ......................................................................... 104
Setting options for a MiddleLink data import ........................................................................... 106
Detailed processing during a MiddleLink data import .............................................................. 106
Topology concerns and restrictions ................................................................................... 107
Node identification From/To versus Source/Load ........................................................... 107
Literal handling of empty records MiddleLink data import .............................................. 107
Feeder and subtran sources MiddleLink data import ..................................................... 108
Method 1 Feeder or subtran references a node in the data source .......................... 108
Method 2 Feeder or subtran does not reference a valid node .................................. 108
Capacitors MiddleLink data import ................................................................................. 109
Protective device conversion MiddleLink data import ..................................................... 109
Conversion during a MiddleLink 3.4 import ................................................................. 109
Conversion during a MiddleLink import (new MiddleLink) ........................................... 109
Section spacing lookup MiddleLink data import ............................................................. 110
Switch conversion MiddleLink data import ..................................................................... 110
General rules, messages, and warnings MiddleLink data import ................................... 110
Browser file MiddleLink data import .................................................................................111
Automating MiddleLink model builds ....................................................................................... 112
Overview of MiddleLink automation tools .......................................................................... 112
General steps for MiddleLink automation .......................................................................... 112
Sample recipe for MiddleLink automation ......................................................................... 113
Sample command line for MiddleLink automation ............................................................. 114

SynerGEE Electric 5.0

User Guide

Table of Contents
Using an Enterprise Database System ......................................................................................... 114
Advantages of an enterprise system ....................................................................................... 115
Setting up an enterprise database system .............................................................................. 115
Using an enterprise system ..................................................................................................... 116
Creating enterprise model DSAs ....................................................................................... 116
Oracle connections for Enterprise databases .............................................................. 117
SQL Server connections for Enterprise databases ...................................................... 118
Creating a new model in an enterprise database .............................................................. 119
Loading and saving feeders in an enterprise system ........................................................ 119
To load feeders from an enterprise database model ................................................... 120
To save feeders back to an existing model .................................................................. 120
Deleting feeders and models in the enterprise database .................................................. 121
To delete feeders from an enterprise model ................................................................ 121
To delete an entire enterprise model ........................................................................... 121
Feeder locks and lock IDs ....................................................................................................... 121
Model locks for Enterprise databases ..................................................................................... 122
Note to database administrators regarding Enterprise databases .......................................... 123
Word of caution regarding enterprise databases and data integrity ........................................ 123
Enterprise models and analysis .............................................................................................. 123
Enterprise database schema .................................................................................................. 123
Importing Real-Time Data ............................................................................................................. 124
PI Historian .............................................................................................................................. 124
PI Messaging script ........................................................................................................... 125
Tag value report ................................................................................................................. 126
DBMS Real-Time Data ............................................................................................................ 127
Automating messaging scripts ................................................................................................ 129
Gallery ........................................................................................................................................... 129
To save the current model to the gallery ................................................................................ 130
To load a model from the gallery ............................................................................................ 130
To delete a gallery model ....................................................................................................... 131
To rename a gallery model ..................................................................................................... 131
Backing Up SynerGEE Data ......................................................................................................... 131
To configure automatic backups ............................................................................................. 131
To manually back up your SynerGEE data ............................................................................ 132
To restore data from the SynerGEE backup file ..................................................................... 132
Working Directly with Database Files ............................................................................................ 132
Data Source Editor .................................................................................................................. 132
Joiner ...................................................................................................................................... 133
Steps for using the joiner ................................................................................................... 134
Joiner data sources and DSAs .......................................................................................... 134

User Guide

SynerGEE Electric 5.0

Table of Contents

Checking and Repairing Database Schemas ............................................................................... 134

Viewing Session Data ................................................................................................................... 136
Editing Default Values for SynerGEE Devices .............................................................................. 136
Validating and Cleaning Up Model Data ....................................................................................... 137
Check Data report ................................................................................................................... 137
Model cleanup scripts ............................................................................................................. 138
Model Inspector ....................................................................................................................... 139
Setting up the Model Inspector .......................................................................................... 139
Running the Model Inspector ............................................................................................. 140

Using SynerGEE
Understanding the SynerGEE Environment ................................................................................. 142
SynerGEE windows ................................................................................................................ 142
Model explorer ........................................................................................................................ 143
Model tab ........................................................................................................................... 143
Warehouse tab .................................................................................................................. 144
Facilities tab ....................................................................................................................... 144
Query tab ........................................................................................................................... 145
Feeders tab ....................................................................................................................... 145
Legend tab ......................................................................................................................... 145
Toolbox tab ........................................................................................................................ 145
Ribbon bar ............................................................................................................................... 146
Quick access toolbar ............................................................................................................... 146
To edit buttons in the quick access toolbar ........................................................................ 147
To change the location of the quick access toolbar ........................................................... 147
Status bar ................................................................................................................................ 148
Function key shortcuts ............................................................................................................ 149
Custom keyboard shortcuts .................................................................................................... 149
Context (right-click) menus ..................................................................................................... 150
Editing data columns ............................................................................................................... 150
Using the SynerGEE Editor .......................................................................................................... 151
Producing the editor ................................................................................................................ 155
Viewing data calculations in the SynerGEE editor .................................................................. 156
Viewing results in the SynerGEE editor .................................................................................. 156
Loading Models ............................................................................................................................. 156
Selecting Feeders ......................................................................................................................... 157
Using the Select Feeders and Substation Transformers editor ............................................... 157
Selecting feeders from the SynerGEE ribbon bar ................................................................... 159
Selecting feeders from the map context menu ........................................................................ 160
Setting a feeder or subtran to be automatically selected when you load a model .................. 161
Using Feeder Sets ........................................................................................................................ 161

SynerGEE Electric 5.0

User Guide

Table of Contents
Setting Preferences ...................................................................................................................... 162
Setting SynerGEE preferences ............................................................................................... 163
Setting units of measurement ................................................................................................. 165
Setting database preferences ................................................................................................. 167
Defining file paths .................................................................................................................... 167
Setting data mining preferences ............................................................................................. 169
Setting values for conductor spacing and height above ground ............................................. 169
Managing load categories ....................................................................................................... 170
Setting feature locks ................................................................................................................ 171
Finding Model Data ....................................................................................................................... 171
Undoing and Redoing Model Edits ............................................................................................... 172
Tagging Sections and Facilities ..................................................................................................... 172
Using the Query Set ...................................................................................................................... 173
Creating a query set from the SynerGEE map display ............................................................ 174
To add sections to the query set ........................................................................................ 174
To add sections to the query set using spatial query mode ............................................... 174
To modify sections in the query set using the query path tool ........................................... 175
To remove a section from the query set ............................................................................ 176
To clear the query set ........................................................................................................ 176
Creating a query set using the Query Wizard ......................................................................... 176
Using the Multiple Editor ............................................................................................................... 177
Printing .......................................................................................................................................... 178
Rap Sheets ................................................................................................................................... 179
Details rap sheet ..................................................................................................................... 179
Voltage Plot rap sheet ............................................................................................................. 180
Arc Flashover rap sheet .......................................................................................................... 181
Fault rap sheet ........................................................................................................................ 182
Organizer ...................................................................................................................................... 183
Launching SynerGEE from the Command Line ............................................................................ 184
Units in SynerGEE ........................................................................................................................ 185
Basic unit concepts ................................................................................................................. 186
Automatic conversion and the importance of internal units ............................................... 186
Units conversion and control tables ................................................................................... 187
Rules for conversion during a save ................................................................................... 188
Generic names for length increments SUL, MUL, and LUL ................................................. 188
Tips for working with units ....................................................................................................... 189
Settings Groups and Settings Files ............................................................................................... 189
Managing settings groups in SynerGEE ................................................................................. 190
To manage settings groups ............................................................................................... 190
To restore startup default settings to factory settings ........................................................ 191

User Guide

SynerGEE Electric 5.0

Table of Contents

Settings files details ................................................................................................................ 191

Using the Bulk Editor .................................................................................................................... 192
Using the SynerGEE Maintenance Wizard ................................................................................... 193

Working with the Map Display

Using the Map Display .................................................................................................................. 196
Zooming .................................................................................................................................. 196
Panning ................................................................................................................................... 197
Rotating the map ..................................................................................................................... 198
Measuring distances ............................................................................................................... 198
Disabling node editing ............................................................................................................. 199
Refreshing the map display ..................................................................................................... 199
Toggling map details ............................................................................................................... 199
Changing the zoom direction of the mouse scroll wheel ......................................................... 200
Customizing the Map Display ....................................................................................................... 200
Configuring the map display style ........................................................................................... 201
Adding section and device annotation to the map display ...................................................... 207
Adding annotation based on analysis results .......................................................................... 208
Customizing section colors and sizes based on analysis results ............................................ 210
Customizing device colors and sizes based on analysis results ............................................. 211
Defining Color By colors .......................................................................................................... 212
Configuring map display symbols ........................................................................................... 213
Configuring visibility levels for map display symbols ............................................................... 214
Showing the map display grid ................................................................................................. 215
Selecting a Coloring Scheme for Sections .................................................................................... 216
Coloring by path type .............................................................................................................. 216
Areas of Interest ............................................................................................................................ 217
Creating an area of interest ..................................................................................................... 218
Reshaping and moving an area of interest ............................................................................. 219
Editing the settings for an area of interest ............................................................................... 220
Associating an area of interest with a section ......................................................................... 223
Deleting an area of interest ..................................................................................................... 223
Location Links ............................................................................................................................... 223
Creating a location link ............................................................................................................ 224
Launching a location link ......................................................................................................... 225
Labels ........................................................................................................................................... 225
Adding a label ......................................................................................................................... 226
Editing a label .......................................................................................................................... 227
Moving a label ......................................................................................................................... 229
Deleting a label ....................................................................................................................... 229
Mobile Items .................................................................................................................................. 229

SynerGEE Electric 5.0

User Guide

10

Table of Contents
Adding a mobile item ............................................................................................................... 230
Editing a mobile item ............................................................................................................... 230
Deleting a mobile item ............................................................................................................. 230
Legend .......................................................................................................................................... 231
Views ............................................................................................................................................ 231
Background Images ...................................................................................................................... 232
Schematic View ............................................................................................................................ 233
Using schematic templates ..................................................................................................... 234
Creating a schematic template .......................................................................................... 234
Editing a schematic template ............................................................................................. 235
Renaming a schematic template ....................................................................................... 236
Copying a schematic template .......................................................................................... 236
Deleting a schematic template .......................................................................................... 236
Creating a schematic .............................................................................................................. 237
Opening a schematic .............................................................................................................. 238
Working in the schematic ........................................................................................................ 238
Editing device and section data in the schematic view ........................................................... 238
Editing the schematic grid ....................................................................................................... 239
Geography View ........................................................................................................................... 239
Setting up the Geography view ............................................................................................... 239
Viewing a model in the Geography view ................................................................................. 241
Using the Geography view window ......................................................................................... 241
Synchronizing the Geography view and the Map view ............................................................ 241
Changing the basemap layer .................................................................................................. 242
Show Manager .............................................................................................................................. 242

Building a Model
Modeling Feeders and Subtrans ................................................................................................... 245
Converting a node into a feeder or a substation node ............................................................ 246
Editing a feeder or subtran node ............................................................................................. 247
Editing general data for a feeder or subtran node ............................................................. 248
Editing voltage levels and source impedance for a feeder/subtran node .......................... 249
Editing node data for a feeder/subtran node ..................................................................... 250
Editing failure rates and the location link for a feeder/subtran node .................................. 251
Viewing analysis results for a feeder/subtran node ........................................................... 251
About feeder and subtran demands ........................................................................................ 252
Subtran details ........................................................................................................................ 252
Modeling Loads ............................................................................................................................. 253
Loops and Wandering Laterals ..................................................................................................... 253
Modeling loops ........................................................................................................................ 254
Loop tie switches ..................................................................................................................... 255

User Guide

SynerGEE Electric 5.0

Table of Contents

11

To model a loop with a loop tie switch ............................................................................... 255

To model a wandering lateral with a tie switch .................................................................. 256
Analysis considerations for loops and wandering laterals ....................................................... 256

Modeling Sections
The SynerGEE Section Model ...................................................................................................... 258
Modeling Sections ......................................................................................................................... 258
Adding a section ...................................................................................................................... 259
Moving a section ..................................................................................................................... 260
Connecting and disconnecting sections .................................................................................. 260
Splitting a section .................................................................................................................... 261
Reconductoring and rephasing sections ................................................................................. 261
To change section conductors ........................................................................................... 262
To add a new phase .......................................................................................................... 262
To change section phasing ................................................................................................ 262
Changing a section ID ............................................................................................................. 262
Deleting a section .................................................................................................................... 263
About force-unfed sections ..................................................................................................... 263
Working with Nodes ...................................................................................................................... 264
Viewing nodes in the map display ........................................................................................... 264
Creating a node ....................................................................................................................... 265
Editing a node ......................................................................................................................... 265
Changing a node ID ................................................................................................................ 265
Moving a node ......................................................................................................................... 266
Converting nodes to other device types .................................................................................. 266
Deleting a node ....................................................................................................................... 266
Reducing the number of nodes ............................................................................................... 267
Setting up a node reduction ............................................................................................... 267
Performing a node reduction ............................................................................................. 270
Node reduction methodology ............................................................................................. 271
Removing nodes .......................................................................................................... 271
Eliminating a node completely ............................................................................... 272
Replacing a node with a vertex .............................................................................. 272
Detailed operation .................................................................................................. 273
Node reduction rules .............................................................................................. 273
Node reduction example ........................................................................................ 275
Removing vertices ....................................................................................................... 276
Breaking loops with elbows ......................................................................................... 277
Load handling .............................................................................................................. 277
Working with Graphic Points ......................................................................................................... 278
Adding a graphic point ............................................................................................................ 278

SynerGEE Electric 5.0

User Guide

12

Table of Contents
Moving a graphic point ............................................................................................................ 278
Deleting a graphic point .......................................................................................................... 279
Adding Sections ............................................................................................................................ 279
Editing Sections ............................................................................................................................ 279
Editing general data for a section ............................................................................................ 280
Editing construction data for a section .................................................................................... 281
Editing additional general settings for a section ...................................................................... 283
Adding distributed loads to a section ...................................................................................... 284
Adding spot loads to a section ................................................................................................ 287
Setting up projects for a section .............................................................................................. 289
Editing projects using the Section editor ........................................................................... 290
Editing projects using the Project worksheet ..................................................................... 292
Editing projects using the Projects Manager ..................................................................... 293
Adding distribution transformers to a section .......................................................................... 295
To edit distribution transformers using the Section editor .................................................. 296
To edit distribution transformers using the DTran worksheet ............................................ 297
Adding a distributed generator to a section ............................................................................. 298
Assigning zones to sections .................................................................................................... 301
Editing graphic points for a section ......................................................................................... 303
Viewing analysis results for a section ...................................................................................... 304
Conductors .................................................................................................................................... 304
Creating a conductor type ....................................................................................................... 305
Editing a conductor type .......................................................................................................... 305
Deleting a conductor type ....................................................................................................... 308
Sorting conductor types .......................................................................................................... 308
Use of conductor data ............................................................................................................. 309
Conductor spacing options ...................................................................................................... 310
Conductor Configuration and Positions ........................................................................................ 310
Simple impedance ................................................................................................................... 310
Conductor/equivalent spacing ................................................................................................. 311
Configuration types (detailed spacing) .................................................................................... 311
About configuration types .................................................................................................. 311
Creating a configuration type ............................................................................................. 311
Editing a configuration type ............................................................................................... 312
Determining coordinates for configuration types ............................................................... 312
Usage of configurations ..................................................................................................... 314
Configuration application examples ................................................................................... 314
Conductor Damage Curves .......................................................................................................... 316

Modeling Devices
Creating and Editing Devices ........................................................................................................ 317

User Guide

SynerGEE Electric 5.0

Table of Contents

13

Adding a device ....................................................................................................................... 317

Editing a device ....................................................................................................................... 318
Moving a device ...................................................................................................................... 318
Copying a device ..................................................................................................................... 318
Deleting a device ..................................................................................................................... 319
Creating and Editing Equipment Types ......................................................................................... 319
Creating a device type ............................................................................................................ 319
Editing a device type ............................................................................................................... 320
Copying a device type ............................................................................................................. 320
Deleting a device type ............................................................................................................. 320
Breakers ........................................................................................................................................ 321
Adding a breaker ..................................................................................................................... 321
Editing a breaker ..................................................................................................................... 321
Editing general data for a breaker ..................................................................................... 322
Setting up relays for a breaker .......................................................................................... 323
Viewing analysis results for a breaker ............................................................................... 325
Deleting a breaker ................................................................................................................... 326
Construction of the breaker model .......................................................................................... 326
Adding and removing relays .............................................................................................. 326
Relay groups ..................................................................................................................... 327
Relays, stages, and curves ............................................................................................... 327
Breaker flexibility A word of caution ................................................................................ 327
Transitioning from older breaker models ........................................................................... 328
Capacitors ..................................................................................................................................... 328
The SynerGEE Capacitor Model ............................................................................................. 329
Fixed and switched capacitor units .................................................................................... 329
Capacitor positioning relative to load ................................................................................. 330
Capacitor kV rating ............................................................................................................ 331
Controlling Switched Capacitor Modules ................................................................................. 331
Capacitor tripping and closing rules .................................................................................. 332
Capacitor metering phase ................................................................................................. 333
Capacitor line-drop compensator ...................................................................................... 333
Capacitor voltage override ................................................................................................. 334
Manually turning on a capacitor switched module ............................................................. 334
Managing Capacitors in the Model .......................................................................................... 334
Adding a capacitor ............................................................................................................. 335
Editing a capacitor ............................................................................................................. 335
Editing general data for a capacitor ............................................................................. 336
Setting up switch controls, location links, and energize and retire years for a capacitor ...
339

SynerGEE Electric 5.0

User Guide

14

Table of Contents
Viewing analysis results for a capacitor ....................................................................... 341
Deleting a capacitor ........................................................................................................... 342
Motor Analysis and Capacitors ............................................................................................... 342
Placement Analysis ................................................................................................................. 342
Fuses ............................................................................................................................................ 342
Adding a fuse .......................................................................................................................... 342
Editing a fuse .......................................................................................................................... 343
Editing general data for a fuse ........................................................................................... 343
Setting failure rates, location links, and the energize and retire years for a fuse .............. 345
Viewing analysis results for a fuse .................................................................................... 346
Deleting a fuse ........................................................................................................................ 346
Fuse time and amp multipliers ................................................................................................ 346
Fuse time multiplier factor ................................................................................................. 346
Fuse amp multiplier factor ................................................................................................. 347
Fuse defaults and uprating ................................................................................................ 347
Generators .................................................................................................................................... 347
Managing generator types in the equipment warehouse ........................................................ 348
Creating a generator type .................................................................................................. 348
Editing a generator type .................................................................................................... 349
Deleting a generator type .................................................................................................. 351
Managing generators in the model .......................................................................................... 351
Adding a generator ............................................................................................................ 352
Editing a generator ............................................................................................................ 352
Editing general data for a generator ............................................................................ 352
Editing machine data and energize/retire years for a generator .................................. 355
Viewing analysis results for a generator ...................................................................... 355
Deleting a generator .......................................................................................................... 356
Scheduled, distributed generation ........................................................................................... 356
Additional notes on generators ............................................................................................... 356
Meters ........................................................................................................................................... 356
Managing meters in the model ................................................................................................ 357
Adding a meter .................................................................................................................. 357
Editing a meter .................................................................................................................. 357
Editing general data for a meter .................................................................................. 358
Setting up demands for a meter .................................................................................. 359
Specifying reliability targets for a meter ....................................................................... 362
Assigning default customer zones to a meter .............................................................. 363
Viewing analysis results for a meter ............................................................................ 363
Deleting a meter ................................................................................................................ 364
Meters and reliability studies ................................................................................................... 364

User Guide

SynerGEE Electric 5.0

Table of Contents

15

Metering points and load allocation ......................................................................................... 364

Motors ........................................................................................................................................... 364
Managing motor types in the equipment warehouse .............................................................. 365
Creating a motor type ........................................................................................................ 365
Editing a motor type ........................................................................................................... 366
Deleting a motor type ........................................................................................................ 367
Managing motor curve types in the equipment warehouse ..................................................... 368
Creating a motor curve type .............................................................................................. 368
Editing a motor curve type ................................................................................................. 368
Deleting a motor curve type ............................................................................................... 369
Managing motors in the model ................................................................................................ 369
Adding a motor .................................................................................................................. 369
Editing a motor .................................................................................................................. 370
Editing general data for a motor .................................................................................. 370
Editing service data for a motor ................................................................................... 371
Selecting a motor starting method ............................................................................... 373
Editing load torque data for a motor ............................................................................ 374
Viewing analysis results for a motor ............................................................................ 374
Deleting a motor ................................................................................................................ 375
Motor analyses ........................................................................................................................ 375
Locked rotor analysis ......................................................................................................... 375
Locked rotor analysis and the motor model ................................................................. 376
Performing a locked rotor analysis .............................................................................. 376
Motor start analysis ........................................................................................................... 377
Performing a motor start analysis ................................................................................ 377
Reclosers ...................................................................................................................................... 377
Adding a recloser .................................................................................................................... 378
Editing a recloser .................................................................................................................... 378
Editing general properties for a recloser ............................................................................ 378
Editing the recloser setup .................................................................................................. 380
Editing primary and alternate settings for a recloser ......................................................... 381
Setting failure rates, location links, and the energize and retire years for a recloser ........ 381
Viewing analysis results for a recloser .............................................................................. 382
Deleting a recloser .................................................................................................................. 383
Recloser mechanical response times ...................................................................................... 383
Regulators ..................................................................................................................................... 383
Managing regulator types in the equipment warehouse ......................................................... 384
Creating a regulator type ................................................................................................... 384
Editing a regulator type ...................................................................................................... 384
Deleting a regulator type ................................................................................................... 386

SynerGEE Electric 5.0

User Guide

16

Table of Contents
Managing regulators in the model ........................................................................................... 386
Adding a regulator ............................................................................................................. 387
Editing a regulator ............................................................................................................. 387
Editing general data for a regulator ............................................................................. 387
Editing line-drop compensation data for a regulator .................................................... 388
Editing reverse mode, first-house, and tap limiter data for a regulator ........................ 390
Setting failure rates, location links, and the energize and retire years for a regulator . 392
Viewing analysis results for a regulator ....................................................................... 392
Deleting a regulator ........................................................................................................... 393
Sectionalizers ................................................................................................................................ 393
Adding a sectionalizer ............................................................................................................. 393
Editing a sectionalizer ............................................................................................................. 394
Editing general data for a sectionalizer ............................................................................. 394
Setting failure rates, location links, and the energize and retire years for a sectionalizer . 395
Viewing analysis results for a sectionalizer ....................................................................... 396
Deleting a sectionalizer ........................................................................................................... 397
Switches ........................................................................................................................................ 397
Switch configuration and connectivity ..................................................................................... 398
Special switch types and functions ......................................................................................... 400
Managing switch types in the equipment warehouse .............................................................. 400
Creating a switch type ....................................................................................................... 401
Editing a switch type .......................................................................................................... 401
Deleting a switch type ........................................................................................................ 402
Managing switches in the model ............................................................................................. 402
Adding a switch ................................................................................................................. 402
Editing a switch .................................................................................................................. 402
Editing general data for a switch .................................................................................. 403
Setting failure rates, location links, and the energize and retire years for a switch ..... 406
Viewing analysis results for a switch ........................................................................... 407
Deleting a switch ............................................................................................................... 407
Modeling auto-transfer switches ............................................................................................. 407
Pad-mounted gear and elbows ............................................................................................... 408
Elbows ............................................................................................................................... 408
Pad-mounted switch gear .................................................................................................. 408
Converting a node to pad-mounted switch gear .......................................................... 409
Editing pad-mounted switch gear ................................................................................ 410
Switch plans ............................................................................................................................ 411
Creating a switch plan ....................................................................................................... 411
Editing a switch plan .......................................................................................................... 411
Deleting a switch plan ........................................................................................................ 413

User Guide

SynerGEE Electric 5.0

Table of Contents

17

Using the Switch Plan Manager ........................................................................................ 413

Contingency and optimal switching analysis ........................................................................... 415
Transformers ................................................................................................................................. 415
Transformer model .................................................................................................................. 415
Tertiary transformer windings ............................................................................................ 416
Basic steps for modeling a tertiary winding ................................................................. 416
Specifying secondary versus tertiary connections ....................................................... 416
Transformer connection models ........................................................................................ 418
Network protectors ............................................................................................................ 420
Tripping and closing the network protectors ................................................................ 421
Sample model .............................................................................................................. 421
Managing transformer types in the equipment warehouse ..................................................... 422
Creating a transformer type ............................................................................................... 422
Editing a transformer type ................................................................................................. 422
Deleting a transformer type ............................................................................................... 424
Managing transformers in the model ....................................................................................... 425
Adding a transformer ......................................................................................................... 425
Editing a transformer ......................................................................................................... 425
Editing general data for a transformer ......................................................................... 426
Setting up a load-tap changer (LTC) for a transformer ................................................ 427
Setting up tertiary windings for a transformer .............................................................. 429
Enabling a network protector for a transformer ........................................................... 429
Setting failure rates, location links, and the energize and retire years for a transformer ...
430
Viewing analysis results for a transformer ................................................................... 431
Deleting a transformer ....................................................................................................... 431

SynerGEE Analyses
Setting Up an Analysis .................................................................................................................. 433
Setting a section for analysis .................................................................................................. 434
Selecting the analysis year and time of day ............................................................................ 434
Setting model and analysis options ......................................................................................... 436
Defining exception load limits ............................................................................................ 437
Setting up general model options ...................................................................................... 438
Setting up general analysis options ................................................................................... 441
Enabling automatic fixes during an analysis ...................................................................... 442
Setting up multi-year analysis options ............................................................................... 442
Setting up model costs ...................................................................................................... 443
Setting analysis output options ............................................................................................... 444
Selecting which attributes are available in the Results Viewer .......................................... 445
Selecting which attributes are available in the Results tab ................................................ 445

SynerGEE Electric 5.0

User Guide

18

Table of Contents
Setting analysis cost options ................................................................................................... 446
Cost files ............................................................................................................................ 447
Cost file format ............................................................................................................. 447
Creating a cost file ....................................................................................................... 448
Editing a cost file .......................................................................................................... 448
Selecting a cost file for analysis ................................................................................... 448
Global costs ....................................................................................................................... 449
Performing an Analysis ................................................................................................................. 449
Re-running an analysis ........................................................................................................... 449
Viewing Analysis Results .............................................................................................................. 449
Suggestions for viewing analysis results ................................................................................. 450
Using the Results Viewer ........................................................................................................ 451
Using the Broadcaster ............................................................................................................. 451
Importing and exporting analysis results ................................................................................. 452
Important information on results handling ......................................................................... 453
Getting started with results import/export .......................................................................... 453
Setting up DSAs for results import and export .................................................................. 454
Exporting results ................................................................................................................ 455
Importing results ................................................................................................................ 455
Reporting on results .......................................................................................................... 456
Enterprise databases and results import/export ................................................................ 456
SynerGEE Reports ....................................................................................................................... 456
Generating analysis reports .................................................................................................... 457
Configuring report options ....................................................................................................... 459
Adding notes to reports ........................................................................................................... 460
Printing reports ........................................................................................................................ 460
Options, errors, and warnings in reports ................................................................................. 460
Dockable reports ..................................................................................................................... 462
Enabling dockable reports ................................................................................................. 462
Docking analysis reports ................................................................................................... 463
Using the auto-hide feature ............................................................................................... 466
Grid-style reports ..................................................................................................................... 467
Editing the appearance of a grid-style report ..................................................................... 468
To edit and save a chapter report template ................................................................. 469
To edit and save a master report template .................................................................. 469
To restore a chapter report template to the master template defaults ......................... 470
To restore the master report template to the original SynerGEE defaults ................... 470
Managing the content of a grid-style report ....................................................................... 470
Coloring report data in the SynerGEE map display ........................................................... 472
Using grid-style reports to generate a scatter-plot graph .................................................. 473

User Guide

SynerGEE Electric 5.0

Table of Contents

19

Saving a grid-style report ................................................................................................... 473

Exporting a grid-style report to Microsoft Excel ................................................................. 474
Exporting a grid-style report to a database ........................................................................ 475
Working with sections and devices included in grid-style reports ...................................... 476
HTML reports .......................................................................................................................... 477
Non-analysis reports ............................................................................................................... 477
Breaker Zone 1 report ....................................................................................................... 477
Digest report ...................................................................................................................... 478
Feeder Tie Path report ...................................................................................................... 478
Line construction report ..................................................................................................... 479
Zones report ...................................................................................................................... 479
SynerGEE Charts ......................................................................................................................... 479
Opening the chart window ....................................................................................................... 480
Creating custom charts ........................................................................................................... 480
To create or edit a custom chart ........................................................................................ 480
To save a custom chart ...................................................................................................... 482
To load a custom chart ...................................................................................................... 482
To delete a custom chart ................................................................................................... 482
Modifying a chart ..................................................................................................................... 483
Exporting a chart image .......................................................................................................... 483
Printing a chart ........................................................................................................................ 483
Closing an individual chart ...................................................................................................... 484
Closing the chart window ........................................................................................................ 484
What-If Analysis ............................................................................................................................ 484
Managing What-If scripts ........................................................................................................ 485
Sample what-if scripts ............................................................................................................. 487
Uncertainty Analysis ..................................................................................................................... 487
Setting up an uncertainty analysis .......................................................................................... 488
Performing an uncertainty analysis ......................................................................................... 488
System Status Analysis ................................................................................................................ 489
R&D Analysis ................................................................................................................................ 489
Concepts View .............................................................................................................................. 490
Opening the Concepts View .................................................................................................... 490
Impedance Concepts View ...................................................................................................... 490
Harmonics Concepts View ...................................................................................................... 491

Loads and Load Analyses

Setting up Loads ........................................................................................................................... 493
Load types ............................................................................................................................... 494
Getting started with load modeling .......................................................................................... 494
About Loads Versus Model Types ................................................................................................ 495

SynerGEE Electric 5.0

User Guide

20

Table of Contents
Radial model loads .................................................................................................................. 495
Network model loads ............................................................................................................... 496
Load %I, %Z, %PQ ....................................................................................................................... 496
To assign I, Z, PQ percentages to loads ................................................................................ 496
I,Z,PQ load model details ........................................................................................................ 497
Constant real and reactive power load model ................................................................... 498
Constant current load model ............................................................................................. 498
Constant impedance load model ....................................................................................... 499
Current/voltage relationship Loads ................................................................................. 499
Power/voltage relationship Loads ................................................................................... 500
The combination load model ............................................................................................. 501
Example calculations with different I, Z, PQ components ................................................. 501
Sample I, Z, PQ values ........................................................................................................... 502
Capacity Factors ........................................................................................................................... 502
Large Customers and Distributed Generation .............................................................................. 503
Adding a large customer to the model .................................................................................... 503
Editing a large customer ......................................................................................................... 504
Editing general data for a large customer .......................................................................... 504
Editing load data for a large customer ............................................................................... 506
Editing generation data for a large customer ..................................................................... 508
Viewing analysis results for a large customer ................................................................... 510
Customer load curves and large customers (scheduling) ....................................................... 511
Projects (Load) .............................................................................................................................. 511
Effect of projects on the model ................................................................................................ 512
Adding, editing, and managing projects .................................................................................. 512
Load-Flow Analysis ....................................................................................................................... 512
Overview of SynerGEE load-flow technology .......................................................................... 513
The radial load-flow foundation ......................................................................................... 513
The radial load-flow engine ............................................................................................... 514
The SynerGEE load-flow advantage ................................................................................. 515
Summary of SynerGEE load-flow benefits ........................................................................ 515
Radial load-flow ....................................................................................................................... 516
Performing a radial load-flow analysis ............................................................................... 516
By-phase versus balanced load-flow analysis ................................................................... 516
Radial load-flow with loops ...................................................................................................... 517
About load-flow with loops ................................................................................................. 517
Example Load-flow with loops .................................................................................. 517
Invalid tie switches and load-flow ................................................................................ 520
Radial load-flow with wandering laterals ................................................................................. 520
About wandering laterals and tie switches ........................................................................ 520

User Guide

SynerGEE Electric 5.0

Table of Contents

21

Sample wandering lateral calculations Load-flow ........................................................... 521

Network analysis ..................................................................................................................... 522
Network analysis types ...................................................................................................... 522
Network load-flow analysis .......................................................................................... 522
Network fault analysis .................................................................................................. 523
Network outage analysis .............................................................................................. 523
Setting up a network analysis ............................................................................................ 523
Performing a network analysis .......................................................................................... 524
Network Load-Flow Analysis ......................................................................................................... 524
Network analysis types ........................................................................................................... 525
Network load-flow analysis ................................................................................................ 525
Network fault analysis ........................................................................................................ 526
Network outage analysis ................................................................................................... 526
Setting up a network analysis ................................................................................................. 526
Performing a network analysis ................................................................................................ 527
Scale Manager .............................................................................................................................. 527

Capacity
Optimal Switching Analysis ........................................................................................................... 529
Optimal switching analysis operation ...................................................................................... 529
OSP application speed ............................................................................................................ 530
Setting up an optimal switching analysis ................................................................................. 530
Performing an optimal switching analysis ............................................................................... 532
Throw-Over Analysis ..................................................................................................................... 533
Auto-Transfer Switch Analysis ...................................................................................................... 533
Automatic Feeder Switching (AFS) Analysis ................................................................................ 534
Substation Bus Transformer Analysis ........................................................................................... 534
Contingency Analysis .................................................................................................................... 535
Contingency analysis methods ............................................................................................... 535
Fast pickup method ........................................................................................................... 536
Optimized pickup method .................................................................................................. 536
Load Transfer method ....................................................................................................... 537
Setting up a contingency analysis ........................................................................................... 537
Selecting the contingency analysis method ....................................................................... 537
Setting up a Fast Pickup contingency analysis ................................................................. 538
Setting up a Load Transfer contingency analysis .............................................................. 540
Setting up an Optimized Pickup contingency analysis ...................................................... 542
Performing a contingency analysis ......................................................................................... 546
Isolating sections ..................................................................................................................... 546
Examples of contingency outage types ................................................................................... 546

SynerGEE Electric 5.0

User Guide

22

Table of Contents

Planning
Load Allocation Analysis ............................................................................................................... 549
When to run load allocation ..................................................................................................... 550
About load allocation demands and meters ............................................................................ 550
Suggested approaches to load allocation ............................................................................... 551
Demands format for load allocation ........................................................................................ 551
Regulator and capacitor options during load allocation .......................................................... 551
Load allocation calculations with customer load curves .......................................................... 552
Other load allocation considerations ....................................................................................... 552
Setting up a load allocation analysis ....................................................................................... 552
Performing a load allocation analysis ...................................................................................... 555
Forecasting Analysis ..................................................................................................................... 556
Setting up a forecasting analysis ............................................................................................ 557
Selecting a forecasting agent .................................................................................................. 560
Performing a forecasting analysis ........................................................................................... 561
Capacitor Placement Analysis ...................................................................................................... 562
Setting up a Capacitor Placement analysis ............................................................................. 562
Performing a Capacitor Placement analysis ........................................................................... 563
Phase Balancing and Load Balancing Improvement .................................................................... 565
Phase Balancing Improvement Analysis ................................................................................. 566
Setting up a Phase Balancing Improvement analysis ....................................................... 566
Performing a Phase Balancing Improvement analysis ...................................................... 567
Load balancing improvement .................................................................................................. 569
Setting up a Load Balancing Improvement analysis .......................................................... 569
Performing a Load Balancing Improvement analysis ........................................................ 570
Design Evaluation ......................................................................................................................... 572
Selecting an optimal conductor ............................................................................................... 572
Conductor evaluation processing ...................................................................................... 572
Tips for using conductor selection ..................................................................................... 573
Setting up a conductor selection evaluation ...................................................................... 573
Performing a conductor selection evaluation ..................................................................... 574
Determining an optimal regulator position ............................................................................... 574
Regulator position processing ........................................................................................... 574
Setting up a regulator position evaluation ......................................................................... 575
Performing a regulator position evaluation ........................................................................ 575
Viewing the results of a regulator position evaluation ....................................................... 575
Multi-Model Analysis ..................................................................................................................... 576
Setting up a multi-model analysis ........................................................................................... 576
Identifying data sources for a multi-model analysis ........................................................... 577
Selecting analysis types and years for a multi-model analysis .......................................... 577

User Guide

SynerGEE Electric 5.0

Table of Contents

23

Selecting pre-processing actions for a multi-model analysis ............................................. 578

Selecting post-processing actions for a multi-model analysis ........................................... 578
Performing a multi-model analysis .......................................................................................... 579
Multi-Year Analysis ........................................................................................................................ 579
Getting started with multi-year modeling ................................................................................. 580
General information about multi-year modeling ...................................................................... 580
Data applicable to multi-year features ............................................................................... 580
Differences between the multi-year modeling and versions .............................................. 581
Interaction with customer load curves and load growth ..................................................... 581
Changing years for multi-year modeling .................................................................................. 581
Modeling for multiple years ..................................................................................................... 582
Multi-year modeling challenges ......................................................................................... 582
Enabling multi-year modeling ............................................................................................ 582
Specifying energize and retire years for multi-year modeling ............................................ 583
Specifying year-specific data for multi-year modeling ....................................................... 583
Multi-year modeling using the SynerGEE editors .............................................................. 583
Year names and time spans between years ...................................................................... 584
Copying data using the Multi-Year Editor .......................................................................... 584
Model Rollover wizard ....................................................................................................... 585
Multi-year analyses ................................................................................................................. 586
Setting up a multi-year analysis ......................................................................................... 586
Performing a multi-year analysis ....................................................................................... 587
Multi-year data characteristics ................................................................................................ 587
Full-Year (8760) Analysis .............................................................................................................. 588
Performance Comparison ............................................................................................................. 589
Setting up a performance comparison analysis ...................................................................... 589
Selecting models for a performance comparison analysis ................................................ 590
Setting costs for a performance comparison analysis ....................................................... 590
Setting analysis options for a performance comparison analysis ...................................... 591
Add phase/change phase factors ............................................................................................ 592
Overall model costs ................................................................................................................. 592
Secondary losses .................................................................................................................... 593
Running a performance comparison analysis ......................................................................... 594
Voltage Optimization Analysis ....................................................................................................... 594
Setting up a Voltage Optimization analysis ............................................................................. 595
Performing a Voltage Optimization analysis ............................................................................ 595
Voltage Optimization analysis reporting .................................................................................. 595
Voltage Optimization analysis example ................................................................................... 596
Economic Analysis ........................................................................................................................ 597

Protection

SynerGEE Electric 5.0

User Guide

24

Table of Contents
Protective Devices ........................................................................................................................ 599
Data management and protective devices .............................................................................. 599
Switchable protective devices ................................................................................................. 600
Protective device details ......................................................................................................... 600
Transformer curves ........................................................................................................... 600
Classic protective devices ................................................................................................. 600
Managing classic protective device types in the equipment warehouse ..................... 601
Creative a classic protective device type ............................................................... 601
Editing a classic protective device type ................................................................. 601
Deleting a classic protective device type ............................................................... 602
Managing classic protective devices in the model ....................................................... 602
Adding a classic protective device ......................................................................... 602
Editing a classic protective device ......................................................................... 602
Editing general data for a classic protective device ......................................... 603
Viewing analysis results for a classic protective device ................................... 603
Deleting a classic protective device ....................................................................... 604
Time Versus Current Coordination (TCC) Graph .......................................................................... 604
Opening the TCC view ............................................................................................................ 604
Using the TCC explorer ........................................................................................................... 605
Plotting curves on the TCC ..................................................................................................... 605
Panning and zooming in the TCC ........................................................................................... 606
Changing TCC view display properties ................................................................................... 606
Editing curves in the TCC display ...................................................................................... 606
Editing reference shifting in the TCC display ..................................................................... 609
Editing the graph in the TCC display ................................................................................. 609
Editing the grid in the TCC display .................................................................................... 610
Editing print settings for the TCC display .......................................................................... 610
Breakers, relays, and the TCC ................................................................................................ 610
Adding notes, time lines, amp lines, and arc flashover to the TCC ......................................... 610
To add a note to the TCC .................................................................................................. 610
To add a time line, amp, or diagonal line to the TCC ......................................................... 611
To add arc flashover values to the TCC ............................................................................ 611
To move a note in the TCC ................................................................................................ 611
To move an amp or time line in the TCC ........................................................................... 611
To delete a note, time line, or amp line from the TCC ....................................................... 611
Using TCC graph measuring tools .......................................................................................... 611
Plotting conductor damage curves on the TCC ...................................................................... 612
Saving and loading TCC views as TCC sets ........................................................................... 612
To create and save a TCC set ........................................................................................... 612
To open (redisplay) a TCC set ........................................................................................... 612

User Guide

SynerGEE Electric 5.0

Table of Contents

25

To rename a TCC set ........................................................................................................ 612

To delete a TCC set ........................................................................................................... 612
To update an existing TCC set with the current view ......................................................... 613
Saving and loading TCC views as external files ..................................................................... 613
Saving a TCC view as a JPEG or BMP image ........................................................................ 613
Copying a TCC view ............................................................................................................... 614
Using other TCC functions and features ................................................................................. 614
To use TCC editing and zooming shortcuts ....................................................................... 614
To remove a device curve from the graph ......................................................................... 615
To add a title to TCC printouts ........................................................................................... 615
To delete an entire graph ................................................................................................... 615
To view a full-screen size version of a graph ..................................................................... 615
To refresh the TCC view .................................................................................................... 615
Protection Lab ............................................................................................................................... 615
Creating a Protection Lab display ........................................................................................... 616
Editing a Protection Lab display .............................................................................................. 616
Copying a Protection Lab display ............................................................................................ 618
Renaming a Protection Lab display ........................................................................................ 618
Deleting a Protection Lab display ............................................................................................ 619
Protection Curve Editor ................................................................................................................. 619
MiddleLink and the protection curve editor ............................................................................. 622
Check Coordination Analysis ........................................................................................................ 622
General check coordination operation .................................................................................... 623
Setting up a check coordination analysis ................................................................................ 623
Editing analysis settings for a check coordination analysis ............................................... 624
Setting time and percentage margins for a check coordination analysis ........................... 626
Selecting coordination rules for a check coordination analysis ......................................... 627
Protection pairs and check coordinations ............................................................................... 639
Sample feeder and pairs Check coordination example .................................................. 639
Pair types and rule prefixes Check coordination ............................................................ 640
Running check coordination analysis ...................................................................................... 641
Coordination range of fault levels Check coordination ......................................................... 641
Cases not checked Check coordination ............................................................................... 642
Ground curve tripping from the inrush of a single- phase transformer .............................. 642
Curve shifting through transformers ........................................................................................ 642
Coordination over non-overlapped ranges .............................................................................. 642
Transformers and Transformer Curves ......................................................................................... 643
Arc Flashover ................................................................................................................................ 643
Arc Flashover Overview .......................................................................................................... 644
Disclaimer ............................................................................................................................... 644

SynerGEE Electric 5.0

User Guide

26

Table of Contents
Exceptions ............................................................................................................................... 645
Model requirements ................................................................................................................ 645
Setting up an arc flashover analysis ....................................................................................... 645
Configuring settings for an arc flashover analysis ............................................................. 645
Selection of PPE rating for clothing ............................................................................. 646
Editing working distances .................................................................................................. 646
Creating an arc flashover label .......................................................................................... 647
Performing an arc flashover analysis ...................................................................................... 648
Fault Analysis ................................................................................................................................ 648
Fault analysis types ................................................................................................................. 648
Fault analysis ..................................................................................................................... 648
Pre-fault load current and fault analysis ...................................................................... 649
Fault flow analysis ............................................................................................................. 649
Pre-fault load current and fault flow analysis ............................................................... 649
Fault voltage analysis ........................................................................................................ 649
Including generators during fault analysis ............................................................................... 650
Setting up a fault analysis ....................................................................................................... 650
Performing a fault analysis ...................................................................................................... 652
Fault analysis with wandering laterals ..................................................................................... 652
Fault Sequence Analysis .............................................................................................................. 653
Setting up a fault sequence analysis ....................................................................................... 653
Performing a fault sequence analysis ..................................................................................... 654
Fault Location Analysis ................................................................................................................. 654
Fault events ............................................................................................................................. 655
Adding a fault event ........................................................................................................... 655
Editing a fault event ........................................................................................................... 655
Deleting a fault event ......................................................................................................... 656
Setting up a fault location analysis .......................................................................................... 656
Performing a fault location analysis ........................................................................................ 658
Protection Scheme Report ............................................................................................................ 658

Reliability
Reliability ....................................................................................................................................... 661
About Reliability and SynerGEE ............................................................................................. 661
Importance of reliability ...................................................................................................... 662
The SynerGEE approach to reliability ............................................................................... 662
Reliability study challenges ............................................................................................... 662
Setting up a Reliability Analysis .............................................................................................. 662
Setting up basic reliability analysis options ....................................................................... 663
Setting up additional reliability analysis options ................................................................ 665
Setting up scalars for a reliability analysis ......................................................................... 666

User Guide

SynerGEE Electric 5.0

Table of Contents

27

Performing a Reliability Analysis ............................................................................................. 667

Aspects of SynerGEE Reliability ............................................................................................. 667
Supported reliability indices ............................................................................................... 667
Publishable reliability results ............................................................................................. 669
Version comparison and reliability analysis ....................................................................... 669
Switching plan models and reliability ................................................................................. 669
Capacity considerations during reliability analysis ............................................................ 670
Metric variance during reliability analysis .......................................................................... 670
Root causes and reliability studies .................................................................................... 670
Spatial mitigation and reliability studies ............................................................................. 671
Using meters for reliability studies ..................................................................................... 671
Exposure factors and reliability studies ............................................................................. 673
Supporting applications for reliability studies ..................................................................... 673
Reliability Data Management .................................................................................................. 674
Outage data calibration Reliability analysis .................................................................... 674
Historical outage data calibration ................................................................................. 674
Analytical model calibration Outage data ................................................................. 675
Variation analysis and reliability ................................................................................... 675
Failures and reliability studies ........................................................................................... 676
Interruptions and reliability studies .................................................................................... 676
Defining root causes for a reliability simulation ................................................................. 677
ReliCauseMeta.txt file format ....................................................................................... 678
Editing ReliCauseMeta.txt ........................................................................................... 679
Exposure zones ................................................................................................................. 679
Exposure zone setup methods .................................................................................... 680
Creating an exposure zone .......................................................................................... 681
Editing an exposure zone ............................................................................................ 681
Assigning an exposure zone to a section .................................................................... 682
Deleting an exposure zone .......................................................................................... 682
Mitigation zones ................................................................................................................. 683
Creating a mitigation zone ........................................................................................... 683
Editing a mitigation zone .............................................................................................. 684
Assigning a mitigation zone to a section ...................................................................... 684
Deleting a mitigation zone ........................................................................................... 685
Devices and failure rates Reliability studies ................................................................... 685
Reliability Analysis Details ...................................................................................................... 686
Reliability processing examples ........................................................................................ 686
Reliability calculation results .............................................................................................. 687
Reliability results presentation ........................................................................................... 687
Trial and study during reliability studies ............................................................................. 687

SynerGEE Electric 5.0

User Guide

28

Table of Contents
Reliability analysis assumptions ........................................................................................ 688
Isolating/switching/pickup example Reliability analysis .................................................. 688
Harmonic ....................................................................................................................................... 689
Harmonic Analysis .................................................................................................................. 689
Setting up a harmonic analysis .......................................................................................... 689
Creating and editing harmonic curves ......................................................................... 690
Creating a harmonic curve ..................................................................................... 690
Editing a harmonic curve ....................................................................................... 690
Deleting a harmonic curve ..................................................................................... 692
Assigning a harmonic curve to a large customer ......................................................... 692
Designating sections for harmonic monitoring ............................................................. 693
Configuring options for a harmonic analysis ................................................................ 693
Performing a harmonic analysis ........................................................................................ 694
Viewing the Harmonic load-flow report .............................................................................. 694
Viewing the impedance frequency scan report .................................................................. 695
Unfused Tap Analysis ................................................................................................................... 696
Device Risk Ranking Analysis ...................................................................................................... 696
Reliability Event Management Wizard .......................................................................................... 697

Scripts
Recipe Scripts ............................................................................................................................... 700
Recipe syntax .......................................................................................................................... 700
Recipe script example ............................................................................................................. 701
Model Forge Scripts ...................................................................................................................... 702
Running the Model Forge wizard ............................................................................................ 703
Viewing the Model Forge schema ........................................................................................... 703
Model Forge Script example ................................................................................................... 703
Python Scripts ............................................................................................................................... 705
Creating a Python script .......................................................................................................... 706
Opening a Python script in the default Python editor .............................................................. 706
Writing a Python script ............................................................................................................ 707
Copying a Python script .......................................................................................................... 708
Renaming a Python script ....................................................................................................... 709
Deleting a Python script .......................................................................................................... 709
Running a Python script .......................................................................................................... 709
Python scripts examples ......................................................................................................... 710
Python script example Reporting model data ................................................................. 710
Python script example Startup script .............................................................................. 711
Python script example Performing a fault analysis ......................................................... 712
Python script example Updating neutrals ....................................................................... 714
Startup Scripts .............................................................................................................................. 715

User Guide

SynerGEE Electric 5.0

Table of Contents

29

Specifying which script type to run at startup .......................................................................... 715

About the Startup recipe script ................................................................................................ 716
Using the Startup Script Wizard .............................................................................................. 716
Setting the current model as a startup recipe script ................................................................ 717
Model Cleanup Scripts .................................................................................................................. 718
Sample model cleanup script .................................................................................................. 718
Model cleanup and supplementing spacing data .................................................................... 719
Model cleanup and classic protective device conversion ........................................................ 719
Automation Scripts ........................................................................................................................ 720
Messaging Scripts ......................................................................................................................... 720
Cable Study Scripts ...................................................................................................................... 721
Writing Scripts ............................................................................................................................... 722
Creating a new script .............................................................................................................. 722
Copying a script ...................................................................................................................... 723
Opening a script file for editing ................................................................................................ 723
Renaming a script ................................................................................................................... 724
Deleting a script ...................................................................................................................... 724
Using the Script Editor ............................................................................................................ 725
Creating a script using the Script editor ............................................................................. 726
Opening a script from the Script editor .............................................................................. 726
Opening a script in Notepad from the Script editor ............................................................ 727
Editing a script using the Script editor ............................................................................... 727
Deleting a script from the Script editor .............................................................................. 729
Using the Script Wizard ........................................................................................................... 729
Running Scripts ............................................................................................................................. 730
Running a script from the SynerGEE ribbon bar ..................................................................... 731
Running a script from the Script wizard ................................................................................... 731
Running recipe scripts automatically ....................................................................................... 731
Repeating the most recently run recipe script ......................................................................... 732
Viewing a Script Schema .............................................................................................................. 733
Process Diagrams ......................................................................................................................... 733
Opening the Process Diagram window ................................................................................... 733
Managing process diagrams ................................................................................................... 734
Editing a process diagram ....................................................................................................... 735
Adding steps to a process diagram ................................................................................... 735
Adding commands to a process step ................................................................................ 736
Editing the appearance of a process diagram step ........................................................... 736
Clearing all steps in a process diagram ............................................................................. 737
Changing the background color of the Process Diagram window ..................................... 737
Saving a process diagram ....................................................................................................... 737

SynerGEE Electric 5.0

User Guide

30

Table of Contents
Running a process .................................................................................................................. 737

Tools, Calculators, and Worksheets

Publishing Export .......................................................................................................................... 739
Setting Publishing export options ............................................................................................ 740
Running a Publishing export ................................................................................................... 742
Layer creation during a DXF Publishing export ....................................................................... 742
SVG output information ........................................................................................................... 744
Power Tool Applications ................................................................................................................ 744
Regulator Setting power tool ................................................................................................... 745
Setting up the Regulator Setting power tool ...................................................................... 745
Performing a Regulator Setting analysis ........................................................................... 746
Regulator Setting power tool examples ............................................................................. 747
I,Z,PQ Calibration power tool .................................................................................................. 748
Power mathematics and I,Z,PQ ......................................................................................... 749
Using the calibrator ............................................................................................................ 749
Calculating Delta %kW / Delta %V .............................................................................. 750
Using the calculated Delta %kW / Delta %V ................................................................ 751
I,Z,PQ Calibration power tool operation ............................................................................ 752
Setting up the I,Z,PQ Calibration power tool ..................................................................... 753
Performing an I,Z,PQ Calibration analysis ........................................................................ 753
Capacitor Flicker Report power tool ........................................................................................ 753
Setting up the Capacitor Flicker Report power tool ........................................................... 754
Generating a Capacitor Flicker Report .............................................................................. 754
Ten-Year Growth Report power tool ........................................................................................ 755
Setting up the Ten-Year Growth Report power tool ........................................................... 755
Generating a Ten-Year Growth Report .............................................................................. 756
Insert Tie Switches power tool ................................................................................................ 756
Setting up the Insert Tie Switches power tool ................................................................... 756
Performing an Insert Tie Switches analysis ....................................................................... 757
Node Overlap Report power tool ............................................................................................. 757
Setting up the Node Overlap Report power tool ................................................................ 758
Generating a Node Overlap Report ................................................................................... 759
Regression .................................................................................................................................... 759
General steps for using regression ......................................................................................... 759
Creating a regression file ........................................................................................................ 760
Deleting a regression file ......................................................................................................... 760
Comparing two regression files ............................................................................................... 760
PowerCalc ..................................................................................................................................... 761
Starting PowerCalc ................................................................................................................. 761
Understanding PowerCalc ...................................................................................................... 761

User Guide

SynerGEE Electric 5.0

Table of Contents

31

Available PowerCalc functions ................................................................................................ 763

Loading and saving calculation scripts .................................................................................... 763
Toolbox .......................................................................................................................................... 763
Switch Manager ...................................................................................................................... 763
Feeder Overview ..................................................................................................................... 764
Capacitor Manager .................................................................................................................. 765
Load Center Manager ............................................................................................................. 765
Creating and editing a load center ..................................................................................... 766
Data Hammer ................................................................................................................................ 767
State Master .................................................................................................................................. 768
Demo Manager ............................................................................................................................. 769
Media Viewer ................................................................................................................................ 770
Library ........................................................................................................................................... 770
Adding a document to the library ............................................................................................ 770
Viewing a document in the library ........................................................................................... 771
Updating a document in the library ......................................................................................... 771
Deleting a document from the library ...................................................................................... 772
SQL Dashboard ............................................................................................................................ 772
Opening the SQL Dashboard .................................................................................................. 773
Using the SQL Dashboard ...................................................................................................... 773
Selecting a data type and data source for use with the SQL Dashboard ................................ 774
Writing a SQL query ................................................................................................................ 775
To write a query ................................................................................................................. 775
To save a query ................................................................................................................. 776
To delete a query ............................................................................................................... 776
Showing tables and fields in the SQL Dashboard ................................................................... 776
Running a SQL query and viewing the results ........................................................................ 777
Using the model-in-memory feature in the SQL Dashboard ................................................... 778
Mining in the SQL Dashboard ................................................................................................. 779
Feature locks and the SQL Dashboard ................................................................................... 779
Common SQL commands ....................................................................................................... 780
Sample SQL queries ............................................................................................................... 782
Running the Solver from Within SynerGEE .................................................................................. 783

SynerGEE Cable
General Steps for SynerGEE Cable Analysis ............................................................................... 785
Modeling Cables ........................................................................................................................... 786
Overview of cable conductor data ........................................................................................... 786
Types of cable conductors ...................................................................................................... 787
Simple impedance cable model ......................................................................................... 787
Separate neutral cable model ............................................................................................ 787

SynerGEE Electric 5.0

User Guide

32

Table of Contents
Concentric neutral cable model ......................................................................................... 787
Tape shield conductor model ............................................................................................. 788
Three-core cable model ..................................................................................................... 789
Applying conductor types to sections ...................................................................................... 789
Creating a Duct Bank .................................................................................................................... 790
Editing Duct Banks ........................................................................................................................ 790
Editing a duct bank using the Duct Bank editor ...................................................................... 790
Editing general data for a duct bank .................................................................................. 791
Editing circuits for a duct bank ........................................................................................... 792
Editing a duct bank using the Cable Duct Bank view .............................................................. 793
Opening the Cable Duct Bank view ................................................................................... 794
Working in the Cable Duct Bank view ............................................................................... 795
Zooming the duct bank view .............................................................................................. 796
Duct bank view display properties ..................................................................................... 796
A word on direct buried cables in the duct bank view ........................................................ 796
Troubleshooting calculation errors shown in the duct bank legend ................................... 797
Duct bank ampacity report ................................................................................................. 797
Applying Duct Banks to Sections .................................................................................................. 797
Duct Bank Evaluation .................................................................................................................... 798
Setting up a duct bank evaluation ........................................................................................... 798
Performing a duct bank evaluation .......................................................................................... 799
About section derating ............................................................................................................ 800
Detailed Cable Studies Using Scripts ........................................................................................... 800

Time-Related Features
Load Growth ................................................................................................................................. 801
Enabling load growth rates ...................................................................................................... 802
Specifying growth rates ........................................................................................................... 804
Growth curves ......................................................................................................................... 804
Creating a growth curve .................................................................................................... 805
Editing a growth curve ....................................................................................................... 805
Configuring SynerGEE to use growth curves .................................................................... 806
Applying a growth curve to a section ................................................................................. 806
Deleting a growth curve ..................................................................................................... 806
Using growth curves in a multi-year environment .............................................................. 807
Using growth curves in a single-year environment ............................................................ 808
Customer Load Curves/Time-of-Day Analysis .............................................................................. 808
Load curve benefits ................................................................................................................. 809
Getting started with load curves/time-of-day ........................................................................... 809
Customer classes .................................................................................................................... 810
Creating a customer class ................................................................................................. 810

User Guide

SynerGEE Electric 5.0

Table of Contents

33

Editing a customer class .................................................................................................... 811

Editing load curves for a customer class ..................................................................... 811
Editing class information for a customer class ............................................................. 812
Editing coincidence settings for a customer class ....................................................... 813
Editing economic data for a customer class ................................................................ 814
Deleting a customer class ................................................................................................. 815
Customer zones ...................................................................................................................... 815
Creating a customer zone ................................................................................................. 816
Editing a customer zone .................................................................................................... 816
Applying customer zones to sections in the model ............................................................ 817
To apply customer zones to sections using the Section editor .................................... 817
To apply customer zones to sections using the Multiple Editor ................................... 817
Deleting a customer zone .................................................................................................. 818
Enabling load curves ............................................................................................................... 818
Load curves and load allocation .............................................................................................. 819
Choosing the time to allocate load .................................................................................... 819
Preparing the model for time-sensitive allocation .............................................................. 819
Understanding time-sensitive allocation results ................................................................ 820
Handling the model after time-sensitive allocation ............................................................ 820
Load curves and large customers ........................................................................................... 821
Load curve summary ............................................................................................................... 821
Controls ......................................................................................................................................... 821
To create a control system script ............................................................................................ 821
To run a control system .......................................................................................................... 822

Weather
An Overview of Weather Modeling in SynerGEE .......................................................................... 823
Defining Weather Conditions ........................................................................................................ 824
Modeling weather based on set weather conditions ............................................................... 825
Modeling weather using weather profiles ................................................................................ 825
Creating a weather profile ................................................................................................. 826
Editing a weather profile .................................................................................................... 826
Configuring a model to use weather profiles ..................................................................... 827
Deleting a weather profile .................................................................................................. 828
Adjusting Loads Based on Weather Conditions ............................................................................ 828
To enable global-based weather load modeling ..................................................................... 829
To enable class-based weather load modeling ...................................................................... 830
To disable weather load modeling .......................................................................................... 831
Configuring Seasonal Weather Modeling ...................................................................................... 831
Setting the season (summer or winter) for a SynerGEE model .............................................. 831
Setting up conductors to use seasonal ratings ....................................................................... 832

SynerGEE Electric 5.0

User Guide

34

Table of Contents
Setting up regulators to use seasonal ratings ......................................................................... 832
Setting up transformers to use seasonal ratings ..................................................................... 833
Performing a Summer/Winter analysis .................................................................................... 833
Using Weather Zones to Model Variations in Cloud Cover ........................................................... 834
Creating a weather zone ......................................................................................................... 834
Editing a weather zone ............................................................................................................ 834
Assigning a weather zone to a section .................................................................................... 835
Deleting a weather zone ......................................................................................................... 835

Customer Management Module

The CMM Process ........................................................................................................................ 838
The CMM and the DSA ................................................................................................................. 838
Using the CMM Wizard ................................................................................................................. 839
Updating a model with customer data ..................................................................................... 839
Importing MiddleLink files into a CMM data set ................................................................. 839
Processing CMM data set bills and loads .......................................................................... 840
Updating model loads with a CMM data set ...................................................................... 841
Automating the CMM process ................................................................................................. 842
Running a CMM script ....................................................................................................... 842
Writing CMM scripts .......................................................................................................... 843
Viewing CMM script commands .................................................................................. 843
CMM script examples .................................................................................................. 845
Maintaining CMM data sets ..................................................................................................... 846
Reporting on a CMM data set ............................................................................................ 846
Creating and destroying data sets ..................................................................................... 847
Merging data sets .............................................................................................................. 848
Using the model in memory to update data set connectivity ............................................. 848
CMM and the SQL Dashboard ...................................................................................................... 849
SQL Dashboard controls ......................................................................................................... 849
CMM queries in the SQL Dashboard ...................................................................................... 850
Security and Support via Lock ID .................................................................................................. 850

Economics
Managing Cost Zones ................................................................................................................... 851
Creating a cost zone ............................................................................................................... 851
Editing a cost zone .................................................................................................................. 852
Assigning a cost zone to a section .......................................................................................... 853
Deleting a cost zone ................................................................................................................ 853

Numerical Recipe Commands

Graphical User Interface Commands ............................................................................................ 855

User Guide

SynerGEE Electric 5.0

Table of Contents

35

3010 Generating a message box ......................................................................................... 856

3013 Refreshing the map display ......................................................................................... 856
3014 Zooming to selected feeders ....................................................................................... 856
Program Operation Commands .................................................................................................... 856
3030 Running an executable file .......................................................................................... 857
3031 Playing a sound file ..................................................................................................... 858
3032 Opening an HTML file in SynerGEE ........................................................................... 858
3034 Deleting a file .............................................................................................................. 858
3035 Shutting down SynerGEE ........................................................................................... 858
Data IO Recipe Commands .......................................................................................................... 858
3050 Creating a DSA ........................................................................................................... 859
3051 Deleting a DSA ............................................................................................................ 861
3052 Testing a DSA connection ........................................................................................... 862
3053 Loading feeders .......................................................................................................... 862
3054 Saving feeders ............................................................................................................ 862
3055 Loading equipment data .............................................................................................. 863
3056 Saving equipment data ............................................................................................... 864
3057 Loading a protection database .................................................................................... 865
3058 Loading a partials data source file .............................................................................. 866
3059 Creating a regression file ............................................................................................ 866
3060 Comparing two regression files ................................................................................... 866
3061 Loading a subset ......................................................................................................... 867
3062 Saving a subset ........................................................................................................... 868
3063 Creating a new model ................................................................................................. 869
3064 Creating a new warehouse ......................................................................................... 869
3065 Prompting the user to load a model ............................................................................ 869
3066 Prompting the use to load a warehouse ...................................................................... 870
3071 Creating a table for MiddleLink loading ....................................................................... 870
3072 Creating a file for MiddleLink loading .......................................................................... 870
3073 Creating MiddleLink table ............................................................................................ 870
3080 Checking and repairing a model schema .................................................................... 871
3081 Checking and repairing an equipment schema ........................................................... 871
3090 Adding a document to the document library ................................................................ 871
3091 Running a SQL Dashboard script ............................................................................... 872
Map Coloring Recipe Commands ................................................................................................. 873
3100 Setting the legend title ................................................................................................. 874
3101 Coloring all sections .................................................................................................... 874
3102 Coloring by overhead or underground construction .................................................... 874
3103 Coloring by conductor type ......................................................................................... 875
3104 Coloring by results within range .................................................................................. 875

SynerGEE Electric 5.0

User Guide

36

Table of Contents
3105 Coloring by sections with bad phasing ........................................................................ 876
3106 Coloring within two ranges .......................................................................................... 876
3107 Coloring by the product of two result parameters ........................................................ 877
3108 Coloring by the quotient of two result parameters ....................................................... 878
3109 Coloring by section prefix ............................................................................................ 878
3110 Applying display style .................................................................................................. 879
3111 Coloring sections fed from wandering lateral ............................................................... 879
3112 Coloring sections fed from a loop ................................................................................ 879
3113 Applying a Geobackground ......................................................................................... 880
3114 Coloring sections by the delta/ground status of lines .................................................. 880
Analysis Recipe Commands ......................................................................................................... 881
3200 Running an analysis .................................................................................................... 882
3201 Running a Model Cleanup script ................................................................................. 882
3203 Running an Outage Import script ................................................................................ 883
3204 Exporting an SVG file .................................................................................................. 883
3205 Exporting a Model Viewer file ...................................................................................... 884
3206 Running a CMM script ................................................................................................. 884
3207 Running another recipe ............................................................................................... 884
3208 Exporting the most recent report ................................................................................. 885
3210 Setting the analysis year ............................................................................................. 886
3211 Running a report script ................................................................................................ 886
3212 Loading and saving an application settings group ...................................................... 886
3230 Setting the growth option ............................................................................................ 887
3231 Setting a single load multiplier as the growth option ................................................... 887
3232 Setting different load multipliers as the growth option ................................................. 888
3233 Setting the time of day ................................................................................................ 888
3250 Setting fault levels in the fault location application ...................................................... 889
3251 Specifying fault types in the fault location application ................................................. 889
Model Modification Recipe Commands ........................................................................................ 890
3300 Setting a custom result for all sections in memory ...................................................... 890
3301 Setting a custom result for a single section in the model ............................................ 891
3302 Setting the open/closed status for a device ................................................................ 891
3303 Setting the open/closed status for an elbow ............................................................... 892
Results Handling Recipe Commands ........................................................................................... 892
3400 Exporting a results set to a database .......................................................................... 893
Selection Recipe Commands ........................................................................................................ 893
3500 Selecting a section ...................................................................................................... 894
3501 Opening the Section editor for the selected section .................................................... 894
3502 Tracing the selected section to its source and adding the results to the query set ..... 894
3503 Clearing the query set ................................................................................................. 895

User Guide

SynerGEE Electric 5.0

Table of Contents

37

3504 Selecting the section with a highest or lowest result ................................................... 895
3505 Selecting a feeder or subtran ...................................................................................... 895
3506 De-selecting a feeder or subtran ................................................................................. 895
3507 Selecting all feeders and subtrans .............................................................................. 896
3508 De-selecting all feeders and subtrans ......................................................................... 896
3509 Zooming to a selected section .................................................................................... 896
3510 De-selecting feeders with low metering ....................................................................... 896
3511 Adding sections identified by substring to the query set .............................................. 896
3512 Setting a section for analysis ...................................................................................... 898
Selection Recipe Example ...................................................................................................... 898
List Recipe Commands ................................................................................................................. 898
3550 Creating a list .............................................................................................................. 899
3551 Destroying a list ........................................................................................................... 899
3552 Clearing a list .............................................................................................................. 899
3553 Adding an item to list ................................................................................................... 899
3554 Removing an item from list .......................................................................................... 900
3555 Loading a list from a file .............................................................................................. 900
Licensing Recipe Commands ....................................................................................................... 900
3600 Checking out a module ............................................................................................... 901
3601 Checking in a module .................................................................................................. 902
Messaging Script Recipe Commands ........................................................................................... 902
3650 Running a messaging script ........................................................................................ 902
3651 Running a messaging script with a prompt ................................................................. 903
Recipe Parameter Reference ....................................................................................................... 903
Colors for recipes .................................................................................................................... 903
Results for recipes .................................................................................................................. 904
Analysis types for recipes ....................................................................................................... 905

Text-Based Recipe Commands

Analysis Commands ..................................................................................................................... 908
Analysis.RunCleanupScript ..................................................................................................... 908
Analysis.CloseAllReports ........................................................................................................ 908
Analysis.CheckData ................................................................................................................ 909
Analysis.Topology ................................................................................................................... 909
CMM Commands .......................................................................................................................... 909
Cmm.RunScript ....................................................................................................................... 910
Contingency Commands ............................................................................................................... 910
Contingency.Run ..................................................................................................................... 910
Fault Location Commands ............................................................................................................ 910
FaultLoc.FaultsToConsider ..................................................................................................... 911
FaultLoc.Run ........................................................................................................................... 911

SynerGEE Electric 5.0

User Guide

38

Table of Contents
FaultLoc.SetFaultAmps ........................................................................................................... 912
File Commands ............................................................................................................................. 912
File.WriteLine .......................................................................................................................... 913
Recipe Control Commands ........................................................................................................... 913
Recipe.Start ............................................................................................................................ 914
Recipe.StartAutomated ........................................................................................................... 914
Recipe.End .............................................................................................................................. 914
Load Allocation Commands .......................................................................................................... 914
LoadAlloc.Run ......................................................................................................................... 915
Load Flow Commands .................................................................................................................. 915
LoadFlow.Run ......................................................................................................................... 915
List Commands ............................................................................................................................. 915
ScriptList.Create ...................................................................................................................... 916
ScriptList.Destroy .................................................................................................................... 916
ScriptList.Empty ...................................................................................................................... 916
ScriptList.AddItem ................................................................................................................... 917
ScriptList.RemoveItem ............................................................................................................ 917
ScriptList.LoadFromFile .......................................................................................................... 917
Map Commands ............................................................................................................................ 917
Map.ZoomNetwork .................................................................................................................. 917
Model Forge Commands .............................................................................................................. 918
ModelForge.RunProcess ........................................................................................................ 918
DataHammer.SigedMidway ..................................................................................................... 918
Model I/O Commands ................................................................................................................... 918
DSA.Create ............................................................................................................................. 919
DSA.Delete ............................................................................................................................. 921
DSA.DropModel ...................................................................................................................... 921
DSA.DropSubstation ............................................................................................................... 922
DSA.DeleteFeeder .................................................................................................................. 922
DSA.DeleteFeederList ............................................................................................................ 922
DSA.ExecStoredProc .............................................................................................................. 923
DSA.LoadFeeders ................................................................................................................... 924
DSA.LoadSubBySection ......................................................................................................... 925
DSA.LoadModelBySub ........................................................................................................... 925
DSA.LoadWarehouse .............................................................................................................. 926
DSA.ResultsSetSave .............................................................................................................. 926
DSA.SaveFeeders .................................................................................................................. 926
DSA.TestConnection ............................................................................................................... 927
DSA.ExportLastReport ............................................................................................................ 927
DSA.ExportLastReport2 .......................................................................................................... 928

User Guide

SynerGEE Electric 5.0

Table of Contents

39

DSA.LoadProtectionDb ........................................................................................................... 929

DSA.SaveWarehouse ............................................................................................................. 929
Model Management Commands ................................................................................................... 930
Model.DropAllFeeders ............................................................................................................ 930
Model.SetAnalysisSection ....................................................................................................... 930
Model.ZoomToSelectedFeeders ............................................................................................. 930
Model.SetAnalysisSectionByFirstBreaker ............................................................................... 931
Model.SetMeterAmps .............................................................................................................. 931
Model.SetSwitchableDeviceStatusUsingSubstring ................................................................. 931
Model.SetRegulatorsManualMode .......................................................................................... 932
Model.SelectFeeder ................................................................................................................ 932
Model.DeselectAllFeeders ...................................................................................................... 932
Model.SetMeterDataType ....................................................................................................... 933
Model.Dtran_PlaceWithXY ...................................................................................................... 933
Model.AnalysisSection ............................................................................................................ 933
Model.AnalysisYear ................................................................................................................. 933
Multi-Model Commands ................................................................................................................ 934
MultiModel.AddDataSource .................................................................................................... 934
MultiModel.CheckCoordination ............................................................................................... 934
MultiModel.CheckData ............................................................................................................ 935
MultiModel.Contingency .......................................................................................................... 935
MultiModel.CreateZonesAndProcessEvents ........................................................................... 936
MultiModel.Fault ...................................................................................................................... 936
MultiModel.LoadAllocation ...................................................................................................... 936
MultiModel.LoadFlow .............................................................................................................. 937
MultiModel.Reliability .............................................................................................................. 937
MultiModel.RemoveAllDataSources ........................................................................................ 938
MultiModel.Run ....................................................................................................................... 938
MultiModel.ThrowOver ............................................................................................................ 938
MultiModel.Years1 ................................................................................................................... 938
MultiModel.Years2 ................................................................................................................... 939
Phase Balancing Commands ........................................................................................................ 940
PhaseBalancing.Run ............................................................................................................... 940
QA Commands ............................................................................................................................. 941
SynQA.GenRemDataFile ........................................................................................................ 941
Reliability Commands ................................................................................................................... 941
Reliability.CreateZonesAndProcessEvents ............................................................................. 942
Reliability.CreateDataSet ........................................................................................................ 942
Reliability.DeleteDataSet ......................................................................................................... 943
Settings Commands ...................................................................................................................... 943

SynerGEE Electric 5.0

User Guide

40

Table of Contents
Settings.LoadXML ................................................................................................................... 943
SQL Commands ........................................................................................................................... 943
SQL.RunFromFile ................................................................................................................... 944
Throw-Over Commands ................................................................................................................ 944
ThrowOver.Run ....................................................................................................................... 945
Warehouse Commands ................................................................................................................ 945
Warehouse.Drop ..................................................................................................................... 945

Model Forge Commands

Areas of Interest ............................................................................................................................ 948
AOI_101 Creating/editing an area of interest ....................................................................... 948
AOI_102 Editing the X,Y coordinates for an area of interest ............................................... 949
AOI_103 Creating/editing an area of interest ....................................................................... 950
AOI_104 Editing the X,Y coordinates for an area of interest ............................................... 951
AOI_105 Creating/editing an area of interest ....................................................................... 952
AOI_106 Editing the X,Y coordinates for an area of interest ............................................... 953
Breakers ........................................................................................................................................ 953
BKR_101 Editing a breaker .................................................................................................. 954
BKR_102 Creating/editing a breaker ................................................................................... 954
BKR_103 Editing the breaker rating and interrupt rating for a breaker ................................ 955
BKR_104 Editing the mechanical response type for a breaker ............................................ 955
BKR_105 Adding/editing a relay on a breaker ..................................................................... 956
BKR_106 Activating a breaker relay stage .......................................................................... 957
BKR_107 Editing the operation type, curve family, and instantaneous curve for a breaker relay
stage ....................................................................................................................................... 957
BKR_108 Editing the pickup type for a breaker relay stage ................................................. 958
BKR_109 Editing primary and secondary amp ratings for a breaker relay stage ................. 959
BKR_110 Editing the CT turns ratio for a breaker relay stage ............................................. 959
BKR_111 Editing the tap and time dial value for a breaker relay stage ............................... 960
BKR_112 Editing multipliers and adders for a breaker relay stage ...................................... 961
BKR_113 Specifying the location of a breaker ..................................................................... 962
BKR_114 Editing the reclosing status for a breaker relay stage .......................................... 962
BKR_115 Editing the mechanical response type for a breaker ............................................ 963
BKR_116 Editing the breaker rating and interrupt rating for a breaker ................................ 964
BKR_117 Editing the note text for a breaker ........................................................................ 964
BKR_118 Enabling/disabling a breaker relay ....................................................................... 965
BKR_119 Editing the connection phase for a breaker .......................................................... 965
BKR_120 Editing the primary amps for a breaker relay stage ............................................. 966
Capacitors ..................................................................................................................................... 966
CAP_101 Editing a capacitor ............................................................................................... 967
CAP_102 Editing a capacitor ............................................................................................... 967

User Guide

SynerGEE Electric 5.0

Table of Contents

41

CAP_103 Creating/editing a capacitor ................................................................................. 967

CAP_104 Editing the fixed kvar, operating status, and operating type for a capacitor ......... 968
CAP_105 Editing the operating type and metering phase for a capacitor ............................ 969
CAP_106 Editing voltage override settings for a capacitor .................................................. 970
CAP_107 Editing the PT ratio and CT rating for a capacitor ................................................ 971
CAP_108 Editing Module 1 settings for a capacitor ............................................................. 971
CAP_109 Editing the control type for a capacitor ................................................................ 972
CAP_110 Editing the Module 1 kvar per phase value for a capacitor .................................. 973
CAP_111 Editing the Module 1 close value for a capacitor .................................................. 973
CAP_112 Editing the Module 1 trip value for a capacitor ..................................................... 974
CAP_113 Editing the voltage rating for a capacitor .............................................................. 974
CAP_114 Editing the metering phase for a capacitor ........................................................... 975
CAP_115 Editing the operating status and metering phase for a capacitor ......................... 975
CAP_116 Editing the PT ratio and CT rating for a capacitor ................................................ 976
CAP_117 Editing Module 1 settings for a capacitor ............................................................. 976
CAP_118 Editing the control type for a capacitor ................................................................. 977
CAP_119 Setting the energize year and retire year for a capacitor ..................................... 978
CAP_120 Specifying whether a capacitor will operate on weekends ................................... 978
CAP_121 Editing the Module 2 and Module 3 kvar per phase value for a capacitor ........... 979
CAP_122 Editing the Module 2 close and trip values for a capacitor ................................... 979
CAP_123 Editing the Module 3 close and trip values for a capacitor ................................... 980
CMM ............................................................................................................................................. 981
CMM_110 Creating a new customer .................................................................................... 981
CMM_113 Assigning a load type to a customer ................................................................... 982
CMM_114 Assigning a class to a customer ......................................................................... 982
CMM_120 Creating a distribution transformer ..................................................................... 982
CMM_121 Updating an existing distribution transformer ..................................................... 983
CMM_123 Setting a distribution transformer as a primary meter ......................................... 983
CMM_124 Setting the XY coordinates for a distribution transformer ................................... 983
CMM_127 Adding a customer to a distribution transformer ................................................. 984
CMM_128 Assigning a distribution transformer to a section ................................................ 984
CMM_130 Adding a customer demand billing record with kW ............................................. 984
CMM_131 Adding a customer demand billing record with kvar ........................................... 985
CMM_132 Adding a customer demand billing record with PctPf ......................................... 985
CMM_140 Adding a customer usage billing record .............................................................. 985
CMM_162 Creating a customer class .................................................................................. 986
CMM_164 Setting the coincidence factor for a customer class ........................................... 986
CMM_211 Creating a customer class curve ......................................................................... 986
CMM_212 Creating a customer class curve and matching customer zone curve ............... 987
CMM_214 Adding metered demand data to a customer curve ............................................ 987

SynerGEE Electric 5.0

User Guide

42

Table of Contents
Distribution Transformers .............................................................................................................. 987
DTR_101 Creating/editing a distribution transformer ........................................................... 988
DTR_102 Editing the kVA for a distribution transformer ....................................................... 988
DTR_103 Editing the X,Y coordinates for a distribution transformer .................................... 989
DTR_104 Editing the demand kVA for a distribution transformer ......................................... 989
DTR_105 Editing the number of customers for a distribution transformer ........................... 990
DTR_106 Editing the connection phase for a distribution transformer ................................. 990
DTR_107 Editing the demand kVA, number of customers, and connection phase for a
distribution transformer ........................................................................................................... 991
Facilities ........................................................................................................................................ 991
FAC_110 Editing the location link, AMS link, and note text for a facility ............................... 992
FAC_111 Editing the location link for a facility ...................................................................... 992
FAC_112 Editing the AMS link for a facility .......................................................................... 993
FAC_113 Editing the note text for a facility ........................................................................... 993
Feeders ......................................................................................................................................... 993
FDR_101 Converting a node to a feeder ............................................................................. 994
FDR_102 Editing minimum and maximum source impedance values for a feeder .............. 994
FDR_103 Editing the balanced voltage level for a feeder .................................................... 995
FDR_104 Editing positive sequence and zero sequence values for a feeder ...................... 996
FDR_105 Editing the note text for a feeder .......................................................................... 996
FDR_106 Editing the continuous amp rating and emergency amp rating for a feeder ........ 997
FDR_107 Setting the color for a feeder ............................................................................... 997
FDR_108 Setting the voltage and angle for phase 1 of a feeder ......................................... 998
FDR_109 Setting the voltage and angle for phase 2 of a feeder ......................................... 998
FDR_110 Setting the voltage and angle for phase 3 of a feeder ......................................... 998
FDR_111 Setting the region ID for a feeder ......................................................................... 999
FDR_112 Editing maximum source impedance values for a feeder .................................... 999
Fuses .......................................................................................................................................... 1000
FUS_101 Adding a fuse to a section .................................................................................. 1000
FUS_102 Editing the manufacturer, model, and amp and volt ratings for a fuse ............... 1001
FUS_103 Specifying the location of a fuse ........................................................................ 1001
FUS_104 Editing the connection phase for a fuse ............................................................. 1002
Generators .................................................................................................................................. 1002
GEN_101 Editing a generator ............................................................................................ 1002
GEN_102 Creating/editing a generator .............................................................................. 1003
GEN_103 Selecting a generator type and connection phase ............................................ 1003
GEN_104 Turning a generator on or off ............................................................................. 1004
GEN_105 Creating/editing a generator .............................................................................. 1004
Large Customers ........................................................................................................................ 1004
LGC_101 Editing a large customer .................................................................................... 1005

User Guide

SynerGEE Electric 5.0

Table of Contents

43

LGC_102 Creating/editing a large customer ...................................................................... 1006

LGC_103 Editing kW values for a large customer ............................................................. 1006
LGC_104 Editing kvar values for a large customer ............................................................ 1007
LGC_105 Editing current and impedance values for a large customer .............................. 1007
LGC_106 Editing customer load values for a large customer ............................................ 1008
LGC_107 Editing connected kVA load values for a large customer ................................... 1008
LGC_108 Editing kW values and the power factor percentage for a large customer ......... 1009
LGC_109 Turning a large customers load settings on or off ............................................. 1010
LGC_110 Setting the rated kVA and Pf values for a larger customer ................................ 1011
LGC_111 Editing kW values for a large customer .............................................................. 1011
LGC_112 Editing kvar values for a large customer ............................................................ 1011
LGC_113 Editing customer load values for a large customer ............................................ 1012
LGC_114 Editing connected kVA load values for a large customer ................................... 1012
LGC_115 Editing kW and kvar values for a large customer for each phase for a specific year .
1013
LGC_116 Editing the load status for a large customer ....................................................... 1014
LGC_117 Enabling and disabling the distributed generator on a large customer .............. 1015
LGC_118 Editing the generator type for a large customer ................................................. 1015
LGC_119 Setting the rated kVA and Pf values for a large customer .................................. 1015
LGC_120 Editing the capacity factor for a large customer ................................................. 1016
Loads .......................................................................................................................................... 1016
LOD_101 Editing a load ..................................................................................................... 1017
LOD_103 Editing kVA values for a meters load ................................................................ 1017
LOD_104 Editing % pf values for a meters load ............................................................... 1018
LOD_105 Setting the override option for a meters load .................................................... 1019
LOD_106 Editing amp values for a meters load ................................................................ 1019
LOA_120 Editing connected kVA load values for a sections distributed load ................... 1020
LOA_121 Editing kWh values for a sections distributed load ............................................ 1020
LOA_122 Editing the number of customers for a sections distributed load ....................... 1021
LOA_123 Editing KW values for a sections distributed load ............................................. 1022
LOA_124 Editing kvar values for a sections distributed load ............................................ 1022
LOA_130 Editing connected kVA load values for a sections spot load ............................. 1023
LOA_131 Editing the number of customers for a sections spot load ................................. 1023
LOA_132 Editing the description for a sections spot load ................................................. 1024
LOA_133 Enabling/disabling a sections spot load ............................................................ 1024
LOA_140 Editing KW values for a sections spot load ....................................................... 1025
LOA_141 Editing kvar values for a sections spot load ...................................................... 1025
LOA_142 Editing the capacity factor for a sections spot load ........................................... 1026
Meters ......................................................................................................................................... 1027
MET_104 Editing a meter .................................................................................................. 1027

SynerGEE Electric 5.0

User Guide

44

Table of Contents
MET_105 Creating/editing a meter .................................................................................... 1027
MET_106 Specifying the location of a meter ..................................................................... 1028
MET_107 Specifying whether to use demands on a meter ................................................ 1028
MET_108 Editing continuous and emergency current ratings for a meter ......................... 1029
MET_109 Editing kW values for a meter ............................................................................ 1029
MET_110 Editing kvar values for a meter .......................................................................... 1030
MET_111 Editing amp values for a meter .......................................................................... 1031
MET_112 Editing % pf values for a meter .......................................................................... 1032
MET_113 Enabling or disabling the Use with Color By Meter feature ................................ 1033
MET_114 Enabling or disabling the Use with Color By Meter feature and selecting the feature
color ...................................................................................................................................... 1033
MET_115 Editing the note text for a meter ......................................................................... 1034
MET_116 Opening or closing a meter ................................................................................ 1035
Nodes .......................................................................................................................................... 1035
NOD_101 Editing the X,Y coordinates for a node .............................................................. 1035
NOD_102 Editing the description for a node ...................................................................... 1036
Projects ....................................................................................................................................... 1036
PRO_101 Editing a project ................................................................................................. 1036
PRO_102 Editing the energize and retire years for a project ............................................. 1037
PRO_103 Editing the total KW and kvar for a project ........................................................ 1038
Reclosers .................................................................................................................................... 1038
REC_101 Editing a recloser ............................................................................................... 1040
REC_102 Creating/editing a recloser ................................................................................. 1040
REC_103 Specifying the manufacturer name and model name for a recloser .................. 1041
REC_104 Editing the amp rating and interrupt rating for a recloser ................................... 1041
REC_105 Editing the mechanical response type for a recloser ......................................... 1042
REC_106 Editing the single phase operation status for a recloser .................................... 1042
REC_107 Editing fast phase settings for a recloser ........................................................... 1043
REC_108 Editing slow phase settings for a recloser ......................................................... 1044
REC_109 Editing the fast phase pickup amps for a recloser ............................................. 1045
REC_110 Editing the fast phase minimum response value for a recloser ......................... 1045
REC_111 Editing the phase source side fuse K factor and phase load side fuse K factor for a
recloser ................................................................................................................................. 1046
REC_112 Editing the disable ground status for a recloser ................................................. 1046
REC_113 Editing fast ground settings for a recloser .......................................................... 1047
REC_114 Editing slow ground settings for a recloser ........................................................ 1048
REC_115 Editing the fast ground pickup amps for a recloser ............................................ 1049
REC_116 Editing the fast ground minimum response for a recloser .................................. 1049
REC_117 Editing the ground source side fuse K factor and load side fuse K factor for a
recloser ................................................................................................................................. 1050
REC_118 Specifying the location of a recloser .................................................................. 1050

User Guide

SynerGEE Electric 5.0

Table of Contents

45

REC_119 Specifying a manufacturer name, model name, and mechanical response type for a
recloser ................................................................................................................................. 1051
REC_120 Editing the interrupt rating for a recloser ............................................................ 1052
REC_121 Editing the fast phase cutoff and fast ground cutoff for a recloser ..................... 1052
REC_122 Editing the slow phase cutoff and slow ground cutoff for a recloser .................. 1053
REC_123 Editing the slow phase and slow ground pickup amps for a recloser ................ 1053
REC_124 Editing fast phase values for a recloser ............................................................. 1054
REC_125 Editing slow phase values a recloser ................................................................. 1055
REC_126 Editing the fast phase and slow phase pickup amps for a recloser ................... 1055
REC_127 Editing fast ground values for a recloser ........................................................... 1056
REC_128 Editing slow ground values for a recloser .......................................................... 1057
REC_129 Editing the fast ground and slow ground pickup amps for a recloser ................ 1057
REC_130 Editing the phasing for a recloser ...................................................................... 1058
REC_131 Editing the bypass status for a recloser ............................................................. 1058
REC_132 Editing the fast phase pickup amps, minimum response, and def time for a recloser
1059
REC_133 Editing fast phase options for a recloser ........................................................... 1060
REC_134 Editing the slow phase pickup amps, minimum response, and def time for a recloser
1061
REC_135 Editing slow phase options for a recloser .......................................................... 1062
REC_136 Editing the fast ground pickup amps, minimum response, and def time for a recloser
1063
REC_137 Editing fast ground options for a recloser .......................................................... 1064
REC_138 Editing the slow ground pickup amps, minimum response, and def time for a
recloser ................................................................................................................................. 1065
REC_139 Editing slow ground options for a recloser ......................................................... 1066
REC_140 Setting the transfer scheme and operating mode for a recloser ........................ 1067
REC_141 Editing the disabled ground option for a recloser .............................................. 1068
REC_142 Editing the fast phase cutoff and fast ground cutoff for a recloser ..................... 1068
REC_143 Editing the slow phase cutoff and slow ground cutoff for a recloser .................. 1069
REC_144 Editing the transfer scheme type, transfer scheme delay, and operating mode for a
recloser ................................................................................................................................. 1069
REC_145 Editing the amp rating for a recloser .................................................................. 1070
Regulators ................................................................................................................................... 1070
REG_101 Editing a regulator ............................................................................................. 1071
REG_102 Editing a regulator ............................................................................................. 1071
REG_103 Creating/editing a regulator ............................................................................... 1071
REG_104 Editing the reverse mode and reverse threshold for a regulator ....................... 1073
REG_105 Editing the connection type, gang operated status, and gang metering phase for a
regulator ................................................................................................................................ 1074
REG_106 Editing forward mode values for a regulator ...................................................... 1075

SynerGEE Electric 5.0

User Guide

46

Table of Contents
REG_107 Editing the reverse mode and reverse threshold for a regulator ....................... 1076
REG_108 Editing reverse mode values for a regulator ...................................................... 1077
REG_109 Editing first house values for a regulator ........................................................... 1078
REG_110 Editing tap limit values for a regulator ................................................................ 1078
REG_111 Editing the tap direction and tap operation for a regulator ................................. 1079
REG_112 Specifying the location of a regulator ................................................................. 1079
REG_113 Turning a regulator on or off .............................................................................. 1080
REG_114 Editing the gang metering phase for a regulator ................................................ 1080
REG_115 Editing forward mode values for a regulator ...................................................... 1081
REG_116 Setting the energize year and retire year for a regulator ................................... 1082
REM ............................................................................................................................................ 1082
REM_201 .............................................................................................................................. 1082
Sectionalizers .............................................................................................................................. 1083
SZR_101 Editing a sectionalizer ........................................................................................ 1083
SZR_102 Creating/editing a sectionalizer .......................................................................... 1083
SZR_103 Editing the actuating current, number of counts, and location for a sectionalizer ......
1084
SZR_104 Specifying the location of a sectionalizer ........................................................... 1085
SZR_105 Editing the amp rating, actuating current, and number of counts for a sectionalizer .
1085
SZR_106 Editing the connection phase for a sectionalizer ................................................ 1086
Sections ...................................................................................................................................... 1086
SEC_101 Adding a section ................................................................................................ 1087
SEC_104 Editing the phasing, connection type, and length (in feet) for a section ............. 1087
SEC_105 Adding a graphic point to a section .................................................................... 1088
SEC_108 Editing the conductor types for a section ........................................................... 1088
SEC_109 Editing the description for a section ................................................................... 1089
SEC_110 Editing the conductor types for a section ........................................................... 1089
SEC_111 Editing the constant current (%I) and constant impedance (%Z) for a sections
distributed load ...................................................................................................................... 1090
SEC_112 Editing the constant current (%I) and constant impedance (%Z) for a sections spot
load ....................................................................................................................................... 1090
SEC_114 Editing the construction model for a section ...................................................... 1091
SEC_115 Editing equivalent spacing and height values for a section ................................ 1091
SEC_116 Editing the detailed spacing configuration type for a section ............................. 1092
SEC_117 Setting the transposition phasing order for a section ......................................... 1092
SEC_118 Configuring elbows on a section ........................................................................ 1093
SEC_119 Editing the phasing, connection type, and length (in meters) for a section ........ 1094
SEC_120 Setting the mitigation zone for a section ............................................................ 1094
SEC_121 Setting a section as a contingency section ........................................................ 1095
SEC_122 Setting the exposure zone for a section ............................................................ 1095

User Guide

SynerGEE Electric 5.0

Table of Contents

47

SEC_123 Editing the constant current (%I) and constant impedance (%Z) for a sections
distributed load ...................................................................................................................... 1096
SEC_124 Editing the constant current (%I) and constant impedance (%Z) for a sections spot
load ....................................................................................................................................... 1096
Sources ....................................................................................................................................... 1096
SRC_101 Editing source impedance values for a source .................................................. 1097
SRC_102 Editing the location link and note text for a source ............................................ 1097
Switches ...................................................................................................................................... 1097
SWT_101 Editing a switch ................................................................................................. 1098
SWT_102 Creating/editing a switch ................................................................................... 1098
SWT_103 Specifying the location of a switch .................................................................... 1099
SWT_104 Setting the operation from analysis status for a switch ..................................... 1099
SWT_105 Setting the energize year and retire year for a switch ....................................... 1100
Substations ................................................................................................................................. 1100
STN_101 Converting a node to a substation ..................................................................... 1101
STN_102 Editing minimum and maximum source impedance values for a substation ...... 1101
STN_103 Editing source impedance values for a substation ............................................. 1102
STN_104 Editing the note text for a substation .................................................................. 1102
STN_105 Editing the AMS link for a substation ................................................................. 1103
STN_106 Setting the region ID for a substation ................................................................. 1103
STN_107 Editing maximum source impedance values for a substation ............................ 1103
Transformers ............................................................................................................................... 1104
TRN_101 Editing a transformer ......................................................................................... 1104
TRN_102 Creating/editing a transformer ........................................................................... 1105
TRN_103 Editing the high-side and low-side connection types for a transformer .............. 1105
TRN_104 Creating/editing a transformer ........................................................................... 1107
TRN_105 Specifying the location of a transformer ............................................................. 1108
TRN_106 Editing the gang operated status, gang metering phase, and tap control for a
transformer ............................................................................................................................ 1109
TRN_107 Editing forward mode values for a transformer ...................................................1110
TRN_108 Editing first house values for a transformer ........................................................1111
TRN_109 Editing tap limit values for a transformer .............................................................1111
TRN_110 Editing the tap setting for a transformer ..............................................................1112
TRN_111 Editing high-side and low-side connection types for a transformer .....................1112
TRN_112 Editing the low-side ground reactance for a transformer ....................................1114
TRN_113 Overriding impedance and reactance values for a transformer ..........................1115

Model Cleanup Commands

4001 Deleting duplicate nodes ..................................................................................................1119
4002 Replacing phase conductors ............................................................................................1119
4003 Replacing neutral conductors ......................................................................................... 1121

SynerGEE Electric 5.0

User Guide

48

Table of Contents
4004 Setting the load connection to line-line for any section without a neutral ....................... 1122
4005 Adjusting the phasing of a section to match the adjacent sections ................................. 1122
4006 Setting phase-to-phase and phase-to-neutral spacing on sections ................................ 1122
4007 Deleting all loop tie switches ........................................................................................... 1123
4008 Deleting all wandering lateral tie switches ...................................................................... 1124
4009 Deleting all classic protective devices ............................................................................. 1124
4010 Copying switch statuses from one year to another ......................................................... 1124
4011 Growing meter demands using the feeder multiplier ....................................................... 1125
4012 Fixing phasing in force unfed areas ................................................................................ 1126
4013 Copying the switchable device status from one year to other years ............................... 1127
4014 Copying meter device demands from one year to other years ....................................... 1128
4015 Resetting feeder colors ................................................................................................... 1129
4016 Moving load from unfed phases to fed phases ............................................................... 1129
4017 Replacing invalid conductors .......................................................................................... 1130
4018 Growing a meters demands using a percent growth rate .............................................. 1131
4019 Resetting meter colors .................................................................................................... 1132
4020 Converting classic fuses ................................................................................................. 1132
4021 Converting classic reclosers ........................................................................................... 1133
4022 Converting classic breakers ............................................................................................ 1133
4023 Converting classic sectionalizers .................................................................................... 1134
4024 Converting existing fuses ................................................................................................ 1134
4025 Converting existing reclosers .......................................................................................... 1135
4026 Converting existing relays ............................................................................................... 1136
4030 Combining close nodes ................................................................................................... 1137
4031 Eliminating close vertices ................................................................................................ 1137
4032 Eliminating duplicate open switchable devices ............................................................... 1138
4033 Eliminating zero-length sections that do not have open devices .................................... 1138
4034 Eliminating exposure zones with no failures ................................................................... 1139
4035 Rephasing one-phase laterals ........................................................................................ 1139
4036 Eliminating duplicate closed switchable devices ............................................................. 1140
4037 Using wandering laterals to feed forced unfed areas ...................................................... 1140
4038 Breaking up forced-unfed sections into one-phase lines ................................................ 1141
4039 Picking up lost neutrals ................................................................................................... 1141
4040 Opening switches to clear loops ..................................................................................... 1142
4050 Setting the value of a field ............................................................................................... 1142
4051 Setting the value of a field if its current value matches a specified value ....................... 1143
4052 Setting the value of a field if its current value is less than a specified amount ............... 1143
4053 Setting the value of a field if its current value is greater than a specified amount .......... 1144
4054 Setting the value of a field if its current value is missing or zero .................................... 1145
4055 Setting the value of a warehouse ID field if its current value is not in the warehouse .... 1146

User Guide

SynerGEE Electric 5.0

Table of Contents

49

4056 Setting the value of a zone ID field if its current value is not in the warehouse .............. 1147
4057 Setting the value of a protection database field if the current value is not in the protection
database ..................................................................................................................................... 1148
4058 Setting the value of a field if its current value matches another field .............................. 1149
4059 Setting the value of a field if its current value includes a specified value ....................... 1150
4060 Settings the value of a field if its current value matches a specified value, and a second field
matches a second specified value .............................................................................................. 1150
4061 Setting the neutral conductor to same as phase ............................................................. 1151
4062 Replacing invalid conductors with the next valid upstream conductor ............................ 1153
4070 Growing loads across multiple years using a specified growth rate ............................... 1153
4071 Growing loads across multiple years using the section growth rates ............................. 1155
4072 Growing loads across multiple years using the section growth curves ........................... 1156
4073 Growing loads across multiple years using the feeder multiplier .................................... 1157
4074 Copying loads across multiple years .............................................................................. 1159
4075 Deleting loads for unenergized years ............................................................................. 1160
4076 Multiplying loads in multiple years .................................................................................. 1160
4077 Growing meter demands across multiple years .............................................................. 1161
4078 Copying phasing and conductor settings across multiple years ..................................... 1162
4081 Deleting kVA for distributed loads for the current year .................................................... 1163
4082 Deleting kWh for distributed loads for the current year ................................................... 1164
4083 Deleting the customer count for distributed loads for the current year ........................... 1164
4084 Deleting kW and kVAR for spot loads for the current year .............................................. 1165
4099 Special code ................................................................................................................... 1165
4101 Suppressing the model cleanup report ........................................................................... 1165
4104 Suppressing the confirmation message to apply fixes .................................................... 1165
4105 Confirming whether to run the script ............................................................................... 1165
4106 Applying the script to the query set only ......................................................................... 1166
4110 Correcting the orientation of regulators and transformers ............................................... 1166

SynerGEE File Summary

Background Image Support
SynerGEE-Supported Image Types ............................................................................................ 1173
World Files for Raster Images ..................................................................................................... 1173
Vector Images and Supplemental Files ...................................................................................... 1175

SynerGEE Electric 5.0

User Guide

50

User Guide

Table of Contents

SynerGEE Electric 5.0

CHAPTER

1
Introduction
SynerGEE Electric is a software package developed by GL Noble Denton that simulates, analyzes, and
plans power distribution feeders, networks, and substations. The package is a modular collection of tools built
on a by-phase simulation engine. The simulation engine is an object-oriented design that consists of highly
detailed models for power system devices such as lines, transformer banks, regulator banks, switched
capacitors, and active generators. The models are built to reflect the actual construction of real power system
equipment. The usability and capability of SynerGEE demonstrates the level of commitment involved in
producing quality analysis software.
SynerGEE is user-friendly. The distribution system models can be constructed quickly and are easy to
maintain. The tools, utilities, and features were designed to get feeders modeled quickly and accurately. Data
requirements are clearly marked in dialog boxes and are kept to a minimum so that the models can be
specified with basic nameplate parameters.
The device models and calculations used within SynerGEE conform to the methods accepted and depended
upon by the power engineering community. GL Noble Denton relies on books, manuals, and technical papers
describing algorithms that have been tested and well-proven. Furthermore, GL Noble Denton is advancing
distribution analysis technology in many areas such as device modeling, Delta-modeling, by-phase looped
load-flow and fault analysis, and generator simulation.
SynerGEE supports an enhanced load model that allows the apportionment of loads into three
classifications. This model provides a better tool for you to create more accurate representations of a
distribution system by having control over the way that loads respond to their voltage level. Loads can be
connected between phases and to ground. A variety of tools is supplied to allocate loads and simulate
growth.
More than 850 engineers and technicians at utilities around the world use SynerGEE Electric. SynerGEE
demonstrates GL Noble Dentons commitment to provide the most accurate, reliable, and easy-to-use
software designed to meet your engineering and operational needs.

THE SYNERGEE APPROACH TO DEVICE MODELS

The SynerGEE simulation engine facilitates the detailed by-phase modeling of distribution systems and their
equipment. The engine is built from an innovative object-oriented design that focuses on the best ways to
model distribution system devices, without matrix-based modeling limitations.
This design allows SynerGEE to support very extensive device models. Every model has terminals that
respond to voltage and current conditions just like the real devices. When the load-flow application is run, it
does not see lines, regulators, and capacitors. It sees distribution power system devices with interconnected

SynerGEE Electric 5.0

User Guide

52

Introduction
terminals. When the load-flow applies voltages or demand current to a device like a regulator, that device
handles its own internal workings.
For example, the regulator model is constructed internally like a real voltage regulator. Models exist for the
autotransformer, the load tap-changer, the tap controller, and the line-drop compensator. These components
are all wired together within the software like a real step voltage regulator is built at the factory. The
regulator is able to look at its terminal conditions and its settings and possibly raise or lower a tap. The
regulator model ratchets up and down during the load-flow like a real regulator in a distribution system.
By building realistic device models, GL Noble Denton produces more effective software and provides a more
realistic tool. The SynerGEE approach decouples the engineering analysis routines from the device models.
This allows a more focused concentration on analysis results, rather than specific device models. For
example, when GL Noble Denton designed fault voltage analysis, it could concern itself primarily with fault
voltages, rather than the proper LDC modeling when working on the voltage regulator model. NewtonRaphson-based programs cannot make this separation because all equations need to be in the Jacobian to
reach the correct solution.
GL Noble Dentons detailed models are based on manufacturer schematics, and are not limited to passive
admittance values like models in a Newton-Raphson environment. Many SynerGEE users with extensive
models have reported model voltages within one volt of measured values, field regulator taps matching the
SynerGEE values to within one tap, and imbalance within a percent of that predicted by SynerGEE.

SYNERGEE DOCUMENTATION
SynerGEE comes with an extensive documentation set, including the following documents:

SynerGEE Electric User Guide. The User Guide is the complete reference for the SynerGEE user,
containing usage procedures, detailed application operation, electrical theory, and power
mathematics. The User Guide contains the same information as the Online Help but is formatted for
easy reading and printing.

SynerGEE Electric Online Help. The SynerGEE help system is designed to provide quick assistance
while you are using SynerGEE. The Online Help contains the same information as the User Guide
but is formatted for quick on-screen access.

SynerGEE Electric Technical Reference. The Technical Reference provides details on the theory
and methods behind the SynerGEE analyses.

Installation Guide. The Installation Guide is provided in hardcopy format and is also saved on the
root level of the installation DVD. This document provides installation procedures.

System Requirements. The System Requirements document is provided in hardcopy format and is
also saved on the root level of the installation DVD. This document provides the minimum and
recommended components SynerGEE needs to run on a system.

Release Notes. The Release Notes describes the new enhancements, fixes, and updates that are
provided with the current SynerGEE release. The release notes are provided as PDF files and can
be accessed from the SUPPORT tab of the SynerGEE ribbon bar.

Knowledge base articles. Knowledge base articles are issued periodically to address concerns or
questions about the software that are not covered in the main documents. Generally, they may be
obtained by contacting Technical Support.

User Guide

SynerGEE Electric 5.0

Introduction

53
Product Advisories. From time to time, if a service release is posted or important issues are
discovered with the current version of SynerGEE, a Product Advisory may be issued. Typically,
Product Advisories are downloaded from the Stoner Software user portal (my.stonersoftware.com).

The Technical Communications staff welcomes your feedback on all SynerGEE documentation. Please send
questions or comments to techcomm@gl-group.com.

TERMS CROSS-REFERENCE
For consistency, SynerGEE documentation and the SynerGEE interface use a standard set of terminology.
For example, an electrical path between two nodes is normally referred to as a section, not a line, facility,
or wire. Because your organization may use different terminology, this cross-reference is provided to help
you find what you are looking for in this document.

Term

SynerGEE
equivalent

Additional notes

actual impedance

simple impedance

asset

(none)

The general term asset is not used. At times, the term

equipment is used in a similar sense. However, more
specific references are more common.

circuit

feeder

contour point

vertex

device name

device ID

DPA/G

(none)

Distribution Primary Analysis/Graphics (DPA/G) was

SynerGEEs predecessor and is no longer supported. All
DPA/G functionality was incorporated into SynerGEE or
deprecated.

failure zone

exposure zone

feeder name

feeder ID

FID (Facility
IDentifier)

ID

Nodes and sections must have unique IDs. Devices have

IDs as well, but are not required to be unique.

directory

folder

In the Windows environment, the terms folder and

directory are mostly interchangeable. For consistency, this
documentation uses the term folder only.

graphic node

vertex

intermediate point

vertex

label

annotation or text
label

Annotations are generally text on the map that is generated

automatically, perhaps representing IDs or analysis results.
Text labels, on the other hand, are generally created
manually, one-at-a-time, with custom content.

SynerGEE Electric 5.0

User Guide

54

Introduction

Term

SynerGEE
equivalent

line

section

The term line is used frequently to describe electrical lines

in a general sense, but in a SynerGEE model, any electrical
path between two nodes is known as a section.

load shape

load curve

node name

node ID

power source

feeder or subtran

section name

section ID

short circuit

fault

study

analysis

Though the word study can be used to describe the overall

process of using SynerGEE analysis features, the term
analysis is used in any reference to a specific SynerGEE
analysis feature.

graphic point

vertex

wire

conductor

Additional notes

SYNERGEE LICENSING
Use of SynerGEE requires a license. A license determines what features of SynerGEE are available to you,
based on your contract with GL Noble Denton. The most basic license available is the planning license, which
provides basic modeling, load-flow, and fault analysis features. More advanced features, such as
contingency analysis, SynerGEE Cable, and SynerGEE Reliability require additional licensing.
Upon startup, SynerGEE will notify you if the license files expiration date is within 30 days of the current date.
While running SynerGEE, you can select which licenses are active at the current time. This feature is
particularly useful within a network licensing system, which maintains licenses on a network server and
issues them on demand. For example, if you had three copies of SynerGEE but only one reliability license,
you would not want a user to have the reliability license active if it was not being used, because this would
prevent another user from accessing SynerGEE Reliability features. For more information on network
licensing, see the Multi-Use Licensing Guide.
If a user attempts to check-out a module that is not available, a message will appear that lists the modules
that are currently unavailable, as well as a list of the users who currently have the module checked out. In
certain instances, SynerGEE will automatically check in a module where it is needed to execute specific
tasks. For more information, see Time Versus Current Coordination (TCC) Graph on page 604 or Importing
GIS Data Using MiddleLink on page 100.

TO SELECTIVELY ENABLE AND DISABLE LICENSING

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the Modules tab.

User Guide

SynerGEE Electric 5.0

Introduction

55

In the list of module names, select and clear check boxes to activate and deactivate licenses.

Select the Retain current configuration check box to use the current licensing settings the next
time you start SynerGEE. If you clear the check box, only the Planning license will be enabled when
you restart SynerGEE. This feature is provided for network license users to help prevent module
licenses from being unnecessarily checked out.

Take note of the license expiration date at the bottom of the editor. Contact GL Noble Denton is your
SynerGEE license is about to expire.

Click OK to accept your changes and close the editor.

MULTIPLE SESSIONS AND NETWORK INSTALLATIONS

Although you can run multiple sessions of SynerGEE simultaneously, it generally is not designed for this sort
of operation. The ways in which SynerGEE references a variety of external files is well-suited for single
session on a local PC, but not multiple sessions, especially on a network server. These external files include
information on analysis settings, analysis output, and several other critical parameters. If you operate multiple
sessions, they can conflict and overwrite data belonging to one another.
Within your preferences, you can set SynerGEE to allow multiple sessions, which does provide some
protection against accidental overwrite. With this option set, SynerGEE appends a unique identifier to each
external file created and/or used by a particular session. Thus, each individual session uses its own set of
files and some data integrity is maintained. However, be aware that when you close a SynerGEE session, it
will delete all files associated with that session, including report files and output databases. You will not have
the opportunity to browse your SynerGEE output after you end a session.
It should be emphasized that running multiple sessions, especially in a network environment, is not
recommended and can produce unpredictable results. If you must have multiple users simultaneously, you
should license individual copies for them and install the application on their PCs. Also, remember that
multiple users should never work on the same model at once, unless you are operating an enterprise
database system. For more information on enterprise databases, see Using an Enterprise Database
System on page 114.

TO SET SYNERGEE TO ALLOW MULTIPLE SESSIONS

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the SynerGEE tab.

Select the Allow Multiple Sessions check box.

Click OK to accept your change and close the editor.

VIEWING SYNERGEE VERSION INFORMATION

Perform either of the following procedures to view information on your version of SynerGEE. You can view
the version information in a traditional About SynerGEE dialog box, or you can view the version information
as a SynerGEE grid-style report. With the Version report, you can use SynerGEEs report controls to export
the version information to an external file format, for example if you need to send the information to GL Noble
Denton Technical Support.

SynerGEE Electric 5.0

User Guide

56

Introduction

TO VIEW SYNERGEE VERSION INFORMATION

1

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Help group, click About SynerGEE.

TO VIEW THE SYNERGEE VERSION REPORT

1

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Help group, click Version.

TECHNICAL SUPPORT
Each SynerGEE license includes comprehensive technical support. Client Services engineers are always
ready to answer your questions, as well as receive any comments you may have about the product. Many of
the features and enhancements included in new versions come from users like you. If you have an idea on
how we could make the product better, GL Noble Denton would like to hear from you.
To get Technical Support contact information, select the SUPPORT tab in the SynerGEE ribbon bar and
then, in the Help group, click Email Technical Support. The email feature allows you to attach key files,
including the currently loaded model and warehouse, the current SynerGEE analysis settings, and a
screenshot of the map. You can send any of these items directly to GL Noble Denton Client Services for
review. A version report will be automatically attached to the support email as an *.HTML file.

User Guide

SynerGEE Electric 5.0

CHAPTER

2
Managing SynerGEE
Data
Distribution system modeling and analysis is complex. The process is inherently data-intensive, and the
accuracy of your analysis results rests solidly on the quality of this data. Therefore, the importance of good
data, and likewise good data management, cannot be overemphasized.
Refer to the topics listed below for more information.

Overview of Data Management on page 58

Network intelligence and enterprise data flow on page 58

SynerGEE Data Types on page 59

SynerGEE Data Formats on page 70

Data Source Aliases (DSAs) on page 75

Subsets on page 82

Versions on page 86

Partials on page 89

Cases on page 91

Data mart on page 98

Unit Tests on page 99

Importing GIS Data Using MiddleLink on page 100

Using an Enterprise Database System on page 114

Importing Real-Time Data on page 124

Gallery on page 129

Backing Up SynerGEE Data on page 131

Working Directly with Database Files on page 132

Checking and Repairing Database Schemas on page 134

Viewing Session Data on page 136

Editing Default Values for SynerGEE Devices on page 136

SynerGEE Electric 5.0

User Guide

58

Managing SynerGEE Data

Validating and Cleaning Up Model Data on page 137

OVERVIEW OF DATA MANAGEMENT

SynerGEE can use a variety of different data types from different source formats, and provides extensive
merging, validation, and other management tools. For this reason, working with SynerGEE data is often more
complex than traditional procedures of simply loading and saving files. Once your data architecture is in
place, SynerGEE usage is designed to be simple; however, construction of this architecture can take time
and consideration. In addition, management of data and your data architecture is often an iterative process
that evolves with your simulation needs and advancing workflows.
To help you manage the variety and number of data source files, SynerGEE uses the concept of data source
aliases (DSAs) to load, merge, and save data. A DSA functions as an intelligent link to a source file that frees
you from the burden of remembering file names, types, and locations.
Many users successfully manage their data solely through SynerGEE, without having to know the details of
databases and other file formats. On the other hand, some users work with source files directly, performing
advanced functions for specific purposes. With SynerGEEs powerful tools and open database structure, you
have the freedom to manage your data in any way that suits you.
Refer to the topics listed below for more information.

NETWORK INTELLIGENCE AND ENTERPRISE DATA FLOW

In addition to local file usage, SynerGEEs data management engine is designed to facilitate enterprise data
concepts. With the variety of local and server file formats supported, along with data merging and validation
tools, you can achieve virtually any level of simulation data integration throughout your network systems.
Many users work with local files only, and SynerGEE is perfectly suitable for this purpose. For example, a
user may maintain an Access database of a model on a PC or server, and all studies are done with that
model. When the model requires updates, they are done manually. Other users extend this workflow to
include integration of GIS data, normally through the import of MiddleLink data. In this case, model updates
are usually more automated, and the organization has achieved some level of system integration.
GIS integration is a common form of integration with SynerGEE, and can facilitate accurate and reliable
modeling. You should be aware, however, that integration possibilities extend far beyond GIS integration.
With SynerGEEs import/export tools and enterprise database features, you can achieve nearly limitless
integration with many different systems, such as SCADA, OMS, CIS, or other systems. In fact, integration is
usually limited only by the availability of accurate data and the personnel to implement it.
Enterprise data management is a complex, architectural concept and is unique to each organization. This
document does not attempt to suggest how you should pursue integration at your organization, or even if you
should integrate at all. It only seeks to make you aware of the possibilities that exist, and help explain the
methodology behind SynerGEEs data management tools. GL Noble Denton has extensive experience with
data integration projects and would be happy to discuss options with you.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

59

SYNERGEE DATA TYPES

SynerGEE data is classified by type. Each data type can be its own independent source file, or series of files.
Data types can also be combined in one single file. To load any particular data type into SynerGEE, you
generally need create a DSA to the source file, where the DSA specifies what data type or types is
associated with the file.
The following table describes the primary data types that are used in SynerGEE. Many of these data types
have a variety of source formats available. For example, model data can be imported from an Access
database, an Oracle database, a MiddleLink text file, and several other formats. In many cases, especially
with model data and equipment data, you can import and merge multiple sources of data, even from different
source formats. For more information on supported data formats, see SynerGEE Data Formats on page 70.
Data source type

Description

Supported formats

Model data

Model data is used to build the topology of a model.

Model data includes information on sections,
nodes, and equipment location, and is largely
responsible for the map you see when a model is
loaded.

Access (personal)

For more information, see Model data on

page 61.
Equipment data

Equipment data refers to the nameplate equipment

data that is mostly invisible in the map display but
plays a critical role during SynerGEE analyses.
Most devices that you see on your map have some
sort of equipment data associated with them that
describes the type of device and related
operational parameters. Equipment data also
includes zone data, such as the definitions of
customer zones.

Enterprise DBs
MiddleLink
Binary (EDM)
XML
Access (personal)
Enterprise DBs
MiddleLink
Binary (EDM)
XML

For more information, see Equipment data on

page 64.
Protection data

Protective device curve data resides in a special,

standalone Access database that is shipped with
SynerGEE. It is required for certain analyses and
protection work, including the SynerGEE TCC view.

Access (personal)

For more information, see Protection data on

page 67.
Versions

Versions allow you to store different versions of the

same model, for conducting planning studies and
other what-if scenarios. For example, you could
model a proposed new subdivision and save it as a
version, rather than making the change
permanently to your base model.

Access (personal)
Enterprise DBs

For more information, see Versions on page 86.

SynerGEE Electric 5.0

User Guide

60

Managing SynerGEE Data

Data source type

Description

Supported formats

Partials

Conceptually similar to subsets, partials allow you

to import a customizable subset of data into your
model.

MiddleLink

For more information, see Partials on page 89.

Subsets

Subsets allow you to save and load related,

predefined subsets of a model dataset, for quick
model reconfiguration. For example, you can save
subsets of your load data, to perhaps reconfigure
your model for winter or summer quickly, without
having to maintain separate models.

Access (personal)
Enterprise DBs

For more information, see Subsets on page 82.

Results

Custom

SynerGEE results, including a wide variety of

analysis results, can be imported and exported to a
supported database format. During the export
process, the target is considered a results-type
source, and the DSA for the transaction must be
specified as such. For more information on this
process, see Importing and exporting analysis
results on page 452.

Access (personal)

The custom data source serves as a catch-all

data type where you can store any type of data
associated with section IDs. It is used by certain
specialized SynerGEE features, including results
import and the joiner.

Access (personal)

Enterprise DBs

Enterprise DBs

For more information on these features, and their

use of the custom data source, see Importing and
exporting analysis results on page 452 and
Joiner on page 133.
Data mart

The SynerGEE data mart is essentially a database

of client related data that can be logically grouped
to provide information useful to model building,
distribution, and analysis.

Enterprise DBs

For more information, see Data mart on page 98.

Historian

Messaging scripts for PI, SQL Server, MySQL, and

Oracle databases that contain semi-real time data.

For more information, see Importing Real-Time

Data on page 124 or DBMS Real-Time Data on
page 127.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

61

Model data
Model data includes the instance data associated with the spatial construction of your model. In other words,
all data for the topology and structure of your model is found in model data. The map of your model is
generated solely from this data.
As an example, model data can include:

Section data, such as length, loading, and phasing

Node coordinates

Equipment location and type

With several data source formats, including Access and binary files, a model data source can include other
data, such as equipment data. For more information, see DSA data types on page 76.

TO LOAD (IMPORT) MODEL DATA

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Load.

Follow the wizard prompts, noting the following:

-

You can browse for a file, but the preferred method is selecting a DSA from the list. If you
do browse manually, a DSA will be created for you. For more information on these
subjects, see Managing DSAs on page 76 and Creating DSAs on page 79.

Regardless of the file format loaded, all data is merged with data currently in memory. A
load action never does a blanket replacement.

After a load, you may need to select feeders before anything is visible on the map. For
more information, see Selecting Feeders on page 157.

Unless you check the Load Warehouse option in the wizard, equipment data is never
loaded by this procedure, even if you are loading a binary file that contains equipment data.
To load equipment data, you must do so explicitly. For more information, see To load
equipment data on page 65.

TO SAVE (EXPORT) MODEL DATA

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Save.

If any errors are detected in the model data, a warning message box will be displayed, describing
the problems that were found. You have the following options from this message box:
-

Copy. Copy the contents of the warning message box to the clipboard, so you can further
investigate the problems or email the warnings to Technical Support.

Commit. Save the model database, including the errors that are listed.

Cancel. Return to the model without saving any changes.

SynerGEE Electric 5.0

User Guide

62

Managing SynerGEE Data

Loading model data Conversion and merging

When you load model data, it is merged with the model data currently in memory, excepting any conflicts that
might arise. For example, you could load a set of feeders from an Access database and then load a different
set of feeders from a binary file, resulting in the combined model in memory. Afterwards, you could resave the
entire model to a third, independent data source, of any format you choose. Loading model data never
outright replaces current memory data, except in the case of loading models from the gallery. For more
information, see Gallery on page 129.
This merging and conversion functionality highlights some of the power of SynerGEE data management
tools. In many cases, simply loading and saving models will be sufficient for your needs. However, with this
level of flexibility, you can do things such as:

Produce a comprehensive model by importing data from a variety of sources, including existing
model data and formatted external data, such as SCADA data.

Conduct focused updates from an external data source, such as a GIS, by merging in specific data
only, perhaps formatted as a MiddleLink data source.

Implement an enterprise database management system for your model data, using a format such as
Oracle or SQL Server. For more information, see Using an Enterprise Database System on
page 114.

The depth to which you use this flexibility depends on your needs, resources, and IT support. GL Noble
Denton has extensive experience with customized data management solutions, and can assist you with
planning and implementation of integration projects. For more information, contact GL Noble Denton.

Saving model data merging versus replacing

When you save model data, you can choose whether to save the entire dataset in memory, or selected
feeders. If you save selected feeders only, SynerGEE replaces existing feeders with the feeders to be saved.
If you save all feeders in memory, SynerGEE merges the data into the target as follows:

If the target data file is a database, SynerGEE merges the saved data with the data currently in the
database.

If the target data file is a binary file or a flat file such as XML or MiddleLink, the original data file is
completely replaced.

For personal files, you should use extreme caution when dealing with selected feeders; that is, loading and
saving less than the whole model. Small switch changes can have a significant impact on connectivity and
feeder ownership of sections, which presents a strong potential for data corruption during a save. To help
prevent this, SynerGEE clears out any existing feeders from an existing target when saving only selected
feeders. This safeguard is only a small token of assistance, though, as the responsibility for careful data
management rests with you, the user. In general, when working with personal model files, you should load
and save the entire model at once, whenever feasible, to prevent these sorts of issues.
For enterprise databases, checking in and out selected feeders is your only option, because an enterprise
system by nature prevents whole-model operations. SynerGEE enterprise features provide some safeguards
to help prevent data corruption, but again, much of the responsibility rests with you. Anytime you are working
with model data from an enterprise system, you should stay aware of switching actions that may cause
potentially disruptive changes. You can help avoid problems by checking out adjacent feeders along with
those you plan to work on. For more information on enterprise databases, see Using an Enterprise Database
System on page 114.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

63

Model data in Access

Microsoft Access is a common format for storing model data. In Access, most tables for model data are
prefixed by Inst, short for instance. This term refers to the instance (or occurrence) of items in the model.
Each section, node, and device is considered an instance of that item, and is represented by its own instance
record in the database. Because naming conventions in the Access schema are designed to be intuitive, they
are often used throughout the interface and documentation to identify pieces of data, even in reference to
other data formats.
An Access database with model data can contain other data, such as equipment data. As such, you can have
your equipment and model data in the same database, if desired. For more information, see DSA data types
on page 76.
Tip:

If you have a large model, set the Jet engine max open file limit to 20000. Newer versions of the Jet
engine ship with the default set at 9500, which can cause issues with large datasets. Adjusting the
file limit size will eliminate the problems.

References to equipment data

In many cases, a model data record will reference an equipment data record. For example, a motor in a
model data source should reference a motor type in an equipment data source. This methodology allows you
to store nameplate and manufacturer information about a piece of equipment in one place and then reuse it
at multiple instances throughout a model. For more information on equipment data, see Equipment data on
page 64.
When you import model data into SynerGEE, no checks are performed to verify that any references are
intact. For example, if you load in a motor that references a motor type not found in the current equipment
data source, SynerGEE will not warn you. In this case, the motor type in the Motor editor will display
Unknown, and motor-related analyses may fail. For this reason, you should be sure that your model and
equipment data sources match up, and that you always have the appropriate equipment data loaded for the
current model in memory.

Comparing model data

SynerGEE includes a data comparison tool that generates a report of differences between a model in
memory and a personal model dataset on disk. When the comparison is run, SynerGEE compares every
comparable data item, looking for any differences. When complete, SynerGEE generates a report listing the
total number of comparisons made, followed by any differences found, including:

Data elements in memory, but not on disk

Data elements in the data source on disk, but not in memory

Data elements shared by both data sources, but with different field values

SynerGEE Electric 5.0

User Guide

64

Managing SynerGEE Data

Sample portion of a database comparison report

Keep in mind that the tool is only useful if you are comparing a complete dataset with another complete
dataset. Therefore, you should have an entire dataset loaded into memory before making the comparison.
Otherwise a lengthy list of messages for all entities not loaded could be generated.
Data comparison is particularly useful if you extract model data directly from a GIS. In this situation, you may
monitor disparities between your SynerGEE model and the GIS, especially as updates are made to the GIS.
As such, you are able to determine more easily when your SynerGEE model needs to be updated (or reextracted).

TO PERFORM A MODEL DATA COMPARISON

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Compare.

In the wizard, select the data source on disk to which you want to make the comparison.

Click Finish.
Tip:

The comparison report lists results from the context of the Access database schema.
However, you can perform comparisons of model data in any format. The Access schema
simply provides a convenient means of identifying specific data items.

Sample model database

SynerGEE ships with a sample database in Access called SampleDb.mdb, which contains a sample model
dataset that you may find useful. This database also includes a complete sample equipment data set. You
can use this sample data for experimentation and learning purposes. If you choose to use this database as a
learning tool, you should preserve a copy of the original somewhere, in the event that you make changes that
impact its integrity.
The sample database can be found in your SynerGEE documents directory under the Sample Data
subfolder.

Equipment data
Equipment data can be thought of as your virtual warehouse of power system devices and certain property
sets. A record within your equipment data source contains nameplate factory data on a certain device type,
such as ratings and physical construction. In Access, tables in the equipment data source use the prefix Dev.
By keeping equipment data as a separate data type, SynerGEE allows you to reference this data multiple
times by the device instances in your model data. For example, assume that you have a 1200LB13 switch
type in your equipment data. This record contains current and voltage ratings, which is nameplate data that

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

65

will be consistent between all switches of this type. Therefore, instead of repeating the same data for each
instance in your model data, the model data simply contains a reference to the 1200LB13 switch type record
in the equipment data, as applicable. In essence, equipment data allows the maintenance and reuse of
common manufacturer data, freeing up the model data to contain only model-specific configuration
information. For example, in the model data, the switch instance record would contain data on whether the
switch is open or closed.
When performing an analysis, SynerGEE requires the correct equipment data in memory that is, data that
matches the references from the model data. For more information, see References to equipment data on
page 63.
With several data source formats, including Access and binary files, an equipment data source can include
other data, such as model data. For more information, see DSA data types on page 76.

Switch instance editor (model data) and Switch type editor (equipment data)

Loading equipment data

TO LOAD EQUIPMENT DATA
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Warehouse group, click Load.

Saving equipment data

TO SAVE EQUIPMENT DATA
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Warehouse group, click Save.

SynerGEE Electric 5.0

User Guide

66

Managing SynerGEE Data

Clearing equipment data from memory

Aside from shutting down SynerGEE, this procedure is the only means of clearing equipment data from
memory. Creating new models or loading model data does not affect equipment data.

TO CLEAR ALL EQUIPMENT DATA FROM MEMORY

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Warehouse group, click New.

How equipment data is loaded and managed in memory

Equipment data is considered an independent type of SynerGEE data, and is loaded, saved, and managed
as such. To load equipment data, you must do so explicitly, using an equipment data DSA. Model data and
equipment data are handled separately, both in a data source and through the SynerGEE interface. Loading
model data does not automatically load equipment data, although the model data references it and requires it
to run analyses.
Likewise, when you save a model, you save model data only. If you want to save equipment data, you must
do so explicitly.

Additional equipment data (zones and curves)

Equipment data can also include the following:

Customer classes (see Customer classes on page 810)

Customer zones (see Customer zones on page 815)

Exposure zones (see Exposure zones on page 679)

Mitigation zones (see Mitigation zones on page 683)

Motor torque curves (see Managing motor curve types in the equipment warehouse on page 368)

Although these types of data may not seem related to nameplate equipment data, they are similar in the
context of SynerGEE modeling and data storage. A particular zone, for example, can be reused for multiple
sections in any given model. Therefore, to facilitate the concept of reuse, these items are stored as
equipment data. Do not be confused by where you may see them in the SynerGEE interface, such as which
tab(s) they fall under in the model explorer.

Merging equipment data

Like model data, you can load equipment data from multiple data sources, and SynerGEE will merge the
model in memory. For example, you could have an equipment data source in Access, and another as a binary
file. When the two are imported, the data is merged as a single equipment data set, which you could then
save as a consolidated set to a separate file.
More than likely, however, you will keep a single database or file that represents the collective set of
equipment, zone, and curve data at your organization. Because equipment data is not likely to be as
extensive as your model data, a consolidated source is rarely an unwieldy file. And, a consolidated

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

67

equipment data file promotes consistency throughout your organization, and allows you to easily promulgate
the data to any user who needs it.
In many cases, you may choose to store copies of equipment data with your model data, for convenience. If
you do so, remember that any changes to equipment data should also be applied to your master equipment
file, if such a file exists. For more information, see DSA data types on page 76.

Sample equipment database

SynerGEE ships with a sample database in Access called SampleDb.mdb, which contains a sample
equipment dataset that you may find useful. However, if you plan to use it in a production capacity, you
should customize it with the actual device types that you use. If your organization has multiple SynerGEE
users, you may find collaboration helpful to develop a comprehensive, standard equipment data source that
is shared by all users.
The sample database can be found in your SynerGEE documents directory under the Sample Data
subfolder. GL Noble Denton makes no claims regarding the accuracy of the manufacturer data contained
within.

Protection data
SynerGEE ships with a protection database in Access that contains the extensive SynerGEE protective
device curve library, used for protection coordination studies. In addition, the protection database contains
information necessary to drive the logic in many of the SynerGEE editors. Data merging, editing, and source
file format changes are not applicable to this data set. The data is not editable within the SynerGEE interface,
and it must be in Access format in your SynerGEE documents directory. DSAs are also not applicable to this
type of data.
Because of the essential information it contains, you should generally load the protection database as well
when you load a model and equipment data.

TO LOAD THE PROTECTION DATABASE

1

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Protection Curves group, click Library.

Click Finish to load the protection curve library.

General information on protection data

When you load the protection database, only the CurveDefinitions table is loaded. This table provides enough
data to run the SynerGEE editors, but does not contain the actual point data for plotting curves on a TCC
graph. To plot curves, SynerGEE performs an automatic query of other tables that remain on disk. For more
information about how SynerGEE uses the protection database, see Protection database and the TCC on
page 69.
The protection database is read-only within the SynerGEE interface. However, you can open it in Access and
make changes if desired. For example, the CurveDefinitions table allows you to selectively enable or disable
individual curves. If you disable a curve, it is not loaded during a protection database load. It is recommended

SynerGEE Electric 5.0

User Guide

68

Managing SynerGEE Data

that you edit the protection database with caution. Also, keep in mind that GL Noble Denton continues to
update this database with new devices and welcomes your suggestions for additions.
Curves in the protection database are normalized on a compound index consisting of five fields.
Manufacturer, Model, Rating, Type, and CurveName rating determine a unique curve. The table below shows
the way in which curve data for fuses, reclosers, and relays are listed in this database.

Device
Expulsion
Fuse

Current Lim.
Fuse

Electronic
Recloser

Hydraulic
Recloser

Electronic
Relay

User Guide

Curve
Name

Manufacturer

Model

Rating

Type

Min Melt

Ex: S&C

Ex: 122

FusExpMelt

Amp
Rating

Max
Clear

Ex: S&C

Ex: 122

FusExpClear

Amp
Rating

Min Melt

Ex: Cooper

Ex: NX

Volt Rat.

FusCurLimMelt

Amp
Rating

Max
Clear

Ex: Cooper

Ex: NX

Volt Rat.

FusCurLimClear

Amp
Rating

Phs
Curve

Ex: Cooper

Ex: Form
4C

RecElecPh

Ex: 101

Grnd
Curve

Ex: Cooper

Ex: Form
4C

RecElecGrnd

Ex: 101

Phs or
Grnd

Ex: Cooper

Ex: Form
4C

RecElecPhOrGr
nd

Ex: 101

Phs
Curve

Ex: Cooper

Ex: V4H
ME

Coil Rat.

RecHydPh

Ex: A

Grnd
Curve

Ex: Cooper

Ex: V4H
ME

Coil Rat.

RecHydGrnd

Ex: A

Phs or
Grnd

Ex: Cooper

Ex: V4H
ME

Coil Rat.

RecHydPhOrGrn
d

Ex: A

Phs
Curve

Ex: GEC

Ex: MCGG

RelElecPh

Family

Grnd
Curve

Ex: GEC

Ex: MCGG

RelElecGrnd

Family

Phs or
Grnd

Ex: GEC

Ex: MCGG

RelElecPhOrGrn
d

Family

Inst
Curve

Ex: GEC

Ex: MCGG

RelElecInst

Ex: 3Is

SynerGEE Electric 5.0

Managing SynerGEE Data

Manufacturer

Model

Rating

Type

Curve
Name

Phs
Curve

Ex:
Westinghouse

Ex: CO-11

RelMechPh

Time Dial

Grnd
Curve

Ex:
Westinghouse

Ex: CO-11

RelMechGrnd

Time Dial

Phs or
Grnd

Ex:
Westinghouse

Ex: CO-11

RelMechPhOrGr
nd

Time Dial

Inst
Curve

Ex:
Westinghouse

Ex: CO-11

RelMechInst

Inst4

Device
Mechanical
Relay

69

Protection database and the TCC

The protection database contains all the point data necessary to plot a curve on the TCC graph. However,
this point data is not loaded when a protection database is loaded. Due to the sheer amount of data,
SynerGEE loads only the enabled curve definitions from the CurveDefinitions table. These definitions
represent curve definitions, but do not contain the actual mathematical points needed to plot a curve on the
graph.
To retrieve the data to plot a curve on the TCC graph, SynerGEE uses a special key in the curve definition,
known as the internal curve number (ICN). The ICN is used as a reference to look up the actual points in the
CurvePoints table, which remains on disk. The CurvePoints table should contain the entire set of actual
points for each ICN found in the CurveDefinitions table. This system of data retrieval allows you to access a
vast wealth of curve data without excessively taxing your memory resources.
If a protective device fails to display in the TCC, check to make sure the protection database has been
loaded. If so, view the rap sheet for the device in question and check the ICN, listed as the Database ID.
With the CurveDefinitions table loaded, SynerGEE should at least be able to produce the ICN. If not, you may
have more serious data problems. Once you have the ICN, you can open the CurvePoints table in Access in
an attempt to track down points associated with the ICN and locate the problem. For more information on rap
sheets, see Rap Sheets on page 179.
Keep in mind that individual curve definitions can be enabled or disabled within the CurveDefinitions table
using Access. If a curve does not display, ensure that the appropriate record(s) in the CurveDefinitions table
has not been disabled. If a definition is disabled, it will not be loaded, and any device requiring that definition
will not display on the TCC (because SynerGEE will not be able to find the ICN to reference the CurvePoints
table).

SynerGEE Electric 5.0

User Guide

70

Managing SynerGEE Data

Part of a rap sheet for a breaker, with some of the associated points in the CurvePoints table

Mechanical response times and the protection database

Often, a device with a particular set of contacts or breakers has a response time listed in standard tables.
SynerGEE has a MechResponseTimes table in the protection database for storing mechanical response
times by device ID. Like all protection data, this data cannot be edited with SynerGEE. New entries must be
made to the table in the protection database through Access or an ADO-, DAO-, or ODBC-enabled tool that
can access the table.
Response curves represent the operation time of the controller for electronic reclosers, electronic relays, and
mechanical relays. Mechanical response times represent the delay between the controller trip signal and the
actual tripping of the mechanical contacts. Mechanical response times are used to shift the curves of
electronic reclosers and all breaker relay models by a constant time value (adder). In the TCC window, you
have the option of displaying response curves, control curves, or both for these devices. For more
information on setting this option, see Changing TCC view display properties on page 606.
Mechanical response times typically range from 0.015 to 0.055 seconds.

SYNERGEE DATA FORMATS

SynerGEE supports a variety of formats for importing and exporting data. These formats can be used in any
combination to support your needs, provided that you adhere to the compatibility rules between data types
and data formats.
Take note that each data format does not support every data type. For example, although you can load
model data from any supported data format, subset data can only be stored in one of the database formats.
Each data format has advantages and disadvantages, and you should make an informed choice of which to
use, based on your workflow and organizational needs. Refer to the topics listed below for more information.

Microsoft Access data format (personal database) on page 71

Microsoft Access data format (server/DBMS) on page 72

Binary data format (EDM) on page 72

MiddleLink data format on page 72

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

MultiSpeak data format on page 74

Oracle and SQL Server data format on page 74

PI Server on page 74

MySQL on page 74

SynerGEE XML data format on page 75

71

Microsoft Access data format (personal database)

Microsoft Access is the traditional means of storing SynerGEE data and remains one of the most flexible
formats. Intermediate users can use SynerGEE to easily load and save model data and equipment data as
personal Access databases. Advanced users can use Access directly, as well as other third party tools, to
perform advanced data population and manipulation through custom querying and other methods.
Because Access is an open data format and generally easy to manage, you may find it to be the most
suitable data format for your general purpose storage needs. Certain data types, such as versions and
subsets, are designed to work with a database format, so using Access may make it more convenient if you
choose to use them.
SynerGEE supports password-protected Access databases. When you create a DSA to a protected
database, you must specify the password information as a part of the DSA. This is described in more detail in
Data Source Aliases (DSAs) on page 75.

Data truncation when saving to an Access database

SynerGEE may need to truncate data during a save to database format, based on maximum string lengths
allowed by the target database.

Saving to an existing database

Before SynerGEE saves data to an existing database, it will do the following:
1

Query the target database for the maximum text field lengths.

Send a warning message about any truncations to the Conflicts writing to database editor. This
editor gives you the opportunity to accept the conflicts and write the data to the database (which in
this case will result in the truncating data for the exceeded text fields), or cancel the operation and
return to the unsaved model.

When truncating data, string lengths that you established within SynerGEE are not considered. For example,
you could create a node ID that is 100 characters long, but SynerGEE will still truncate according to the target
database, as needed.
In rare circumstances, truncation could result in a loss of uniqueness between identifiers, if the strings differ
only past the point of truncation. If you need longer maximum string lengths, you can use Microsoft Access to
manually extend the fields and then resave the database in SynerGEE.

Saving to a new database

When SynerGEE generates new tables in a database, it uses internal values to establish maximum lengths
for text fields. In most cases, the maximum string length is set to 32. Some previous versions of SynerGEE

SynerGEE Electric 5.0

User Guide

72

Managing SynerGEE Data

allowed only 15 characters. If you are loading from and saving to an old database, you may see warnings if
you edit text strings to exceed 15 characters. You can eliminate this problem by saving the model to a new
database.

Microsoft Access data format (server/DBMS)

In addition to personal Access databases, SynerGEEs enterprise database tools support Access in a server/
DBMS environment. For more information on enterprise databases, see Using an Enterprise Database
System on page 114.

Binary data format (EDM)

SynerGEE supports a proprietary binary file format with an EDM extension. This format is not an open or
flexible file format, like Access or XML. SynerGEE EDM files can only be used by SynerGEE. Only model
data and equipment data types can be saved to the binary EDM file format.
The primary advantage of binary files is speed. Import and export tasks with binary files take a fraction of the
time that they would with databases and XML files. In addition, the file size for binary files is much smaller,
making it easier to store and move your data around.
If you have large models and you use SynerGEE as your data management tool, binary files can significantly
speed up the process of loading and saving data. In addition, if you need to email a model to another
SynerGEE user, then the binary file format might be your best choice.
However, it is recommended that you do not rely on binary files for long-term data storage. Binary files are
best-suited for short-term use only. Databases should always be used to store models between releases. In
addition, if you want or need to perform data management directly in the source files, then another file format,
such as the Access database or XML, would be the better choice.

MiddleLink data format

The MiddleLink data format is a flat text file approach to scripting and data import. It has a wide variety of
applications within SynerGEE, and many features of SynerGEE rely on source data in the MiddleLink format.
MiddleLink data can be written to one or more database tables.
Refer to the topics listed below for more information.

History of the MiddleLink format on page 72

Architecture of MiddleLink data on page 73

Additional notes on the MiddleLink data format on page 73

History of the MiddleLink format

Originally, the MiddleLink data format was designed for use with the standalone MiddleLink product, which
served as a model-building utility. MiddleLinks purpose was to build SynerGEE models with data extracted
from a GIS or other spatial database, helping to reduce redundancy and model-building costs. The data
format, therefore, represented the interim step between the GIS and SynerGEE, as a standard which
MiddleLink could process. Because of the wide variety of databases and formats present in the distribution

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

73

industry, an intermediary standard format was necessary for an off-the-shelf product like MiddleLink to
function.
Beginning with SynerGEE 3.5, the standalone MiddleLink product was discontinued, and MiddleLink import
functionality was incorporated into SynerGEE as a module. This change brought dramatic improvements to
the MiddleLink process, as data could be imported directly into SynerGEE memory, rather than used to
generate a database on disk. In conjunction with the import process, users also had full access to
SynerGEEs powerful data management and merging tools to assist with the model building task.
When the MiddleLink functionality was incorporated into SynerGEE, it provided an opportunity to reevaluate
and reinvent the data format schema. As such, the schema underwent a significant overhaul to facilitate
usability and future expansion. As a result of this overhaul, the MiddleLink format began to demonstrate its
usefulness for other SynerGEE functions, beyond its original purpose of data import. In a short amount of
time, the data format was incorporated into a wide variety of SynerGEE functions, particularly those
associated with scripting. Throughout this expansion, the term MiddleLink has been maintained to describe
the data format, although its meaning has changed significantly since its use with the original standalone
product.

Architecture of MiddleLink data

MiddleLink data is stored in a text file in comma-separated value (CSV) format. Beginning in SynerGEE 3.5,
each MiddleLink record begins with a number that identifies the purpose of the record. After the number, a
record may contain additional parameters as necessary to fulfill the records purpose.
When used for data import, the number of a MiddleLink record generally indicates the type of data to be
imported. For example, the following MiddleLink record might be used to import a section named Sect_01,
using the MiddleLink data loader:
201, Sect_01, Node_A, Node_B

Many of SynerGEEs scripting applications use the MiddleLink format as their language. When used for this
purpose, the initial number generally indicates a command or action, or a set of processing instructions or
other settings for a scripting action. For example, the following record instructs the model cleanup application
to search the entire model and replace all 1/0 ACSR conductors with 336 ACSR:
4002, 1, 1/0 ACSR, 336 ACSR

To help prevent conflicts between the different scripting applications, the schema numbering is unique for
each application. For example, the 4000 series in the overall schema is reserved for model cleanup
commands. Therefore, the 4002 record above has no relevance to MiddleLink model building. If it happened
to appear in a model-build source file, it would be simply ignored. Likewise, if a 200-series model-build record
appeared in a model cleanup script, it would be ignored.
In general, records may appear in any order in a MiddleLink file. For example, during model data import, if
you have a record to place a switch on a section that appears before the section creation record itself,
SynerGEE will adjust to process those records in the correct order. You may, however, find that a logical
ordering of records facilitates organization and efficiency.

Additional notes on the MiddleLink data format

When using the MiddleLink data format, you should note the following:

SynerGEE Electric 5.0

User Guide

74

Managing SynerGEE Data

Spacing. Spacing is generally unimportant, although each record should exist on its own line.

Comments. You can make any line in a MiddleLink file a comment by proceeding it with an
apostrophe ('). Commented lines are ignored by SynerGEE.

Syntax errors. In some cases, syntax errors are reported in the respective report following the
import or analysis action. However, many are not, and in some cases, syntax errors cause
SynerGEE to simply ignore a record. You should use care to avoid syntax errors, because you may
have no indication of their presence other than data problems later.

Schema. The entire MiddleLink schema, including data import, model cleanup, and other records, is
available in SynerGEE by selecting the SUPPORT tab in the SynerGEE ribbon bar. In the Tools
group, click Schemas and then select the type of schema that you want to view.

Database tables. MiddleLink data can be written to one or more database tables.

MultiSpeak data format

MultiSpeak is an emerging specification for electrical distribution data, the result of a collaborative effort of the
National Rural Electric Cooperative Association (NRECA) along with other software providers and
consultants. Based in XML, MultiSpeak is intended as a common format by which different applications,
systems, and organizations can share data. For more information on the MultiSpeak initiative, including the
progress, history, and goals, visit www.multispeak.org.
To import MultiSpeak data, you must have a DSA with MultiSpeak specified as the provider type. For more
information on DSAs, see Data Source Aliases (DSAs) on page 75.

Oracle and SQL Server data format

Oracle and SQL Server are database formats supported by SynerGEEs enterprise database tools. These
formats apply to model and equipment-related data, including subsets and versions. For more information on
enterprise databases, see Using an Enterprise Database System on page 114.

PI Server
If you have access to a PI Historian database, DSAs can be linked through the DSA wizard. It is not
necessary to specify the contents of the data source as you would with model data or equipment data, as
SynerGEE will automatically recognize the PI format. For more information, see Importing Real-Time Data
on page 124.
PI system data can be mined in the SQL dashboard. Select PI from the list of supported DSA types and then
select a query from the list, or write it in the dashboard window. For more information, see SQL Dashboard
on page 772.

MySQL
MySQL is a supported database type in SynerGEE. This format can support the same data found in any
typical database type such as Access or Oracle. Like other formats, MySQL can handle most model and
equipment-related tasks.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

75

SynerGEE XML data format

SynerGEE can import and export model data and equipment data in XML format. This format has three
primary uses:

External data import. XML can be used as an alternative to the MiddleLink format to bring in model
data from external sources, such as CIS, OMS, and SCADA systems.

Exporting usable data. If you need to export and transport SynerGEE data in a non-database
format, XML may be a good choice.

Saving program settings. Program settings such as growth options, fault location, design
evaluation, check coordination, model options, contingency, and publishing settings are saved in
XML format, in addition to the binary files.

SynerGEE XML files are based on a proprietary schema, rather than a document type definition (DTD). The
SynerGEE XML schema is designed with a simple structure and intuitive tag names so that data is easily
recognized and managed. To view the entire schema within SynerGEE, select the SUPPORT tab in the
SynerGEE ribbon bar. In the Tools group, click Schemas and then select Model > XML.

DATA SOURCE ALIASES (DSAS)

A data source alias (DSA) is an intelligent link that allows you to load, merge, and save SynerGEE data,
without having to remember where a source file is located or even what it is named. For example, to load a
particular model, you can simply select its DSA from the list that is provided in the Load Feeders/Stations
editor. You do not have to navigate through your network to find its associated data file.
A DSA contains information about the location and name of the data source file, but it also contains other
information necessary for SynerGEE to process the associated data. For example, a DSA for a MiddleLink
file contains settings specific to a MiddleLink data import, such as phase settings and a length multiplier.
Likewise, a DSA for an enterprise database model contains information about the server, database, and user
permissions.
DSA definitions are stored in the SynDataSources.xml file, which is saved in your Settings file directory.
DSAs may be created, edited, and deleted at any time, and there is no limit to the number of DSAs that you
may have.
Refer to the topics listed below for more information.

Why DSAs? on page 76

DSA data types on page 76

Managing DSAs on page 76

Creating DSAs on page 79

Creating DSAs with custom content on page 80

Validating DSAs on page 80

Sharing DSAs with other users on page 81

Saving DSAs on page 81

SynerGEE Electric 5.0

User Guide

76

Managing SynerGEE Data

Deleting DSAs on page 81

Why DSAs?
DSAs represent a step toward making SynerGEE a fully network-intelligent, central management point for
distribution simulation data. DSAs provide a common interface with which you can import, manage, and
export many different types and formats of data, which is important as the flow of data becomes more
complex. As a hypothetical example, suppose you wanted to engineer a system in which GIS, SCADA, and
CIS information is regularly merged into your simulation data, and then SynerGEE analysis results are
exported and merged elsewhere. To achieve this level of integration within SynerGEE, you would need a
standard means of getting data in and out, which the DSA provides.
Even if you have no plans for such integration, DSAs still simplify how you access your data. And, it is
important to note that traditional methods of loading and saving data are still available, if you choose not to
deal with DSAs directly. For example, when loading model data, the Load Feeders/Stations wizard still allows
you to browse for a file and load it directly. SynerGEE will end up creating and using a DSA behind the
scenes, but you do not necessarily need to be concerned with it, if you so choose.
DSAs are important as SynerGEE moves towards greater roles in data management and integration. It is
encouraged that you do actively use them and learn how they work. For more information on network
intelligence and SynerGEE, see Network intelligence and enterprise data flow on page 58.

DSA data types

You must specify at least one data type for each DSA. This data type association allows SynerGEE to identify
what kind of data is included in the source. For example, you can specify in a DSA that a source contains
either model data or equipment data, or both model and equipment data, or any other combination of a
number of other data types. Data type associations help SynerGEE organize your data sources and present
only the applicable DSAs at the appropriate time. For example, when loading model data, the Load Feeders/
Stations wizard only lists the DSAs that have been configured to include model data.
As noted in the previous paragraph, a DSA can specify multiple data types, just as a SynerGEE data source
can contain multiple data types. For example, you could have an Access database that contains model data,
equipment data, subset data, and version data. Instead of creating four different DSAs, you only need to
create one DSA that specifies the inclusion of these four data types. This single DSA will appear in the
appropriate wizards whenever you are working with any of the associated data type.
Detailed information on the data types that you can configure in DSAs is provided in SynerGEE Data Types
on page 59.

Managing DSAs
DSAs, including those automatically created by SynerGEE, can be created and edited at any time.
In most cases, during DSA creation you can point to a non-existent file. Afterwards, when you use the DSA to
save data, the file will be created automatically. To point to a currently non-existent file, you can use the
browsing tools to navigate to the future folder of the file and then type the name of the future file in the
applicable file name box. For example, if you plan to save feeders to a new, currently non-existent Access
database, you can create the DSA using a path to the future database and SynerGEE will create it when you
save those feeders.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

77

The Edit Data Source wizard provides an intuitive means of specifying any required information when you are
creating or editing a DSA.

TO CREATE, DELETE, AND MANAGE DSAS

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Data Sources.

Use the Data Sources editor to add, edit, and delete DSAs as desired. While adding and/or editing
DSAs, follow the wizard prompts, and keep in mind the following:

The DSA manager includes a button to clear model locks. For more information about this
button, see Model locks for Enterprise databases on page 122.

The Privileges button generates a report for DBMS-type data sources. The report contains
information about the specified users privileges in the selected database.

If you are creating a DBMS-type data source, a No Model button is included on the Model
Assignment page. Click this button if you want to set up a DSA that has no assigned
model. This feature allows you to set up a warehouse-only DSA, with no associated model.

Click Apply to accept your changes, and then click X to close the editor.

Editing a DSA
Perform the following procedure to edit an existing DSA. Keep the following notes in mind:

The DSA manager includes a button to clear model locks. For more information about this button,
see Model locks for Enterprise databases on page 122.

The Privileges button generates a report for DBMS-type data sources. The report contains
information about the specified users privileges in the selected database.

If you are creating a DBMS-type data source, a No Model button is included on the Model
Assignment page. Click this button if you want to set up a DSA that has no assigned model. This
feature allows you to set up a warehouse-only DSA, with no associated model.

TO EDIT DSAS
1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Data Sources.

In the Data Sources editor, select the DSA that you want to edit and then click Edit.

Use the first page of the Edit Data Source wizard to specify general information about the DSA,
including its name and data source format. The following table describes the different options that
you can set.
Description

Name that will be used to identify the DSA in SynerGEE.

Provider

Specifies the data source type, such as Access, Oracle, or

MiddleLink.

SynerGEE Electric 5.0

User Guide

78

Managing SynerGEE Data

Source is read-only

Select this check box to prevent the DSA from being edited using
SynerGEEs Data Source Editor. Note that this check box does
not set any type of read-only status on the file. The DSA can still
be edited by using SynerGEE and by editing the file directly. The
check box only impacts whether data can be edited in the Data
Source Editor.
For more information on using the Data Source Editor, see Data
Source Editor on page 132.

Apply model lock to DBMS

when reading
(recommended)

Select this option to apply a model lock to a DBMS when reading

model data. This prevents one user from altering tables while
another user is reading them. While this option is recommended,
it can be disabled if multiple users load feeders from the same
model.

Use the second page of the Edit Data Source wizard to associate a file or database with the DSA.
The following table describes the different options that you can set.
Path

Specify the path to the data source. If desired, you can specify a
file name that does not yet exist on your network. In this case,
the file will be created during the first time you save data to that
DSA. It is not created automatically on your network simply
because you created a DSA for it.

User Name

If required, specify a user name to connect to the data source.

Password

If required, specify a password to connect to the data source.

Test Connection

Click this button to test the connection to the data source. After
testing the connection, SynerGEE will report Success or
Failure in the wizard.

Execute SQL After

Connect

If desired, select this check box and then type SQL commands
that you want to execute immediately after SynerGEE connects
to the specified database. The SQL commands can be used to
perform tasks such as configuring the database or setting the
version.

Use the third page of the Edit Data Source wizard to associate a data type with the DSA. SynerGEE
data types are described in SynerGEE Data Types on page 59.
In some cases, a SynerGEE data type may contain multiple types of data, and even non-SynerGEE
data. For example, an Access database can contain both model data and equipment data, and also
virtually any array of non-SynerGEE related tables. When SynerGEE loads a certain type of data, it
only retrieves data from the tables applicable to the type and ignores the others, provided that the
applicable data still adheres to the proper schema.

If you are creating an enterprise database DSA, use the fourth page of the Edit Data Source wizard
to specify enterprise-related options. For general information on enterprise databases, see Using
an Enterprise Database System on page 114. For specific information on creating enterprise
database DSAs, see Creating enterprise model DSAs on page 116.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

79

If you are creating a MiddleLink DSA, use the fifth page of the wizard to specify MiddleLink options.
For more information, see Setting options for a MiddleLink data import on page 106.

Use the last page of the Edit Data Source wizard to verify the settings that you configured for the
DSA. If you are satisfied with the settings, click Update to close the Edit Data Source wizard.
Otherwise, click Back to return to previous pages of the wizard and make further edits, as required.

Click OK to close the Data Sources editor.

Creating DSAs
DSAs can be created manually using the Data Sources editor, or automatically by loading a model directly
into SynerGEE. Refer to the following procedure for more information.

TO CREATE A DSA MANUALLY

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Data Sources.

In the Data Sources editor, click Add.

Use the Add Data Source wizard to configure the new DSA. The options in the Add Data Source are
the same as the Edit Data Source wizard and are described in Editing a DSA on page 77.

SynerGEE Electric 5.0

User Guide

80

Managing SynerGEE Data

4

When you are finished configuring the new DSA, click Add to close the Add Data Source wizard.

Click OK to close the Data Sources editor.

TO CREATE A DSA AUTOMATICALLY

Most SynerGEE editors where you can select a DSA (such as the Load Feeders/Stations editor that you use
when you load model data) also allow the traditional method of manually navigating to a specific file to
perform the desired action (such as loading the model data into SynerGEE). When you navigate directly to a
file in this manner, SynerGEE will automatically create a DSA for you, prompting you to provide a name for
the new DSA. This DSA then becomes available in the applicable editor, and you can use that DSA to
complete the action you want to perform.
While it is recommended that you use SynerGEEs Data Sources editor to create and edit DSAs, an
automatically created DSA is a legitimate and fully functioning DSA, and you can edit it in the same manner
that you edit any other DSA.

Creating DSAs with custom content

Most DSAs refer to a specific data type and format, with a specific set of contents. One type, however, is
reserved for custom content and is used by some SynerGEE features such as the joiner (as described in
Joiner on page 133) and results import.
A custom content DSA provides the flexibility to interface non-standard data with your SynerGEE model,
especially if that data does not follow any SynerGEE-generated schema. For example, the joiner allows you
to associate a custom data source with current model data, using the SectionId field to complete the
association. Therefore, a custom data source used by the joiner can have virtually any type of information in
any schema, provided that the SectionId column exists to make the match.
Custom content DSAs are only applicable to local Access databases. When you create a custom content
DSA, you must select Custom as the data type on the third page of the Edit Data Source wizard. You must
also specify a table within the data source, and that table must contain a SectionId column.

Validating DSAs
As you use SynerGEE, your list of DSAs can sometimes grow long, and may contain references to obsolete
or invalid files or items. SynerGEEs data source validation tool can help you maintain your list of DSAs by
verifying the accuracy of each one. The Data Source report that is created by this tool will list key information
about your DSAs, including whether each DSA is valid or invalid. An invalid DSA indicates that the file could
be missing or inaccessible, or an enterprise database connection could not be made.
Refer to the following procedure for more information.

TO VALIDATE DSAS
1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Sources group, click Validate Data Sources.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

81

Sharing DSAs with other users

All DSA definitions are saved in a single file, which is named SynDataSources.xml and is saved in your
Settings file directory. If you have multiple SynerGEE users that need access to the same data sources, you
might find it convenient to distribute this file to multiple users, once it has been properly configured with the
correct DSAs. Or, you can edit the Paths location for each user to reference the same Settings directory, for
example in a network location. For more information on editing path locations, see Defining file paths on
page 167.

Saving DSAs
When you create, edit, and delete DSAs using the Data Sources editor, those changes are saved to the
SynDataSources.xml file when you exit SynerGEE. However, a Save button is provided in the Data Sources
editor to immediately save the changes that you have made. Refer to the following procedure for more
information.

TO SAVE DSAS
1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Data Sources.

Click Save.

Click OK to close the confirmation message.

Click OK to close the Data Sources editor.

Deleting DSAs
Perform the following procedure to delete one or more DSAs from SynerGEE.

TO DELETE DSAS
1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Data Sources.

Perform the following steps to delete single, multiple, or all DSAs.

To ...
Delete a single DSA

Delete multiple DSAs

SynerGEE Electric 5.0

Do This ...
a

Select the DSA that you want to delete.

Click the Delete button.

Click Yes to confirm the deletion.

Hold the Ctrl and Shift keys as you select the DSAs
that you want to delete.

Click the Delete button.

Click Yes to confirm the deletion.

User Guide

82

Managing SynerGEE Data

To ...

Do This ...

Delete all DSAs

Click the Delete All button.

Click Yes to confirm the deletion.

Click OK to close the Data Sources editor.

SUBSETS
A subset, as the name implies, is a subset of model data, often stored in the same data source from which it
originated. The data in a subset represents a collection of related information that can be used to quickly
reconfigure your model, according to the specific subset type.
Subsets can serve any variety of purposes. For example, you might keep load subsets for winter and
summer, rather than keeping two separate models. Or, you might save a series of different switch
configurations as different subsets, allowing you to change configurations quickly for study, rather than
maintaining versions or different models.
Subsets are supported for all database formats, including Access, Oracle, and SQL server.
Refer to the topics listed below for more information.

Getting started with subsets on page 82

Subset types on page 83

Saving a subset on page 84

Loading a subset on page 84

Creating and editing subsets outside of SynerGEE (schemas) on page 85

About subset tables on page 85

Subsets and multiple years on page 85

Subsets with special functions on page 85

Getting started with subsets

To get started with subsets, you might follow the following general steps:
1

Identify your subset needs. If you are considering using a subset, you probably have an idea of
what you might need it for. Before using a subset, be sure you understand exactly what data is
included. For more information, see Subset types on page 83.

Create a DSA for the subset(s). Subsets are stored in a database, often the same database from
which you loaded model data. Or, subsets can reside in their own database. In either case,
SynerGEE requires a data source alias (DSA) to communicate data back and forth. If you are
storing subset data in an existing model data source, this process may be as simple as adding the
Subset specification to the existing DSA for that source. For more information, see DSA data
types on page 76.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

3

83

Save and load subsets. Using the DSA, you can save and load subsets at will. When saving and
loading subsets, you simply specify a name and type, and the DSA does the rest. For more
information, see To load a subset on page 84.

Subset types
The following table details the types of subsets available. Each subset type is stored as its own data entity
and can be loaded independently of any other subset type. You determine the type of subset to be saved
during the save process. For more information, see To load a subset on page 84.
You should always remain aware of the subset scope. Some subsets save data from the entire model in
memory, while others save data from selected feeders only. When loading a subset, however, the entire
model is updated with any applicable data. Feeder selection is irrelevant when loading a subset.
Subset type

Contents

Scope for saving

Capacitors

Capacitor on/off status

Selected feeders

Trip/close settings for switched modules 1 and 2.

Distributed loads

kW, kvar, cKVA, KWH, and number of customers for

distributed loads of all sections, all phases

Selected feeders

Distributed and
spot loads

kW, kvar, cKVA, KWH, and number of customers for all

loads of all sections, all phases.

Selected feeders

Elbows

Elbow open/close status for all sections with elbows.

Because pad-mounted switch gear uses elbows from a data
standpoint, it is also included in this subset. For more
information on pad-mounted gear, see Pad-mounted switch
gear on page 408.

Whole model

Meters

For all sections with a meter:

Selected feeders

Enabled/disabled status of the meter

Type of meter, for example, amp or kVA.

Metered values for all three phases. Each phase

has two values. For example, an amp meter
includes an amperage and a power factor value.

Mobile items

Enable/disable status, symbology, and location of mobile

items

Whole model

Queried sections

List of sections in the current query set, at the time the

subset was saved

Selected feeders

Source demands

Source voltages, and individual flags for each indicating

whether to apply the voltage during import.

Whole model

Spot loads

kW, kvar, KWH, and number of customers for spot loads of

all sections, all phases

Selected feeders

SynerGEE Electric 5.0

User Guide

84

Managing SynerGEE Data

Subset type

Contents

Scope for saving

Switches and
elbows

Open/closed status for all switchable devices in the model,

including fuses, breakers, reclosers, sectionalizers, and
elbows.

Whole model

Source node flow

A special subset for transferring demands from a fed

system to an independently modeled feeding system. For
more information, see Source node flow subset on
page 86.

Whole model

Projects

Places multiple, itemized spot loads on a single section. On/

off status, customer load curves, and I,Z,PQ assigned to
specific sections.

Selected feeders

Large Customers

Distributed generators, co-generators, and large customers.

A large customer may also be used to model manholes and
vaults because they use their own map symbols and
separate editors.

Selected feeders

Regulators

On/Off status, tap position, tap direction.

Selected feeders

Saving a subset
Perform the following procedure to save a subset. Even though subsets are normally represented as
additional tables in an existing data source, you must still have a DSA for them. For example, if you are
saving your subsets to a certain model database, the DSA to that database will not appear in the subset load
and save wizards, unless you have the DSA specifically configured to contain subset data as well. For more
information on creating and editing DSAs, see Managing DSAs on page 76.
Saving a subset acts as an update process, rather than a replacement. For example, saving a switch subset
updates all applicable switches in the current subset, while ignoring any other records.

TO SAVE A SUBSET
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Parts group, expand Subsets and then select Save.

Loading a subset
Perform the following procedure to load a subset.

TO LOAD A SUBSET
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Parts group, expand Subsets and then select Load.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

85

Creating and editing subsets outside of SynerGEE

(schemas)
In some cases, you may wish to manage subset data through some process external to SynerGEE. For
example, perhaps you want to use switch subsets to import SCADA-generated switch configurations. In this
situation, you will need to know the layout and schema of the applicable subset table(s), so that you can
populate the data in the appropriate locations.
Because of their general simplicity, and because they are subject to change, subset table schemas are not
published in this document or a SynerGEE report, like certain other schemas. To learn the schema of a
subset table, you should use SynerGEE to create a sample subset in Access, which you can then open to
view the schema hands-on. By comparing field names with the associated SynerGEE editors, you should be
able to quickly understand the required data and format.

About subset tables

Each subset you save gets its own table in the target database, often the database from which the model was
loaded. The table name is constructed as follows:
SubSet_Type_UserName_SubsetName

where Type is an acronym for the subset type and SubsetName is the name you gave it. UserName
generally applies only in an enterprise database environment. For example, a distributed load subset called
MySubset would appear in the following local Access table:
SubSet_DLD_MySubset

Spaces are not permitted in subset names.

Subsets and multiple years

Subsets include data from a single year only. When you save a subset, it saves data from the current year.
When you load a subset, it loads the data into the current year, regardless of the year from which it was
saved. Therefore, you could use a subset to transfer data from one year to another.
If you do not use multi-year modeling, the year setting is largely invisible and irrelevant while handling
subsets. For more information on multi-year modeling, see Multi-Year Analysis on page 579.

Subsets with special functions

Most subsets represent a basic subset of data that is saved from and loaded to the same data fields. That is,
you can save a subset and then reload it, and your model will not have changed.
Some subsets, however, perform special data functions, where the transfer of data is not necessarily parallel.
For example, the data may come from one place when the subset is saved, but populated elsewhere when
the subset is reloaded. Therefore, saving and reloading the same subset may result in a changed model.

SynerGEE Electric 5.0

User Guide

86

Managing SynerGEE Data

SynerGEE supports the following special subsets:
Subset

Description

Source node flow

The source node flow subset is designed to transfer demands from a fed
system to the feeding system, by the creation of spot loads on the feeding
system. For example, it may be used to simulate the demands of a primary
feeder/subtran system on a subtransmission system, such that the
subtransmission system can be accurately analyzed without the entire primary
system in memory. For more information, see Source node flow subset on
page 86.

Source node flow subset

This subset allows you to transfer the demands of a primary system, such as a feeder/subtran system, to an
independently modeled feeding system, such as a subtransmission system. Unlike most subsets, you
generally would save it from one model (subtran/feeder) and load it into another (subtransmission) to transfer
subtran/feeder demands to the subtransmission system.

VERSIONS
SynerGEE supports the loading and saving of versions, which are stored in a database in separate version
tables. This function allows you to make changes to a model and save just those changes, without having to
do a complete save to a different database. In other words, when you save a version, you save only new
changes to your model. As such, a version can serve as a useful tool for tentative planning and cost analysis.
Versions can be saved in any supported database format. When you load a version, the model is updated
with any applicable data that is found. Therefore, when loading a version, you should have the model in
memory from which you saved the version originally. Otherwise the two datasets may be incompatible.

TO LOAD A VERSION
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Parts group, expand Versions and then select Load.

TO SAVE A VERSION
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Parts group, expand Versions and then select Save.

TO MANAGE (INCLUDING DELETE) VERSIONS

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Parts group, expand Versions and then select Manage.

Follow the wizard prompts.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

87

Sample version workflow

The following steps illustrate a sample workflow involving two versions of a base model. Assume that you
want to make two different versions, present them to colleagues at a meeting, and then decide which shall
become the permanent modification. This workflow is intended to familiarize you with the version concept and
does not imply any expected end use of the feature.
1

Create a DSA to database MyVersions.mdb. This is the database that will house the versions
library.

Load a base model from MyModel.mdb.

Make changes to the base model that you would like to represent the first version.

Save the first version, by selecting MyModel.mdb as the base model to version, and storing the
version in MyVersions.mdb.

Make more changes that represent the second version. If you want to start from the base model
again, first close MyModel.mdb without saving changes and reload it. You can close the model by
selecting the MODEL tab in the SynerGEE ribbon bar, and in the Model group, clicking New.

Save the second version, like you did with the first one.

Close SynerGEE.

Later, at the meeting, restart SynerGEE and load MyModel.mdb.

Load the first version, and present it to the audience.

10 Select the MODEL tab in the SynerGEE ribbon bar, and in the Model group, click New. Do not save
changes. Reload MyModel.mdb, and then the second version.
11 Assuming that the consensus of the meeting is to implement the first version, again close the model
without saving changes and reload MyModel.mdb.
12 Reload the first version.
13 Save the model data to MyModel.mdb to make the first version permanent in the database.
14 Delete or archive the second version.

Version processing
SynerGEE generates versions based on a comparison of the model in memory with a database on disk. Any
differences found are compiled into a version data set and stored in special version instance tables in the
specified database. When you save a version, you give it a name, select the data source for comparison, and
also select the database in which to store the version tables. With this functionality, you could do things such
as the following:

Keep versions in the original model database. You can specify the data source for comparison
and the target for the version tables as the same source file. In this manner, you could store all
versions for a particular model in the same database as the model.

Have a separate versions file, like a version library. Because you can store version tables in any
database, you could keep a library of all versions in a separate file, regardless of what model they
originated from. If you maintain a file such as this, you must always be careful that you load versions

SynerGEE Electric 5.0

User Guide

88

Managing SynerGEE Data

back into the correct model data set later, the one from which they originated. Otherwise, the results
could be unpredictable.
There is no limit to the number of versions you can store in a data source. At any time, a stored version can
be loaded back into memory and displayed on your screen, provided you are loading it into a comparable
data set, ideally the one from which the version originated.

Model on disk

Memory model

Version
tables

Overview diagram of creating a version

After the version has been saved, the base model can be reloaded, after closing the old model without
saving. At this point, you are back where you started, with a version saved in the target data source. If you
want to keep the version isolated from the base model, be sure not to save the changes to the base model
after saving the version. Otherwise, those changes will be incorporated permanently into the base model, and
your version probably will not have value.
After you create them, versions can be loaded into the model and used for analysis. The records in the
versions tables are simply loaded and added to the model. You can load multiple versions. However, care
should be taken when versions represent changes to the same facilities. If a version contains data that
conflicts with data in memory, conflicting data is not loaded. Again, remember not to save changes to the
base model after loading a version, unless you want that version to become a permanent addition to the base
model.

Model on disk

Version
tables

Memory model

Loading a version

SynerGEE does not manage versions individually once they are loaded. If you try to re-save changes to a
version, SynerGEE will not compare the original version to any changes you have made. Rather, each time a
version is saved, SynerGEE compares the whole model in memory to the stored model again. Therefore, if
you load multiple versions, you will not be able to make changes to one and save those changes back to the
individual version.
In a database, versions are stored in instance tables prefixed with SC_. These version tables are structured
similar to their corresponding regular instance tables, except that each record contains two additional fields:

WorkPlanID The name of the version

Code The action type code indicating the type of change made, either A, D, or U for Add, Delete,
or Update, respectively

When the version is loaded, the SC_ tables are read and the appropriate adds, deletes, or updates are made
to the model, based on the name of the version being loaded.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

89

PARTIALS
Partials are a means to import a customizable subset of data into your model, using data source files in the
MiddleLink format. Partials use the same record set from the MiddleLink schema that you would use to import
model data. In some ways, partials function similarly to the established subset feature, except that they are
customizable and flexible, while established subsets are structured and only operate on a predefined set of
data. For more information on the established subsets feature, see Subsets on page 82.
Partial imports include categories, so a partial can load specific sets of data, such as regulators and fuses.
The categories are saved as MiddleLink records. For example, you could create a partial for fuses which
saves the fuses out of a current model as MiddleLink records. Results are available for: Load-flow, Fault,
Capacity, and Reliability.
Tip:

Partials can be used to import data from any source, such as a GIS, SCADA, or any type of external
system. The only requirement is that the data conforms to the MiddleLink format before import. For
an introduction to the MiddleLink format from a GIS import perspective, see MiddleLink data source
(new MiddleLink) on page 104.

TO LOAD A PARTIAL
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Parts group, expand Partials and then select Load.

Why partials are different than normal MiddleLink

imports
Partials are different from normal model data imports, MiddleLink or otherwise, because they allow
SynerGEE to use the model in memory to import individual pieces of data, which otherwise could not stand
alone. For example, consider the following MiddleLink record for creating a section:
201, MySection, Node A, Node B

If this record were in a model data source, SynerGEE could not create the section unless it also found
records to create nodes A and B. However, if imported from a partial data source, SynerGEE could create the
section anyway, provided that nodes A and B already existed in memory. As another example, you could
import a particular device without a record to create the host section, as long as the section already existed.
In other words, partials allow SynerGEE to search the model in memory to resolve required references, while
a model data source must provide all of them internally.
In a general sense, you can consider partials to be an update process, whereas normal model data import
is more like a build process. However, partials do have the capability to build as well. For example, consider
the following MiddleLink record:
401, Sect_01, MySwitch, 600LB13, 0, 0

If you were importing this record as a partial, and the switch did not exist previously, it would be created. If it
did exist, the existing switch record would be updated. If you were doing a general model data import and the
switch already existed, however, this duplicate record would be rejected.

SynerGEE Electric 5.0

User Guide

90

Managing SynerGEE Data

The following diagram shows an overall comparison of internal processing between the two functions. You
can see that during a normal MiddleLink import, all data is collected into a temporary storage area and then
merged as a unit. During a partial import, however, individual items are imported as they are read.
Normal MiddleLink import
Complete
data
import
MiddleLink
data

Temporary model
(for validation, etc.)

Merge
SynerGEE
model

Partials import
Item-by-item
import
MiddleLink
data

SynerGEE
model

How partials work

Using partials, you can import virtually any data item supported by the MiddleLink schema for model data.
From a user perspective, the import process is similar to loading model data, as SynerGEE accepts and
rejects items as necessary to maintain data integrity, and provides a report when it is finished. As the data is
imported, facilities are created and/or updated as applicable. A partial data source must be in the MiddleLink
format, using the same records used to construct a MiddleLink model data source. To view the full MiddleLink
schema, select the SUPPORT tab in the SynerGEE ribbon bar. In the Tools group, click Schemas and then
select Model > MiddleLink.

A word of caution when using partials

Because partials are so flexible, they place added responsibility on you, the user, to protect data integrity.
When you load model data normally, SynerGEE performs extensive data checks within the data source and
can prohibit faulty data from ever entering the model. For partials, however, the rule-base is less stringent by
necessity, and you have a greater potential for data corruption.
As an example, consider the following MiddleLink record to create a capacitor:
701, Section_1, MyCapacitor, 6, OD34, 600

If you import this record as part of a model data source, you will get a 600 kvar/phase capacitor with each
import no matter what, because the section and its equipment come as a unit. However, if you import it from
a partial data source, the results are less predictable. If the capacitor does not currently exist, you will get a
600 kvar capacitor as expected. But if it does, you will get 600 kvar/phase added to the existing device, just
as if you had multiple 701 records in a model data source. If the existing capacitor was not named
MyCapacitor, the import will even change the name.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

91

Therefore, use care when designing a workflow that includes partials. Test them thoroughly and be sure that
they are performing the actions you expect.

CASES
Cases are script files written in either the Python format or the text-based recipe format that are designed to
load a model, warehouse, and protection database, as well as select feeders and perform other tasks as
specified in the script. The basic script can be created automatically from the MODEL tab of the SynerGEE
ribbon bar. Simply configure SynerGEE with the model, warehouse, and protection database that you want to
load, as well as the feeder selection, and then save the case file. SynerGEE will create the script that sets up
the current modeling environment. You can then edit the script to add any additional commands that are
available in the respective scripting language, for example to run an analysis or perform other related tasks.
The case file can be run from the MODEL tab of the SynerGEE ribbon bar at any time.
Note that case files are stored by default in your Macros file directory. You can identify and even change the
location of the Macros directory from the Preferences editor, as described in Defining file paths on
page 167.
Refer to the topics listed below for more information on working with case files.

Sample case file (text-based recipe format) on page 91

Sample script file (Python format) on page 93

Specifying which script type to use with cases on page 95

Creating a case on page 95

Editing a case on page 96

Running a case on page 97

Deleting a case on page 98

Sample case file (text-based recipe format)

The script example provided in this section shows the default SynerGEE model saved as a case file in the
text-based recipe format. The commands in this script will do the following:
1

Recipe.Start and Recipe.End. The Recipe.Start and Recipe.End commands are required
commands in the text-based recipe format. These two commands signal to SynerGEE when the
text-based recipe starts and ends.

Model.DropAllFeeders and Warehouse.Drop. The first two commands will clear all data that is
currently in memory, for both feeders and the warehouse. No data will be saved, and you will not be
prompted to save data as you are running the case. Therefore, it is critical that you address any
unsaved data issues before you run any case.

ScriptList.Create and ScriptList.AddItem. The ScriptList commands create a list of values for later
use in the script. Here, the ScriptList.Create command is used to create a list named Feeders, and
the ScriptList.AddItem commands are used to add the names of the feeders in the sample model to
this newly created list. The script list will then be referenced when loading a DSA, which occurs in
the next step.

SynerGEE Electric 5.0

User Guide

92

Managing SynerGEE Data

4

DSA.LoadFeeders. The DSA.LoadFeeders command loads the DSA named Access Database
(Sample Model) and then loads the feeder names that have been added to the Feeders list (using
the ScriptList commands described in the previous step).

Model.DeselectAllFeeders and Model.SelectFeeder. The Model.DeselectAllFeeders command

clears any feeder selection that is loaded by default from the designated DSA. Then, the
Model.SelectFeeder command is used repeatedly to select feeders that will be displayed in the
SynerGEE map display.

DSA.LoadWarehouse and DSA.LoadProtectionDb. The DSA.LoadWarehouse command loads the

warehouse from the specified DSA name into memory. The DSA.LoadProtectionDb command loads
the protection database into memory.

Map.ZoomArea. The Map.ZoomArea command zooms the SynerGEE map display to the current
extents in the SynerGEE map display.

The following example shows the script case file that is described above. To see the same example saved in
the Python script format, see Sample script file (Python format) on page 93.
Recipe.Start
'Create new model
Model.DropAllFeeders
'Create new warehouse
Warehouse.Drop
'Set feeders to be loaded
ScriptList.Create, Feeders
ScriptList.AddItem, Feeders, Camp - Market
ScriptList.AddItem, Feeders, Camp Hill
ScriptList.AddItem, Feeders, Carlisle Xfmr 1
ScriptList.AddItem, Feeders, Carlisle Xfmr 2
ScriptList.AddItem, Feeders, Cls - Dickinson
ScriptList.AddItem, Feeders, Cls - Louther
ScriptList.AddItem, Feeders, Cls - Pomfret
ScriptList.AddItem, Feeders, LTFeeder
ScriptList.AddItem, Feeders, New - Big Spring
ScriptList.AddItem, Feeders, New - Cove
ScriptList.AddItem, Feeders, New - Liberty
ScriptList.AddItem, Feeders, New - Springfield
ScriptList.AddItem, Feeders, Newville 1
ScriptList.AddItem, Feeders, Newville 2
ScriptList.AddItem, Feeders, Ship - South Penn
ScriptList.AddItem, Feeders, Ship - West Martin
ScriptList.AddItem, Feeders, Ship sub 1
ScriptList.AddItem, Feeders, Ship sub 2
ScriptList.AddItem, Feeders, York - Grantham
'Load feeders
DSA.LoadFeeders, Access Database (Sample Model), Feeders
'Select feeders
Model.DeselectAllFeeders
Model.SelectFeeder, New - Big Spring
Model.SelectFeeder, New - Cove
Model.SelectFeeder, New - Liberty

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

93

Model.SelectFeeder, New - Springfield

Model.SelectFeeder, Newville 1
Model.SelectFeeder, Newville 2
Model.SelectFeeder, Ship - South Penn
Model.SelectFeeder, Ship - West Martin
Model.SelectFeeder, Ship sub 1
Model.SelectFeeder, Ship sub 2
'Load equipment
DSA.LoadWarehouse, Access Database (Sample Warehouse)
'Load protection data
DSA.LoadProtectionDb
Zoom to the view extents
Map.ZoomArea 2199554.06 400981.10 2232186.94 384023.90
Recipe.End

Sample script file (Python format)

The script example provided in this section shows the default SynerGEE model saved as a case file in the
Python script format. The commands in this script will do the following:
1

Create an initialize the Solver. These initial steps are required for any Python script that is written for
use with SynerGEE.

Clear the current model and warehouse from memory.

Load feeders from a specified DSA. In this example, the script will use the DSA for the sample
model that is provided with SynerGEE, Access Database (Sample Model).

Specify which of those feeders will be selected when the model is loaded into SynerGEE.

Load a specified equipment warehouse.

Load a specified protection database.

The following example shows the script case file that is described above. To see the same example saved in
SynerGEEs text-based recipe format, see Sample case file (text-based recipe format) on page 91.
For more information on using Python scripts in SynerGEE, see Python Scripts on page 705.
# Import the Solver enumerated types
import SELib
# Import the module which creates the Solver
from win32com.client import Dispatch
# Import the module for COM exception handling
import pythoncom
try:
# Create the Solver
s = Dispatch("SESolver.StonerElectricSolver")
# Initialize the Solver
s.Init("", "kilowatt")
# Create new model
s.Model().Clear()
s.Model().Connect()

SynerGEE Electric 5.0

User Guide

94

Managing SynerGEE Data

# Create new warehouse
s.Warehouse().Clear()
# Load feeders
m = s.Settings().DataSources().Item("Access Database (Sample Model)")
# Set feeders to be loaded
s.Model().SetFeederToBeLoaded("Camp - Market")
s.Model().SetFeederToBeLoaded("Camp Hill")
s.Model().SetFeederToBeLoaded("Carlisle Xfmr 1")
s.Model().SetFeederToBeLoaded("Carlisle Xfmr 2")
s.Model().SetFeederToBeLoaded("Cls - Dickinson")
s.Model().SetFeederToBeLoaded("Cls - Louther")
s.Model().SetFeederToBeLoaded("Cls - Pomfret")
s.Model().SetFeederToBeLoaded("LTFeeder")
s.Model().SetFeederToBeLoaded("New - Big Spring")
s.Model().SetFeederToBeLoaded("New - Cove")
s.Model().SetFeederToBeLoaded("New - Liberty")
s.Model().SetFeederToBeLoaded("New - Springfield")
s.Model().SetFeederToBeLoaded("Newville 1")
s.Model().SetFeederToBeLoaded("Newville 2")
s.Model().SetFeederToBeLoaded("Ship - South Penn")
s.Model().SetFeederToBeLoaded("Ship - West Martin")
s.Model().SetFeederToBeLoaded("Ship sub 1")
s.Model().SetFeederToBeLoaded("Ship sub 2")
s.Model().SetFeederToBeLoaded("York - Grantham")
s.Model().LoadFromDataSource(m)
s.Model().Connect()
# Select feeders
s.Model().Feeders().Item("Camp - Market").bIsSelected = False
s.Model().Subtrans().Item("Camp Hill").bIsSelected = False
s.Model().Subtrans().Item("Carlisle Xfmr 1").bIsSelected = False
s.Model().Subtrans().Item("Carlisle Xfmr 2").bIsSelected = False
s.Model().Feeders().Item("Cls - Dickinson").bIsSelected = False
s.Model().Feeders().Item("Cls - Louther").bIsSelected = False
s.Model().Feeders().Item("Cls - Pomfret").bIsSelected = False
s.Model().Feeders().Item("LTFeeder").bIsSelected = False
s.Model().Feeders().Item("New - Big Spring").bIsSelected = True
s.Model().Feeders().Item("New - Cove").bIsSelected = True
s.Model().Feeders().Item("New - Liberty").bIsSelected = True
s.Model().Feeders().Item("New - Springfield").bIsSelected = True
s.Model().Subtrans().Item("Newville 1").bIsSelected = True
s.Model().Subtrans().Item("Newville 2").bIsSelected = True
s.Model().Feeders().Item("Ship - South Penn").bIsSelected = True
s.Model().Feeders().Item("Ship - West Martin").bIsSelected = True
s.Model().Subtrans().Item("Ship sub 1").bIsSelected = True
s.Model().Subtrans().Item("Ship sub 2").bIsSelected = True
s.Model().Feeders().Item("York - Grantham").bIsSelected = False
# Load equipment
w = s.Settings().DataSources().Item("Access Database (Sample
Warehouse)")
s.Warehouse().LoadFromDataSource(w)

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

95

# Load the protection database

# Replace username in the file path below with your Windows user name.
s.Warehouse().ProtDevCurves().LoadFromDatabase("C:\\Users\\username\\Doc
uments\\Stoner Software\\SynerGEE Electric\\SynProtectionDb.mdb")
except pythoncom.com_error as e:
SELib.SEMsg("Exception", SELib.SEException(e))
# Delete the Solver
del s

Specifying which script type to use with cases

You can configure SynerGEE to use either recipe scripts or Python scripts with SynerGEEs case feature.
Refer to the following procedure for more information.
Note:

By changing this option, you will also change the script type that is used for SynerGEEs startup
script. See Startup Scripts on page 715 for more information.

TO SPECIFY WHICH SCRIPT TYPE TO USE WITH CASES

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, click the SynerGEE tab.

Select Use Python for Startup Script and Case Files to use Python scripts with SynerGEEs case
feature.
or
Clear the check box to use recipe scripts with SynerGEEs case feature.

Creating a case
You can use SynerGEE to automatically create a new case script file from the MODEL tab of the SynerGEE
ribbon bar. Based on how you have set your preferences (as described in Specifying which script type to use
with cases on page 95), the new script will be in either the Python format or the SynerGEE recipe format.
The initial script will include commands to clear the current data from memory; load a DSA, warehouse, and
protection database (those that are already loaded in SynerGEE at the time you create the script); select the
currently selected feeders; and zoom to the network boundaries for the selected feeders. All case files are
saved in your Macros file directory with a *.syncase file extension. There is no distinction in the file naming or
file extension between Python files and text-based recipe files.
Once created, you are free to edit the script file to add additional commands (for example, to run a certain
analysis type). For more information on editing a case script, see Editing a case on page 96.

TO CREATE A CASE
1

Prepare the case that you want to create by loading the appropriate DSA, warehouse, and
protection database in SynerGEE, as well as selecting the feeders that you want to work with.

In the MODEL tab of the SynerGEE ribbon bar, in the case text box, type the name of the new case
that you want to create.

SynerGEE Electric 5.0

User Guide

96

Managing SynerGEE Data

3

Click the Save button.

Figure 2-1 Save button (SynerGEE cases)

Note:

Remember that when you click the Save button for a case, you are only saving the script
case file, which includes commands for actions such as loading a model, warehouse, and
protection database. It is important to note that you are not actually saving the model,
warehouse, or protection database.

If a case file already exists with the specified name, you will be prompted to overwrite the current
file. Click Yes to replace the file, or click No to cancel.

Editing a case
Once you have created a case, you can edit the case as required to add, modify, and remove commands.
Cases are saved in either the SynerGEE text-based recipe format or the Python scripting format, based on
how you have configured your preferences (as described in Specifying which script type to use with cases
on page 95). You can use any commands available in the respective scripting language to modify the case,
as appropriate.
The following procedure describes how to open a case file directly from SynerGEE for the purpose of editing
the case, using either with the Script editor (for text-based recipe scripts) or the Python IDLE editor (for
Python scripts). Take note that all case files are saved in your Macros file directory with a *.syncase file
extension. Therefore, you can also navigate to that file directory and directly edit the file using other file
editing tools. You can also copy the case files to other locations, for example to use the case file with another
SynerGEE installation.

TO EDIT A CASE
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Case group, select the name of the case that you want to edit.

Click the Edit button.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

97

Figure 2-2 Edit button (SynerGEE cases)

The script will open in either the SynerGEE script editor or the Python IDLE editor, depending on the
type of script that you have selected to edit. Use the script editor to edit the script as required. For
more information on editing text-based recipes using the SynerGEE script editor, see Using the
Script Editor on page 725. For more information on editing Python scripts, see Python Scripts on
page 705.

Running a case
Perform the following procedure to run a case from SynerGEE. This procedure will likely replace the model in
memory, even if the case loads the same data source that you are already editing. Furthermore, you will not
be prompted to save your model before you run a case. Therefore, make sure you have taken precautions to
save your data, if necessary, before you run a case.
Note that Python scripts can also be run from the Python IDLE editor. For more information, see Running a
Python script on page 709.

TO RUN A CASE
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Case group, select the name of the case that you want to run.

Click the Run button.

Figure 2-3 Run button (SynerGEE cases)

SynerGEE Electric 5.0

User Guide

98

Managing SynerGEE Data

Deleting a case
Perform the following procedure to delete a case from SynerGEE. This procedure will delete the case file that
is saved (by default) in your Macros file directory. In addition, the case file name will no longer be available
from the Model tab of the SynerGEE ribbon bar.

TO DELETE A CASE
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Case group, select the name of the case that you want to delete.

Click the Delete button.

Figure 2-4 Delete button (SynerGEE cases)

Click Yes to confirm the deletion.

DATA MART
The SynerGEE data mart is essentially a federation of our clients related data that can be logically grouped
to provide information useful to model building, distribution, and analysis. The resulting engine is a custom
application created through a close collaboration between SynerGEE engineers and the utility engineers. The
more engineers take advantage of building and maintaining the data mart, the more it can grow in its maturity.

Gathering data mart data

Because a true data mart may vary through utilities based on the type of data available, this section will
attempt to outline a typical, but not definitive, data mart extraction process.
The figure below represents a general approach to model building where data is gathered and built within the
GIS. The relevant model data is collected and pushed out into text files in a MiddleLink format. SynerGEE
reads the resulting text files and constructs the network models. SynerGEE then corrects modeling problems
and cleans up issues. The power distribution model is ready for analysis and can be retained in SynerGEE or
saved to Oracle for later use. Typically, this gathering and extract process is done on a per-feeder basis with
each feeder taking 2 to 5 minutes to extract.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

99

The following figure shows extraction of data directly from the AMS database, known as the model forge
method. DataPrep and MiddleLink files are no longer part of the extraction process or architecture. With the
model forge method, models are built by region instead of by feeder, causing build times to be dramatically
reduced. SynerGEE builds models from the clients data mart, which can include databases from various
locations defined by the client.

UNIT TESTS
Unit tests can be used to test small models for line calculations and load calculations. The small models are
analyzed by hand, and the expected results are made a part of the MiddleLink file that is used to describe the
system. SynerGEE will process the MiddleLink unit test file and generate a report showing which tests
passed and which tests failed.
Unit tests help ensure that SynerGEEs calculations remain accurate and consistent as future updates are
made to the SynerGEE application, architecture, and database. Performing unit tests will reduce costs and
improve the time needed to upgrade to new versions of SynerGEE.
Unit test files must be saved in your SynerGEE Electric Units folder, which by default is in the following
location (Windows 7), where username is your Windows user name:
C:\Users\username\Documents\Stoner Software\SynerGEE Electric\
Units

The Units folder can be changed from the Paths tab on the SynerGEE Preferences editor. For more
information, see Defining file paths on page 167.

SynerGEE Electric 5.0

User Guide

100

Managing SynerGEE Data

Refer to the following procedure for more information on performing a unit test.

TO PERFORM A UNIT TEST

1

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Model QA section, select Unit Tests.

In the Unit Test editor, select the check box for each unit test that you want to perform.

Click Finish to run the unit test.

IMPORTING GIS DATA USING MIDDLELINK

The MiddleLink format is the most common means of preparing GIS and other external data for import into
SynerGEE, to build a model. Because the process of building a model from GIS data involves many facets
and technicalities, this portion of the User Guide is devoted solely to that endeavor. Keep in mind, however,
that the MiddleLink format is very flexible and can be used in a variety of ways, other than a full-scale,
comprehensive model build. Also, SynerGEE supports several other data formats for importing model data,
though MiddleLink is by far the most common for bringing in GIS-originated data.
To conduct a full-scale model build in this manner, you must have your GIS data formatted in one or more
text files, adhering to the MiddleLink schema. Typically, these files are produced from a GIS extraction by a
customized DataPrep software solution from GL Noble Denton. However, you do not need DataPrep to build
a model from GIS data, provided that your imported data adheres to the MiddleLink schema.
In older versions of SynerGEE, the import of MiddleLink files was done with the separate, standalone product
called MiddleLink. In SynerGEE Electric 3.5, the standalone MiddleLink functionality was incorporated into
SynerGEE as a module. At the same time, the MiddleLink schema underwent a major renovation. Therefore,
there are two different MiddleLink schemas that you will see referenced in the User Guide, and it is important
that you understand the differences between the two.

MiddleLink. Any time you see a reference to the MiddleLink schema, this refers to the newer
schema introduced with SynerGEE Electric 3.5. This schema was expanded to accommodate many
additional functions, such as outage and customer data. For general information on this schema,
see MiddleLink data format on page 72.

MiddleLink 3.4. The MiddleLink 3.4 schema refers specifically to the MiddleLink file format that is
used by the last release of the standalone MiddleLink product, version 3.4. This format required a
set of source files to build a model. For compatibility, SynerGEE can still import MiddleLink 3.4 data,
but this functionality will eventually be deprecated. For more information on the MiddleLink 3.4
schema, see MiddleLink 3.4 data source on page 103. If you are or were a MiddleLink 3.4 user,
see Note to MiddleLink 3.4 users Building models from GIS data on page 101.

At a lower level, building a model from GIS data can involve a host of data issues that are unique to your
situation. This User Guide does not attempt to cover every possible data issue that might arise. Rather, it
attempts to present a higher-level overview of the import process, so that you can understand the tools well
enough to customize an extraction/model build system that works for you.
Refer to the topics listed below for more information.

Benefits of GIS extraction on page 101

Note to MiddleLink 3.4 users Building models from GIS data on page 101

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

General steps for a SynerGEE-MiddleLink import on page 102

Running a MiddleLink data import (model build) on page 103

The MiddleLink data source Building a model from a GIS on page 103

Setting options for a MiddleLink data import on page 106

Detailed processing during a MiddleLink data import on page 106

Automating MiddleLink model builds on page 112

101

Benefits of GIS extraction

By using GIS data to automatically build models, you can enjoy a host of benefits, including:

Significant time and cost savings. By eliminating the manual process of model building, you will
immediately realize a significant reduction in time and expenses.

Consistency throughout the organization. When your SynerGEE models are generated from GIS
data, everyone is looking at the same data.

Regular updates to SynerGEE models. GIS extraction allows you to quickly update your SynerGEE
models automatically when updates are made in the GIS.

Two-way data validation. When you bring GIS-based data into SynerGEE, you can use the import
tools native validation features to find and fix data problems, and later use SynerGEE data
management tools as well. After you correct a problem, the change can be implemented in the GIS
source, providing benefit to all parties. Many organizations find that data import validation by
SynerGEE has played a significant role in improving their GIS data.

To create the data source files used by the import tool, you need a GIS extraction process in place. You can
build this process yourself, adhering to the MiddleLink schema. Or, GL Noble Denton can create a
customized, turnkey extraction process for you, known as DataPrep. The GL Noble Denton approach is
comprehensive and does not end until your models are validated and working in SynerGEE. For more
information on customized DataPrep systems, contact GL Noble Denton. For more information on source
files, see The MiddleLink data source Building a model from a GIS on page 103.

Note to MiddleLink 3.4 users Building models from

GIS data
Beginning with SynerGEE Electric 3.5, MiddleLink functionality has been incorporated into SynerGEE and
development of the standalone MiddleLink product has been discontinued. Therefore, in this User Guide, the
term MiddleLink generally refers to MiddleLink as a SynerGEE module. References to the older standalone
product are specifically designated as such.
Models generated by the standalone MiddleLink are still compatible with SynerGEE and you can continue to
use the product. However, the SynerGEE import tool has many advantages over the standalone MiddleLink
product, including:

Import directly into SynerGEE. When you build a model with the SynerGEE data import tool, it
opens directly in the SynerGEE map view. You can then use the full suite of SynerGEE tools to
check and validate the model, such as the check data report and load-flow analysis.

SynerGEE Electric 5.0

User Guide

102

Managing SynerGEE Data

Easy data merging. When the import tool builds a model, it merges the new data with any data
already in memory. As such, you can quickly merge new data with an existing model by simply
loading the existing model before importing the new data.

Consistency with defaults and settings. SynerGEE maintains a set of parameter defaults, as does
the standalone MiddleLink product. Using MiddleLink 3.4, these defaults have to be maintained in
two places, creating the potential for inconsistencies. Using the SynerGEE import tool, defaults
assignment and validation all takes place within the SynerGEE environment, helping to promote
consistency. For more information on defaults, ranges, and validation, see Editing Default Values
for SynerGEE Devices on page 136 and Validating and Cleaning Up Model Data on page 137.

Easier file management. Because the tool builds models directly within SynerGEE, you can manage
the model files afterward using familiar SynerGEE features. This means that once a model is built,
you have all of SynerGEEs powerful data management tools at your fingertips, such as standard
loading and saving, data comparison, versions, the gallery, and much more.

Speed. The combination of a common interface and SynerGEEs powerful engine make model
builds much faster than before. And, because the model is built directly in SynerGEE, the separate
MiddleLink step is eliminated and your time to manage the file is reduced.

The SynerGEE import tool is compatible with previous versions of MiddleLink files, including version 3.4.
However, if you import MiddleLink 3.4 data directly into SynerGEE, you should begin working to switch to the
newer MiddleLink schema, because the older format is no longer under active development and will only
become increasingly obsolete.
Some users, who have source data formatted in the MiddleLink 3.4 format, continue to use the standalone
MiddleLink product to generate models. If you choose this approach, you should be warned that standalone
MiddleLink is no longer in active development. Eventually, operating system evolution will make the
standalone MiddleLink product non-functional. In addition, standalone MiddleLink will never generate a
model any newer than version 3.4. With each successive release of SynerGEE, this version becomes
increasingly obsolete and may eventually cause compatibility issues. If you are still using standalone
MiddleLink 3.4, you should begin the effort to migrate to the newer MiddleLink schema and use SynerGEE to
import the data.
To import features introduced after SynerGEE 3.4, you must a use a newer MiddleLink data source. Once
you upgrade your data source files to the newer format, the source will become incompatible with the
standalone MiddleLink product and you must use SynerGEE to build your models. For more information on
compatibility and the data source, see The MiddleLink data source Building a model from a GIS on
page 103.

General steps for a SynerGEE-MiddleLink import

If you choose to use SynerGEE to build your models from a MiddleLink data source, the following are the
general steps you should take. These steps do not apply if you decide to use the standalone MiddleLink
product instead. If you are a MiddleLink 3.4 user, see Note to MiddleLink 3.4 users Building models from
GIS data on page 101.
1

User Guide

Extract the data from your GIS and format it as a MiddleLink data source, adhering to the
established schema. For more information on the data source schema, see The MiddleLink data

SynerGEE Electric 5.0

Managing SynerGEE Data

103

source Building a model from a GIS on page 103.

2

Create a DSA to the MiddleLink data source, configuring your MiddleLink import options as
appropriate. For more information on these options, see Setting options for a MiddleLink data
import on page 106. For more information on DSAs, see Data Source Aliases (DSAs) on page 75.

Import the data source into SynerGEE. For more information, see Running a MiddleLink data
import (model build) on page 103.

In the map view, select feeders as desired to view the model that you imported.

As necessary, run the model cleanup tool without applying any changes, and review the report. For
more information on using the tool, see Model Cleanup Scripts on page 718.

If proposed changes (if any) are acceptable, run model cleanup a second time and implement the
changes.

Run the check data report to track down and resolve any lingering issues. For more information on
this report, see Digest report on page 478.

Save the model.

Perform studies as normal.

Running a MiddleLink data import (model build)

The procedure for importing MiddleLink model data is similar to importing any model data. The only
difference is that you are generally doing it for the express purpose of building a model. During an import, all
source data is imported and merged with any data in memory. For more information on importing model data,
see To load (import) model data on page 61.

The MiddleLink data source Building a model from a

GIS
This portion of the User Guide reviews the MiddleLink schemas for model data, from the view of building
models from GIS data.
Refer to the topics listed below for more information.

MiddleLink 3.4 data source on page 103

MiddleLink data source (new MiddleLink) on page 104

MiddleLink 3.4 data source

MiddleLink 3.4 data source files are comma-separated (CSV) text files and must follow a strict schema. This
schema is based on the historic MiddleLink standard and is significantly different than the newer standard
introduced in SynerGEE Electric 3.5.
As an example of a 3.4 source file, the following is an excerpt from a node (NOD) file:
;ID,
"NOD1",

Xcoord,
446741,

SynerGEE Electric 5.0

Ycoord, NodeID, LocDesc

83781, "1",
""

User Guide

104

Managing SynerGEE Data

"NOD2",
"NOD3",
"NOD4",

445168,
445174,
444910,

85368,
85039,
84717,

"1005",
"1016",
"1030",

""
""
""

Each line of this particular file represents an individual node and contains five pieces of data to describe it.
The pieces of data must be separated by commas and ordered precisely, as dictated by the schema. For
example, the X coordinate of a particular node is always found in the second position of its respective line.
This type of CSV format is common to all 3.4 data source files. There are over 20 data source file types that
can be used because each piece of equipment has its own file type, as do items such as nodes, sections,
and loads. However, you are not required to have every single file in a data source to build a model. If one or
more is missing, SynerGEE simply leaves that item(s) out. For example, if you are missing the capacitor
(CAP) file, SynerGEE simply skips capacitors and adds none to the build.
Note that the first line of the sample file above is a comment line, denoted by the initial semi-colon (;).
Comment lines can be added anywhere within a data source file and are not processed. Also, note that the
string fields in the example above are enclosed in quotes. Quotes were required for string fields by the
standalone MiddleLink product. However, when SynerGEE imports version 3.4 data source files, quotes are
optional. SynerGEE can import string data properly with or without quotes and simply ignores any quotes it
finds in the data source.
A version 3.4 data source also requires a MAP file, which is slightly different than the other data source files.
Instead of containing model data, it contains important information about the data source in general, such as
the data source version number. The MAP file is similar to a control file around which the remaining files are
organized. When you perform a data import/model build, you specify the MAP file only, and SynerGEE finds
the remaining data source files based on the MAP file name. For more information on the format of a MAP
files, use the MiddleLink 3.4 schema, accessible by selecting the SUPPORT tab in the SynerGEE ribbon bar.
In the Tools group, click Schemas and then select Legacy > MiddleLink 3.4.

TO VIEW THE MIDDLELINK 3.4 SCHEMA

1

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Help group, click Schemas and then select Legacy > MiddleLink 3.4.

MiddleLink data source (new MiddleLink)

The newer MiddleLink schema, introduced with SynerGEE 3.5, represents a significant restructuring of the
historic MiddleLink format. Rather than a series of files, the newer format combines the entire data source
into one, comma-delimited text file. The file is broken into individual records, using a standard numbering
system and unique record IDs to sort the data. As an example, the following is an excerpt from the newer
MiddleLink schema:
Description

Code

Field 1

Field 2

Field 3

Field 4

Field 5

Basic switch
data

401

Section
ID (s)

Switch
ID (s)

Switch
type (s)

Near from
node (b)

Is open (b)

Automatic /
Autotransfer
switch

402

Section
ID (s)

Is autotransfer (b)

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

105

Description

Code

Field 1

Field 2

Field 3

Field 4

Field 5

Loop tie
switch

403

Section
ID (s)

Wandering
lateral tie
switch

404

Section
ID (s)

In the data source, for example, you might see the following entries, which would create an auto-transfer
switch:
401, SEC_0110, Switch_32A, 1200LB13, 1, 0
402, SEC_0110

The first line uses code 401 to indicate that a switch should be created on section SEC_0110 named
Switch_32A, on the from-node end of the section, using switch type 1200LB13, and should be closed. The
second line uses code 402 to indicate that the switch on SEC_0110 should be marked as an autotransfer
switch. Because code 402 applies only to switches, and because only one switch can exist on a section, no
further identifying information is needed for this line.
All device types have their own numerical category, based on a multiple of 100. In this example, you can see
that the 400s are reserved for switch data. If you look at the full schema, you will see that node data is in the
100s, section data in the 200s, feeder data in the 300s, and so on. Within categories, each numerical code
groups up to eight pieces of related data items for easier management. Using these codes, you can logically
sort your source as needed to manage your data.
Because data is identified by numerical codes, lines can exist in the source file in any order. Quotation marks
should not be used in the new MiddleLink data source.
The transformation of the MiddleLink data source has occurred for the following reasons:

Easier management. Because all the source data is in one file, it is much easier to manage. In
addition, since it is arranged by number and category, it is easier to sort, identify, and troubleshoot.

Easier to expand. As the data required for SynerGEE has increased over time, the original data
source format became cumbersome to expand and manage. Whenever a new field was introduced,
it had to be appended to the end of an existing record entry, resulting in some very long records in
the source files. With the newer schema and beyond, new features will receive a new numerical
code which can be used as any other, and any codes that no longer apply can be simply ignored.

Keep in mind that the MiddleLink 3.4 format is still compatible with SynerGEE. For more information, see
Note to MiddleLink 3.4 users Building models from GIS data on page 101.

TO VIEW AND PRINT THE NEWER MIDDLELINK SCHEMA

1

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, click Schemas and then select Model > MiddleLink.

SynerGEE Electric 5.0

User Guide

106

Managing SynerGEE Data

Setting options for a MiddleLink data import

SynerGEE provides several options that control how a model is built when it imports MiddleLink files. These
options can have a significant impact on how the data is handled. You should take care to set them correctly.
These options are specified in the DSA used to import the data. For more information on creating and editing
DSAs, see Data Source Aliases (DSAs) on page 75.
Option

Description

Phasing

Designates the phase letters assigned to phase positions within the data
source. Because only phase letters appear in the data source, SynerGEE
needs to know which actual positions they apply to. After the import, data
source lettering is discarded and phases are lettered according to settings in
your preferences. For more information on setting the phase lettering, see
Setting SynerGEE preferences on page 163.

Calculate Length

Sets SynerGEE to calculate section lengths based on node coordinates. If this

option is set, all lengths of all imported sections are calculated, regardless of
any length values found in the data source file.

Set Neutral Phasing

On

Sets SynerGEE to add a neutral phase to any line read from the data source
without a neutral phase.

Voltage Base

Voltage base used by your organization, used to configure the SAI_Control

table in the model data source.

Length Multiplier

Multiplier used for section lengths read from the data source. The multiplier
also applies to calculated lengths, if that option is set.

Detailed processing during a MiddleLink data import

The import/export tool performs a variety of tasks while building a model by importing MiddleLink data. Refer
to the topics listed below for more information.

Topology concerns and restrictions on page 107

Node identification From/To versus Source/Load on page 107

Literal handling of empty records MiddleLink data import on page 107

Feeder and subtran sources MiddleLink data import on page 108

Capacitors MiddleLink data import on page 109

Protective device conversion MiddleLink data import on page 109

Section spacing lookup MiddleLink data import on page 110

Switch conversion MiddleLink data import on page 110

General rules, messages, and warnings MiddleLink data import on page 110

Browser file MiddleLink data import on page 111

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

107

Topology concerns and restrictions

Because SynerGEEs topology validation engine is fairly strict, it must resolve any unsupportable topology
violations at the time of a MiddleLink import. For example, if two different sections share the same pair of
nodes, one of those sections must be eliminated at the time of import. Often, topology violations are resolved
by simply discarding the component that caused the original problem. In the previous example, SynerGEE
may attempt to preserve the section that contains any equipment, but this is not guaranteed and the simple
order of source file data may be more of a determining factor.
While efforts have been made to cover these situations in the data import report, not all can be accurately
tracked. If your source files contain an unusual amount of unsupportable topology data, you may find that
data is altered and/or removed during import without your knowing. Therefore, it is important to keep your
source file data as compliant with SynerGEE as possible, before attempting to import it.

Node identification From/To versus Source/Load

In the MiddleLink standard, nodes are always referenced using the From/To designation, which is different
than the Source/Load distinction. The From/To convention operates from a strict data standpoint and has no
inherent relation to which nodes ultimately become source or load nodes.
The differences between From/To and Source/Load can be explained follows:

From/To. In a data source, every section has a literal from-node and to-node. When this
nomenclature is used in the interface, it is referring directly to the nodes as they are listed in the
respective section data record.

Source/Load. When this nomenclature is used, SynerGEE uses actual power flow to determine
which node is which. SynerGEE does not necessarily follow the same direction as the from/to
designations in the data source. Because the source/load concept is less applicable in a meshed
network model, the source/load terminology is only used in the interface when you have your
preferences set to disallow loop creation.

The source/load method is a mostly an interface convenience, using SynerGEEs topology engine to
determine whether a node is a source or load node, shielding you from the added complexity of from-nodes
versus to-nodes. SynerGEE can use this method when working with a full model within the map view, with all
topology tools running. However, SynerGEE MiddleLink must always use the literal from/to node
designations, because the topology engine cannot operate fully on a partial model as it is being built.
Many MiddleLink records use the from/to node terminology to indicate equipment location and orientation.
For example, a 1301 record to create a primary transformer uses node designations to determine the
direction of the high-side winding. When creating your data extraction/model build process, use and
designate from- and to-nodes as they literally appear in your data source, not as they may relate to the actual
power flow in the final model. During a MiddleLink data import, SynerGEE has no concern for whether a node
will ultimately come to represent a source or load node.
Other records that include from/to node data and adhere to this concept include 401, 801, 901, 1001, and
1201.

Literal handling of empty records MiddleLink data import

When SynerGEE imports MiddleLink data, it imports the data exactly as it is found in the source file, and
makes no assumptions about the data. For example, if you have an empty field in the source file, this empty

SynerGEE Electric 5.0

User Guide

108

Managing SynerGEE Data

value will replace any value currently in the model, or in effect, delete it. Consider the following record based
on the new MiddleLink schema:
203, Sect_01, 7, 357, ,

This record is intended to supply conductor data for section Section_01, but the conductor fields are blank.
When the section was originally created with a 201 record, SynerGEE applied defaults from SynDefaults.xml,
but this 203 record would come behind and delete that default conductor data.
Although situations such as this may not be common, it remains your responsibility to manage your data in a
fashion that supports your needs. SynerGEE does provide several tools for finding and correcting data
issues, which may be your best approach for ensuring that your final model is what you expected. These
tools include Check Data report on page 137, Editing Default Values for SynerGEE Devices on page 136,
and Model Cleanup Scripts on page 718.

Feeder and subtran sources MiddleLink data import

In SynerGEE, a feeder or subtran record must be associated with a node. This association is described in
detail in Modeling Feeders and Subtrans on page 245.
During a MiddleLink data import, there are two methods by which SynerGEE can establish a feeder or
subtran power source, based on whether the feeder or subtran has a corresponding node in the data source.
These methods are described in the sections listed below. Note that new MiddleLink no longer supports the
second method.

Method 1 Feeder or subtran references a node in the data source on page 108

Method 2 Feeder or subtran does not reference a valid node on page 108

Method 1 Feeder or subtran references a node in the data source

If a feeder or subtran in the data source has the same ID as a valid node in the same data source,
establishing the feeder or subtran is relatively straightforward. The feeder or subtran record is created using
its respective data, and the node is created using its respective data. Any coordinate data found with the
feeder or subtran is disregarded, as well as any section references. This method of establishing a feeder is
valid for all versions of MiddleLink data.

Method 2 Feeder or subtran does not reference a valid node

In some cases, a GIS may not store node information at a feeder or subtran power source. In this case, any
MiddleLink 3.4 data source generated straight from the GIS would be missing the node data that is required
for the feeder/subtran/node association. Therefore, SynerGEE provides this second method for establishing
a feeder or subtran during a data import.
When processing a feeder or subtran whose ID does not match that of a valid node, SynerGEE can still
establish the feeder or subtran, provided that the following two conditions are met:

The feeder or subtran includes valid X and Y coordinates.

The feeder or subtran references a valid section that is missing only one of its nodes.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

109

If these two conditions are met, SynerGEE creates the missing node using the coordinates in the feeder or
subtran data, giving it the same ID as the feeder or subtran. Afterward, it creates the feeder or subtran itself,
and the proper feeder/subtran/node relationship exists in the model.

Capacitors MiddleLink data import

If the import tool encounters multiple 702 records (kvar data) in a MiddleLink data source for a single
capacitor, the kvar values are summed for that capacitor.

Protective device conversion MiddleLink data import

If your MiddleLink 3.4 data source contains information on classic protective devices, these devices will be
converted to newer device types during an import. SynerGEE does not import classic protective devices
directly into a model.
Refer to the topics listed below for more information.

Conversion during a MiddleLink 3.4 import on page 109

Conversion during a MiddleLink import (new MiddleLink) on page 109

Conversion during a MiddleLink 3.4 import

During a MiddleLink 3.4 data import, protective device conversion occurs automatically, using any data
supplied with the classic device, such as location and phasing. Then, SynerGEE supplies default data for
other missing items. SynerGEE also populates the new devices Manufacturer field with field 5 from the PDV
file, Classic Type Name. Afterward, you can use the SynerGEE model cleanup tool to supply the proper
data to fully configure these devices. For more information on this model cleanup function, see Model
cleanup and classic protective device conversion on page 719.
If you are familiar with the standalone MiddleLink 3.4 product, you may be familiar with its protective device
conversion feature, which is significantly different than SynerGEEs data import process. The standalone
MiddleLink product used a lookup table to convert classic protective devices and supply all missing data at
once. If a classic device was not found in the lookup table, it was rejected from the build altogether.
Using the post-import cleanup system, SynerGEE is more flexible than the standalone MiddleLink 3.4.
Because conversion is automatic and no lookup table is initially required, all classic device data is preserved
and placed in SynerGEEs memory, where you have better access to it for validation and configuration.

Conversion during a MiddleLink import (new MiddleLink)

The newer MiddleLink standard does not support classic devices at all, so conversion during import is not
applicable. If you have classic devices and plan to use the newer MiddleLink standard, you must convert the
data before or during the generation of the MiddleLink data source itself. There is no newer equivalent to the
PDV file.
For more information on data source files, see The MiddleLink data source Building a model from a GIS
on page 103.

SynerGEE Electric 5.0

User Guide

110

Managing SynerGEE Data

Section spacing lookup MiddleLink data import

The standalone MiddleLink product used a special lookup table to supply conductor spacing information that
might not be supplied from a GIS. This functionality has been discontinued and replaced by the SynerGEE
model cleanup application. For general information on model cleanup, see Model Cleanup Scripts on
page 718.

Switch conversion MiddleLink data import

The standalone MiddleLink product had a feature to convert node-type switches to compatible SynerGEE
switches, through an option called Collapse Open Switches. This option has become obsolete and is no
longer available for a MiddleLink data import.

General rules, messages, and warnings MiddleLink data

import
SynerGEE uses a limited rule-base when importing MiddleLink data. If any of the rules are violated during the
import, SynerGEE reports it and performs the applicable remedy. For example, if a piece of equipment does
not reference a valid section, it is rejected from the import and SynerGEE reports this action.
The following table lists the messages that may appear in a report, based on rule usage:
Code

Message

Description

Syn_01

Bad node information on

section. Section WILL BE
DROPPED.

Each section record must reference two valid nodes. If not,

the section is not imported.

Syn_02

Referenced section could

not be found.

Each device record must reference a valid section. If not, the

device is not imported.

Syn_03

Duplicate record found.

Duplicate records in any source file are ignored. A record is

considered a duplicate if the item ID is the same as the ID of
a comparable item in a previously read record.

Syn_04

Unknown protective device

category.

If an error in a PDV file record prevents SynerGEE from

recognizing the protective device category, such as fuse or
breaker, the record is ignored.

Syn_05

Critical error reading data.

Any severe data problem, especially one that violates the

SynerGEE data structure, will cause a record to be ignored.

Syn_06

Classic protective device

converted.

Classic protective devices must be converted to newer,

detailed device types. If a conversion occurs, this message
is presented, along with information about the new device.
For more information about protective device conversion,
see Protective device conversion MiddleLink data import
on page 109.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

111

Code

Message

Description

Syn_07

Lookup table error.

SynerGEE attempted to convert a classic protective device,

but found no corresponding information in the protective
device lookup table. This error applies to the legacy
MiddleLink 3.4 data import only, because SynerGEE
performs automatic conversions and relies on the model
cleanup tool afterwards to complete the process.

Syn_08

General syntax error.

SynerGEE encountered an irreconcilable syntax error and

did not process the offending line.

Browser file MiddleLink data import

As part of validation during a model build, SynerGEE creates a browser file that contains build messages and
validation results. This browser file is identical to the browser file produced by the standalone MiddleLink
product. It is produced in the original data source folder with a BRS extension.
The browser file is a CSV file that contains messages found in the MiddleLink import report, along with the X
and Y coordinates of the associated nodes and elements. As such, you may find it useful for browsing your
GIS maps to find the original problem spots. Some MiddleLink users employ a custom application within their
GIS that reads the browser file and automatically zooms to the locations contained therein.
The following table shows the data format for the browser file, for a facility. Field descriptions for a node are
similar, except a nodes from-node and to-node coordinates are identical. The comment character for the file
is a semi-colon ;.
Field Description

Data Type

1.

Data source name located in the map file.

Text

2.

ID of the component with the problem.

Text

3.

X coordinate of the from-node of the element.

Real number

4.

Y coordinate of the from-node of the element.

Real number

5.

X coordinate of the to-node of the element.

Real number

6.

Y coordinate of the to-node of the element.

Real number

7.

Code indicating the error type.

Integer

8.

Error message.

Text

The following is three sample lines from a browser file

;"*8/24/1999 9:44:47 AM Data Source Name", "Data Source ID", x1, y1, x2, y2,
"Error Code", "Message"
"Mle6Sample", "R216 K",5567.794, -6023.306, 5567.794, -6023.306,
13590,"Protective Device with ID R216 K, has an invalid value, 0, for
attribute Minimum Pickup Multiplier (Setting); used default, 1."

SynerGEE Electric 5.0

User Guide

112

Managing SynerGEE Data

"Mle6Sample", "F228",2411, 4693, 2411, 4693, 13590,"Protective Device with
ID F228, has an invalid value, 0, for attribute Minimum Pickup Multiplier
(Setting); used default, 1."

Automating MiddleLink model builds

Many users prefer to automate the process of importing MiddleLink data, perhaps through a system of daily
or overnight builds. This type of automation helps ensure accurate, up-to-date model data, while leaving
more time for users to perform engineering work, rather than data management tasks.
This section of the User Guide presents a suggested, general approach towards automation. It is mainly
intended to introduce the tools available for this task. Your process may have unique aspects that require any
number of variations.
Refer to the topics listed below for more information.

Overview of MiddleLink automation tools on page 112

General steps for MiddleLink automation on page 112

Sample recipe for MiddleLink automation on page 113

Sample command line for MiddleLink automation on page 114

Overview of MiddleLink automation tools

SynerGEE provides two main tools for automation:

Recipes. Recipes are custom scripts that can perform a variety of tasks within SynerGEE, including
the import of data. For detailed information on recipes, see Recipe Scripts on page 700.

Command line arguments. When you launch SynerGEE from a command line, you can specify
certain arguments that initiate processing tasks after startup. One of these arguments allows you to
run a recipe as soon as SynerGEE starts up. For detailed information on command line arguments,
see Launching SynerGEE from the Command Line on page 184.

Briefly stated, to automate a MiddleLink build, you should create a command line setup which launches a
recipe, which in turn runs a model build process. For a more detailed examination of this process, see
General steps for MiddleLink automation on page 112.

General steps for MiddleLink automation

The following general steps illustrate a suggested approach towards automating MiddleLink builds. Your
situation may require variations according to your normal workflow and data setup.
1

Write and test a recipe that builds the model from your MiddleLink data source and saves the
results.
With DataIO recipe commands, you can fully automate the task of importing and saving feeders.
You should write this recipe and test it fully within SynerGEE before adding it to any automated and/
or unattended process. For an example of this type of recipe, see Sample recipe for MiddleLink
automation on page 113.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

113

Create and test a command line configuration that launches the model build recipe. For a sample
command line, see Sample command line for MiddleLink automation on page 114.

Implement some sort of scheduled launch for the command line, perhaps nightly at a certain time.
You may use any variety of external tools to schedule a regular application launch, via a command
line. One of the common means is through Windows Scheduler, accessed through the Windows
Control Panel. For more information on Windows Scheduler, see your Windows documentation.

In summary, with this configuration in place, Windows Scheduler will start SynerGEE at the prescribed time,
and command line arguments will launch a recipe that initiates and completes the model build. Note that this
process does not include preparation of the MiddleLink data source itself. Naturally, for a regular model build
to have value, the data source must also be updated regularly from the original source, usually a GIS
database. As data extraction methods vary widely between organizations and networks, this document does
not attempt to address this task. For assistance and ideas, you may consider contacting your IT department
or GL Noble Denton.

Sample recipe for MiddleLink automation

A recipe that performs a MiddleLink build will likely consist of DataIO recipe commands. DataIO commands
allow tasks such as data loading and saving, the primary tasks involved with MiddleLink model builds. The
recipe may also contain commands to automatically run the model cleanup application, if you typically use
the application to validate data following a MiddleLink build. For more information on model cleanup, see
Model Cleanup Scripts on page 718.
As an example, assume that you have the following:

A DSA to a MiddleLink data source called MyMiddleLinkSource.

A DSA to an Access model database called MyNewModel.

A model cleanup script called PostMiddleLinkCleanup.

With these items, you could write the following recipe to automate building, validating, and saving:
Recipe DataIO
'Load the MiddleLink data, using the DSA "MyMiddleLinkSource"
DIO_04, MyMiddleLinkSource
'Save the completed model to an Access database, using the DSA "MyNewModel"
DIO_05, MyNewModel
End Recipe
Recipe Analysis
'Run model cleanup to correct and supplement data. Skip the reporting.
ANL_02, PostMiddleLinkCleanup, False
'Shut down SynerGEE. Normally, this command would only apply if this
'recipe were run as an unattended process. You probably don't want
'SynerGEE to shut down on you while testing this recipe.

SynerGEE Electric 5.0

User Guide

114

Managing SynerGEE Data

GEN_02
End Recipe

Depending on your needs, you could further expand this recipe to perform other functions, such as running
analyses. Note that this recipe assumes that you already have DSAs created for your files. You could have
the recipe generate the DSAs automatically as well, although DSA creation is normally a one-time task and
not applicable to a regularly occurring process. For more information on DSAs, see Data Source Aliases
(DSAs) on page 75.
For general information on recipes, see Recipe Scripts on page 700. For detailed information on recipe
command syntax, see Numerical Recipe Commands on page 855.

Sample command line for MiddleLink automation

The following command line would launch SynerGEE and run a recipe called MyOvernightBuildRecipe. This
example assumes that SynerGEE is installed in the default folder, and the recipe is already created and
tested:
"C:\Program Files\SynerGEE Electric 5.0\SynerGEE.exe" -r
"MyOvernightBuildRecipe"

This command line might be used to launch a recipe such as the one described in Sample recipe for
MiddleLink automation on page 113. You could put this command line anywhere that accepts command
lines, including Windows Scheduler settings and the Run dialog box, accessed by selecting Start > Run from
the Windows desktop.

USING AN ENTERPRISE DATABASE SYSTEM

An enterprise database refers to one that is stored and managed on a network server by a resident
management system. In an enterprise system, no user actually owns the data source files. Instead, multiple
users essentially check feeders in and out of a central database that remains permanently on the server. In
this respect, an enterprise database serves as a central, protected data repository that multiple users can use
simultaneously.
Only model, equipment, and associated data, such as subsets, can be managed within an enterprise
database system. All other data types must be managed with personal data management tools.
Within an enterprise database system, your models reside on a network server, often in an Oracle or SQL
Server database. When you want to work on a model, you check out the feeders that you need, which loads
the feeders into your PCs memory. When you are finished with those feeders, you can save them back to the
database, which replaces the feeders you originally checked out. You can also create a new enterprise
model with the feeders that you checked out. Because the feeders are in your PCs memory, you can also
save them to any other personal data format, such as an Access database on your PC for local use.
Note that the SynerGEE application itself is always installed on your PC. SynerGEE is not designed to
function in a client/server environment, even when using an enterprise database system. When you load
feeders from an enterprise system, a copy of the entire dataset is loaded into your PCs memory. When you
run analyses and work in the editors, this is the data you are using and/or changing. You cannot directly
manipulate data on the server, other than saving whole feeders back with data changes.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

115

Refer to the topics listed below for more information.

Advantages of an enterprise system on page 115

Setting up an enterprise database system on page 115

Using an enterprise system on page 116

Feeder locks and lock IDs on page 121

Model locks for Enterprise databases on page 122

Note to database administrators regarding Enterprise databases on page 123

Word of caution regarding enterprise databases and data integrity on page 123

Enterprise models and analysis on page 123

Enterprise database schema on page 123

Advantages of an enterprise system

If you have large models and/or multiple SynerGEE users, an enterprise database system could have
significant advantages, including the following:

Consistency. Because all users are working from the same set of models, all users are looking at the
same data. The chance of two or more versions of the same model being used is greatly reduced.

Data security. When your models are managed by a central enterprise system, they are not subject
to the inadvertent corruption or misplacement that can occur when individual users maintain their
own files. And, since the models normally reside on a network server, they are naturally included in
any network backup systems that your company may have in place.

Better workflow. The SynerGEE enterprise manager only allows one user to work on any given
feeder at a time. Therefore, you do not need to worry about redundancy and inconsistency that can
result when two people are working on the same system at once.

Management of large models. If you have large models with hundreds of feeders, a personal
database may be simply too unwieldy to manage. An enterprise system allows you to work with just
the feeders you need, which minimizes the amount of actual data that you must handle at any given
time.

When you use an enterprise database system, you can still enjoy the traditional flexibility of data
management offered by SynerGEE. Once you check out feeders, the data is in your PCs memory and you
can use it with any SynerGEE data management tool. For example, you can create a new enterprise model,
or you can create a personal data source from it so that you have a backup or a working copy. You can use it
for any sort of data comparison, model merging, or version work. Or, you can use any of SynerGEEs import
and export functions, including XML, subset, and MiddleLink features.

Setting up an enterprise database system

The following steps illustrate the general process of establishing the enterprise database and models. This
process will not apply if your system is already established and you are only connecting as a user.

SynerGEE Electric 5.0

User Guide

116

Managing SynerGEE Data

1

Set up your enterprise database table space and user permissions. IT personnel generally handle
this process.

Install the appropriate client application on your PC to communicate with the database. Again, IT
personnel can assist with this step.

In SynerGEE, create at least one enterprise model to contain your data. Generally, the number of
models you can maintain in an enterprise environment is only limited by your available disk space.
While creating the model, you will also be ensuring that your connection to the enterprise database
is working. For more information, see Creating a new model in an enterprise database on
page 119.

In SynerGEE, create a DSA to the model. For more information, see Creating enterprise model
DSAs on page 116.

In SynerGEE, save your data to the model with the DSA. If this is a new model, you must first load
the data from somewhere else, such as a local model file. For more information, see Loading and
saving feeders in an enterprise system on page 119.

After this, your model data is saved in the enterprise database system, and the model is ready for multipleuser use.

Using an enterprise system

To use an enterprise database system, you must first set up your connection to the enterprise database
where your models reside, using a DSA. The DSA must reflect the data format, such as Oracle or SQL
Server, and the particular model involved. After your DSA is established, you can begin normal enterprise
database functions, including feeder loading and saving and database management.
To create a new enterprise model, you must do so manually before you can save any feeders to it. This
requirement is different from local files, which can be created on-the-fly during a save action, if they do not
already exist.
When you save to an enterprise database, like any model data save, you can save all feeders or just selected
feeders. If you are moving model data from a local file into an enterprise database model, you must first load
it into SynerGEE from the local file and then save it to a new enterprise model. For example, if you have a
local Access file that you want transferred to Oracle, you should load the data from Access with SynerGEE
and then save it to the Oracle model.
Refer to the topics listed below for more information.

Creating enterprise model DSAs on page 116

Creating a new model in an enterprise database on page 119

Loading and saving feeders in an enterprise system on page 119

Deleting feeders and models in the enterprise database on page 121

Creating enterprise model DSAs

To connect to your server database and access a model, SynerGEE uses settings within a DSA. These
settings include information such as the provider type, server name, and user identification.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

117

Remember that before you can make a connection, the database tables must be set up properly and you
must have the appropriate database client application on your PC. Your database administrator or IT
representative can help with client installation. If you are a database administrator, see Note to database
administrators regarding Enterprise databases on page 123.
When creating a DSA to an enterprise database, note the following:

A DSA points to a specific model within an enterprise database system. Therefore, you must be
sure to pick the appropriate model during DSA creation. If the model does not exist yet, you can
create it within the DSA wizard. Or, you can create it with the DBMS model manager before starting
DSA creation. For more information, see Creating a new model in an enterprise database on
page 119.

Be sure to enter server information correctly. An IT representative may be able to assist with server
naming and user permissions.

The Test Connection button in the DSA wizard is a good means of testing for a solid connection.

The feeders themselves are not relevant to the DSA, only the model. The particular feeders are
chosen during load and save actions.

For an overview of DSAs, see Data Source Aliases (DSAs) on page 75. For specific steps on creating a
DSA, see Editing a DSA on page 77.
Refer to the topics listed below for more information.

Oracle connections for Enterprise databases on page 117

SQL Server connections for Enterprise databases on page 118

Oracle connections for Enterprise databases

When connecting to Oracle, you are connecting to a table space with access to certain tables, based on your
login profile as set by a database administrator. Within the contexts of SynerGEE DSAs, you do not
necessarily need to be concerned with selecting a database, because the specified server name essentially
represents the only database. Once connected, the particular model should be the only concern.

Edit Data Source wizard, showing connection information to an Oracle table space

SynerGEE Electric 5.0

User Guide

118

Managing SynerGEE Data

SQL Server connections for Enterprise databases

Unlike Oracle, SQL Server does have the concept of different databases, and if you are an SQL Server user,
this concept may or may not affect you. Like a master Oracle database, each individual SQL Server database
can contain any number of SynerGEE models. If you keep all your models in a single database, the particular
database should not be of concern. Your database administrator can set up your SynerGEE model database
as your default database, to which you automatically connect when you access SQL Server through
SynerGEE. However, if you store data in multiple databases, you may need to specify a database name
during connection.
If you do not have multiple SQL Server databases, the connection parameters are basic, identical to those
described in Oracle connections for Enterprise databases on page 117. When you connect, you will
automatically connect to your default database, as established by a database administrator. However, if you
need to connect directly to a specific database, you can add the database name to the server name,
separated by a semicolon. For example:

Connecting to a specific SQL Server database

Also, if your SQL Server setup supports Windows Authentication, you can leave the User Name and
Password blank, whether or not you have specified a particular database. For example:

Using Windows Authentication to connect to SQL Server

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

119

Windows Authentication uses your Windows login information to connect, and must be set up at the database
level by a database administrator.

Creating a new model in an enterprise database

An enterprise database can contain any number of models, and a model must exist previously before you can
save data to it. SynerGEE cannot generate the model automatically during a save action, as it can do with
local files like Access databases.
There are two ways to create a new model:
1

During DSA creation

In the DBMS model manager

Once a model is created, you can save data to it, and all users can begin to check feeders in and out. Refer
to the following procedures for more information.

TO CREATE A NEW ENTERPRISE MODEL WITH THE EDIT DATA SOURCE WIZARD
Follow the directions provided in Creating DSAs on page 79 and Editing a DSA on page 77 to create or
edit an enterprise database DSA. On the fourth page of the wizard, type the name of the new model and then
click the Create New Model button to create and reserve the model name within the assigned table space.
The new model will be added to the list of models that are provided on this page.

TO CREATE A NEW ENTERPRISE MODEL WITH THE DBMS MODEL MANAGER

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Tools group, click DBMS Model Manager.

Use the DBMS Login editor to enter the required connection information, and then click OK.

In the Model to Manage wizard, select the Create option. Type a Model ID and Description, and
then click the Create button.

Loading and saving feeders in an enterprise system

You can load feeders from the enterprise database at any time. You can also save feeders back to the
original model if they are locked under your lock ID. If you do not have them locked, you can still save them
back, provided that you create a new enterprise model, or you manually reset the locks in your name. For
more information on locks and lock IDs, see Feeder locks and lock IDs on page 121.
Always remain aware of the type of data you are managing with an enterprise database. For example, if your
database contains model data only, you will need to load your equipment (and most likely protection) data
from a personal data source before running any analyses.
Due to database resource issues, SynerGEE limits load and save operations to 300 feeders or less. Also,
you must have at least one feeder or subtransformer source in the model to save it to an enterprise database.
You cannot save a model that is completely unfed.
Use caution when renaming or moving feeder sources in an enterprise model. A feeder source is an integral
data item within a model dataset, referenced in many other places. Altering a feeder ID and/or location can
cause conflicts when data is saved back to the enterprise database. Unlike with personal data sources,

SynerGEE Electric 5.0

User Guide

120

Managing SynerGEE Data

SynerGEE is unable to scan an entire enterprise model prior to a save, and thus cannot fix data issues
resulting from fundamental feeder changes. In most cases, conflict issues from feeder source alterations will
prevent you from saving that feeder back to the enterprise database altogether. If this occurs and you are in a
hurry to save your feeders, remember that you can always save the current feeders to a personal data source
and take the time later to resolve the conflict issues.
Refer to the following procedures for more information.

To load feeders from an enterprise database model on page 120

To save feeders back to an existing model on page 120

TO LOAD FEEDERS FROM AN ENTERPRISE DATABASE MODEL

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Load.

In the Load Feeders/Stations wizard, follow the instructions in the wizard to load the desired
feeders, noting the following:
-

If you want to save the feeders back later, be sure to set the wizard to lock them in your
name. This will appear as an option in the feeder selection page. For more information on
locks, see Feeder locks and lock IDs on page 121.

Following the load, the feeders may be unselected and thus do not appear on the screen. If
so, you can select them and do work as usual. For more information on selecting feeders,
see Selecting Feeders on page 157.

Remember that once the feeders are in memory, you can save them to a local file if you
want a backup or a working copy.

TO SAVE FEEDERS BACK TO AN EXISTING MODEL

As with any model data save, you have the choice whether to save all feeders or just selected feeders.
Saving selected feeders will delete all other feeders from of the target. Therefore, you should use extreme
caution when saving only selected feeders back to an enterprise model. If you are not careful, you could
potentially lose a significant amount of data.
1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Save.

In the Save Model wizard, select a model from the list and follow the instructions in the wizard,
noting the following:

User Guide

In the enterprise database, you must have feeders locked in your name to save back to
them. If you did not lock them when you loaded them, you can still set the lock manually
and redo the save later. Click Cancel to exit the wizard and see Feeder locks and lock IDs
on page 121.

If you save a feeder that does not currently exist in the model, it will be added.

Any unfed sections in memory are assigned to a feeder based on a topology trace and
proximity.

SynerGEE Electric 5.0

Managing SynerGEE Data

121

Deleting feeders and models in the enterprise database

You can delete any feeder or whole model within the enterprise database system. Refer to the following
procedures for more information.

To delete feeders from an enterprise model on page 121

To delete an entire enterprise model on page 121

TO DELETE FEEDERS FROM AN ENTERPRISE MODEL

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Tools group, click DBMS Model Manager.

Use the DBMS Login editor to enter the required connection information, and then click OK.

In the Model to Manage wizard, select Manage Feeders.

Select the model that you want to delete feeders from and then click Next.

On the next page of the wizard, select the feeders that you want to delete from the list of available
choices and then click Delete.

TO DELETE AN ENTIRE ENTERPRISE MODEL

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Tools group, click DBMS Model Manager.

Use the DBMS Login editor to enter the required connection information, and then click OK.

In the Model to Manage wizard, select Delete.

Select the model that you want to delete from the list of available models and then click Delete.

Feeder locks and lock IDs

When you load feeders from an enterprise database, you have the option of locking those feeders with your
personal lock ID (which is set in the User tab of the Preferences editor). This lock, with your personal lock ID,
is required if you want to save the feeders back later. No other user can save data to feeders that you have
locked, and you cannot save data to a feeder that is unlocked.
This feature is designed to prevent two users from making different changes to the same facilities and then
saving back to the same server. When you do save feeders back to the enterprise database, you have the
option of removing or keeping the lock.
This locking system is not intended to be a rigid security feature that enforces usage rules. Instead, it is
designed as a general measure to prevent data errors. If necessary, locks can be easily reset or removed
manually through SynerGEEs enterprise management tools. For example, if you load feeders without locking
them and still want to save them back later, you can use the tools to simply add your lock to those feeders
and then save them as normal. Or, consider the case where another user loads and locks feeders but does
not save them back, and then goes on vacation. If you must save data to those feeders, you can manually
remove those locks and proceed with your work.

SynerGEE Electric 5.0

User Guide

122

Managing SynerGEE Data

If used as intended, the locking system should serve as an overall safety net that helps prevent data conflicts
in a multiple-user environment. For more information on setting and resetting locks manually, see the
following procedure. For more information on setting your lock ID, see Setting database preferences on
page 167.
Generally, it is preferable that you allow locking and unlocking to take place during loading and saving
actions. However, tools are provided for cases where you must manually apply or remove locks, if required.
Refer to the following procedure for more information.

TO LOCK OR UNLOCK ENTERPRISE MODEL FEEDERS

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Tools group, click DBMS Model Manager.

Use the DBMS Login editor to enter the required connection information, and then click OK.

In the wizard, select Manage Feeders.

In the Model to Manage wizard, select the model that contains the feeders to be locked or unlocked.

Click Next.

On the next page of the wizard, select the feeders to be locked or unlocked from the list of available
choices.

Click Lock to lock the feeders with your lock ID.

or
Click Unlock to clear any existing lock, regardless of who created the lock originally.

Model locks for Enterprise databases

In addition to the concept of feeder locks, as described in Feeder locks and lock IDs on page 121, the
SynerGEE database manager also temporarily locks a whole model while feeders are being loaded or saved.
This feature helps prevent data corruption during a save action, because the conflicts between two users,
especially with regards to switching changes, could be severe. When the feeder load or save is complete, this
temporary lock is automatically removed.
If you attempt to load feeders from a locked model, you may have the option to continue with the load
anyway. You should choose this option only if you are sure that no one is currently saving data to those
feeders.
If the save action is interrupted before it completes, perhaps due to a power outage, network failure, or
SynerGEE abort, the model lock will not be removed and the model will be rendered inaccessible to any user.
If this occurs, you can manually remove a whole-model lock in the DSA manager. For more information on
producing the DSA manager, see Editing a DSA on page 77.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

123

Note to database administrators regarding Enterprise

databases
A SynerGEE enterprise database system first requires an administrator to perform preliminary steps to
prepare the database. Users may also need client software installed and configured on their workstation PCs.
If you are using Oracle, the following general steps are recommended:
1

Prepare the table space.

Create a user account to own the data, with Connect and Resources roles.

Ensure that users have Oracle installed with the OLE/DB driver.

Additional steps may be required, depending on your system and organizational protocol. For more
information on preparing the database, contact GL Noble Denton Technical Support.

Word of caution regarding enterprise databases and

data integrity
Alterations to model data, especially switching actions, can cause significant changes to a distribution model.
When you alter the topological path of electricity, you may alter the perceived feeder ownership of sections,
and thus alter the foundations of how SynerGEE categorizes and stores data. SynerGEE has a number of
safeguards in place to help prevent data corruption and anomalies which can occur in a multiple-user
environment, but none are 100% effective. Because SynerGEE cannot anticipate the actions of any user on a
dynamic and flexible distribution model, it is incumbent on all users to remain vigilant of their actions,
especially in respect to other users and the data repository itself. Before performing switching actions and
saving data back, take a look at the changes that may have occurred and try to gauge what impact it might
have on your data integrity.

Enterprise models and analysis

When you have feeders loaded into memory from an enterprise database, you can run any SynerGEE
analysis as normal, provided that you have also loaded equipment data and perhaps protection data from
some data source. In some cases, you may notice slight differences in analysis results between feeders
retrieved from an enterprise database and the same feeders from a local data source. These differences are
due to the different standards of rounding numbers between different database packages, such as Access
versus Oracle. Any differences that do occur should be very small and inconsequential.

Enterprise database schema

The enterprise database schema is very similar to the Access personal database schema, except that each
table name is preceded by the model ID. For example, if your model ID is MyModel, the section table in the
enterprise model would be MyModel_InstSection. There are also some slight differences at the field level
between the personal and enterprise database schemas.
The model ID is specified when the model is created. For more information on creating a model within an
enterprise database, see Creating a new model in an enterprise database on page 119.

SynerGEE Electric 5.0

User Guide

124

Managing SynerGEE Data

TO VIEW THE ENTERPRISE DATABASE SCHEMA

1

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, click Schemas > Model > DBMS.

TO VIEW THE ENTERPRISE DATABASE INDICES

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Tools group, click DBMS Model Manager.

Use the DBMS Login editor to enter the required connection information, and then click OK.

In the Model to Manage wizard, select the Create option. Type a Model ID and Description, and
then select the Generate SQL report, do not create tables check box.

Click the Create button. Because you selected the Generate SQL report, do not create tables
option, SynerGEE will generate a report that lists the queries that are used to create tables in a
report. This report will include the required indices for the enterprise database schema.

IMPORTING REAL-TIME DATA

Semi real-time data can be brought into the simulation environment using Messaging scripts. This data
typically comes from database systems or data warehouses tied to real-time data hubs. In the SynerGEE
environment, the information can affect switch status, metered demands, load values and more.
Refer to the topics listed below for more information.

PI Historian on page 124

DBMS Real-Time Data on page 127

Automating messaging scripts on page 129

PI Historian
Messaging scripts are used to connect to a PI Historian database through a PI OleDb driver configured on
the current machine. Once connected to the database, SynerGEE retrieves values for the tags specified in
the script. The values are then associated with parameters for various facilities within the SynerGEE model.
The script can also be configured to have SynerGEE write calculated values into the historian. This results in
tags with calculated values or virtual SCADA points.
Refer to the topics listed below for more information.

PI Messaging script on page 125

Tag value report on page 126

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

125

PI Messaging script
A Messaging script is used to specify connection information as well as the desired relationships between
tags in the PI system and parameters within SynerGEE facilities. The 15205 record is used to connect to a PI
Historian data source through ADO.
15205, Server, Username, Password

Note that the PI OleDB component must be installed.

The status of the connection can be checked with a 15206 record. Testing the connection is recommended
but the 15206 record should not be a part of the final working script.
Tags from the PI system are mapped to SynerGEE facilities with the following records:
Script Record Number

Description

15210

Capacitor on / off

15215

Switch open / closed

15220

Metered kW

15221

Metered amps

15222

Metered kvar

15223

Metered pf

15225

Recloser open / closed

15230

Breaker open / closed

15240

Substation LTC tap value

15241

Regulator tap value

15242

Feeder volts

15243

Feeder kV

15250

Volts > Tag

Records 15220, 15221, 15222, 15223, and 15242 are equipped with an optional multiplication factor. This
allows you to scale the value between the PI Historian and SynerGEE.
The 15207 record generates a validation report for all tags in the script file. If this record is used, SynerGEE
will not read data from the PI system. It will only validate the tags.
The following is an example of a working script:
' ***** Start of code sample
'Log into the Pi server
15205,localhost,piadmin,
'Indicate connection succeeded
15206

SynerGEE Electric 5.0

User Guide

126

Managing SynerGEE Data

'Retrieve 3Ph kW demands for meters

15220,79520,7,MT-001
15220,79521,7,MT-002
'Get switch open / closed status
15215,22630,SW-011
15215,79530,SW-012
15215,33564,SW-021
'Get capacitor on/off status
15210,Dkn_00053,CAP-001
15210,53515,CAP-002
'Connect the model
15002
'Run load allocation
15003,alloc
'Write voltage
15250,52536,VOLT-001
'Refresh the map
15001
' ***** End of code sample

Notice that this script is writing calculated voltage values back into the PI Historian with the 15250 record.
The following script commands are general to all of SynerGEEs messaging platforms.

15001 Refresh SynerGEE map after retrieval

15002 Reconnect the model after switching

15003 Run an engineering analysis application and generate an analysis report.

15004 Post a message in a message box

These commands can be mixed into a messaging script to support user interaction.

Tag value report

SynerGEE generates a tag usage report when the 15202 record is used in your Messaging script. This report
lists tags, values, and related facilities that SynerGEE brings in from a PI system and applies to the model.
Running the script on an interval causes the report to update or reopen at each interaction with PI. Each time
the script is run, you can retrieve the most recent data from the tag usage report. For more information on
using scripts with a PI system, see PI Messaging script on page 125.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

127

DBMS Real-Time Data

SynerGEE uses a messaging script based interface for real-time data stored in a DBMS to update values for
meter kW and kvar, feeder voltage, and substation voltage. This real-time data functions much in the same
way as the PI Historian system and pulls its records from the same type of data hub.
The figure below charts a typical interface between SynerGEE and a DBMS. Because each utilitys database
system acts differently, the way SynerGEE interacts with a system will vary.

The DBMS messaging script works in three steps:

1

SynerGEE connects to the DBMS through a DSA.

SynerGEE presents prompts and reports when necessary.

SynerGEE matches tags in the tables that contain real time data to appropriate facilities.

Tags in the DBMS are mapped to SynerGEE facilities with the following records:
Script Record Number

Description

15102

Connects DBMS to a DSA

15104

Retrieves values

15106

Prompts for the date and time

SynerGEE Electric 5.0

User Guide

128

Managing SynerGEE Data

Script Record Number

Description

15107

Prompts connection status

15108

Generates tag validation report

15114

Sets feeder voltage

15120

Sets metered kW

15122

Sets metered kvar

When the 15108 command is used, SynerGEE will issue a report that lists tags found in the database with the
latest read and read value, as well as limit violations. Tags in the DBMS are associated with the model using
records that are typically structured as follows:
FacilityID, Phase, TagID, Min, Max, Multiplier

The Min and Max values are used to check for violations against the unmultiplied value. The multiplied value
is applied to the model.
The 15104 command retrieves values from the DBMS. The query must contain these columns:

SynDate The field holding the tag that SynerGEE will use to associate the date and time.

SynValue The field holding the tag that SynerGEE will use to associate sections.

SynTag The field holding value that SynerGEE will use to set up the model.

The query can return other fields; however, these must be a subset of these fields.
Below is a sample working model of the script:
**Specify DSA holding the real-time reads
15102,My SCADA
**Query to gather the reads. The query must have these fields in its return
** SynTag -- Field holding the tag that SynerGEE will use to associate
sections
** SynValue -- Field holding value that SynerGEE will use to set up the
model
**
**
15104,select timeline.DateTimeLocal as SynDate, param.name as SynTag,
timeline.value as SynValue from timeline, param, device where
timeline.paramid = param.id and timeline.deviceid = device.id and
device.Active = true order by timeline.DateTimeLocal desc;
**Put up prompt for connection status
15107
**Tag validation report
15108
**Prompt for date/time

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

129

15106
**Metered kW values
** Section ID, phase, tag, multiplier
15120,79520,5,EJT42010.KWTOT,2e2,2e4,1.0
15122,79520,5,EJT42010.KVARTOT,-5e3,5e4,1.0
15120,79521,5,OXD42010.KWTOT,2e2,2e4,1.0
15122,79521,5,OXD42010.KVARTOT,2e2,2e4,1.0
**Metered kV values
**Source ID, phase, tag, multiplier 13.8 -> 120
15114,Ship sub 1,4,OAP42010.VPROM,11e3,15e3,0.00869565
15114,Ship sub 2,4,SFo42015.VPROM,11e3,15e3,0.00869565

Messaging scripts can be run at any time from the MACROS tab of the SynerGEE ribbon bar. SynerGEE can
also be configured to run a Messaging script on a scheduled basis. For more information, see Automating
messaging scripts on page 129.

Automating messaging scripts

Messaging scripts can be run at any time from the MACROS tab of the SynerGEE ribbon bar. SynerGEE can
also be configured to run a Messaging script on a scheduled basis.
Once the interval option is selected and the script is running, the Run button becomes a Stop button. Click
the Stop button to cease running the script.

TO RUN AN AUTOMATED MESSAGING SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Other Scripts group, next to Type, select Messaging. A list of all current scripts will appear in
the Script options list.

Next to Scripts, select the name of the script that you want to run.

Select the check box next to Intervals and then enter the time lapse in seconds for the script run.

Click Run to start the script.

Click Stop to end the running of the script.

GALLERY
The SynerGEE gallery is a repository where you can store frequently used models. Any currently loaded
model can be saved to the gallery. When you load a model from the gallery, it will replace all model data that
is currently in memory no merging of model data will take place. After you load a model from the gallery,
you can save it back to the gallery or save it to any supported SynerGEE format, just like you would save a
regular SynerGEE model.

SynerGEE Electric 5.0

User Guide

130

Managing SynerGEE Data

Models in the gallery are stored in binary EDM format in the Gallery subfolder of your SynerGEE documents
directory. Note that equipment data is also saved in the resulting EDM file, but you cannot reload it with the
gallery tools. If you want to load equipment data from a model stored in the gallery, you must manually create
an equipment DSA and use the normal equipment data loading tools. For more information, see To load
equipment data on page 65.
You may find the gallery useful for saving multiple versions of the same model, perhaps during the course of
making different modifications. For example, consider the case where you have several different ideas or
proposals to address an issue in your model, and you want to independently model each idea. You can use
the gallery to save multiple copies of the model and then work independently on each idea. The gallery may
provide a more convenient method to explore your proposed options than other SynerGEE features,
including standard model loading and even the version feature. When you are finished, you can save the final
design back to your original data source.
The Gallery Manager is used to save, load, and delete models from the SynerGEE gallery. Refer to the
procedures listed below for more information.

To save the current model to the gallery on page 130

To load a model from the gallery on page 130

To delete a gallery model on page 131

To rename a gallery model on page 131

TO SAVE THE CURRENT MODEL TO THE GALLERY

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Gallery and then select Save.

In the Gallery Save editor, under Model Save, type the name of the model as you want to save it in
the gallery.
or
In the list of gallery models, select the name of the gallery model that you want to replace.

Use the option buttons at the bottom of the editor to select whether you want to save All feeders/
subtrans to the gallery model, or only the Selected feeders/subtrans (that is, only those feeders
that are in the current selection set, as defined by the Select Feeders and Substation Transformers
editor).

Click Save.

TO LOAD A MODEL FROM THE GALLERY

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Gallery and then select Load.

In the Gallery Load editor, in the list of gallery models, select the name of the gallery model that you
want to load.

Click Load.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

131

TO DELETE A GALLERY MODEL

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Gallery and then select Manage.

In the Gallery Manager, in the list of gallery models, select the name of the gallery model that you
want to delete, and then click Delete.
or
Click Delete All to delete all models from the gallery.

Click Close to close the Gallery Manager.

TO RENAME A GALLERY MODEL

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Gallery and then select Manage.

In the Gallery Manager, in the list of gallery models, select the name of the gallery model that you
want to rename, and then click Rename.

In the Rename Gallery Model editor, type the new name for the gallery model and then click OK.

Click Close to close the Gallery Manager.

BACKING UP SYNERGEE DATA

SynerGEEs file backup feature can help prevent extensive data loss in the event of an unexpected system
shutdown. You should note that this is not an auto-save feature SynerGEE does not modify your source
files through the backup feature. Instead, a binary backup file named SynBackup.edm is created in your
SynerGEE documents directory. Each new backup overwrites the previous one.
Since backups are saved in a binary file format, they generally save very quickly. You can manually save
backup files from the MODEL tab in the SynerGEE ribbon bar, or you can configure SynerGEEs preferences
to automatically back up your SynerGEE data at a user-defined interval. Backup files can be restored from
the MODEL tab of the SynerGEE ribbon bar.
You are encouraged to use the automatic backup feature. The default backup interval is set to 60 minutes,
but you may want to consider backing up your files on a more frequent basis, either manually or
automatically.
Refer to the procedures listed below for more information on backing up and restoring your model data.

To configure automatic backups on page 131

To manually back up your SynerGEE data on page 132

To restore data from the SynerGEE backup file on page 132

TO CONFIGURE AUTOMATIC BACKUPS

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the Backup tab.

SynerGEE Electric 5.0

User Guide

132

Managing SynerGEE Data

3

Click Enable Backup to enable SynerGEEs automatic backup feature. You can also configure the
backup interval (the default value is 60 minutes) and specify whether SynerGEE will prompt you
before backing up your files.

Click OK to accept your changes and close the editor.

TO MANUALLY BACK UP YOUR SYNERGEE DATA

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Backup and then select Save.

TO RESTORE DATA FROM THE SYNERGEE BACKUP FILE

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Backup and then select Load. Click Yes to confirm the action. The
recovered data will replace the model that is currently in memory.

WORKING DIRECTLY WITH DATABASE FILES

SynerGEE includes several tools that you can use to view and edit table directly from the source file. These
include the following:

Data Source editor. The Data Source editor is a native database editor that you launch from within
SynerGEE. It allows you to directly view and edit the tables and fields of any model, equipment, or
customer database. All edits are saved directly to the source file on your network, just like if you
were working in a dedicated database application such as Access.

Joiner. The joiner is a special database table editor that allows you to match external data with
current memory data, using section ID associations. The joiner does not edit model data in memory.
It is a viewer/editor for external database tables, which can contain any type of data, provided that
they have a SectionId column.

Refer to the topics listed below for more information.

Data Source Editor on page 132

Joiner on page 133

Data Source Editor

The Data Source editor is a native database editor that you launch from within SynerGEE. It allows you to
directly view and edit the tables and fields of any model, equipment, or customer database. All edits are
saved directly to the source file on your network, just like if you were working in a dedicated database
application such as Access.
The Data Source editor provides only limited control over data and is not intended to replace a dedicated
database application such as Access. For complex data management directly with source files, you should
use the application designed for that purpose.
Note that the Data Source editor only applies to source files in a database format. For example, you cannot
edit a binary model file with the Data Source editor. Also, a source file must be configured as a DSA in order

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

133

for SynerGEE to recognize it in the Data Source editor. For more information on working with DSAs, see
Data Source Aliases (DSAs) on page 75.
You should also note that individual DSAs, and even all DSAs, can be locked out from editing via the Data
Source editor. You can still view data from the data source file, and you will be able to edit the data elsewhere
in SynerGEE, but you will not be able to edit the data by specifically using the Data Source editor. To lock out
an individual DSA from editing, select the Source is read-only check box on the first page of the Edit Data
Source wizard. To lock out all DSAs from editing, select the Read-Only Data Source Editor option in the
Feature Locks tab of the Preferences editor.

TO EDIT A DATA SOURCE USING THE DATA SOURCE EDITOR

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Sources group, click Data Source Editor.

In the Database Editor window, click Data Sources.

Use the Select Data Source editor to select the Source Type for the database that you want to view
(Model, Equipment, and Customer) and also to select a Source, which corresponds to a DSA that
has been configured for use with SynerGEE. Only DSAs for the selected Source Type will be made
available for selection.

Click OK to accept your selections and close the Select Data Source editor.

Use the Database Editor window to edit the data source as required. As is common with database
applications, all edits you make in the Data Source editor are automatically written to the source file,
as soon as you move to another record. There is no undo. When you are finished, simply close the
Database Editor window to end the editing session.

Joiner
The joiner is a special database table editor that allows you to match external data with current memory data,
using section ID associations. The joiner does not edit model data in memory. It is a viewer/editor for external
database tables, which can contain any type of data, provided that they have a SectionId column.
To use the joiner, the following requirements must be met:

The external database table you want to associate must have a SectionId column.

When you launch the joiner, you must have established a section query set that matches the set of
model data you want to associate.

The external data must be in a supported format, such as Access, Oracle, or SQL Server.

When the joiner runs, it looks for section IDs in the external database that match section IDs in the current
query set. For any records that match, the entire external record is displayed in SynerGEE for viewing and
editing.
The joiner is different from other database editors because it allows you to access data that has a specific
relationship to your model. To clarify the role and usage of the joiner, you should review Steps for using the
joiner on page 134.
Refer to the topics listed below for more information.

Steps for using the joiner on page 134

SynerGEE Electric 5.0

User Guide

134

Managing SynerGEE Data

Joiner data sources and DSAs on page 134

Steps for using the joiner

The following steps illustrate the general procedure for using the joiner.
1

Determine and locate the external database table you wish to edit.

Ensure that the database table has a SectionId column.

In SynerGEE, create a DSA to the external database table.

In SynerGEE, create a query set that represents the section IDs you want to match with the external
data.

Perform the following steps to launch the joiner:

In the SynerGEE ribbon bar, select the FORGE tab.

In the Database group, click Joiner.

Click Join.

When the joiner runs, it brings in all records whose SectionId field matches a section ID in the query
set. You can view and edit this data as needed.

Joiner data sources and DSAs

To join with an external database table, the table must have a SectionId column. This name is not casesensitive. For example, SectionID is acceptable.
To access the external table from the joiner, you must also have a DSA to it. When creating a DSA for the
joiner, note the following:

The joiner can join with any database format that SynerGEE supports, including Access, Oracle,
and SQL Server. Therefore, the DSA must accurately represent the source file format.

On the second page of the Edit Data Source wizard, you must specify a path to the database that
contains the desired table.

On the third page of the Edit Data Source wizard, you must select Custom as the data type and
then type the name of the specific table in the Table field. This table name must be spelled correctly,
although case is not important.

For additional information on working with DSAs, see Data Source Aliases (DSAs) on page 75.

CHECKING AND REPAIRING DATABASE SCHEMAS

Beginning with version 3.6, SynerGEE no longer performs field-level updates to schemas when you save
data to a previous version database. Therefore, if you load an older model into the current version of
SynerGEE and then attempt to save data back to the same database, you may lose data associated with the
current version.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

135

To prevent this type of data loss, you should run SynerGEEs check/repair schema function to update older
databases before saving data back to them. Check/repair schema performs a complete schema update,
ensuring that the database is prepared to receive all applicable data. The check/repair schema can be run on
both model data and equipment data.
It should be noted that all new databases created by SynerGEE have the latest schema, regardless of where
the data was originally imported from. Therefore, check/repair schema does not apply to new databases.

TO CHECK AND REPAIR A DATABASE SCHEMA

1

In the SynerGEE ribbon bar, select the MODEL tab.

To check and repair a database schema: In the Model group, click Check Schema.
or
To check and repair an equipment schema: In the Warehouse group, click Check Schema.

On the first page of the Check and Repair Schema wizard, select the data source that you want to
check and repair. Click Next to continue.
Tips:

Click the Go To button to edit the selected DSA using the Edit Data Source wizard.

Go To button

Click the Browse button to directly select a SynerGEE model file without using a DSA.

Browse button

On the second page of the wizard, select the check boxes for each data correction category that you
want to check and repair. Only selected categories will be checked and repaired, as required.
The following data correction categories are available:
-

Add missing tables

Add missing fields

Add missing table indices

Set capacity factor (in Loads table) to 1.0 if it is 0.0

Set project load multiplier to 1.0 if it is 0.0 or NULL

Set multi-ground neutral on sections where value is NULL

Set switch withstand rating equal to the current rating

Set missing winter ratings equal to summer ratings

Set exposure factors to 1.0 if they are 0.0

Set nominal voltage multipliers to 1.0

Update feeder ties on switch records

Clean up orphan nodes

SynerGEE Electric 5.0

User Guide

136

Managing SynerGEE Data

5

Click Finish. SynerGEE will display a second editor showing the results of its findings. Click
Commit to commit the changes to the data source, or click Cancel to abort the repair.

VIEWING SESSION DATA

The Session viewer provides key information about the currently loaded model and warehouse. In addition to
the names of the model database and the warehouse database, the Session viewer shows the number of
devices of each type that are currently in the model, as well as the number of device types that are currently
available in the warehouse. Refer to the following procedure for more information.

TO VIEW SESSION DATA

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Model group, click Session.

EDITING DEFAULT VALUES FOR SYNERGEE DEVICES

The Defaults file is an XML file, named SynDefaults.xml, that provides SynerGEE with default values for a
number of devices, including facilities, sections, and feeders. SynerGEE will automatically apply the default
values from this file in the following circumstances:

When external data is imported, such as from a MiddleLink data source.

When new sections are modeled that are not connected to existing sections.

When new equipment is modeled that is created from a general equipment type in the equipment
warehouse (including breakers, fuses, motors, reclosers, and sectionalizers)

You can edit the default values directly from SynerGEE, using the MODEL tab of the SynerGEE ribbon bar.
Click on the Defaults button to open a list of the devices that you can edit. Then, click on any device name to
open a special version of the standard SynerGEE editor for that device. You can then proceed to edit the
default values for that device. If a field is disabled, such as the X and Y coordinates for a feeder, that values
is not a default that can be saved. Any other field, however, can be edited, and the changes will be saved the
next time you exit SynerGEE.

TO EDIT DEFAULT VALUES FOR SYNERGEE DEVICES

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Edit group, click Defaults and then select the name of the device that you want to edit.

Use the SynerGEE editor to edit default values for any option that is enabled. For descriptions of the
individual fields, press F1 to open the Online Help topic for the device and editor tab that you are
viewing. If an option is disabled, then it is not a default that can be saved to the SynDefaults.xml file.
Note that any changes you make will not be saved to the SynDefaults.xml file until after you exit
SynerGEE.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

137

VALIDATING AND CLEANING UP MODEL DATA

SynerGEE has several tools to help you manage the integrity of your data. Each of these tools has a
particular focus, and you should understand the differences between them before selecting one for use.
Some tools may overlap in functionality, but each is different and has its own intended purpose. Some tools
are intended for reporting only, while others have the ability to correct data problems as they are found.

Check data report. The check data report evaluates your model data and reports on any
discrepancies found. The analysis of your data is comprehensive and can provide valuable
information on the quality of your data. The check data report evaluates all model data in memory
and uses a non-customizable rule base. For more information, see Check Data report on
page 137.

Model cleanup scripts. Model cleanup scripts can be written to correct specific data issues. Cleanup
scripts follow the MiddleLink format. For more information, see Model cleanup scripts on page 138.

Model Inspector. The Model Inspector is a collection of reports that are designed to find problems
demonstrated by the model or with model data. For more information, see Model Inspector on
page 139.

Refer to the topics listed below for more information.

Check Data report on page 137

Model cleanup scripts on page 138

Model Inspector on page 139

Check Data report

The Check Data report presents the findings of a full evaluation of the model data in memory. This evaluation
is very comprehensive and includes checks for topological errors and data mismatches. You can filter the
Check Data report by problem category, so that you can quickly find items with a higher severity. If you know
that model data problems exist, the Check Data report may be the best option for initial troubleshooting.
The problems that are presented in the Check Data report are divided into the following categories:

Errors. Errors are problems that are severe enough to prevent certain analyses from running.

Warnings. Warnings are problems that may affect the accuracy of analyses, but probably will not
prohibit you from performing an analysis.

Fixes. Fixes are temporary fixes that SynerGEE would assign if an analysis were run with the model
in its current condition. These fixes are for reference use only. They are not actually applied to the
model in memory or on disk during the check data process.

Messages. Messages provide information that you should be aware of, but will not necessarily affect
the accuracy of analyses.

Refer to the following procedure for information on viewing the Check Data report.

SynerGEE Electric 5.0

User Guide

138

Managing SynerGEE Data

TO VIEW THE CHECK DATA REPORT

1

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Worksheets group, click Digest.

On the left side of the Digest window, select Check Data.

Use the subheadings on the left side of the Digest window to select from the following subreports:

Totals

Problems

Missing Warehouse Items

Perform any of the following tasks to further work with the data in the report.
To ...

Do This ...

Filter the Problems section

based on problem severity

View the Problems section of the Check Data report. On the right
side of the report, click Show: All and then select the specific
problem category that you want to view. When Show: All is
selected, all problem categories are displayed in the report.

Edit a device that is included

in the report

View the Problems section of the Check Data report and then
select the row that contains the device you want to edit. On the
right side of the report, click Edit.

Zoom to the location of a

device that is included in the
report

View the Problems section of the Check Data report and then
select the row that contains the device you want to view. On the
right side of the report, click Map Zoom.

Refresh the report

On the right side of the Check Data report, click Re-Run.

Model cleanup scripts

Model cleanup scripts can be written to find and fix model data problems. Following a model cleanup run, you
can either implement the actual cleanup results or simply produce a report of the recommendations. Model
cleanup is very flexible and can search and replace data on an individual field level, as well as perform global
repairs such as the removal of duplicate nodes.
A model cleanup script is a text file that follows the MiddleLink format. Model cleanup runs on the model data
in memory, on selected feeders only. Source files on disk are not affected unless you manually resave the
data afterwards.
Although model cleanup scripts use the MiddleLink format, you do not need a MiddleLink license to run the
application. The MiddleLink license pertains to the functionality specifically involved with model building and
partials importing, not model cleanup.
For more information on working with model cleanup scripts, see Model Cleanup Scripts on page 718.

User Guide

SynerGEE Electric 5.0

Managing SynerGEE Data

139

Model Inspector
The Model Inspector is a collection of reports that are designed to find problems demonstrated by the model
or with model data. The Model Inspector includes the reports listed below. Each report can be individually
enabled or disabled in the Reports tab of the Model Inspection Options editor. In addition, the asterisk ( * )
character in the report names below denotes a configurable value in the Settings tab of the Model Inspection
Options editor. The values shown in the report name below are the default values that are set up by the
SynerGEE installation.

Check for voltages < 115.0* v

Show sections with customers but no kW load

Show nodes that are 50* ft apart (one node fed and one unfed)

List unfed sections

List unenergized loads

List switches where switch rating < section conductor rating

Protective device coverage report

Report loading levels: 50* % < loading <= 100* %

List sections where the phasing specified on the section is different than the phasing that is
propagated through the section from the substation, feeders, and transformers.

Refer to the topics listed below for more information.

Setting up the Model Inspector on page 139

Running the Model Inspector on page 140

Setting up the Model Inspector

Perform the following procedure to select which reports you want to generate when running the Model
Inspector, and also to set up other options that are related to specific reports.

TO SET UP THE MODEL INSPECTOR

1

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Model QA group, click the text label Model Inspector and select Settings.

In the Model Inspection Options editor, select the Reports tab. Use the Reports tab to select which
reports you want to generate with the Model Inspector. The following reports are available. Note that
the asterisk ( * ) character in the report names below denotes a value that can be edited in the
Settings tab of the Model Inspection Options editor, as described in step 4 of this procedure. The
values shown in the report name below are the default values that are set up by the SynerGEE
installation.
-

Check for voltages < 115.0* v

Show sections with customers but no kW load

Show nodes that are 50* ft apart (one node fed and one unfed) *

SynerGEE Electric 5.0

User Guide

140

Managing SynerGEE Data

List unfed sections

List unenergized loads

List switches where switch rating < section conductor rating

Protective device coverage report

Report loading levels: 50* % < loading <= 100* %

Section specified phasing differs from propagated phasing

Select the Settings tab. Use the Settings tab to enter values that configure the data parameters for
specific Model Inspector reports. Refer to the following table for more information on these options.
Distance between
close nodes

Specify the distance between nodes that will be reported in the Show
nodes that are X ft. apart report. The default value is 50 feet.

Only identify fed/

unfed close nodes

Select this check box to only evaluate fed / unfed node combinations
in the Show nodes that are X ft apart report. In other words, if two
fed nodes are within X feet apart, they will not be reported; likewise, if
two unfed nodes are within X feet apart, they will also not be reported.
If this check box is cleared, then all nodes and all node combinations
will be considered.

Loading level range

Specify the loading level range that will be considered in the Report
loading levels report. The default range is 50% to 100%.

Low voltage threshold

Specify the low voltage value that will be evaluated in the Check for
voltages report. The default value is 115 v.

Click Apply to accept your changes, and then click X to close the editor.

Running the Model Inspector

Perform the following procedure to run the Model Inspector.

TO RUN THE MODEL INSPECTOR

1

Before you run the Model Inspector, make sure you have used the Model Inspection Options editor
to select which reports you want the Model Inspector to generate, and also to configure specific data
parameters that will be considered in the report, if desired. For more information, see Setting up the
Model Inspector on page 139.

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Model QA group, click the Model Inspector icon. Your results will appear in a new SynerGEE
tab.

User Guide

SynerGEE Electric 5.0

CHAPTER

3
Using SynerGEE
To successfully model and analyze your distribution system, you need to fully understand how to use
SynerGEE. SynerGEE is designed to be intuitive and user-friendly, and a thorough knowledge of its powerful
and convenient interface will significantly increase productivity. From little shortcuts to big time-savers, you
should take some time to learn about the features provided to optimize your SynerGEE usage.
Refer to the topics listed below for more information.

Understanding the SynerGEE Environment on page 142

Using the SynerGEE Editor on page 151

Loading Models on page 156

Selecting Feeders on page 157

Using Feeder Sets on page 161

Setting Preferences on page 162

Finding Model Data on page 171

Undoing and Redoing Model Edits on page 172

Tagging Sections and Facilities on page 172

Using the Query Set on page 173

Using the Multiple Editor on page 177

Printing on page 178

Rap Sheets on page 179

Organizer on page 183

Launching SynerGEE from the Command Line on page 184

Units in SynerGEE on page 185

Settings Groups and Settings Files on page 189

Using the Bulk Editor on page 192

Using the SynerGEE Maintenance Wizard on page 193

SynerGEE Electric 5.0

User Guide

142

Using SynerGEE

UNDERSTANDING THE SYNERGEE ENVIRONMENT

Refer to the topics listed below for more information.

SynerGEE windows on page 142

Model explorer on page 143

Ribbon bar on page 146

Quick access toolbar on page 146

Status bar on page 148

Function key shortcuts on page 149

Custom keyboard shortcuts on page 149

Context (right-click) menus on page 150

Editing data columns on page 150

SynerGEE windows
SynerGEE allows you to view the map, reports, and many other windows all at the same time. Some
windows, such as the map window and the Organizer, can only be opened once. Other windows can be
opened multiple times. For example, you can open multiple report windows to view different reports at the
same time. If you close the map window and all windows associated with the model, the model will be closed.
Take note that some tabs in the SynerGEE ribbon bar will change based on the window you are viewing. In
general, ribbon bar tabs that are window-specific are located at the right-end of the ribbon bar. The majority of
ribbon bar tabs are common to all window types, and those are at the left-end of the ribbon bar.

TO RENAME A WINDOW
In the tab for the SynerGEE window, double-click on the window name and then type a new name. Renamed
windows are a temporary change. If you close the window and then open it again, the original window name
will be restored.

TO CHANGE BETWEEN WINDOWS

Click on the tab names above the SynerGEE windows to view the open windows. If your mouse has side
buttons, you can click the side button to cycle through the open windows.

TO VIEW A WINDOW IN FULL SCREEN MODE

1

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, select Full Screen.

In full screen mode, the SynerGEE ribbon bar, model explorer, and all windows except the active
window are hidden from view. The Windows task bar is also hidden from view. You can use the
right-click menu, keyboard shortcuts, and mouse buttons to perform the same tasks you could
perform in the traditional SynerGEE view. However, any tasks that you can only access through the
ribbon bar, model explorer, or other hidden means will not be available.

User Guide

SynerGEE Electric 5.0

Using SynerGEE
3

143

To exit full screen mode, press Esc or click the Exit button.

Model explorer
The model explorer organizes your model data in a tabbed area to the left of the map display, providing you
with quick and easy access to the feeders, sections, and devices in your model. The model explorer also
provides access to your equipment warehouse and to the legend for your SynerGEE map display.
Refer to the topics listed below for more information on the different tabs that are included in the model
explorer.

Model tab on page 143

Warehouse tab on page 144

Facilities tab on page 144

Query tab on page 145

Feeders tab on page 145

Legend tab on page 145

Toolbox tab on page 145

Model tab
The Model tab in the SynerGEE model explorer provides access to all sections, nodes, and devices in the
model, including feeder and subtran sources. The upper half of the Model tab is a tree view that lists object
categories, such as Network, Facilities, and Zones. The lower half of the Model tab lists specific objects in the
selected category, plus pertinent information for each listed object. For example, switches include the
sections ID, open/closed status, and switch type. Regulators, meanwhile, lists the regulator status (on or off),
amp rating, and notes, if attached.
You can double-click any object name in the Model tab to open the editor for that object. You can also rightclick on the object name to open a context menu with a variety of editing and navigational options.
The following list includes the major categories that are included in the Model tab:

Network. The Network category includes lists of the feeders, nodes, sections, and subtrans in the
active feeders in your model.

Facilities. The Facilities category includes lists of all of the devices in the active feeders in your
model. If no devices of a particular type exist in the active feeders, then that device type will not be
listed in the Facilities category.

Locations/Groups. The Locations/Groups category includes lists of the labels, switch plans, and
TCC sets in the active feeders in your model.

Section Lists. The Sections Lists category includes lists of sections that share common properties,
such as contingency sections, sections with automatic switches, and sections with notes. Devices
with notes and devices with links are also included in the Section Lists category. If no sections exist
in the active feeders in the model that meet the criteria for a specific category, then that list will be
empty.

SynerGEE Electric 5.0

User Guide

144

Using SynerGEE

Facility Lists. The Facility List category includes lists of facilities with any exceptions or with loading
exceptions only. If no facilities exist in the active feeders in the model that meet the criteria for a
specific category, then that list will be empty.

Warehouse tab
The Warehouse tab in the SynerGEE model explorer is a tree view that lists all equipment types that are
available for modeling, according to the equipment data that is currently in memory. You can quickly add a
device anywhere on the model by dragging an equipment type from the Warehouse tab and dropping it onto
a section or to another appropriate area in the SynerGEE map display. You can also double-click on any
equipment type name to open the editor for that item.
You may notice that some equipment type categories, including fuses, reclosers, sectionalizers, breakers,
and protective devices, are listed in the Warehouse tab as General items. This is because these items are
defined entirely by instance data and do not reference a device type in the equipment dataset. Capacitors are
also defined entirely by instance data, although they appear to have types in the Warehouse tab. These
types are not actual equipment types, though, and have no corresponding record in the equipment dataset.
They are intended only as a more convenient way of modeling a certain size capacitor, without having to
enter kvar values following each drag and drop operation. Therefore, although they appear in the Warehouse
tab, capacitor types actually only represent pre-populated instance data.
For more information on modeling equipment in SynerGEE, see Modeling Devices on page 317.

Facilities tab
The Facilities tab in the SynerGEE model explorer lists various categories of facilities and devices in a
hierarchical view, organized by feeders and sections. The options list at the top of the tab can be used to
select the facility category that you want to view. The following categories are available:

Conductors

Devices

Fault Devices

Fused Taps

Loads > 100 kVA

Loads > 50 kVA

Phasing

Protective Devices

Switches

Once you select a category, you can expand and collapse the feeder and section names in the Facilities tab
to see all devices of the selected type. The right-click menu includes many options that you can use to work
with a device, including zooming or panning to its location in the map display, toggling its Query status, and
opening the device editor.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

145

Query tab
The Query tab in the SynerGEE model explorer provides access to the query set, which is a temporary group
of sections that you want to work with in SynerGEE. Multiple edits, for example, can only be performed on
sections or devices associated with the sections that are included in the query set. In addition, some
SynerGEE analyses can be run only on sections in the query set, including the fault analysis and the network
fault analysis.
For more information on the creating and using query sets, see Using the Query Set on page 173.

Feeders tab
The Feeders tab in the SynerGEE model explorer displays a topological tree view of any feeders that are
currently selected in the model as well as all of the sections that are associated with those feeders. The
sections in the Feeders tab are grouped in order starting with the feeder source and cascading downstream
throughout the feeder. Devices are not included in the Feeders tab.
You can double-click any object name in the Feeders tab to open the editor for that object. You can also rightclick on the object name to open a context menu with a variety of editing and navigational options.

Legend tab
The Legend tab in the SynerGEE model explorer displays a detailed legend for the SynerGEE map display.
The legend shows the current color and line options that are being used by the map, as well as the device
type symbols and the coordinates for the area that is currently visible in the SynerGEE map display. The
same legend you see in the Legend tab is included when you print the SynerGEE map display.
For more information on the SynerGEE map display legend, see Legend on page 231.

Toolbox tab
The Toolbox tab in the SynerGEE model explorer provides access to a several tools that allow you to focus
on specific aspects of your model and their effect on the model as a whole. The following tools are included in
the Toolbox tab:

Switch Manager. The Switch Manager allows you to see certain switch pairs in the selected feeders
as well as general information about the feeders, such as connected kVA, power factor, and low
volts. Using the Switch Manager, you can toggle the status of any switch pair and run a quick loadflow analysis to see the results. Only switches that can transfer load from one selected feeder to
another are listed. Therefore, you must have more than one feeder selected for the tool to have
value.
For more information, see Switch Manager on page 763.

Feeder Overview. The Feeder Overview provides a tree list that gives general, balanced information
about selected feeders, including minimum and maximum voltages, maximum loading, and some
basic equipment information. The Feeder Overview is designed to give you an overall view of your
feeders and provide quick access to some basic editing functions.
For more information, see Feeder Overview on page 764.

SynerGEE Electric 5.0

User Guide

146

Using SynerGEE

Capacitor Manager. The Capacitor Manager displays all capacitors in the selected feeders as well
as general information about the feeders, such as connected kVA, power factor, and low volts.
Using the Capacitor Manager, you can toggle the on/off status of any capacitor and run a quick loadflow analysis to see the results.
For more information, see Capacitor Manager on page 765.

Load Center Manager. The Load Center Manager allows you to pinpoint an area of your map and
determine the amount of load within that area. This is an excellent means to determine the
placement of a substation or feeder.
For more information, see Load Center Manager on page 765.

Ribbon bar
The ribbon bar, which runs along the top of the SynerGEE window, provides quick access to all of
SynerGEE's commands. The ribbon bar is a replacement for menu paths and toolbar buttons. Groups of
related functions are first organized by tabs in the ribbon bar and then organized into functional groups.
Many ribbon bar tabs are always visible in SynerGEE, no matter which type of window you are viewing. Other
ribbon bar tabs are only available with specific window types. When you are viewing the map display, for
example, several ribbon bar tabs are available for building models, navigating in the map display, and editing
display settings. The report window, meanwhile, has a tab that is dedicated to report-related tasks, such as
printing and saving report data. All window types have at least one dedicated tab, including the Organizer,
TCC, Chart window, and Script editor.
Unlike toolbars, the ribbon bar cannot be customized. However, you can double-click on any tab in the
SynerGEE ribbon bar to minimize the ribbon bar, so that only the tab names are visible. When minimized, the
ribbon bar will appear when you click on any tab name, and it will be hidden again after you click on a button
in the ribbon bar or click in the main SynerGEE window. Double-click again on any tab in the ribbon bar to
maximize the ribbon bar.

Quick access toolbar

The quick access toolbar is a small toolbar that by default appears in the top-left corner of the SynerGEE
window, between the SynerGEE logo and the program title. During installation, the quick access toolbar is
configured with the New Model, Undo, and Redo buttons. However, you can customize the toolbar to include
virtually any feature that is available in SynerGEE. This includes all options that are available in the
permanent ribbon bar tabs as well as those tabs that are available with specific window types, such as the
Map window, Report window, and Organizer window. The quick access toolbar is a great way to customize
SynerGEE for fast and easy access to the tasks you most commonly perform.
You can also move the location of the quick access toolbar, to either above or below the ribbon bar. Refer to
the procedures listed below for more information.

To edit buttons in the quick access toolbar on page 147

To change the location of the quick access toolbar on page 147

User Guide

SynerGEE Electric 5.0

Using SynerGEE

147

TO EDIT BUTTONS IN THE QUICK ACCESS TOOLBAR

1

Click the down arrow at the right end of the quick access toolbar and select More Commands.

Use the Customize editor to add and remove commands from the quick access toolbar. The
following table describes the different tasks that you can perform.
To ...
Add a command to the quick
access toolbar

Remove a command from

the quick access toolbar

Reorder commands in the

quick access toolbar

Reset the quick access

toolbar to its default settings
Customize keyboard
shortcuts
3

Do This ...
a

Under Choose commands from, select the ribbon bar

tab that includes the command that you want to add.
Common ribbon bar tabs are listed at the top of the
list, and window-specific ribbon bar tabs are listed
toward the end of the list.

Under Commands, select the specific command that

you want to add to the quick access toolbar.

Click Add.

On the right side of the Customize editor, select the

specific command that you want to remove from the
quick access toolbar.

Click Remove.

On the right side of the Customize editor, select the

specific command that you want to reorder.

Click the Up or Down arrow buttons, as appropriate, to

move the command.

Click Reset.

Click Yes to confirm the action.

Click Customize. Refer to Custom keyboard shortcuts on

page 149 for more information.

Click OK to accept your changes and close the editor.

TO CHANGE THE LOCATION OF THE QUICK ACCESS TOOLBAR

Click the down arrow at the right end of the quick access toolbar and select Show Below the Ribbon. The
quick access toolbar moves from above the ribbon bar to below it.
or
Click the down arrow at the right end of the quick access toolbar and select Show Above the Ribbon. The
quick access toolbar moves from below the ribbon bar to above it.

SynerGEE Electric 5.0

User Guide

148

Using SynerGEE

Status bar
The status bar is located at the bottom of the SynerGEE application. The status bar provides key information
about the model you are editing and in some cases even lets you change options that are being used in your
model.
The default fields that are shown in the status bar are as follows. Note that you can right-click on the status
bar to remove any of these fields, if desired.

Status area. The status area, located at the left end of the status bar, updates dynamically as you
move the mouse around SynerGEE. If the mouse is over empty space in the SynerGEE map
display, the geographical coordinates of the current mouse location is shown. If the mouse is over a
section or device in the mouse display, the name of that section or device as well as key information
is shown. If the mouse is over a table-style report, the table cell of the current mouse location is
shown.

Data source and warehouse. The names of the current model data source and equipment
warehouse data source are shown near the middle of the status bar.

Model characteristic and application setting codes. The status bar displays two sets of status codes
enclosed in brackets (for example, < Z > and < DY >). The first status code shows model
characteristics, and the second status code shows application settings. The meaning of these codes
is discussed at the end of this help topic.

Time and weather data. Time and weather data is shown near the right end of the status bar. This
data updates each time an analysis is run. The time and weather data shown in the status bar
includes the Time of Day Adjustment (specified in the Hour/Day tab of the Time and Weather
Options editor), the Seasonal Rating (specified in the Exceptions tab of the Model and Analysis
Options editor), and the current temperature.

Growth group. The growth group is shown at the right end of the status bar. Clicking on the current
growth group will open an options list that you can use to select a new growth group. For more
information on working with growth groups, see Enabling load growth rates on page 802.

Model characteristic codes

The model characteristic codes are the first set of codes that you will see enclosed in brackets in the
SynerGEE status bar. The meaning of these code letters is as follows:

F Forced unfed areas are in the model.

L Loops are in the selected feeders.

U Unfed areas exist in the model.

X External tie to non-loaded feeder exists in the model.

XA Auto-transfer tie to non-loaded feeder exists in the model.

W Wandering laterals are in the selected feeders.

Z Some sections are energized in years not being analyzed.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

149

Application setting codes

The application setting codes are the second set of codes that you will see enclosed in brackets in the
SynerGEE status bar. The meaning of these code letters are as follows:

D Time of day modeling is activated.

G Growth is activated.

Y Year other than year 0 (base year) is being analyzed.

Function key shortcuts

The following table describes the function key shortcuts that are available in SynerGEE.
Command

Action

F1

Opens the Online Help file. In most cases, a help topic will display that corresponds to
the currently displayed editor.

F2

Opens the Select Feeders editor.

F3

Toggles the map details. This will show or hide the device symbols.

F4

Opens the Results Viewer.

F5

Switches to Default mode.

F6

Switches to Spatial Query mode.

F7

Opens the PowerCalc application.

F8

Closes all open reports.

F9

Opens the Map Settings editor.

F10

Displays hotkeys for the SynerGEE ribbon bar.

F11

Refreshes the map display.

F12

Re-runs the last analysis.

Custom keyboard shortcuts

SynerGEE includes a custom keyboard shortcut editor that you can use to assign any keyboard shortcut to
any available SynerGEE option. Refer to the following procedure for more information.

TO CUSTOMIZE KEYBOARD SHORTCUTS

1

Click the down arrow at the right end of the quick access toolbar and select More Commands.

In the Customize editor, click the Customize button.

SynerGEE Electric 5.0

User Guide

150

Using SynerGEE
3

Use the Customize Keyboard editor to perform the following tasks.

To ...
Assign a keyboard shortcut

Unassign a keyboard
shortcut

Reset all keyboard shortcuts

Do This ...
a

Use the Categories list and the Commands list to

locate and select the SynerGEE command that you
want to set. The Categories list corresponds to the tabs
in the SynerGEE ribbon bar, and the Commands list
correspond to available options on the selected
Category (ribbon bar tab).

Place the cursor in the Press new shortcut key text

box.

Use the keyboard to press the keyboard shortcut that

you want to assign to the selected command. The key
combination that you press will be displayed in the text
box.

Click Assign.

Use the Categories list and the Commands list to

locate and select the SynerGEE command that you
want to set. The Categories list corresponds to the tabs
in the SynerGEE ribbon bar, and the Commands list
correspond to available options on the selected
Category (ribbon bar tab).

Place the cursor in the Press new shortcut key text

box.

Click Remove.

Click Reset All.

Click Yes to confirm the action.

Click Close to accept your changes and close the Customize Keyboard editor.

Click OK to close the Customize editor.

Context (right-click) menus

Context menus appear when you right-click in different locations in SynerGEE. The menu items that you see
will change based on where you right-click the mouse. Most of the options available in the context menus are
also available through the SynerGEE ribbon bar.

Editing data columns

Data columns within SynerGEEs windows and reports can be edited by resizing and moving the columns.
You can also sort and filter the data in the columns. The changes that you make will be retained in future

User Guide

SynerGEE Electric 5.0

Using SynerGEE

151

SynerGEE sessions. The model explorer, report results, Digest report, and Organizer are just some of the
SynerGEE window types that can be organized, sorted, and filtered using these methods.

TO MOVE A DATA COLUMN

Click on a filter header and drag the column to move it to a new location.

TO RESIZE A DATA COLUMN

Place the pointer between two column headers. The pointer will change to a two-sided arrow. Click and drag
the mouse to create the new column width, and then release the mouse button.
You can also double-click the column divider to resize the column to the width of the longest data value.

TO ADD AND REMOVE DATA COLUMNS

In the SynerGEE model explorer, right-click on any column header. A list will appear showing all available
column headings. Select the check box for each data column that you want to show, and clear the check box
for each data column that you want to hide. Click OK to accept your changes and close the data column list.

TO SORT A DATA COLUMN

Click on a column header to sort the data on that column. The data will be sorted alphabetically or
numerically, depending on the data that is contained in the column. Click the column header again to reverse
the sort order.

TO FILTER A DATA COLUMN

Click in the filter area and type the text to filter for, and then click the Filter button. Delete the text you typed
and click the Filter button again to remove the filter. The filter field is not case-sensitive.

< or > will filter for items greater or less than the given value.

!= will filter for items that do not equal the given value.

* is a wildcard character that represents multiple unknown characters.

? is a wildcard character that represents a single unknown character.

USING THE SYNERGEE EDITOR

The SynerGEE editor is the primary tool for editing model and equipment data. All devices and equipment
types use the same basic editor, customized with the appropriate contents. The following image shows an
example of the Switch editor:

SynerGEE Electric 5.0

User Guide

152

Using SynerGEE

The SynerGEE editor

The following subsections describe some key features of the SynerGEE editor.

Tabs
In SynerGEE Electric, tabs are positioned on the left side of the editor. Each tab provides access to a
related group of settings. The following example shows a portion of the Switch editor, which has three tabs:
Switch, Rates, and Results. The Switch tab is the selected tab.

Switch editor tab names

Tabs that are positioned along the side of the editor provide several advantages over the traditional format
of placing tabs along the top of the editor. For example, if you are a long-time user of SynerGEE, you may
recall how tab names historically used a smaller font and were often abbreviated, and sometimes in a rather
awkward manner, just to provide enough room to fit the required tabs. Side tabs enhance usability by allowing
full tab names to be used and by providing an easier method to change from one tab to another. The User
Guide continues to use the term tab to refer to all tabs, whether they appear along the side or the top of an
editor.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

153

Navigation buttons
Five navigation buttons, located in the upper left-corner of the SynerGEE editor, allow you to easily browse to
previously viewed editors and zoom to the location of an object in the SynerGEE map display. Refer to the
following table for more information on each button.
Previous and Next

Click the Previous and Next buttons to browse through recently viewed
SynerGEE editors. You can navigate to any object that you viewed since you
most recently opened the editor. Once you close the editor, the navigation
history is reset.

Previous and Next buttons

History

Click the History button to quickly jump to any recently viewed SynerGEE
editor. You can jump to any object that you viewed since you most recently
opened the editor. Once you close the editor, the navigation history is reset.

History button

SynerGEE Electric 5.0

User Guide

154

Using SynerGEE

Lock

Click the Lock button to lock the SynerGEE editor so that it will only show the
current model object. This feature is useful if you want to leave a specific
model object open in the SynerGEE editor and then click around in the map
display without opening a new object in the SynerGEE editor with each model
object that you select.
When the editor is in locked mode, the navigational buttons will be hidden so
that you cannot navigate to other recently viewed editors. Also, if you close the
editor while it is in locked mode and you then attempt to open the editor for a
different object in your model, the locked model object will display instead.
You must click the Lock button again to unlock the editor before you can
open the editor for other objects in your model.

Lock button (unlocked mode)

Lock button (locked mode)

Locate

Click the Locate button to zoom the SynerGEE map display to the location of
the object that you are currently viewing in the editor. If you are viewing an
equipment type editor, the Locate button will zoom on successive clicks to the
locations of each section where the equipment type is used. If the equipment
type is not used in the currently selected feeders, then the Locate button will
do nothing. If the equipment type is not used anywhere in the model, then the
Locate button will not be present in the equipment type editor.

Locate button

Auto-hide and Roll-up buttons

The Auto-hide and Roll-up buttons, located in the upper-right corner of the SynerGEE editor, control the
display on the SynerGEE editor and how the editor responds when you click the Apply button.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

155

Refer to the following table for more information.

Roll-up

Click the Roll-up button to minimize the editor so that just the title bar is
displayed. You can use this feature to see more of the screen while not
completely closing the editor.

Roll-up button

Auto-Hide

When the Auto-Hide feature is disabled, the SynerGEE editor will remain open
when you click the Apply button. When the Auto-Hide feature is disabled, the
button appears as follows:

Auto-Hide button (auto-hide feature is disabled)

When the Auto-Hide feature is enabled, the SynerGEE editor will close when
you click the Apply button. The button will appear as shown below. Click the
button to toggle the Auto-Hide feature on and off.

Auto-hide button (auto-hide feature is enabled)

Producing the editor

Use any of the following methods to open the SynerGEE editor for an object in your model:

Double-click on the object on the map display.

Double-click on the object anywhere in the model explorer.

Double-click on the object anywhere in the TCC Explorer or the TCC graph.

SynerGEE Electric 5.0

User Guide

156

Using SynerGEE

Right-click on the object in the map display and select Edit.

Right-click on the object in the model explorer and select Edit.

Select the object in a report, right-click, and select Edit.

Click the Jump To button in another SynerGEE editor.

Viewing data calculations in the SynerGEE editor

The Facets tab provides data calculations for sections and motors. These calculations provide data that is not
required for the SynerGEE analysis but may be of interest to an electrical engineer. For example, the Facets
tab on the Section editor shows the calculated by-phase impedance for a section. Although SynerGEE does
not use the per-unit system for its analysis, engineers often use them in their work. The PU impedance for the
line section is also shown.

Viewing results in the SynerGEE editor

Each section and device editor in SynerGEE includes a Results tab that lists pertinent analysis results for the
section or device. The Results tab can be very helpful if you are running multiple analyses and focusing on a
particular section or device. Since the settings update automatically with each analysis, you can run an
analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.

LOADING MODELS
Because SynerGEE provides extensive data source types and flexible merging capabilities, loading models
and other data into SynerGEE may involve some consideration beforehand. The procedures and theory for
loading and merging data are covered in detail in Managing SynerGEE Data on page 57.
If you are an enterprise database user, the concept of loading models is somewhat different than opening
local files, because you must connect to the server database and check out feeders. For more information
on enterprise database systems, see Using an Enterprise Database System on page 114.
If you want to remove the current model and load an entirely new model, you should first click the New button
in the MODEL tab of the SynerGEE ribbon bar. This action removes all current model data from memory, with
the exception of equipment data.
You can also set SynerGEE to automatically open a particular model and/or equipment data source upon
startup, using the Startup recipe. In addition, you can specify which feeders, if any, you would like to be
automatically selected. For more information, see Startup Scripts on page 715.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

157

SELECTING FEEDERS
Once a model is loaded into memory, you need to decide which feeders you would like to have selected.
Feeder selection affects which feeders are displayed on the map, and in some cases, which feeders are
affected by an analysis. It does not alter which feeders are in memory.
Feeder selection is global; it is not specific to any particular map or TCC view. For example, you can have
multiple TCC views displaying different curves, but you cannot have unique feeder selection sets. In a TCC
window, feeder selection determines which feeders and associated devices are available to plot.
How the map display responds to feeder selection is based in part on your map settings. In the Style tab of
the Map Settings editor, you can select a View mode that determines what feeders are displayed, based on
your feeder selection. For example, you can view the selected feeder only, or you can view all feeders but
apply special coloring (gray by default) to the unselected feeders. You can also view regional feeders and
adjacent feeders in the same manner. For more information, see Configuring the map display style on
page 201.
Refer to the procedures listed below for more information on selecting feeders in SynerGEE.

Using the Select Feeders and Substation Transformers editor on page 157

Selecting feeders from the SynerGEE ribbon bar on page 159

Selecting feeders from the map context menu on page 160

Setting a feeder or subtran to be automatically selected when you load a model on page 161

Using the Select Feeders and Substation Transformers

editor
The Select Feeders and Substation Transformers editor is one of the easiest ways to manage your feeder
selection in SynerGEE. You can open this editor by pressing the F2 button or by clicking the Select Feeders
button on the MODEL tab in the SynerGEE ribbon bar.
The Select Feeders and Substation Transformers editor is shown in Figure 3-1. You can use the check boxes
in the left column to select which feeders are selected in your model. Like many SynerGEE editors, the list of
feeders can be sorted or filtered by using the controls at the top of each column heading. The toolbar buttons
at the top of the editor can be used to highlight all feeders in the list and then select, clear, or toggle the
highlighted feeders. You can also use the Shift and Ctrl keyboard keys to highlight multiple feeders in the list.

SynerGEE Electric 5.0

User Guide

158

Using SynerGEE

Figure 3-1 Select Feeders and Substation Transformers editor

Refer to the following procedure for more information.

TO SELECT FEEDERS USING THE SELECT FEEDERS AND SUBSTATION TRANSFORMERS EDITOR
1

In the SynerGEE ribbon bar, select the MODEL tab and in the Settings group, select Select
Feeders.
or
Press F2 on your keyboard.

In the Select Feeders and Substation Transformers editor, select the check box for each feeder and
substation transformer you want to be selected. The following table describes additional tasks that
you can perform.
To ...

Do This ...

Select multiple feeders and

substation transformers

Use the Ctrl and Shift keys or click the Highlight All button to
highlight the feeders and substation transformers that you want
to select, and then click the Select button.

Figure 3-2 Highlight All button

Figure 3-3 Select button

User Guide

SynerGEE Electric 5.0

Using SynerGEE

159

To ...

Do This ...

Clear multiple feeders and

substation transformers

Use the Ctrl and Shift keys or click the Highlight All button to
highlight the feeders and substation transformers that you want
to clear, and then click the Clear button.

Figure 3-4 Highlight All button

Figure 3-5 Clear button

Filter the list of feeders

Click in the filter area for the data column you want to filter. Type
the text to filter for, and then click the Filter button. Delete the text
you typed and click the Filter button again to remove the filter.

Zoom to the selected

feeders and substation
transformers

Select the Zoom to network bounds on selection check box.

Include transmission models

in the selection list

Select Include Transmission Models.

Click OK to accept your changes and close the editor.

Selecting feeders from the SynerGEE ribbon bar

The MODEL tab of the SynerGEE ribbon bar includes six buttons that provide a quick method to select
certain configurations of feeders and substation transformers. Refer to the following procedure for more
information.

TO SELECT FEEDERS FROM THE SYNERGEE RIBBON BAR

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, next to the Select Feeders button, use the following buttons to select and
clear feeders and substation transformers in your model.
Button

Description

Select Window

Select only the feeders that are currently visible in the SynerGEE
map window. All other feeders will be deselected.

Figure 3-6 Select Window button

SynerGEE Electric 5.0

User Guide

160

Using SynerGEE

Button

Description

Select Region

Select feeders in the displayed region. Feeders not previously

showing on the map will be selected and displayed.

Figure 3-7 Select Region button

Select Adjacents

Select non-selected feeders with ties to selected feeders.

Figure 3-8 Select Adjacents button

Toggle Subs

Toggle the selection set of substation transformers.

Figure 3-9 Toggle Subs button

Select Last

Revert to the previous set of selected feeders.

Figure 3-10 Select Last button

Select All

Select all feeders in the model.

Figure 3-11 Select All button

Selecting feeders from the map context menu

From the right-click menu in the SynerGEE map display, you can select a single feeder, toggle the selection
status of a feeder, and revert to the last feeder selection. Refer to the procedures listed below for more
information.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

161

TO SELECT A SINGLE FEEDER ONLY

1

In the model explorer or the SynerGEE map display, locate the feeder that you want to deselect.

Right-click on a device that is included in the feeder and select Select Only This Feeder.

TO DESELECT A SINGLE FEEDER

1

In the model explorer or the SynerGEE map display, locate the feeder that you want to deselect.

Right-click on a device that is included in the feeder and select Toggle Feeder Selection.

TO REPEAT THE LAST FEEDER SELECTION

In the SynerGEE map display, right-click and select Get Last Feeder Selection.

Setting a feeder or subtran to be automatically selected

when you load a model
Refer to the following procedure for information on how to configure a feeder to be selected automatically
when you load a model.

TO SET A FEEDER OR SUBTRAN TO BE AUTOMATICALLY SELECTED WHEN YOU LOAD A MODEL

1

Open the Feeder editor and select the Feeder tab.

or
Open the Subtrans editor and select the Subtrans tab.

Select the Display on Load check box.

Click OK to accept your changes and close the editor.

Tip:

You can also create recipes that perform automated feeder selection. In particular, if you
have your startup recipe set to load model data, you might include commands to select
certain feeders as well. For more information, see Recipe Scripts on page 700 and
Startup Scripts on page 715.

USING FEEDER SETS

Feeder sets allow you to create and save specific groupings of feeders. Feeder sets can only be configured
through the NAVIGATE tab in the SynerGEE ribbon bar.
Refer to the following procedures for more information.

TO CREATE A FEEDER SET

1

Configure SynerGEE to select the feeders that you want to save in the feeder set. For more
information on selecting feeder sets, see Selecting Feeders on page 157.

In the SynerGEE ribbon bar, select the NAVIGATE tab.

SynerGEE Electric 5.0

User Guide

162

Using SynerGEE
3

In the Favorites group, next to Feeder Sets, type a name for the new feeder set that you are
creating.

Click the Add Feeder Set button.

TO SELECT A FEEDER SET

1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Favorites group, next to Feeder Sets, use the options list to select the name of the feeder set
you want to load. SynerGEE will automatically select the feeders in the selected feeder set.

TO REPLACE A FEEDER SET

1

Configure SynerGEE to select the feeders that you want to save in the feeder set. For more
information on selecting feeder sets, see Selecting Feeders on page 157.

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Favorites group, next to Feeder Sets, use the options list to select the name of the feeder set
that you want to replace.

Click the Add Feeder Set button.

Click Yes to confirm the action.

TO DELETE A FEEDER SET

1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Favorites group, next to Feeder Sets, use the options list to select the name of the feeder set
you want to delete.

Click the Delete feeder set from list button.

Click Yes to confirm the deletion.

SETTING PREFERENCES
SynerGEE allows you to customize the overall environment with a series of Preference settings. These
settings include items such as the unit system, phase designations, and the voltage base.
It is very important that you set your preferences correctly for accurate SynerGEE performance. Your
preferences are global they are not specific to any particular model. Also, your preferences are stored
automatically and applied each time you start SynerGEE. Preferences do not change between SynerGEE
sessions, unless you intentionally change them.

TO SET PREFERENCES
1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

On the left side of the Preferences editor, select from the different tab names to access the available
preference settings. The following topics describe the different tasks that you can perform:
-

User Guide

Setting SynerGEE preferences on page 163

SynerGEE Electric 5.0

Using SynerGEE

163
-

Setting units of measurement on page 165

Setting database preferences on page 167

Defining file paths on page 167

Setting data mining preferences on page 169

Setting values for conductor spacing and height above ground on page 169

Managing load categories on page 170

Setting feature locks on page 171

Backing Up SynerGEE Data on page 131

Running recipe scripts automatically on page 731

Click OK to accept your changes and close the editor.

Setting SynerGEE preferences

Perform the following procedure to set general preferences in SynerGEE.

TO SET SYNERGEE PREFERENCES

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the SynerGEE tab. The following table describes the different
options that you can set.
User

Name of the SynerGEE user.

Company

Company name, as read from your license file. This field cannot
be edited.

Default Project Name

Specify the default project name, which will appear in the title of
all reports.

Lock Name

Specify the user name that will be used when you check out
feeders from an enterprise database. SynerGEEs locking
feature prevents other users from saving data to the same
feeders that you are editing. For more information on feeder
locks and lock names, see Feeder locks and lock IDs on
page 121.

SynerGEE Electric 5.0

User Guide

164

Using SynerGEE

Node Prefix and Section

Pattern

Specify the default naming convention for new nodes and

sections. The section default applies to isolated (or orphan) new
sections only. If you draw a new section attached to an existing
one, SynerGEE does one of two things:

If the Generate Section IDs check box is selected,

SynerGEE generates a random, unique section ID.

If the Generate Section IDs check box is not selected,

SynerGEE attempts to maintain the naming pattern of
the section to which you attached the new one.

A pattern can be up to 31 characters long. New, default node IDs

will consist of the prefix you type here and an integer-based time
stamp. The section ID pattern must contain at least 4 question
marks (????) as a placeholder for the default number.
Prompt for Section IDs

If selected, SynerGEE will prompt you to enter an ID name for

each new section that you create. A default ID name will be
provided that you can accept or change, as desired. If cleared,
SynerGEE will apply the default ID name automatically.
Take note that you cannot edit the ID name once a section has
been created.

Allow Loop Creation

Select this check box to allow loop creation without using any
topological workarounds, such as loop tie switches. For more
information on modeling loops, see Loops and Wandering
Laterals on page 253.

Allow Multiple Sessions

Select this check box to allow multiple SynerGEE sessions to be

run without overwriting individual session data. This option allows
basic SynerGEE functioning within a network environment. For
more information on operating within a network environment, see
Multiple Sessions and Network Installations on page 55.

Generate Section IDs

Select this check box to have SynerGEE generate a random

section ID when a new section is modeled. The random ID is
generated from a time-based function to help ensure
uniqueness. Generally, this option should be used with enterprise
database systems to prevent data conflicts when saving newly
modeled sections. For more information on this option and
default section naming, see Modeling Sections on page 258.

Use Python for Startup

Script and Case Files

Select this check box to use the Python script format with
SynerGEEs startup script and case files.
or
Clear the check box to use recipe scripts with SynerGEEs
startup script and case files.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

165

Section Length After Node

Insert

Select an option to indicate whether SynerGEE should calculate

the actual lengths of split sections, or determine lengths based
on the previous length of the original section.

Zoom Percentage

Specify the increment of change during a zoom in or zoom out

action.

Click OK to accept your changes and close the editor.

Setting units of measurement

Perform the following procedure to set up units of measurement in your model. Additional information on
units of measurement is provided in Units in SynerGEE on page 185.

TO SET UNITS OF MEASUREMENT

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the Units tab. The following table describes the different options
that you can set.
Unit System

Units of measurement to be used in your models. Available

choices are as follows:

Metric

English (KFt)

English (Miles)

Phase Designations

Designations for phases 1, 2, and 3, as used in your

organization. The default values are A, B, and C, respectively.
These designations appear throughout SynerGEE, including in
the device editors and in SynerGEEs reports.

Voltage Base

Voltage base to be used in your models.

Year Descriptions

Specify a description for each year in multi-year modeling. These

names are for identification purposes only and do not affect how
SynerGEE regards the time span between years. For more
information on how the time span is determined between years,
see Year names and time spans between years on page 584.

Enable multi-year
modeling

Select this check box to enable SynerGEEs multi-year modeling

features. If disabled, SynerGEE will disregard energize/retire
years for devices and sections, displaying all model items in the
map display regardless of the year setting. For more information
on multi-year modeling, see Multi-Year Analysis on page 579.

SynerGEE Electric 5.0

User Guide

166

Using SynerGEE

Update Year Descriptions

From Model

Frequency

PT Secondary

Select whether the years loaded into the Year Descriptions

fields are loaded from the SynerGEE preferences or from the
model database.

If the check box is not selected, the year descriptions

are read from the SynerGEE preferences. This is the
default option. If the model year descriptions do not
match the SynerGEE year descriptions, you will be
notified of the difference and given the opportunity to
cancel the operation. If you continue to load the model,
the year descriptions from the SynerGEE preferences
will be used; the year descriptions from the model will
be ignored

If the check box is selected, the year descriptions are

read from the SynerGEE model database. However, if a
model is already in memory and another model is
loaded, the check box will be ignored and the behavior
described in the unselected option above will be
followed.

Frequency to be used in your models. Available choices are as

follows:

60 Hz

50 Hz

PT Secondary voltage to be used in your models. Available

choices are as follows:

120V

100V

The PT secondary voltage option affects voltage and first house

settings on regulators and transformers. For more information,
see Editing line-drop compensation data for a regulator on
page 388 and Setting up a load-tap changer (LTC) for a
transformer on page 427.
Rotation

Load Density

User Guide

Phase rotation to be used in your models. This setting can have

an impact on line calculators and rotating machines. Available
choices are as follows:

Positive

Negative

Preferred kW density to be used in your models. Available

choices are as follows:

kW / Square MI

kW / Acre

SynerGEE Electric 5.0

Using SynerGEE
3

167

Click OK to accept your changes and close the editor.

Setting database preferences

Perform the following procedure to set database preferences in SynerGEE.

TO SET DATABASE PREFERENCES

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the Database tab. The following table describes the different
options that you can set.
Format for new databases

Specify the Access file format that will be used for any new
databases that you create. Existing databases will be maintained
in their current file format.
The following options are available:

Use Access 97 format for new databases

Use Access 2000 format for new databases

Use Access 2002 - 2003 format for new databases

Use Access 2007 format for new databases

Prompt if using more than

X feeders from a DBMS

Specify a warning limit when loading feeders from a DBMS. If the

threshold is exceeded, SynerGEE will prompt you before loading
additional feeders.

ID Field Size in Database

Tables

Specify the size of ID fields in an Access database. Enter a value

from 32 and 100 characters.

Click OK to accept your changes and close the editor.

Defining file paths

In addition to your model files, you may interact with a number of different file types as you use SynerGEE.
Macros, scripts, output data, and settings data are just some of the features in SynerGEE that save data in
respective file types.
By default, SynerGEE saves these files in two general locations, based on the operating system that you are
using. The default paths for these file locations are defined in the following table.
Directory type

Default path (Windows XP)

Default path (Windows 7 and Vista)

Documents folder

C:\Documents and Settings\

[UserName]\My Documents\
Stoner Software\
SynerGEE Electric

C:\Users\[UserName]\
My Documents\Stoner Software\
SynerGEE Electric

SynerGEE Electric 5.0

User Guide

168

Using SynerGEE

Directory type

Default path (Windows XP)

Default path (Windows 7 and Vista)

Installation folder

C:\Program Files\
SynerGEE Electric 5.0\

C:\Program Files (x86)\

SynerGEE Electric 5.0\

The default path for each specific file type is shown below, where [DocumentsDirectory] and
[InstallationDirectory] refer to the respective paths as listed above.
File Type

Default Path

Calcs (calculations)

[DocumentsDirectory]\Calcs

CMM

[DocumentsDirectory]\Scripts

Events

[DocumentsDirectory]\Scripts

Gallery

[DocumentsDirectory]\Gallery

Layers

[InstallationDirectory]\GeoLayers

Macros

[DocumentsDirectory]\Macros

Output

[DocumentsDirectory]\Output

Projections

[InstallationDirectory]\GeoProjections

Protection Lab

[DocumentsDirectory]\Protection Lab

Schematic Templates

[DocumentsDirectory]\Schematics

Scripts

[DocumentsDirectory]\Scripts

Settings

[DocumentsDirectory]\Settings

Unit

[DocumentsDirectory]\Unit

What Ifs

[DocumentsDirectory]\Scripts

In the Preferences editor, you can use the Paths tab to change the target folders for the various types of files
that SynerGEE uses. These values are stored in your system registry, so you can store unique settings for
each Windows login profile, as applicable.
From the Paths tab, you can define a specific location for each individual file type, or you can define a new
location for all files types. Refer to the topics listed below for more information.

TO EDIT INDIVIDUAL FILE PATHS

1

User Guide

If you have not already done so, perform the following steps to open the Paths tab of the
Preferences editor.
a

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select
Preferences.

In the Preferences editor, select the Paths tab.

SynerGEE Electric 5.0

Using SynerGEE

169

For each listed path category, type the full path to be used to save all files of the selected file type, or
click the Browse button and navigate to the desired directory.

Click OK to accept your changes and close the editor.

TO EDIT ALL FILE PATHS

1

If you have not already done so, perform the following steps to open the Paths tab of the
Preferences editor.
a

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select
Preferences.

In the Preferences editor, select the Paths tab.

At the bottom of the Paths tab, select Set root folder for all subfolders.

In the text box at the bottom of the editor, type the full path to be used as the root folder for all
SynerGEE files types, or click the Browse button and navigate to the desired directory. Once you
select a target folder, SynerGEE will prompt you to create subfolders in that directory to save each
of the related file types.
Note that SynerGEE will not transfer files from your default file locations to the new file locations. If
you wish to continue to have access to your current files, you must manually copy the files from the
old path location to the new one.

Click OK to accept your changes and close the editor.

Setting data mining preferences

When used in conjunction with a SQL Dashboard query, the mining feature allows you to view data in nonSynerGEE databases. A query should first be written in the SQL Dashboard. The Preference editor can then
be opened and the facility type selected from the list. The Name and SQL Script fields will fill in automatically
as an applicable facility type is chosen.

Setting values for conductor spacing and height above

ground
The sections in your model can be edited to specify the phase-to-phase and phase-to-neutral conductor
spacing distances and also the distance from the conductor to the ground. In the Section editor, you can only
select from a set of pre-defined values for these options. These pre-defined values are defined in the Spacing
tab of the Preferences editor.
Refer to the following procedure for more information on defining the conductor spacing and height-aboveground values. The values you set on the Spacing tab do not set any data in your model; they simply define
the options that you can select from when you are working in the Section editor. For information on setting
these values in the Section editor, see Editing construction data for a section on page 281.

SynerGEE Electric 5.0

User Guide

170

Using SynerGEE

TO DEFINE CONDUCTOR SPACING AND HEIGHT ABOVE GROUND VALUES

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the Spacing tab.

To add a value, click the appropriate Insert button and then type the new value.
or
To delete a value, select the value that you want to delete and then click the appropriate Delete
button.

Click OK to accept your changes and close the editor.

Managing load categories

Load categories are an optional SynerGEE feature that you can use to group common sections for reporting
and mapping purposes. For example, you can assign certain sections to a Critical Load category, and then
use the load category column to filter any report that supports the load category setting (such as the
Balanced Results and By-Phase Results sections of the Load Flow report). You can also use the load
category as a color-by scheme in your SynerGEE map display. Load categories have no effect on analysis
and do not have any other impact on your model.
Load categories are defined in the Categories tab of the Preferences editor. Refer to the procedure below for
more information. Load categories are then assigned to sections on the Properties tab of the Section editor,
as described in Editing additional general settings for a section on page 283.

TO MANAGE LOAD CATEGORIES

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the Categories tab. The following table describes the different
tasks that you can perform.

User Guide

To ...

Do This ...

Create a new load category

Select the row for an empty category. At the bottom of the

Preferences tab, type a name and select a color to associate with
the category.

Edit an existing load

category

Select the row for the category that you want to edit. At the
bottom of the Preferences tab, type a new name and select a
new color for the category.

Delete a load category

Select the row for the category that you want to delete. At the
bottom of the Preferences tab, clear the category name or
replace it with an asterisk (*).

Click OK to accept your changes and close the editor.

SynerGEE Electric 5.0

Using SynerGEE

171

Setting feature locks

Use the Feature Locks setting in the Preferences editor to prevent changes from being made to specific
aspects of SynerGEE. For example, if you set a feature lock for Switching, users will not be able to open or
close switches. This option is particularly useful if a master user wants to set limits for other users in the
organization. Refer to the following procedure for more information.

TO SET FEATURE LOCKS

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the Feature Locks tab.

Use the check boxes in the features list to specify which SynerGEE features will be locked out.
Selected features will be locked, while cleared features will remain available for editing.

Click OK to accept the changes and close the Preferences editor. You must restart SynerGEE
before your changes will take effect.

FINDING MODEL DATA

SynerGEE provides a search tool that you can use to quickly locate sections, devices, and other items in your
model. This tool is located above the model explorer area, next to the year indicator. To search for an object
in your model, simply click the Search text and then type the name or partial name of the object you want to
find. Wildcard characters may also be used as a part of the search criteria, as described in the procedure
below.
The search feature searches the entire model in memory not just the selected feeders, which is what you
can see in the map display and model explorer. If you select a model object that is located on an unselected
feeder, SynerGEE will prompt you to add the feeder to the selected set so that the model object may be
viewed.

TO USE THE SEARCH FEATURE

1

At the top of the SynerGEE model explorer, click Search ....

Type the object name or partial object name that you want to find. The results list will update
automatically with each character that you type. If desired, you can use the following symbols to
further filter the find results:
-

? is a wildcard character that represents a single unknown character.

* is a wildcard character that represents multiple unknown characters.

< or > will filter for items greater or less than the given value.

!= will filter for items that do not equal the given value.

To remove a filter, simply delete the text that you typed.

3

To narrow the search to a specific object type or a group of object types, right-click on the search
text and then select the check box for each object type that you want to search. Available categories
include Devices, Equipment, Feeders, Nodes, Sections, and Text Labels. All categories are
selected by default.

SynerGEE Electric 5.0

User Guide

172

Using SynerGEE
4

To see more details about a specific item in the results list, click on the result name. The object will
be highlighted in the model explorer, and the map display will zoom to the location of the object. You
can then use standard model explorer or mapping tools to edit the object or to perform other tasks.

Click anywhere outside the search results list to close the search window.

UNDOING AND REDOING MODEL EDITS

SynerGEE supports a limited undo/redo feature, applicable mostly to modeling and device editing functions.
You can use this feature to undo and redo the following actions:

Any graphical operation (such as deleting a section or moving a node)

Any device edit (such as changing phasing or copying a device)

Any change made in the device editor before clicking Apply

Node conversions (such as node to feeder or subtran to node)

SynerGEE stores up to 100 previous actions in a stack which is undone or redone sequentially. The stack is
emptied when certain operations are performed, including (but not limited to) the following:

Loading and merging data of any type

Using the Multiple Editor

Creating a new model

Refer to the following procedures for more information.

TO UNDO A MODEL EDIT

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Edit group, click Undo.

Tip:

You can also press Ctrl+Z on your keyboard.

TO REDO A MODEL EDIT

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Edit group, click Redo.

Tip:

You can also press Ctrl+Y on your keyboard.

TAGGING SECTIONS AND FACILITIES

Tagging is a way to temporarily identify key sections and devices that you want to work with. You can tag a
section or facility by right-clicking on it in the SynerGEE map display or model explorer and selecting the Tag
option. You can view the list of tagged sections and facilities in the Model tab of the model explorer. From this
list, you can perform a number of actions from the right-click menu, including zooming to the location in the
map display and opening the SynerGEE editor. From the NAVIGATE tab of the SynerGEE ribbon bar, you
can click the Next Tag button to zoom to the location of each tagged facility.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

173

Tagging is a temporary condition. Once you close your model or exit SynerGEE, the list of tagged facilities
will be cleared. While you are working in the current session, you can also use the SynerGEE ribbon bar or
the appropriate right-click menu to remove tags for one or all tagged sections and facilities.
Refer to the following procedures for more information.

TO TAG A SECTION OR FACILITY

1

In the SynerGEE map display or model explorer, right-click on the facility or section that you want to
tag.

Select Tag.

TO VIEW THE LIST OF TAGGED SECTIONS AND FACILITIES

1

In the SynerGEE model explorer, select the Model tab.

Expand Locations/Groups and select Tagged.

Note:

If no facilities have been tagged in the model, then the Tagged group will not appear.

TO VIEW TAGGED SECTIONS AND FACILITIES IN THE SYNERGEE MAP DISPLAY

1

Open the SynerGEE editor.

In the SynerGEE ribbon bar, select the NAVIGATE tab.

Click Next Tag. The SynerGEE map display will zoom to the location of each tagged facility each
time you click the Next Tag button.

TO REMOVE A TAG FROM A SECTION OR FACILITY

1

In the SynerGEE map display or model explorer, right-click on the facility or section that you want to
un-tag.

Select Remove Tag.

TO REMOVE TAGGING FROM ALL SECTIONS AND FACILITIES

1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Tools group, click Remove Tags.

Note:

The list of tagged facilities will also be cleared each time you exit SynerGEE or close the
current model.

USING THE QUERY SET

The query set is a temporary group of sections and associated equipment that you want to work with in
SynerGEE. SynerGEE uses the query set in the following ways:

When using the multiple editor, only sections that are included in the query set, or devices that are
on the sections in the query set, will be edited.

SynerGEE Electric 5.0

User Guide

174

Using SynerGEE

Some SynerGEE analyses work on queried sections only, including the fault analysis, network fault
analysis, and the optimal conductor selection tool in the Design Evaluation analysis. The Joiner is
another SynerGEE tool that only works with the Query set.

When using scripts, some script commands can be used to apply edits to the query set only. For
example, the 4106 command can be used to apply a Model Cleanup script to the query set only. In
addition, several individual model cleanup scripts commands, including 4013, 4014, 4074, and 4078
can be applied individually to either model cleanup scripts or to the entire model.

When using annotation on the SynerGEE map display, you can configure the annotation to only be
shown for sections in the query set, or for devices that are on the queried sections. This option can
be selected in the Text tab of the Map Settings editor.

The Query tab of the model explorer shows which sections are currently included in the query set. In addition,
sections in the query set appear in a different color on the map, according to your map display settings. The
default color for queried sections is gray, but you can change this color from the Color tab in the Map Settings
editor.
SynerGEE provides several different methods for adding sections to the query set. Each method provides a
different process of selecting sections, and you can combine these methods to set up the query set according
to your needs. Refer to the topics listed below for more information.

Creating a query set from the SynerGEE map display on page 174

Creating a query set using the Query Wizard on page 176

Creating a query set from the SynerGEE map display

The quickest way to add sections to the query set is to use the context menus in the SynerGEE map display.
Refer to the procedures listed below for more information.

To add sections to the query set on page 174

To add sections to the query set using spatial query mode on page 174

To modify sections in the query set using the query path tool on page 175

To remove a section from the query set on page 176

To clear the query set on page 176

TO ADD SECTIONS TO THE QUERY SET

1

In the SynerGEE map display, right-click on the section that you want to add to the query set.

Select Toggle Query. The section will be added to the query set, which you can view from the
Query tab in the model explorer. If the section is already in the query set, this command will remove
it.

TO ADD SECTIONS TO THE QUERY SET USING SPATIAL QUERY MODE

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Query group, click the Query button. The cursor changes to include a plus sign and a
question mark.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

175

Tip:
3

You can also press F6 to enter spatial query mode.

Once in the Spatial Query mode, use the following mouse and key combinations to add sections to
the query set:
-

Click and drag a box over a region of the map. All sections inside of or touching the box are
added to the query set. (Note that this click-and-drag process will delete the existing query
set and replace it with a new one.)

Click on an individual section to add it. (Note that this single-click option will delete the
existing query set and replace it with a new one.)

Press Ctrl and click to add multiple sections to the existing query set.

Press Shift and click on a section to add that section and all sections downstream,
including all branches, to the existing query set.

Press Ctrl+Shift and click on a section to add that section and all sections on a direct path
back to the feeder (or subtran) source to the existing query set.

Click in any empty space in the SynerGEE map display to clear the query set.

Press F5 to return to Default mode.

TO MODIFY SECTIONS IN THE QUERY SET USING THE QUERY PATH TOOL
1

In the SynerGEE map display, right-click on the section that you want to work with using the Query
Path tool.

Select Query Path.

Use the Query Path editor to set up the condition for your query. The following table describes the
different options that you can set.
Query Set

Select whether you want to use the current query set or clear the
query set and replace it with a new one.

Action

Select the action that you want to perform when modifying the
query set.

Sections

Select which sections you want to use to modify the query set.

Highlight Queried Area in

Map Display

Select whether you want to highlight the queried sections in the

SynerGEE map display using SynerGEEs query set color,
which by default is gray. (This color can be changed in the Color
tab of the Map Settings editor.)
Tip:

This check box is also available in the Style settings in

the Map Settings editor.

Click Finish to accept your settings and modify the query set accordingly.

SynerGEE Electric 5.0

User Guide

176

Using SynerGEE

TO REMOVE A SECTION FROM THE QUERY SET

1

Right-click on the section in the Query tab of the model explorer or in the SynerGEE map display.

Select Toggle Query.

TO CLEAR THE QUERY SET

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Query group, click Clear.

Tip:

You can also press Ctrl+Q on the keyboard to clear the query set.

Creating a query set using the Query Wizard

You can use the Query Wizard to create and modify the query set by specifying selected data parameters.
You can use the results to generate a new query set, append the existing set, or remove items from the
existing set. The wizard steps will vary depending on the options that you select, but the following procedure
provides a general overview of how to use the Query Wizard.

TO USE THE QUERY WIZARD

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Query group, click Generator.

On the first page of the Query Wizard, select what data type you want to query. Available choices
are as follows:
-

Section Parameters

Equipment

Results

Zone

On the second page of the wizard, specify the criteria by which you want to query your data. The
options on this page will vary depending on what you selected on the first page of the wizard. For
example, if you selected Zone on the first page, then on the second page you can select a specific
zone type to query Customer, Exposure, Mitigation, or Growth.

On the third page of the wizard, select which portion of the model you are querying. Available
choices are as follows:

User Guide

Selected Feeders

Whole Model

Existing Query Set

On the fourth page of the wizard, select how you want to apply the queried results. Available choices
are as follows:
-

Generate New Query Set

Add to Existing Query Set

SynerGEE Electric 5.0

Using SynerGEE

177
-

Remove from Existing Query Set

On the last page of the wizard, review the sections that will be used to create or modify the query
set. You can remove individual sections from the query set at this point by right-clicking on a query
set name and selecting Remove.

Click Finish to complete the query and close the Query Wizard. The query set, as reflected on the
Query tab of the model explorer, will be updated according to the choices that you made.
Instead of clicking Finish, you can also click Launch Multiple Editor on the last page of the wizard.
This will also accept the new query set and also launch SynerGEEs Multiple Editor.
To exit the Query Wizard without committing any changes, click Cancel.

USING THE MULTIPLE EDITOR

SynerGEEs Multiple Editor allows you to make sweeping changes to your model quickly and conveniently.
Actions performed with the Multiple Editor only affect items within the SynerGEE query set. Therefore, before
you perform a multiple edit, you first must place all applicable sections that you want to edit, or sections
associated with the devices you want to edit, in the query set.
Refer to the following procedure for more information on using the Multiple Editor. For information on creating
a query set, see Using the Query Set on page 173.

TO USE THE MULTIPLE EDITOR

1

Build a query set that includes the sections and equipment that you want to edit. For more
information, see Using the Query Set on page 173.

Use one of the following methods to open the Multiple Editor:

-

In the SynerGEE ribbon bar, select the TOOLS tab. Then, in the Model group, select
Multiple Editor.
or

In the SynerGEE ribbon bar, select the BUILD tab. Then, in the Query group, select
Multiple Editor.

Along the top of the Multiple Editor, click the category button for the SynerGEE data category that
you want to edit. Available choices include Devices, Loads, General, Sections, and Zones.

Along the left side of the Multiple Editor, select the subcategory that you want to edit. For example, if
you clicked the Devices button along the top of the editor, select from the subcategories to edit
Capacitors, Generators, Motors, Regulators, Switches, or Transformers.

On the right side of the editor, select the specific edit that you want to make for the selected category
and subcategory type. You can also do the following:
-

SynerGEE Electric 5.0

Click the >> button to open a panel at the bottom of the Multiple Editor that shows list of the
proposed changes, based on the selections you made in the Multiple Editor and the
sections that you have added to the query set. Right-click on any proposed change and
select Exclude from Multiple Edit to remove that change from the multiple edit. Rightclick again and select Restore All Excluded Items to return the list to its original settings.

User Guide

178

Using SynerGEE

Click the Back up model button to save a copy of your currently loaded model and
warehouse before applying changes.

Click Save a report of the listed changes button to save the proposed changes to a
report file. You can also click this button after the changes have been completed by clicking
the Finish button.

When the list of proposed changes is satisfactory, click OK or Apply to complete the edit.

PRINTING
You can print any SynerGEE view, including the map, charts, and TCC graphs. You can also view a print
preview before printing, to get an idea of what the output will look like. Note that print preview is not always
100% reliable, especially with HTML reports. This is due to the variations between file formats and printer
types, of which SynerGEE, like any software product, is unable to fully accommodate.
Before printing a SynerGEE view, you should make sure that your page setup options reflect the type of
printout you want. Page setup options control overall appearance features, including margins and font styles.
You can also configure page setup options for specific SynerGEE view types, including the map display,
report and chart windows, the Organizer, and the TCC.
Refer to the following procedure for more information on using the Page Setup editor.

TO EDIT PAGE SETUP OPTIONS

1

At the left end of the SynerGEE ribbon bar, click the Pole icon. Hover the mouse over Print, and
then select Page Setup.

On the left side of the Page Setup editor, select from the following tab names to edit page setup
options for all SynerGEE printouts:

User Guide

Margins

Sets the page margins and unit of measurement (either inches or

centimeters).

Options

Specifies whether you want to include the project name, current date/time,
title lines, and logo in your reports.

Font Sizes

Sets font sizes for the various text categories that may appear on the
printout.

In addition, select from the following tab names to edit page setup options for printouts of specific
SynerGEE views.
Map

Sets the title, legend, and other options for map display printouts.

TCC

Sets the title text for TCC view printouts.

Chart

Sets the title text for chart view printouts.

Cable

Sets the title text for Cable Duct Bank view printouts.

SynerGEE Electric 5.0

Using SynerGEE

179

Report

Sets the title text, alignment, and other options for any SynerGEE report
printouts.

Joiner

Sets the title text, alignment, and other options for Joiner view printouts.

Projects

Sets the title text for the Project Worksheet.

Feeders

Sets the title text for printing the Feeder view in the model explorer.

Organizer

Sets the title text for the Organizer view printouts.

DTrans

Sets the title text for the DTrans view printouts.

Click OK to accept your changes and close the Page Setup editor.

TO PRINT SELECTED CHAPTERS OF A REPORT

1

In the SynerGEE ribbon bar, select the CONTROLS tab.

In the Printing group, click Multiple Chapters.

In the Report Export dialog box, select the check box next to the name of each chapter that you
want to print.

Click Finish.

Use the Print dialog box to set additional printing options, and then click OK to print the selected
report chapters.

RAP SHEETS
Rap sheets provide simple, brief information on specific devices or sections in the model. You can open the
Rap Sheet editor from the TOOLS tab in the SynerGEE ribbon bar. However, in most cases you will want to
display a rap sheet directly from a specific device or section. You can do this by right-clicking on the device or
section name and selecting the desired rap sheet type from the resulting context menu. Each rap sheet (with
the exception of Voltage Plots) is added to the list area in the Rap Sheet editor. You can use the Rap Sheet
editor to zoom to a selected device or section, remove a single rap sheet from the list, or clear all rap sheets
from the list. You can also open a selected rap sheet in WordPad.
The topics listed below provide more information on the different rap sheets that are available in SynerGEE.

Details rap sheet on page 179

Voltage Plot rap sheet on page 180

Arc Flashover rap sheet on page 181

Fault rap sheet on page 182

Details rap sheet

The Details rap sheet provides simple, brief report on a specific device or section in the model.

SynerGEE Electric 5.0

User Guide

180

Using SynerGEE

Details rap sheet

TO CREATE A DETAILS RAP SHEET

In the SynerGEE map display, right-click on the device or section and select Rap Sheet > Details.
or
In the TCC explorer or TCC graph, right-click on the device ID or curve and select Rap Sheet.
or
Select the Rap Sheet option in the Find window, as described in Finding Model Data on page 171.

Voltage Plot rap sheet

The Voltage Plot rap sheet provides a voltage plot chart for a given section or piece of equipment.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

181

Voltage Plot rap sheet

TO CREATE A VOLTAGE PLOT RAP SHEET

In the SynerGEE map display, right-click on the device or section and select Rap Sheet > Voltage Plot.

Arc Flashover rap sheet

The Arc Flashover rap sheet provides a quick look at Arc Flashover data in a more condensed format than
the Arc Flashover analysis. The rap sheet data only covers the selected section, rather than the entire map
as covered in the Arc Flashover analysis.
Information on SynerGEEs Arc flashover analysis feature is provided in Arc Flashover on page 643.

SynerGEE Electric 5.0

User Guide

182

Using SynerGEE

Arc Flashover rap sheet

TO CREATE AN ARC FLASHOVER RAP SHEET

In the SynerGEE map display, right-click on the device or section and select Rap Sheet > Arc Flashover.

Fault rap sheet

The Fault rap sheet provides Fault Analysis data for a device or section in your model.

Fault rap sheet

User Guide

SynerGEE Electric 5.0

Using SynerGEE

183

TO CREATE A FAULT RAP SHEET

In the SynerGEE map display, right-click on the device or section and select Rap Sheet > Fault.

ORGANIZER
The Organizer provides access to all of the data in your model and all of SynerGEEs functions without the
graphic overhead of a map display. The Organizer is essentially an alternate way to work with your model,
allowing you to view more data at one time, thus saving you time as you view attributes and edit model
properties.
All SynerGEE users have access to the Organizer, but users with an especially large model and database
may find it most helpful when running more complex analyses that tend to take longer to generate. All ribbon
bar tabs and analysis options can be used in the exact same way as the map view. You can double-click on
any device name in the Organizer window to open the associated device editor. Organizer columns can be
sorted and filtered to show only the data that you need to see.
The Organizer includes three subtabs that are located to the left side of the Organizer window:

Model Wide. The Model Wide tab allows you to view all feeders and equipment in your model,
regardless of whether they are selected. You can view a summary of your model data by selecting
the Model wide metrics and Settings branches of the Model Wide tabs tree view. Specific details
can be viewed by selecting the Network, Paths, Facilities, Section Lists, Facility Lists, and Zones
branches.

Selection. The Selection tab shows the feeders and equipment that are currently selected in the
standard model. Specific details can be viewed by selecting the Network, Facilities, Section Lists,
Paths, and Facility Lists branches.

Issues. The Issues tab shows potential data problems in your model. Specific details can be viewed
by selecting the Issues, Connectivity, Bad Types, Loads, and Exceptions branches.

In addition, you can open additional Organizer tabs within the main Organizer view, in case you want to
toggle quickly between different views of the data in your model. These Organizer tabs are located along the
right side of the Organizer view. You can add tabs and remove tabs by clicking the respective buttons in the
SynerGEE ribbon bar.

TO WORK IN THE ORGANIZER VIEW

1

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Organizer.

In the upper-left corner of the Organizer window, click the light bulb icon to toggle analysis reports
on and off. When the light bulb is "on" (yellow), reports will be generated. When the bulb is "off"
(white), reports will not be generated.
Also, click the up and down arrows above the year indicator to change the analysis year.

On the left side of the Organizer window, select the Model Wide, Selection, and Issues subtabs,
and then associated options in the Organizer tree view, to view different categories of data in your
model.

SynerGEE Electric 5.0

User Guide

184

Using SynerGEE
5

Use the right-click menu to access shortcuts for interacting with the devices and sections in your
model. The following table describes many of the options that are available.
Right-Click Option

Description

Delete

Deletes the device or section.

Pan To

Pans to the location of a device or section in the map display.

Zoom To

Zooms to the location of a device or section in the map display.

Zoom Feeder

Zooms to the location of a devices or sections feeder in the map

display.

Toggle Query

Toggles the status of the associated section in the Query tab.

Edit

Opens the SynerGEE editor for the device or section. (You can also
double-click a device or section name to open the SynerGEE editor.)

Turn On/Off

Turns the associated device on or off.

Open/Close Device

Opens or closes the associated device.

Add to TCC

Sends the associated device to the TCC window.

Link

Open the location link that is associated with a device. (If no location
link is set up for the device, the Link option will be disabled.)

Change ID

Changes the ID of a section.

Set for Analysis

Sets the section for analysis.

Charts/Reports

Sends the section to a chart or report, such as the Rap Sheet or a

Voltage Plot.

Open in Excel

Sends the current Organizer window data to an Excel spreadsheet.

LAUNCHING SYNERGEE FROM THE COMMAND LINE

Like most Windows applications, you can start SynerGEE from a command line by simply typing the full path
of the associated EXE. For example, to start SynerGEE from the default installation folder on Windows XP,
you can enter the following with a command line:
C:\Program Files\SynerGEE Electric 5.0\SynerGEE.exe

Command lines are used in a variety of places within the Windows environment. One common way of
accessing a command line is by selecting Start > Run from the Windows desktop. Or, you can create a batch
file that contains multiple command lines and run the file at regular intervals.
When launching SynerGEE from a command line, you can also use certain autostart commands to perform
specialized functions. For example, you can load a specified database automatically, or you can have
SynerGEE automatically run a specified recipe after loading the database.

User Guide

SynerGEE Electric 5.0

Using SynerGEE

185

All SynerGEE autostart commands begin with a hyphen, followed by a single letter and then any additional
parameters that SynerGEE might need. The following autostart commands are available. Several examples
of these commands are provided after the table.
Command

Description

-m path

Loads a model database, where path is the path name of the model database file.
If the path contains any spaces, you must enclose the entire path in quotes.

-e path

Loads an equipment database, where path is the path name of the equipment
database file. If the path contains any spaces, you must enclose the entire path in
quotes.

-p path

Loads a protection database, where path is the path name of the protection
database file. If the path contains any spaces, you must enclose the entire path in
quotes.

-r name

Runs a recipe, where name is the recipe name. If the name contains any spaces,
you must enclose it in quotes.

Command line example 1

The following command line starts SynerGEE and loads the model database Example1.mdb from the same
directory as the SynerGEE exe file:
"C:\Program Files\SynerGEE Electric 5.0\SynerGEE.exe" -m Example1.mdb

Command line example 2

The following command line starts SynerGEE, loads the model database Example1.mdb from the My Data
folder, loads equipment data from the same file, and then runs a recipe called RunLoadFlow:
"C:\Program Files\SynerGEE Electric 5.0\SynerGEE.exe" -m "C:\Program
Files\SynerGEE Electric 5.0\My Data\Example1.mdb" -e "C:\Program
Files\SynerGEE Electric 5.0\My Data\Example1.mdb" -r "RunLoadFlow"

UNITS IN SYNERGEE
With normal usage, units handling in SynerGEE is automatic, with seamless conversion from data sources to
the interface and back. Supporting both the English and metric systems, SynerGEE can easily convert
between different systems as necessary and provide the results in the system you prefer.
In some cases, though, you may encounter a situation in which you need to understand the details of units
handling, especially if you are building or manipulating a data source outside of SynerGEE. For external data
management purposes, units handling is very flexible, but requires a strong knowledge of SynerGEEs
processes and architecture for units.
The topics listed below provide detailed information on how SynerGEE reads, writes, and converts units. If
you perform work directly in your SynerGEE data sources, you should have an understanding of these
concepts, even if you do not work with units explicitly.

Basic unit concepts on page 186

SynerGEE Electric 5.0

User Guide

186

Using SynerGEE

Generic names for length increments SUL, MUL, and LUL on page 188

Tips for working with units on page 189

Basic unit concepts

Units are specified at two different levels in SynerGEE:

In the interface. In the Preferences editor, you can select the units system that you use in
SynerGEE. This preference setting affects most of the editors, wizards, and reports that are
included in the SynerGEE interface. For more information on setting this option, see Setting units of
measurement on page 165.

In a data source. Each data source also has its own global units setting, which allows SynerGEE to
determine the units system within that entire data source. In Access, this setting is found in the
SAI_Control and SAI_Equ_Control tables. For detailed information on the control tables, see Units
conversion and control tables on page 187.

All units displayed within the SynerGEE interface will use the same system, just as all data included in any
given data source must use the same system. The two units systems, however, do not need to be the same.
SynerGEE will automatically convert between the two different units systems when you load and save
SynerGEE data.
Refer to the topics listed below for more information.

Automatic conversion and the importance of internal units on page 186

Units conversion and control tables on page 187

Rules for conversion during a save on page 188

Automatic conversion and the importance of internal units

A key concept regarding SynerGEE units is the use of independent internal units while processing or storing
data in memory. All numbers stored and processed within SynerGEE use this internal units system, which is
invisible to you as the user. You only see the data after it has been converted to your preferred units, either
when it is displayed in the interface, or sent to a data source during a save operation. You never see the data
in terms of the internal units.
The following diagram illustrates the general internal process of units conversion during data transactions:

Data source
on disk

Converter
(using SAI_Control
table settings)

SynerGEE
internal units

Converter
(using preferences
settings)

SynerGEE
user interface
(editors, etc.)

Overall diagram of units conversion

In the diagram, you can see that two distinct conversion processes take place during normal SynerGEE
usage:

User Guide

SynerGEE Electric 5.0

Using SynerGEE

187

The conversion from the data source units to internal units. This occurs when data is loaded (and
also when data is saved).

The conversion from internal units to user-preference units. This occurs any time data must be
displayed in an editor or a report (and also when you are required to enter data in SynerGEE).

The independence of internal units makes SynerGEE very flexible for converting between different units
systems. As soon as data is loaded, it is converted to internal units. All internal data uses the same internal
system regardless of the original source units, meaning that SynerGEE can load and merge data from any
combination of sources using different systems. In fact, after loading the data, the original source units are
largely irrelevant until SynerGEE saves data back to the source, at which time the appropriate conversion
occurs again. Through this process, you could merge an English kFeet data source with a metric data
source, and display the data in the interface in English miles, without compromising any data integrity.
Afterwards, you could save the merged data to any system you prefer, especially if you create a new data
source.

Metric data
source

Converter

SynerGEE
internal units
English kFt
data source

Converter

SynerGEE interface
(displaying English
miles)

Converter

Units conversion when loading from different data sources

Units conversion and control tables

Any given data source must use a single units system exclusively. To indicate the system within a particular
data source, SynerGEE uses a setting within the control table.
Among other settings, a data source control table records the units system to which all its data adheres.
Then, when SynerGEE transacts with the source, it can determine the system and perform conversions
appropriately. Depending on the type of data source, SynerGEE uses two different control tables:

SAI_Control Control table for a model data source. When model data is loaded or saved, this table
is read. If a new model data source is created, this table is created within it.

SAI_Equ_Control Control table for an equipment data source. When equipment data is loaded or
saved, this table is read. If a new equipment data source is created, this table is created within it.

Generally, all of your data sources should use the same system, and this is especially true if you store both
model data and equipment data in the same database. Both tables store the length units system in the
LengthUnits field, which can be one of the following values:

English English system (based in kFeet)

English2 English system (based in miles)

Metric Metric system

Once a data source is written, it is very important that you do not alter this field within the control table.
Changing this field does not cause SynerGEE to automatically convert any values. Instead, it causes

SynerGEE Electric 5.0

User Guide

188

Using SynerGEE
SynerGEE to run the wrong converter on the existing data, causing unpredictable results. If you did manually
alter the control table, you would also need to manually convert every piece of length data accordingly.
SynerGEE has no tools to automatically convert the units within an existing data source. To perform a
source-wide conversion, you must load the entire source, set your preferences to the desired system, and
then save the data to a new source. The units system in the new source will reflect your preference settings.

Rules for conversion during a save

During a save action, SynerGEE attempts to determine the existing system within the data source by reading
the control table. If an existing system can be determined, SynerGEE saves all numbers according to that
system. If the control table is not present or you are saving to an entirely new data source, SynerGEE uses
the same system as your display preferences, and establishes that system in a new control table.
For more information on the role of the control table, see Units conversion and control tables on page 187.

Generic names for length increments SUL, MUL, and

LUL
For any units system, SynerGEE recognizes three quantities of length. For example, if you work in the
English miles system, the only units you see in the interface are inches, feet, and miles. For schema and
categorization purposes, these quantities are often referred to generically as the following:

SUL Short unit of length

MUL Medium unit of length

LUL Long unit of length

These generic descriptions allow important standardizations within SynerGEE, including a common, intuitive
data source schema for all units systems. As an example, in the InstSection table in Access, you can find the
following field:
SectionLength_MUL

This name, with the generic quantity suffix, was chosen for this field because:

SectionLength does not indicate the unit, which is important for a user attempting to directly
populate this value

SectionLength_Feet restricts the schemas intuitiveness to the English system.

Therefore, in the data source schema and certain other places, SynerGEE uses the SUL, MUL, and LUL
convention exclusively to keep the core functionality generic and localizable.
The following table details the actual units applicable to the three generic quantities, per system:
English (miles)

English (kFeet)

Metric

SUL

inches

inches

centimeters

MUL

feet

feet

meters

LUL

miles

kFeet (1000 ft)

kilometers

User Guide

SynerGEE Electric 5.0

Using SynerGEE

189

Remember that in a data source, SynerGEE expects units as specified in the control table. For example, if a
field specifically calls for SUL units, and the control table specifies Metric, SynerGEE will assume the value to
be in centimeters. For more information on control tables, see Units conversion and control tables on
page 187.

Tips for working with units

In a database, do not manually configure the SAI_Control or SAI_Equ_Control table contents,

unless you are also prepared to manually convert every piece of measurement data in the database.
If the fields indicating the units system are changed, SynerGEE assumes that the database contains
data in the new units. No automatic conversion takes place if you change these tables.

You can change the units system in your preferences at any time, and data shown in the editors and
on the map updates instantly and automatically. However, analysis reports are static and do not
change. If you change your units after generating a needed report, you should run the analysis
again to regenerate the report.

On the map, SynerGEE uses an X and Y coordinate system in feet or meters, depending on the
units system in your preferences. Likewise, when background images are imported, they must
include coordinate data so that SynerGEE can properly position them. Therefore, you should be
sure that the image coordinates match the units system of SynerGEE. If they do not, images will
likely be improperly positioned. This consideration is especially important if you import background
landbase maps for the purposes of tracing your distribution system.

SETTINGS GROUPS AND SETTINGS FILES

SynerGEE uses a wide variety of settings stored in many different places. Settings groups contain defined
collections of settings and allow you to store and retrieve whole settings configurations at once. Available
settings groups include the following:

Application settings. Application settings include all settings that are associated with SynerGEE
analyses and other applications. For example, all of your fault analysis settings are part of an
application settings group.

Map settings. Map settings include all settings that are associated with the map display, except for
background images. These settings include coloring options, flow arrow display, annotations, and
zoom settings.

Geobackground. Geobackground settings are settings associated with background images. A

Geobackground settings group is essentially a set of images that you can display at once by
activating a single settings group.

Feature Lock. A feature lock settings file saves your current feature lock configuration, as set in the
Preferences editor. Feature locks prevent changes from being made to specific aspects of
SynerGEE, by disabling the ability to edit selected features.

Settings files provide the convenience of reconfiguring significant parts of SynerGEE with a single, simple
operation. Settings groups also provide the ability to share settings within your organization, by sharing the
settings files.
Refer to the topics listed below for more information.

SynerGEE Electric 5.0

User Guide

190

Using SynerGEE

Managing settings groups in SynerGEE on page 190

Settings files details on page 191

Managing settings groups in SynerGEE

You can maintain as many different settings groups as needed with the SynerGEE Settings Manager. You
can save or load settings using an existing group, or save current settings to a new group.
The Default settings group in each category is the group that is used when SynerGEE starts up. If you save
to it, you are effectively changing your startup defaults. If a defaults file does not exist when SynerGEE shuts
down, SynerGEE regenerates it with current settings.
Refer to the procedures listed below for more information.

To manage settings groups on page 190

To restore startup default settings to factory settings on page 191

TO MANAGE SETTINGS GROUPS

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Settings.

Use the options in the Settings Manager to perform the following tasks.
To ...
Create a new settings group

Load a settings group

User Guide

Do This ...
a

Under Settings Group, select the category for the

settings group that you want to create. Available
choices are Application, Map, Geobackground, and
Feature Lock.

In the settings group text box, type the name of the new
settings group that you want to create.

Click Save. The new settings group is added to the list

of available groups.

Under Settings Group, select the category for the

settings group that you want to load. Available choices
are Application, Map, Geobackground, and Feature
Lock.

In the list of settings groups, select the name of the

settings group that you want to load.

Click Load.

SynerGEE Electric 5.0

Using SynerGEE

191

To ...

Do This ...

Save an existing settings

group

Delete a settings group

Under Settings Group, select the category for the

settings group that you want to save. Available choices
are Application, Map, Geobackground, and Feature
Lock.

In the settings group list, select the name of the settings

group that you are saving.

Click Save.

Click Yes to confirm the save.

Under Settings Group, select the category for the

settings group that you want to delete. Available
choices are Application, Map, Geobackground, and
Feature Lock.

In the list of settings groups, select the settings group

that you want to delete.

Click Delete.

Click Yes to confirm the deletion.

Click OK to accept your changes and close the Settings Manager.

TO RESTORE STARTUP DEFAULT SETTINGS TO FACTORY SETTINGS

1

Shut down SynerGEE.

Delete the defaults files that correspond to the settings groups you want to restore. For example, if
you are trying to restore your map settings, you should delete Default.DispSet. For more information
on defaults files and their locations, see Settings files details on page 191.

Start SynerGEE. Because the default settings group from step 2 does not exist, SynerGEE will use
internal factory defaults to configure the applicable settings.

Shut down SynerGEE again. In doing so, SynerGEE will now create the missing defaults file(s)
using the current SynerGEE settings, which also happen to be the default factory settings.

Settings files details

Each settings group type is stored in its own file type. These files are maintained by default in your Settings
file directory, which is defined in the Paths tab of the Preferences editor. Each settings group file can be
identified by its respective file extension, as defined below.
File extension

Settings group

*.AppSet

Application settings

*.AppSet_xml

Application settings in XML format

SynerGEE Electric 5.0

User Guide

192

Using SynerGEE

File extension

Settings group

*.DispSet

Map display settings

*.GbTileSet

Geobackground image (tile) settings

*.FeatureLock

Feature Lock settings

SynerGEE always maintains default files for each settings group in your Settings file directory. These default
files are named Default.AppSet, Default.DispSet, Default.GbTileSet, and Default.FeatureLock. The default
files are read during startup to retrieve initial settings. These files are never written to automatically, so your
startup defaults will not change unless you manually change them. If you delete a defaults file, SynerGEE will
regenerate it with current settings during the next shutdown. You can use this method to restore the defaults
file to the original SynerGEE settings, should you happen to overwrite your Defaults file by mistake. For more
information, see To restore startup default settings to factory settings on page 191.
Settings files can be shared with other SynerGEE users to help maintain organizational consistency. To
share a settings file, copy and paste it from your Settings file directory to another users Settings file directory.
For more information on editing path locations, see Defining file paths on page 167.

USING THE BULK EDITOR

The Bulk Editor provides a convenient area where you can view and edit loads of several different types,
including capacitor loads, large customer loads, and spot loads. Refer to the following procedure for more
information.

TO USE THE BULK EDITOR

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Edit group, select the text Bulk Editor and then select the type of load that you want to edit.
Available choices are as follows:

User Guide

Capacitors

Large Customers

Spot Loads

The Bulk Editor lists all of the applicable load values for each section or device of the selected type
in your model. You can perform several tasks directly from the Bulk Editor, including the following:
-

Open the SynerGEE editor for a section or device. In the Description column, click the
name of any section or device to open the applicable SynerGEE editor.

Edit loads for the section or device. Select any cell in the Bulk Editor and then type a new
value for the selected load. If both the SynerGEE editor and the Bulk Editor are open at the
same time, you will see your edits applied automatically as you edit loads in either editor.

Filter the list of sections or devices. Click in the filter area and type the text to filter for, and
then click the Filter button. Delete the text you typed and click the Filter button again to
remove the filter. The filter field is not case-sensitive.

SynerGEE Electric 5.0

Using SynerGEE

193
Several special characters are available for use with the SynerGEE filter. For example, < or
> will filter for items greater or less than the given value. In addition, != will filter for items
that do not equal the given value. And, * is a wildcard filter that will filter for results that
contain the given syntax anywhere in its name or value.
-

Apply custom coloring to the values in the Bulk Editor. Use the grid at the top of the
SynerGEE editor to create custom rules to color load values that are greater than, less
than, or equal to a specified value.

USING THE SYNERGEE MAINTENANCE WIZARD

The SynerGEE Maintenance Wizard allows you to perform the following tasks:

Clear the SynerGEE registry. Select this option to clear all settings related to SynerGEE Electric
from your computers registry. Note that SynerGEE will automatically shut down as a part of this
process. You must make sure that you manually save any unsaved model data before you perform
this procedure.

Set the maximum number of locks in an Access database. When saving a large model to Access,
locks are placed on records while they are read from or written to the database. If the number of
locks exceeds the default maximum value of 9,500, a message box will display and the model will
not be saved. Select this option to edit the registry to change the maximum number of locks to
100,000, which is sufficient to save a large SynerGEE model.

Refer to the following procedure for more information.

TO CLEAR THE REGISTRY

1

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, select Maintenance Wizard.

Select the appropriate check boxes to perform the following tasks:

-

Clear SynerGEE settings from the registry

Set max number of locks for Access db to 100,000

Click Finish. Note that if you select the Clear SynerGEE settings from the registry option,
SynerGEE will immediately shut down, after which you can start a new SynerGEE session.

SynerGEE Electric 5.0

User Guide

194

User Guide

Using SynerGEE

SynerGEE Electric 5.0

CHAPTER

4
Working with the
Map Display
The SynerGEE map provides a geospatial representation of your model. The map is based on the geography
and scale of your system, as defined in your model data.
The SynerGEE map provides many more features than traditional maps, including the following:

Extensive control over symbology, coloring, and line styles based on many different possible
parameters, including construction characteristics and analysis results.

A comprehensive set of navigational and zooming features, including the ability to bookmark
specific areas with views and points of interest.

Quick editing of model data, by allowing you to produce an editor by double-clicking on any object in
the map display.

A thorough understanding of the map, especially coloring and annotation features, will improve your
productivity with SynerGEE. Refer to the topics listed below for more information.

Using the Map Display on page 196

Customizing the Map Display on page 200

Selecting a Coloring Scheme for Sections on page 216

Areas of Interest on page 217

Location Links on page 223

Labels on page 225

Mobile Items on page 229

Legend on page 231

Views on page 231

Background Images on page 232

Schematic View on page 233

Geography View on page 239

Show Manager on page 242

SynerGEE Electric 5.0

User Guide

196

Working with the Map Display

USING THE MAP DISPLAY

Refer to the topics listed below for general information on working in the map display.

Zooming on page 196

Panning on page 197

Rotating the map on page 198

Measuring distances on page 198

Disabling node editing on page 199

Refreshing the map display on page 199

Toggling map details on page 199

Changing the zoom direction of the mouse scroll wheel on page 200

Zooming
Zooming enlarges and reduces the scale of your map display, allowing you to focus on a small area of the
model or view the entire map at one time. As you zoom in and out of the map display, certain features in the
map may change based on your SynerGEE settings. For example, in the Zoom tab of the Map Settings
editor, you can specify the scale at which selected map display symbols are displayed. This allows you to
reduce map clutter when you are zoomed out from your model, but see detail when you have zoomed in to
the model.
The following table describes how to perform various zoom operations from the SynerGEE ribbon bar and
also the right-click menu in the SynerGEE map display, as well as by using the buttons on your mouse.
NAVIGATE tab ribbon
bar button

Right-click menu

Description

In

Zoom > In

Zooms in at the location of the mouse click.

Tip:

Out

Zoom > Out

Zooms out at the location of the mouse click.

Tip:

Rectangle

Zoom > Rectangle

User Guide

Zoom > Previous

You can also press and hold the Shift key

and then click the left mouse button, or
use the mouse scroll wheel, to zoom out
of the map display.

Zooms in to the boundaries specified by a clickand-drag action.

Tip:

Previous

You can also use the mouse scroll wheel

to zoom into the map display.

You can also press and hold the Ctrl key

and then click and drag the left mouse
button to create a zoom box.

Returns to the previous view.

SynerGEE Electric 5.0

Working with the Map Display

197

NAVIGATE tab ribbon

bar button

Right-click menu

Description

Go To X,Y

Zoom > Go To X,Y

Zooms to X, Y coordinates that you specify in the

Go To X, Y dialog box.

Network Bounds

Zoom > Network

Bounds

Zooms to the extents of the entire active model.

Map Bounds

Zoom > Map Bounds

Zooms to all active models and their borders.

Background Bounds

Zoom > Background

Bounds

Zooms to the extents of the background image. If

no background images are loaded, this option is
disabled.

Item in Editor

Zoom > Item in Editor

Zooms to the section or device that is open in the

editor. If the section or device editor is not open,
this option will be disabled.

Magnifier

Zoom > Magnifier

Creates a special magnifying glass area in the

map display.

Zoom (in the Analysis

Section group)

Zoom > Analysis

Section

Click and drag the magnifying glass to

move it around the map.

Click in the magnifying glass area and use

the scroll wheel to zoom in and out of the
magnified area. Click on the main map
and use the scroll wheel to zoom in and
out of the main map display.

Zooms to the section that has been selected for

analysis.

Panning
Panning allows you to move the map up, down, left, or right to view different areas of your map display. You
can use the mouse or the arrow keys to pan the map display.

TO PAN USING THE MOUSE

1

In the SynerGEE ribbon bar, select the DISPLAY tab. In the Settings group, make sure the Drag
Panning button is selected (highlighted).

Select the BUILD tab. In the General group, select Default or press F5 to enter Default mode.

Click and hold the mouse in the map display, and then drag the mouse to pan to a new location.

TO PAN USING THE SCROLL WHEEL

Hold Shift and scroll the mouse wheel to pan the map left and right.

Hold Ctrl and scroll the mouse wheel to pan the map up and down.

SynerGEE Electric 5.0

User Guide

198

Working with the Map Display

TO PAN USING THE ARROW KEYS

1

Click anywhere in the map display to activate the map.

Using your keyboard, press the Up, Down, Left, or Right arrow key to pan the map display in the
selected direction.
Tip:

Panning with the keyboard is particularly helpful when you are drawing sections that
extend beyond the current map bounds. You can pan with the keyboard while you are
drawing the section with the mouse.

TO PAN USING THE MAP CENTERING MODE

1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Zoom group, click Pan Centering.

Click anywhere in the map display to center on that location.

Press F5 to exit pan centering mode.

Rotating the map

Perform the following procedure to rotate the map display. Note that raster images cannot be rotated. The
map rotation options will be disabled and the map rotation reset to zero if you add a raster image to the map
background.

TO ROTATE THE MAP

1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Zoom group, click Clockwise or Counterclockwise, depending on which direction you want
to rotate the map.

Click in the map display to rotate the map in the selected direction. Click again to continue rotating
the map.

Press F5 to exit map rotation mode.

Measuring distances
Perform the following procedure to measure the distance between different points in the SynerGEE map
display.

TO MEASURE DISTANCES IN THE SYNERGEE MAP DISPLAY

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the General group, click the Map Measure button or press Ctrl+M to enter the map measurement
mode.

Click on the first point in the map display to begin the measurement. A dotted line will appear as you
move the mouse away from the point you clicked. The distance from the starting point to the current
mouse location is displayed in the status bar, in both feet and miles.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

199

Click the left mouse button to add a vertex point to the measurement. Each time the left mouse
button is clicked, another vertex point will be added. The distance shown in the status bar will be the
sum of your measurements, including the distance in each vertex that you have created.

Press Esc to end the current measurement.

Press F5 to exit map measurement mode.

Disabling node editing

Like any other SynerGEE object, you can double-click on nodes in the map display to launch the Node editor.
However, because nodes are rarely edited, you can disable the ability to open the node editor from map
display. This can make it easier to edit devices and sections, especially in a congested model.

TO ENABLE/DISABLE NODE EDITING FROM THE MAP

1

In the SynerGEE ribbon bar, select the DISPLAY tab.

In the Settings group, click the Allow Node Selection button. When the option is selected
(highlighted), nodes are visible in the map display and can be edited by double-clicking on them.
When the option is not selected (not highlighted), nodes are not visible and the node editor cannot
be opened in this manner.

Refreshing the map display

Refer to the following procedure to refresh (redraw) the map display. Normally the map is refreshed
automatically after most edit actions, but it may sometimes be necessary to refresh manually.

TO REFRESH (REDRAW) THE MAP DISPLAY

In the SynerGEE ribbon bar, select the DISPLAY tab. In the Tools group, click Refresh.
or
Press F11 on your keyboard.

Toggling map details

SynerGEEs map toggle feature can be used to quickly hide details on your SynerGEE map display,
including the equipment symbols and custom labels. When these details are hidden, only the sections and a
few key symbols, such as feeder and subtran symbols, will remain in view.
This feature is for display purposes only. All equipment is still considered during analysis.

TO TOGGLE THE MAP DETAILS

1

In the SynerGEE ribbon bar, select the DISPLAY tab.

In the Tools group, click Details or press F3 on your keyboard.

SynerGEE Electric 5.0

User Guide

200

Working with the Map Display

Changing the zoom direction of the mouse scroll wheel

In SynerGEE versions prior to 4.0, the map display would zoom in when you scrolled the mouse wheel
upward, and zoom out when you scrolled the mouse wheel downward. ESRI applications, however, behave
in the opposite manner. The ESRI map display zooms out when you scroll up, and zooms in when you scroll
down.
With the introduction of the ESRI-based Geography view in SynerGEE Electric 4.0, it was necessary to
change the behavior of the mouse scroll wheel so that both the traditional SynerGEE map display and the
newer, ESRI-based Geography view would scroll in the same direction. Rather than make an arbitrary
decision on which direction to scroll, an option was added to the Preferences editor to allow you to select the
scroll direction. Take note that if you set this option to the traditional SynerGEE behavior, it will change the
scroll direction for all ESRI applications on your computer. The scroll direction is not an independent variable
that can be set in SynerGEE alone.
Refer to the following procedure for more information on setting the mouse scroll option.

TO CHANGE THE ZOOM DIRECTION OF THE MOUSE SCROLL WHEEL

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the Map tab.

Under Mouse Roll Wheel Up, select one of the following options to set the direction of the mouse
wheel when you scroll it in the upward direction:

Zoom In. Select this option to zoom in to the map when you scroll the mouse wheel
upward.

Zoom Out. Select this option to zoom out from the map when you scroll the mouse wheel
upward.

Click OK to accept the change and close the Preferences editor.

CUSTOMIZING THE MAP DISPLAY

A majority of the built-in map customization options are available from the Map Settings editor. The map
settings provide control over a number of different customization features, including:

Line styles and colors

Equipment symbols, colors, and visibility

Flow arrows and other annotations

Tiles (background images)

Refer to the following procedure for more information on customizing the map display using the Map Settings
editor.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

201

TO CUSTOMIZE THE MAP DISPLAY

1

Open the Map Settings editor by using any of the following methods:
-

In the SynerGEE ribbon bar, select the DISPLAY tab. Then, in the Tools group, click
Settings.

Double-click in any empty location in the SynerGEE map display.

Press the F9 key on your keyboard.

On the left side of the Map Settings editor, select from the different tab names to access the
available map display settings. The following procedures describe the different tasks that you can
perform:
-

Configuring the map display style on page 201

Adding section and device annotation to the map display on page 207

Adding annotation based on analysis results on page 208

Customizing section colors and sizes based on analysis results on page 210

Customizing device colors and sizes based on analysis results on page 211

Defining Color By colors on page 212

Configuring map display symbols on page 213

Configuring visibility levels for map display symbols on page 214

Showing the map display grid on page 215

You can also configure background images, as described in Background Images on page 232.
3

Click Apply to accept your changes, and then click X to close the editor.

Configuring the map display style

The Style tab in the Map Settings editor allows you to set up a number of map customization features. You
can select a color-by scheme to apply to the map display, and you can use the Views setting to determine
which feeders are displayed on the map. You can also set the background color, specify whether flow arrows
are shown, and set the line style for one-, two-, and three-phase lines.
Refer to the following procedure for more information.

TO CONFIGURE THE MAP DISPLAY STYLE

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Style tab.

SynerGEE Electric 5.0

User Guide

202

Working with the Map Display

3

Use the options in the Style tab to customize the map display. Refer to the following table for
information on the tasks you can perform.
To ...

Do This ...

Select a color-by scheme

Click Color By and then select the specific coloring scheme that
you want to apply. The active Color By scheme also applies to
any open schematics.
Tips:

You can also enable the color-by scheme from the

Legend tab of the model explorer, and you can create
coloring schemes with recipes. For more information on
recipes, see Recipe Scripts on page 700.
You can also set up customized coloring schemes
based on analysis results using in the Theme tab in the
Map Settings editor, and device results using the
Facilities tab. For more information, see Customizing
section colors and sizes based on analysis results on
page 210 and Customizing device colors and sizes
based on analysis results on page 211, respectively.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

203

To ...

Do This ...

Select a feeder view mode

Click View Mode and then select the specific view mode that you
want to apply. The view mode determines which feeders appear
in the map display. It works in conjunction with the feeder
selection set, as described in Selecting Feeders on page 157.
The following view modes are available:

Adjacent Feeders. SynerGEE displays selected

feeders using the colors defined in the Feeder editor.
Unselected adjacent feeders in are shown in
SynerGEEs non-selected color, which by default is
gray. (This color can be changed in the Color tab of the
Map Settings editor.)

All Feeders. SynerGEE displays selected feeders and

any unselected feeders from the same substation(s) as
selected feeders. Selected feeders are using the colors
defined in the Feeder editor, while unselected feeders
are shown in SynerGEEs non-selected color, which
by default is gray. (This color can be changed in the
Color tab of the Map Settings editor.).

Regional Feeders. SynerGEE displays selected

feeders using the colors defined in the Feeder editor.
Any other feeders in the region are shown in
SynerGEEs non-selected color, which by default is
gray. (This color can be changed in the Color tab of the
Map Settings editor.).

Selected Feeders. SynerGEE displays selected

feeders only, using the colors defined in the Feeder
editor.

All Switching. SynerGEE displays only those sections

that are along the paths from open switches back to the
feeders.

Xfer Switching. SynerGEE displays only those

sections that are along the paths from transfer switches
back to the feeders.

You can also select the feeder view mode from the DISPLAY tab
of the SynerGEE ribbon bar.

SynerGEE Electric 5.0

User Guide

204

Working with the Map Display

To ...

Do This ...

Simplify the map display

Several options allow you to quickly and easily remove clutter

from the map display. These include the following:

Black & White mode. Select this check box to remove

all coloring from the map display. The background of the
map will turn white, while the model, symbols, text, and
nodes will turn in black. This mode is designed to make
the map display easy to print. When you are finished
with black-and-white mode, clear the check box to
return the map display to the original color schemes.
Tip:

You can also set the black and white mode

from the DISPLAY tab in the SynerGEE ribbon
bar. In the Settings group, click the Black and
White Mode button.

Hide Details. Select this check box to hide all of the

device symbols (switches, fuses, amp meters, and so
on) in the map display, leaving only the line sections.
You can perform this same function by pressing F3 or
by clicking the Details button in the DISPLAY tab of the
SynerGEE ribbon bar.
SynerGEE will also hide details automatically in some
extreme circumstances, such as when a model is
loaded that adds 30,000 or more sections to the set of
selected sections. This is done to improve the loading
time of the model. When this occurs, you can re-enable
the map details through any of the methods described
here.

User Guide

Hide sections fed by fuse. Select this check box to

hide all sections that are downstream from a fuse.

Hide sections rated < X amps. Select this check box

to hide all sections that are rated below a specified amp
value. Summer and winter continuous ratings are used.

Show only. Select this check box and then expand the
options list to select specific facility types that you want
to display. Map display symbols for any unselected
device types will be hidden from view in the map.

SynerGEE Electric 5.0

Working with the Map Display

205

To ...

Do This ...

Show flow arrows

Use the Arrows option list to select the arrow category that you
want to display. Flow arrows can provide a helpful visual display
of power flow or model topology. For example, select Real
Power Flow to display arrows pointing in the direction of the
power flow on the map. To hide flow arrows, select the No
Arrows option.
In addition, you can use the number box next to the Arrows
options list to specify a size for your flow arrows. The default size
is 20.
You can also select the flow arrow option from the DISPLAY tab
of the SynerGEE ribbon bar.

Set the map background

color

In the Background Color section, next to Style, select the color

that you want to apply to the background of your map display.
You can also select a second color under Master and then select
and clear the Master check box to specify which of the two colors
is applied.
Tip:

You can also set the map background color from the
DISPLAY tab in the SynerGEE ribbon bar, in the
Background group.

Show text labels

Select the check box in the Text Labels section. Then, click the
Font button to select a font type, style, and size for the annotated
text.

Show feeder boxes

Click the Show feeder boxes check box. Feeder boxes will be
shown with a dotted outline in the map display.

Highlight the section that is

selected for analysis

Click the Show selected section check box. The section that is
selected for analysis (as described in Setting a section for
analysis on page 434) will be indicated with a thicker line than
the other sections in the map display.
Tip:

Highlight the sections that

are in the queried set

Click the Highlight Queried Area check box. Any sections that
are in the query set will be highlighted in the SynerGEE map
display using SynerGEEs query set color, which by default is
gray. (This color can be changed in the Color tab of the Map
Settings editor.)
Tip:

SynerGEE Electric 5.0

You can also change the color of the selected section in

the Color tab of the Map Settings editor.

This check box is also available in the Query Path

editor.

User Guide

206

Working with the Map Display

To ...

Do This ...

Customize the appearance

of line sections

In the Line Styles section, select a style that you want to use to
show the lines in your model, and also the specific line styles for
three different categories within the selected style.

Phasing. Select this option to apply unique line styles

for three-phase, two-phase, and single-phase lines.

Overhead/Underground. Select this option to apply

unique line styles for overhead, underground, and
underground lateral lines.

Switch Path. Select this option to apply unique line

styles for transfer lines, feeder only lines, and laterals.

Feeder Tier. Select this option to apply unique line

styles for the first half of a feeder, the second half of a
feeder, and laterals.

Note that the selected line styles are not affected by the zoom
level.
Specify how unfed items are
shown

Show polygons

Show display symbols for

specific devices only

In the Unfed Items section, select from one of the following

options:

Show All. All unfed items will be shown.

Selection Extents. The display of unfed items will be

restricted to those within the extents of the selected
feeders. Essentially, if you drew a box around all
selected feeders, only those items within that box would
be shown (within a 10% buffer).

Hide All. All unfed items will be hidden.

In the Show Polygons section, select the appropriate check

boxes for each polygon type that you want to display. Available
choices are as follows:

Growth areas

Speculative loads

Areas of interest

Next to Show only, click the options list and then select the
check box for each map display symbol that you want to show.
Unchecked items will be hidden in the map display but still be
available for editing (for example, through the model explorer).
You can also select this option from the DISPLAY tab of the
SynerGEE ribbon bar.

User Guide

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Working with the Map Display

207

Adding section and device annotation to the map

display
SynerGEE allows flexible and extensive annotation to be placed on the map. You can annotate both sections
and equipment types, or only selected sections and equipment types, if desired. You can customize the
rotation angle for each annotation category, and you can also customize the font type, size, and color for all
annotation.
Refer to the following procedure for more information.

TO ADD SECTION AND DEVICE ANNOTATION TO THE MAP DISPLAY

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Text tab.

Clear the Hide All Annotation text box.

Use the rest of the settings in the Text tab to set up annotation for selected sections and equipment
types. The following table describes the different tasks you can perform.
To ...

Do This ...

Enable section and/or

equipment annotation

Select the check boxes next to the Section Information and

Equipment Information headings, as appropriate. Then, use
the options list to select the data type that you want to annotate.
For example, for a section, you can select Section ID,
Description, Phasing, or several other options. You can also use
the Rotation options list to set the rotation of the annotated text.

SynerGEE Electric 5.0

User Guide

208

Working with the Map Display

To ...

Do This ...

Specify which sections and

equipment types are
annotated

In the General Settings section, select from any of the following

options:

Customize the annotation

font

Only Annotate Queried Items. Select this check box to

show section annotation for queried sections only.

Just Ends and Junctions. Select this check box to

only show section annotation for sections that feed
more than one downstream section or feed no sections
at all.

Only Annotate Sections With. Select this check box to

only show section annotation for sections with selected
facility types, such as those that include breakers,
capacitors, or fuses. Use the options list to select the
facility types for the sections that you want to annotate.
You can select as many facility types as necessary.

Only Annotate Equipment of Type. Select this check

box to only show equipment annotation for specific
facility types. Use the options list to select the facility
types that you want to annotate, such as breakers,
capacitors, and fuses. You can select as many facility
types as necessary.

In the Section and Equipment Font section, click the Font button
to select a font type, style, and size for the annotated text. In
addition, you can select the Use Custom Color check box to
specify a custom color for the annotated text.

Click Apply to accept your changes, and then click X to close the editor.

Adding annotation based on analysis results

Use the Results tab in the Map Settings editor to configure section annotation based on analysis results. You
can enable up to three lines of analysis results categories, each with a different font color. You can also
customize the font type, size, and rotation angle for all three results annotation categories.
Refer to the following procedure for more information on how to set up the analysis results annotation. You
must first perform the desired analysis before you can complete this procedure.

TO SET UP ANNOTATION BASED ON ANALYSIS RESULTS

1

Double-click anywhere in the map display to open the Map Settings editor.

In the Map Settings editor, select Text. Make sure that the Hide All Annotation text box is not
selected.

Select the Results tab.

Select the check box next to Show Section Results.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

5

209

Use the rest of the settings in the Show Section Results section to set up section result annotation
for up to three analysis results categories. The following table describes the different tasks you can
perform.
To ...

Do This ...

Set up section result

annotations

Select from one to three check boxes to enable the section

results lines. For each line, select a results category from the
options list, and also a color for the corresponding text annotation
in the map display. You can also use the Rotation button to set
the rotation of the text in the map display, and the Font button to
change the font type, style, and size.
If you select the Use Phasing check box, the three available
results slots will be phase-specific, meaning that the result is only
displayed if the corresponding phase exists on the respective
section. If you use this setting, the phasing of the selected
analysis results type should correspond to the phasing of the
respective slot. For example, the results type that you select in
the first slot should be a phase A result.

Hide all zero and null values

Select the Hide 0.00s check box. If a results parameter is

specific to a phase that does not exist on a section, it will be
considered a zero value and hidden. For example, if you have
Phase A Amps specified for display on a phase B section, the
result will be zero, and thus hidden if you select this option.

Specify the number of

decimal places

Select the Specify decimal places check box and then specify a
decimal value from 0 to 4. If you set the value to 0, the section
results data will be rounded to the nearest whole numbers.

Show results at specified

distance intervals only

Select the Limit result display check box and then specify the
distance interval at which you want results to display.

Specify a range of values

within which results will be
displayed

Select the Restrict to value interval check box and then specify
the minimum and maximum values for the results you want to
display.

Limit the result annotation to

tagged sections only

Select the Only show Tagged sections check box if you want to
display the analysis results for tagged sections only.
Tagging is a way to temporarily identify key sections and devices
that you want to work with. You can tag a section or facility by
right-clicking on it in the SynerGEE map display or model
explorer and selecting the Tag option. For more information, see
Tagging Sections and Facilities on page 172.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

210

Working with the Map Display

Customizing section colors and sizes based on analysis

results
Use the Theme tab in the Map Settings editor to customize section colors and sizes based on analysis
results. You can set up six results ranges with either automatic or custom values. For each range, you can
optionally apply a unique color to the sections in the map display based on a selected analysis results
category. You can also modify the section line thickness, if desired. Values that are out of the defined range
can also be shown with an optional color and custom line thickness.
Refer to the following procedure for more information on how to set up the analysis results section coloring.
You must first perform the desired analysis before you can complete this procedure.

TO CUSTOMIZE SECTION COLORS AND SIZES BASED ON ANALYSIS RESULTS

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Theme tab.

Use the options list under Results for Thematic Mapping to select the analysis category that you
want to use to customize the section color and thickness.
Note:

If the options list is empty, then no analysis has been run and thus no results are available
to display.

Refer to the following table for the different tasks that you can perform from the Theme tab.
To ...
Set the analysis results
range (Max to Min) with
automatic intervals

Set the analysis results

range (Max to Min) with
custom intervals

User Guide

Do This ...
a

Select the Auto Intervals check box.

Click the Apply button. The Min and Max cells will
automatically be populated with the minimum and
maximum values for the selected analysis results type.
The values in the remaining analysis results range cells
will be evenly distributed between the Min and Max
values.

Clear the Auto Intervals check box.

Type the Max and Min values for the range that you
want to display.

Click Setup Max > Min. The values in the remaining

analysis results range cells will be evenly distributed
between the Min and Max values that you entered. If
desired, you can skip this step and simply type in the
remaining values directly into the text boxes.

SynerGEE Electric 5.0

Working with the Map Display

211

To ...

Do This ...

Set the analysis results

range colors

Use the Color options lists to select a color for each analysis
results range. If desired, you can click Invert Colors to reverse
the order of the six color choices, or you can click the Default
Colors button to reset the six color options to the default choices
as installed by SynerGEE. The Out-of-Range color is not affected
by these two buttons.
Tip:

Enable line sizes

You can also set the invert colors mode from the
DISPLAY tab in the SynerGEE ribbon bar. In the
Settings group, click the Invert Colors button.
a

Select the Apply Line Widths check box.

Select a line width value for each analysis results range.

Tip:

Clear the list of analysis

result categories
5

Set a line width to zero to hide that results

range in the map display.

Click Clear Results.

Click Apply to accept your changes, and then click X to close the editor.

Customizing device colors and sizes based on analysis

results
Use the Facilities tab in the Map Settings editor to customize device colors and sizes based on analysis
results. You can set up four results ranges with either automatic or custom values. For each range, you can
specify the map display color and size for the symbols of that result type. You can also enable circles in the
map display to further highlight the devices. Values that are out of the defined range can also be shown with
a unique custom color and symbol size.
Refer to the following procedure for more information on how to set up the device result symbols. You must
first perform the desired analysis before you can complete this procedure.

TO CUSTOMIZE DEVICE COLORS AND SIZES BASED ON ANALYSIS RESULTS

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Facilities tab.

Select the Color By Device Results check box to enable the Color By Device Results feature, and
to enable the remaining fields in the Facilities tab.

Use the options list under Color By Device Results to select which device results category you
want to use to add color and symbols to the map.

SynerGEE Electric 5.0

User Guide

212

Working with the Map Display

5

Refer to the following table for the different tasks that you can perform in the Facilities tab.
To ...

Do This ...

Set the device range (Max to

Min) with automatic intervals

Set the device range (Max to

Min) with custom intervals

Select the Auto Intervals check box.

Click the Apply button. The Min and Max cells will
automatically be populated with the minimum and
maximum values for the selected device results type.
The values in the remaining device range cells will be
evenly distributed between the Min and Max values.

Clear the Auto Intervals check box.

Type the Max and Min values for the range that you
want to display.

Click Setup Max > Min. The values in the remaining

device range cells will be evenly distributed between the
Min and Max values that you entered. If desired, you
can skip this step and simply type in the remaining
values directly into the text boxes.

Set the device range colors

Use the Color options lists to select a color for each device
range. If desired, you can click Invert Colors to reverse the
order of the four color choices, or you can click the Default
Colors button to reset the four color options to the default
choices as installed by SynerGEE. The Out-of-Range color is not
affected by these two buttons.

Enable symbol sizes

Select the appropriate check box in the Symbol Size column and
then set the size value as appropriate.

Enable circle coloring and

size

Select the appropriate check box in the Circle Diameter column

and then set the diameter value as appropriate. You can also use
the Circle Thickness option to change the thickness of the circle
symbols that will be applied by this feature.

Click Apply to accept your changes, and then click X to close the editor.

Defining Color By colors

Use the Color tab in the Map Settings editor to configure the colors that are used by most of the Color By
options in the SynerGEE map display. The Color By feature, which is enabled in the Style tab in the Map
Settings editor, allows you to color sections and devices based on your data settings or analysis results. For
example, in the Style tab, you can specify the map to be colored by Phases. In the Color tab, you can define
which colors are used for which phases: AN, BN, CN, etc. Or, you can specify the map to be colored by
Energize Year and then define a color associated with each of the available model years.
Note that some colors, such as feeder and zone colors, are specified in the respective editors, not in the
Color tab. For example, if you are coloring by customer zones, you must open the respective Customer Zone
editor to change the color that is used with the Color By scheme.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

213

Refer to the following procedure for more information.

TO DEFINE COLOR BY COLORS

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Color tab.

In the Colors for Mapping section, select the mapping category that you want to edit. In the bottom
of the editor, use the options list to select a new color for the selected category.

Click Apply to accept your changes, and then click X to close the editor.

Configuring map display symbols

All map display symbols are controlled from the Map Settings editor. For each device, equipment, and node
symbol category, you can edit which symbol is used in the SynerGEE map display, and also the size and
color of each symbol. You can also hide symbols from being shown the SynerGEE map display.
Refer to the following procedure for more information.

TO CONFIGURE MAP DISPLAY SYMBOLS

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Symbols tab.

In the Device Colors and Symbols section, select the device type that you want to edit and then
perform any of the following tasks:
To ...

Do This ...

Change the map display

symbol

Use the Symbol options list to select a new map display symbol.

Change the symbol size

Use the Size options list to select a new symbol size.

Change the symbol color

Use the Color options list to select a new symbol color.

Hide the symbol in the map

display

Select the Hide check box.

Enclose the map display

symbol in a circle

Select the Circle check box.

SynerGEE Electric 5.0

User Guide

214

Working with the Map Display

To ...

Do This ...

Copy the current settings to

memory

The Copy To Master and Copy From Master buttons allow

SynerGEE to remember and then reapply the current symbol
configuration. For example, assume that you want to apply a
temporary change to the map display symbols, and return those
symbols to your current settings when you are done. First, click
Copy To Master, before you make any changes. This will save
your original settings to memory. Then, make your changes as
appropriate, apply them to the model, and even close the Map
Settings editor. Later, you can return to the Symbols tab in the
Map Settings editor and click Copy From Master. The original
settings, before you made any edits, will be re-applied to your
model.

Click Apply to accept your changes, and then click X to close the editor.

Configuring visibility levels for map display symbols

In the SynerGEE map display, all symbols and text can be configured with independent zoom visibility
characteristics. Using this feature, you could specify that all capacitor symbols appear at one specified zoom
level, while all regulator symbols appear at another. You could also configure nodes to appear only at a
relatively high zoom level, to make the map display cleaner and faster when you have zoomed out from the
model.
These visibility levels are configured in the Zoom tab in the Map Settings editor. The Zoom tab lists a number
of categories for which visibility levels can be set, and also provides check boxes to enable or disable the
visibility feature for each category. When disabled, the corresponding map display symbols will display at all
zoom levels.

TO CONFIGURE ZOOM LEVELS FOR MAP DISPLAY SYMBOLS

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Zoom tab and then do the following:

To ...
Set a visibility level

Do This ...
a

In the list of display symbol categories, select the

display symbol category that you want to edit.

In the text box at the bottom of the Map Settings editor,

type the new zoom level at which map display symbols
for the selected category will be visible. Or, select the
Set to Current Zoom button (Figure 4-1) to set the
zoom level equal to the current zoom level in the map
display.

Figure 4-1 Set to Current Zoom button

User Guide

SynerGEE Electric 5.0

Working with the Map Display

To ...
Enable and disable visibility
levels

Copy the current settings to

memory

215

Do This ...
a

In the list of display symbols categories, select the map

display category that you want to edit.

Select the Enabled check box to enable the visibility

level. Or, clear the check box to disable the visibility
level (meaning that the corresponding map display
symbol will be visible at all zoom levels).

The Copy To Master and Copy From Master buttons allow

SynerGEE to remember and then reapply the current zoom
configuration. For example, assume that you want to apply a
temporary change to the zoom settings, and return to your
current settings when you are done. First, click Copy To Master,
before you make any changes. This will save your original
settings to memory. Then, make your changes as appropriate,
apply them to the model, and even close the Map Settings editor.
Later, you can return to the Zoom tab in the Map Settings editor
and click Copy From Master. The original settings, before you
made any edits, will be re-applied to your model.

Click Apply to accept your changes, and then click X to close the editor.

Showing the map display grid

The map display grid can be enabled and disabled from the Grid tab in the Map Settings editor. When the grid
is enabled, you can customize the grid style and line colors, and also the text colors for the grid axes.
Refer to the following procedure for more information.

TO SHOW THE GRID IN THE MAP DISPLAY

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Grid tab and then do the following:

To ...

Do This ...

Enable the grid

Select the Show Grid check box, and then use the Style and
Color options to configure the grid line style and color.

Enable tic marks for the

map display grid

Click the Tics button.

Enable grid lines for the map

display grid

Click the Lines button.

Customize the axis text

color

Next to Text Color, select a color for the grid lines in the map
display.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

216

Working with the Map Display

Tip:

You can also show and hide the grid from the DISPLAY tab in the SynerGEE ribbon bar. In
the Settings group, click the Map Grid button to show and hide the grid, as appropriate.

SELECTING A COLORING SCHEME FOR SECTIONS

SynerGEE provides powerful map coloring options to help you understand topology and interpret results. In
many cases, map coloring may can your preferred method of handling analysis results, rather than using
reports.
Most map coloring options are focused on sections, allowing you to use colors to quickly distinguish certain
model characteristics. When you perform certain SynerGEE actions, such as analysis runs and equipment
edits, colors often update automatically based on the selected scheme. Some of the color-by schemes that
you can select from include the following:

Conductor count. Different colors based on the number of conductors.

Exceptions. Special colors for sections that produced exceptions during analysis.

Feeders. Different colors for each selected feeder.

Results. Customizable colors based on specific analysis results.

Phases. Different colors for each type of phasing.

Elbow. Different colors that indicate no elbow on either end of the section, an end is open, or an end
is closed.

Most of the colors used in these color-by schemes are specified in the Color tab in the Map Settings editor.
For example, if you select the Color by: phases scheme, the colors that are used in the map for each phase
are defined in the Color tab. Other colors, such as feeder and zone colors, are specified in the respective
editors. For example, if you are coloring by customer zones, you must open the respective customer zone
editor to change the color for that zone. One exception is in regard to feeders and subtrans. Feeder and
subtrans colors are assigned in the respective device editors, as described in Modeling Feeders and
Subtrans on page 245.
Refer to the following procedure for more information on setting up a coloring scheme.

TO SET A COLORING SCHEME FOR SECTIONS

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Style tab.

Under Color By, select the method by which you want to color. For more information on working
with this option, see Configuring the map display style on page 201.

Click Apply to accept your changes, and then click X to close the editor.

Coloring by path type

In the Style tab of the Map Settings editor, you can choose to color sections by path type. This coloring
scheme is intended to help you see looped and wandering lateral configurations on the map. Sections
associated with loops and/or wandering laterals appear in unique colors, and for loops without a tie switch,

User Guide

SynerGEE Electric 5.0

Working with the Map Display

217

SynerGEE displays where it would simulate a tie switch during analysis, called an Internal Break. This
functionality allows you to evaluate where SynerGEE would break the loop for analysis purposes. If you
deem an internal break location as inappropriate, you can model a tie switch somewhere else to override this
break point. For more information on tie switches, see Loops and Wandering Laterals on page 253.
When you color by path type, you can also view force-unfed sections in a special color. Force unfed
sections are those to whom propagated phasing is insufficient for specified phasing. For example, a phase
AB section fed by a phase AN section is considered force-unfed. For more information on force-unfed
sections, see About force-unfed sections on page 263.

AREAS OF INTEREST
Areas of interest are two-dimensional geographic entities that you can draw on the SynerGEE map display to
represent areas of speculative or future load, or to simply indicate locations of interest, such as a lake or a
restricted area. Areas of interest are always associated with a particular section. SynerGEE chooses an initial
association based on geography, but you can change the association at any time, as described in
Associating an area of interest with a section on page 223.
If an area of interest represents a speculative load, load-flow-based analyses will consider the speculative
load component as a part of the associated section. The speculative load component is defined in the area of
interest editor.
Likewise, if an area of interest represents a future load, SynerGEEs forecasting analysis will consider the
spot and distribution load components as a part of the associated section. The spot and distribution load
components are also defined in the area of interest editor.
If the area of interest is only being used to represent a geographical area, then the load options are disabled
and the area of interest is not factored into any SynerGEE analysis.
Figure 4-2 shows an example of how an area of interest might appear in the SynerGEE map display.
SynerGEE allows you to edit a number of settings for each area of interest, including the shape, color, and fill
pattern.

Figure 4-2 Area of interest on the map

SynerGEE Electric 5.0

User Guide

218

Working with the Map Display

The following sections provide more information on creating and editing areas of interest:

Creating an area of interest on page 218

Reshaping and moving an area of interest on page 219

Editing the settings for an area of interest on page 220

Deleting an area of interest on page 223

Creating an area of interest

Areas of interest are created like many other devices in your model, by selecting an area of interest type in
the Warehouse tab of the model explorer and dragging-and-dropping it onto your SynerGEE map display.
You must drop the area of interest on a section in order for the area to be created.
Refer to the following procedure for more information on creating an area of interest.

TO CREATE AN AREA OF INTEREST

1

In the SynerGEE model explorer, select the Warehouse tab.

Under Area of Interest, select the name of the area of interest type that you want to create (Growth
Area, Speculative Load, or General) and drag it into the map display. (Note that you can change
the area of interest type after it has been added to the model.)

Without releasing the mouse button, drag the mouse to the section where you want to add the area
of interest. When the cursor changes to a crosshair (Figure 4-3), you can release the mouse button
to add the area of interest. Click Yes to confirm the action.

Figure 4-3 Creating an area of interest

By default, the new area of interest is created as a simple square, as shown in Figure 4-4.

Figure 4-4 New area of interest

To edit the shape of the area of interest, you must modify the graphic points or use the right-click
menu to redraw it. For more information, see Reshaping and moving an area of interest on
page 219.

To edit the settings for the area of interest, double-click the area to open the Area of Interest editor.
For more information, see Editing the settings for an area of interest on page 220.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

219

Reshaping and moving an area of interest

A new area of interest is added as a simple square at a selected section in your SynerGEE map display. You
will likely need to modify the area of interests shape and also move it to the proper location in your model
before you can use it effectively with your model.
From a mapping perspective, the area of interest is essentially a series of connected vertices with a shaded
interior. These vertices can be manipulated like any other map vertices. In the BUILD tab of the SynerGEE
ribbon bar, you can use the Add Graphic Point, Move Graphic Point, and Delete Graphic Point buttons to
modify the area of interests shape. However, you may find it easier to use the right-click menu to simply
redraw the area of interest. In addition, SynerGEEs Move Device mode can be used to move the entire area
of interest from one location to another.
Refer to the following procedures for more information on redrawing, reshaping, and moving an area of
interest.

TO REDRAW AN AREA OF INTEREST

1

In the SynerGEE map display, right-click on the area of interest that you want to edit and then select
Reshape.

Click the left mouse button to create the vertex points that will define the new boundary of the area
of interest.

Click the right-mouse button to complete the redraw.

Press Esc to exit the Reshape mode and return to the Default mode. Note that if you remain in the
Reshape mode, you will effectively begin a new redrawing of the same area of interest each time
you click in the map display.

TO RESHAPE AN AREA OF INTEREST

1

In the BUILD tab of the SynerGEE ribbon bar, click the Add Graphic Point, Move Graphic Point,
or Delete Graphic Point buttons, as appropriate.
-

If you are adding a graphic point, click and hold the mouse in the position along the area of
interest where you are adding a graphic point, and then drag the point to the new location.

If you are moving a graphic point, click and hold the mouse over the graphic point that you
want to move, and then drag the point to a new location.

If you are deleting a graphic point, click the mouse over the graphic point that you want to
delete.

When you are finished, press F5 to return to the Default mode.

TO MOVE AN AREA OF INTEREST

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Devices group, click Move.

Click on the area of interest and drag it to a new location.

Press F5 to exit the Move Device mode and return to the Default mode.

SynerGEE Electric 5.0

User Guide

220

Working with the Map Display

Editing the settings for an area of interest

After you have created and edited the shape of an area of interest, you will need to edit the settings for the
area of interest by using the Area of Interest editor. The Area of Interest editor defines the type of area of
interest that you have created. Growth Areas are used during a Forecasting analysis to specify changes in
distributed load and/or spot load during multi-year modeling. Speculative Load areas allow load-based
analyses to consider speculative loads as defined by the area of interest. Or, if desired, an area of interest
can simply be used to mark a geographic region in your SynerGEE map display, without having an impact on
any SynerGEE analysis.
The following procedure provides more information about using the Area of Interest editor to configure an
area of interest. Note that some of the options in this editor will be enabled or disabled depending on the area
of interest type that you select.

TO EDIT AN AREA OF INTEREST

1

In the SynerGEE map display, double-click the area of interest to open the Area of Interest editor.

In the Area of Interest editor, select the Area tab. The following table describes the different fields
that you can edit.

User Guide

Description

Specifies an optional description for the area of interest.

Type

Specifies the area of interest type. The option that you select here will
enable/disable fields in other tabs in the Area of Interest editor. The
following options are available:

Growth Area. Growth Area specifies that during a

Forecasting analysis, all sections underneath the area of
interest will grow over the years in distributed load and/or
spot load, as specified in the Dist Growth and Spot Growth
tabs.

Speculative Load. Speculative Load specifies that loadflow-based analyses will consider the speculative load
component as specified in the Spec. Load tab.

Area of Interest. Area of Interest specifies that the area of

interest is being used only to represent a geographical area
on the map display, such as a lake or a restricted area. With
this option selected, the area of interest will have no impact
on any SynerGEE analyses.

SynerGEE Electric 5.0

Working with the Map Display

Display

221

Specifies how the area of interest is shown in the SynerGEE map

display.

Show. Select this check box to show the area of interest in

the SynerGEE map display. If the check box is cleared (and
thus, the area of interest is hidden), the area of interest is
still present and used in the model. You can access the full
list of areas of interest from the Model tab of the model
explorer.

Color. Specifies the color that is used to show the area of

interest in the SynerGEE map display.

Pattern. Specifies the fill pattern that is used to show the

area of interest in the SynerGEE map display.

Year

Specifies the Energize year and the Retire year for the area of
interest.

Associated section

Identifies the section associated with the area of interest. For more
information on changing the associated section, see Associating an
area of interest with a section on page 223.

Turn Off

Select this option to disable the area of interest for analysis purposes.
The settings in the editor will be retained, but any load and growth
estimates will be ignored during SynerGEE analyses.

Select the Spec Load tab. Use the options in this tab to set the speculative load for the area of
interest. The options in this tab are only enabled if you have selected Speculative Load as the area
of interest type in the Area tab.
Demand Type

Specifies the type of demand (kVA, kWh, or kW) for the speculative
load. Any demand values that you enter will be assigned to the
section associated with the area of interest for any load-flow studies.

Reference

Specifies how the speculative load will be applied to the section. The
following options are available:

Absolute. When this option is selected, the specified values

are added directly to the distributed load components of the
associated section, thus treating it like a spot load.

kW / kVA / kWh per sq. mile / feet / meter. When this

option is selected, SynerGEE first determines the total load
components based on the area within the polygonal area of
interest, and then applies the calculated values to the parent
section.

Note that load values are applied to the area of interests parent
section only, regardless of how they are ultimately determined. For
this reason, the area of interests section association can be
important. For more information, see Associating an area of interest
with a section on page 223.

SynerGEE Electric 5.0

User Guide

222

Working with the Map Display

User Guide

Load PF

Specifies the load power factor, which is applied to all demand years.

Area

Read-only information regarding the size of the area of interest.

Demand

Specifies the speculative demand that you expect for each year. The
multi-year values only apply if you are actively using multi-year
modeling and analysis. If you are not, specify your load data in the
first year listed and leave the remaining values at zero.

Select the Dist Growth tab. Use this options in this tab to set distributed growth options for the area
of interest. The options in this tab are only enabled if you have selected Growth Area as the area of
interest type in the Area tab.
To ...

Do This ...

Specify distributed load

growth by yearly
percentages

Select Distributed growth and then use the text boxes to specify the
percentage of distributed load growth for each year. As an alternative,
you can select the Growth Curve check box to use a growth curve
from your model to specify that the distributed load growth
percentages are determined by a pre-defined growth curve in your
model. For more information on working with growth curves, see
Growth curves on page 804.

Specify distributed load

growth by yearly
distributed load

Select Distributed new load and then use the text boxes to specify
the spot load growth for each year.

Select the Spot Growth tab. Use this options in this tab to set spot growth options for the area of
interest. The options in this tab are only enabled if you have selected Growth Area as the area of
interest type in the Area tab.
To ...

Do This ...

Specify spot load

growth by yearly
percentages

Select Spot growth and then use the text boxes to specify the
percentage of spot load growth for each year. As an alternative, you
can select the Growth Curve check box to use a growth curve from
your model to specify that the spot load growth percentages are
determined by a pre-defined growth curve in your model. For more
information on working with growth curves, see Growth curves on
page 804.

Specify spot load

growth by yearly
distributed load

Select Spot new load and then use the text boxes to specify the spot
load growth for each year.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Working with the Map Display

223

Associating an area of interest with a section

Areas of interest are always associated with a section on the model. The association is important because it
impacts how speculative load data is considered during load flow-based analyses.
Perform the following procedure to change the section that is associated with an area of interest.

TO CHANGE THE SECTION ASSOCIATION OF AN AREA OF INTEREST

1

Locate the section that you want to associate with an area of interest.

Right-click on the section and select Set for Analysis.

Double-click the area of interest that you want to associate with the section.

In the Area tab of the Area of Interest editor, click Selected Section. Once clicked, the section that
you selected in step 1 and step 2 will be listed under Associated Section.

Deleting an area of interest

Perform the following procedure to delete an area of interest from your model.

TO DELETE AN AREA OF INTEREST

In the SynerGEE map display, right-click on the area of interest that you want to delete, and then select
Delete.

LOCATION LINKS
Location links allow you to link specific labels and devices to external files and websites. When you activate a
link, the file or website is opened directly within the SynerGEE workspace, either in a window or a dialog box.
Links can be launched via the right-click menu on the particular label or device.
Location links are for general purpose and reference use only. They do not have any interactive capabilities
with your SynerGEE model data.
There are three types of links that you can create:

Links to external files. You can link a map element to certain popular file formats, including DOC,
XLS, JPG, and BMP. When you activate a document link, such as DOC and XLS, the document
opens in the SynerGEE window and can be edited from there. Some image links open the image in
a separate SynerGEE window. You could use this type of link to attach an actual schematic or a
digitized photo to a SynerGEE model element, or you could attach a spreadsheet file that shows
other data, such as maintenance history.

Links to websites. When you activate a website link, SynerGEE connects to the Internet using your
company network and opens that site in a separate SynerGEE window. For example, you could link
a device to its manufacturers homepage for quick access to technical data.

Links to Internet mapping software. With this type of link, you specify an address or latitude and
longitude coordinates for the device, and SynerGEE uses Internet mapping software, such as

SynerGEE Electric 5.0

User Guide

224

Working with the Map Display

MapQuest, Google Earth, Google Maps, or Microsoft Live Search Maps to produce a map marking
its location.
Refer to the topics listed below for more information on creating and launching location links in SynerGEE.

Creating a location link on page 224

Launching a location link on page 225

Creating a location link

Perform the following procedure to create a location link for a label or device in your model. Take note that
the location link syntax must be exactly correct. If a link contains a syntax error, the command that you would
use to launch the link in the applicable right-click menu will be disabled.

TO CREATE A LOCATION LINK

1

Open the editor for the label or device where you want to create a location link, and find the
Location Link field.

Use the Location Link field to do the following:

To ...

Do This ...

Add a link to an external file

(such as a Word, Excel, or
image file)

Type the path to the file in the following format:

<FI>{path}

For example:
<FI>C:\Regulators\Schematics\R141.jpg

Add a link to a website

Type the website address or URL in the following format:

<FI>{URL}

For example:
<FI>my.stonersoftware.com

User Guide

SynerGEE Electric 5.0

Working with the Map Display

225

To ...

Do This ...

Add a link to Internet

mapping software (such as
MapQuest, Google Earth,
Google Maps, or Microsoft
Live Search Maps)

Type the address or latitude and longitude coordinates of the

device or section in the following format:
<MQ>{street},{city},{state},{zip code}
<GE>{latitude},{longitude}

For example:
<MQ>1170 Harrisburg Pike,Carlisle,PA,17013
<GE>40.259882,-77.03147800000001

Keep the following tips in mind:

The zip code is optional.

The code to link to Google Earth is <GE>.

The code to link to Google Maps is <GM>.

The code to link to MapQuest is <MQ>.

The code to link to Microsoft Live Search Maps is

<MM>.

Click Apply to accept your changes, and then click X to close the editor.

Launching a location link

Perform the following procedure to launch a location link. The linked file or website will open within SynerGEE
in a separate window.

TO LAUNCH A LOCATION LINK

1

In the SynerGEE map display, right-click on a label or device where you have created a location link.

Select Link. A separate SynerGEE window opens containing the linked file or website. If the Link
option is disabled on the context menu, either there is no link established for that device, or the link
format is incorrect. For more information on establishing a location link, see Creating a location link
on page 224.

LABELS
Standard and customized labels can be added anywhere in the map display. Each label may contain up to
three lines, including text, analysis results, or a combination of both text and results. You can select from one
of several predefined quick label formats, or you can define your own label format by selecting from more
than 20 results categories for each of the three label lines. Each label line can be assigned an individual
color, and you can select from several other options for each label line, including whether to display units of
measurement and whether to display data by phase or as a total for the results category type.

SynerGEE Electric 5.0

User Guide

226

Working with the Map Display

Figure 4-5 shows an example of a label in the SynerGEE map display.

Figure 4-5 Custom label in the SynerGEE map display

A label is always associated with a section, and each section can only have one label associated with it. You
can move the label anywhere you want in the map display, but the label and label data will always be
associated with the parent section, regardless of label location. You start the process of adding a label by
right-clicking on a section and selecting from the Text Label options.
Refer to the topics listed below for more information on working with labels in SynerGEE.

Adding a label on page 226

Editing a label on page 227

Moving a label on page 229

Deleting a label on page 229

Adding a label
Perform one of the following procedures to add a label to the SynerGEE map display. The predefined quick
labels can be added directly from the right-click menu in the SynerGEE map display, while custom labels
require you to use the Text Label editor to set up the data for your label.
Labels are always associated with sections, and each section can only have one label. If the add label menu
option is disabled for a section, then the section already has a label associated with it.
Label display (on or off) is controlled globally in the Style tab of the Map Settings editor, as described in
Configuring the map display style on page 201. If you add a label but it does not appear in the map display,
then the label display preference is most likely disabled for your model.

TO ADD A PREDEFINED LABEL

1

In the SynerGEE map display, right-click on the section where you want to add the label.

Select Text Label and then select the quick label type that you want to add.
SynerGEE assigns the selected label to the section. Once you have added the label, you must use
the Text Label editor to change the label options or select a different quick label type. For more
information, see Editing a label on page 227.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

227

TO ADD A CUSTOM LABEL

1

In the SynerGEE map display, right-click on the section where you want to add the label.

Select Text Label > Add.

SynerGEE assigns a default label to the section and displays the Text Label editor. For information
on editing the label, see Editing a label on page 227.

Editing a label
The Label editor allows you to provide up to three lines of text or analysis results for each label. You can
display data values and units of measurement, and also configure the text color for each line. The label editor
also allows you to specify text justification, a location link, and energize and retire years for the label.
Refer to the following procedure for more information on editing a label. For information on editing the font
type, size, and style for all labels, see Configuring the map display style on page 201.

SynerGEE Electric 5.0

User Guide

228

Working with the Map Display

TO EDIT A LABEL
1

In the SynerGEE map display, double-click on the label you wish to edit.

Use the options in the Text Label editor to configure the settings for the label. The following table
describes the different tasks that you can perform.

User Guide

To ...

Do This ...

Configure up to three lines

of label text

In the Enable column, select the check box next to each label
line that you want to enable. In addition, the following options are
available for each label line:

Auto Label. Select the Auto Label check box to have

SynerGEE automatically insert a label for the display
value that you have selected. For example, if you
selected Volts Out as your display value, the auto
label will be V =. SynerGEE will change the auto label
as appropriate each time you change the display value.

Label Text. If you do not select the Auto Label check

box, use the Label Text box to specify a custom label
for the associated label line. The label text will appear
before the display value in your label.

Display Values. Use the Display Values option to

select an analysis results category that you want to
display in the label line.

By Phase. Select the By Phase check box to display

the results of each phase for the selected display value.
If this check box is cleared, an average or total value
will be shown, as appropriate for the display value type.

Display Units. Select the Display Units check box to

display the units of measurement for the selected
display value.

Color. Use the Color option to select the color for the
associated label line.

Select a predefined quick

label style

Next to Quick Setup, select from one of the predefined label

formats. Note that as soon as you select a quick label style, the
current settings in the editor will be replaced by the settings for
the selected label style.

Change the text justification

for the label

Under Text Justification, select Left, Center, or Right.

Set the energize and retire

years for the label

Select values next to Energize and Retire, as appropriate. For

more information, see Multi-Year Analysis on page 579.

Set up a location link for the

label

Under Location Link, type the appropriate syntax to link the

label to an external source, such as a file or website. For more
information, see Location Links on page 223.

SynerGEE Electric 5.0

Working with the Map Display

229

To ...

Do This ...

Save the label with your

model

Select the Store in database check box. If this check box is

cleared, the label will be discarded when the model is closed.

Click Apply to accept your changes, and then click X to close the editor.

Moving a label
You can move labels in the map display at any time. Unlike moving other objects in the map display, you do
not need to enter Build mode before moving the label, nor do you have to return to Default mode when you
are done moving a label. Refer to the following procedure for more information.

TO MOVE A LABEL
1

Move the cursor over the label you want to move.

Click the label and drag it to a new location, releasing the mouse button when you are done. Note
that the associated section is highlighted in the map display as you click and drag the label.

Deleting a label
Perform the following procedure to delete a label from your map display. Note that if you delete a section that
has an associated label, the label will also be deleted.

TO DELETE A LABEL
1

In the map display, right-click on the label that you want to delete.

Select Text Label > Delete.

MOBILE ITEMS
Mobile items are unique symbols that you can add to the map display to mark locations of interest in your
model. Mobile items can be placed anywhere in the SynerGEE map display. Unlike labels, mobile items are
not tied to a specific section. When editing a mobile item, you can select from a number of symbol types and
also customize the color and size of the symbol.
Note that mobile items are not saved with your SynerGEE model. They can, however, be saved as a part of a
subset.
Refer to the topics listed below for more information.

Adding a mobile item on page 230

Editing a mobile item on page 230

Deleting a mobile item on page 230

SynerGEE Electric 5.0

User Guide

230

Working with the Map Display

Adding a mobile item

Mobile items are added to a model in the same manner as any other equipment, by dragging the mobile item
from the Warehouse tab of the model explorer and dropping it anywhere in the SynerGEE map display. Refer
to the following procedure for more information.

TO ADD A MOBILE ITEM TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Mobile Items and then select General Mobile Item. Drag it onto the map display and drop
it onto the desired location.

Editing a mobile item

Mobile items do not have any impact on a SynerGEE model. However, you can edit several properties for the
mobile item, including its symbol type, size, and color.
Refer to the following procedure for more information.

TO EDIT A MOBILE ITEM

1

In the SynerGEE map display or model explorer, double-click the mobile item that you want to edit.

Use the Mobile Item editor to edit the following properties for the mobile item:
-

Description

Symbol

Size

X Coordinate

Y Coordinate

If desired, you can also select the Hide check box to hide the mobile item from the SynerGEE map
display. (You can still locate and edit the mobile item from the model explorer.)
3

Click Apply to accept your changes, and then click X to close the editor.

Deleting a mobile item

Perform the following procedure to delete a mobile item from your model. Note that mobile items are not
saved with your model. (They are only saved with subsets.) Therefore, any mobile items will be deleted
automatically when you close the model.

TO DELETE A MOBILE ITEM FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the mobile item that you want to delete.

Right-click on the mobile item and select Delete.

Click Yes to confirm the deletion.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

231

LEGEND
The Legend tab in the SynerGEE model explorer displays a detailed legend for the SynerGEE map display.
The legend shows the current color and line options that are being used by the map, as well as the device
type symbols and the coordinates for the area that is currently visible in the SynerGEE map display. The
same legend you see in the Legend tab is included when you print the SynerGEE map display.
The Legend window provides another way that you can view the legend for the SynerGEE map display. The
Legend window is a free-floating window that displays the current coloring scheme in the SynerGEE map
display in both pie chart and bar chart form. As you hover the mouse over each area of the chart, the Legend
window will display the name of the corresponding area, the total number of sections in that area, and the
total length in miles for all sections in that area. The size of the area in the respective chart is based on the
total number of miles for all sections in that area.
The Legend window displays automatically when you start SynerGEE. If you close the Legend window, you
can re-open it from the DISPLAY tab of the SynerGEE ribbon bar.

TO SHOW THE LEGEND WINDOW

1

In the SynerGEE ribbon bar, select the DISPLAY tab.

In the Show area, click Legend Window.

VIEWS
A view is a specified geographical region of the map that you can snap to quickly using the NAVIGATE tab in
the SynerGEE ribbon bar. You can use views to set up frequently visited areas of your map and return to
those areas any time with just a click of the mouse.
Views are stored as model data, and are therefore portable between different data formats. You can create
as many different views of your map as necessary.
Refer to the following procedures for more information on creating, viewing, and deleting views.

TO CREATE A VIEW
1

Pan and zoom the map to the location you want to become a view.

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Favorites group, next to Views, type a new name for the view you are creating.

Click the Add View button to save the view.

TO VIEW A VIEW
1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Favorites group, next to Views, select the name of the view that you want to view. If the name
of the view is already showing, click the Go To View button to view the view.

SynerGEE Electric 5.0

User Guide

232

Working with the Map Display

TO REPLACE A VIEW
1

Pan and zoom the map to the location you want to become a view.

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Favorites group, next to Views, select the name of the view that you want to replace.

Click the Add View button to replace the view.

Click Yes to confirm the action.

TO DELETE A VIEW
1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Favorites group, next to Views, select the name of the view that you want to delete.

Click the Delete View button.

Click Yes to confirm the deletion.

BACKGROUND IMAGES
SynerGEE allows you to display raster and vector images in a wide range of popular formats underneath
the map of your model. This feature is useful during the development and maintenance of distribution system
models, especially for those situations when you need to be able to quickly relate your distribution system to
real-world features, or when presenting model results to a general audience.
You can load background images directly from the DISPLAY tab of the SynerGEE ribbon bar, or you can load
them through the Tiles tab in the Map Settings editor. From this tile library, you can select which images are
displayed at any given time. In addition, you can use a Geobackground settings file to save the current
background image settings for use with future SynerGEE sessions. For more information on working with
settings files, see Settings Groups and Settings Files on page 189.
Your imported background images must conform to a SynerGEE-supported file format. Many image types
require a supplemental file for SynerGEE to display them. For more information on SynerGEE image support,
see Background Image Support on page 1173.

TO MANAGE BACKGROUND IMAGES

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Tiles tab.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

3

233

Refer to the following table for the actions you can perform to add and remove map display
background images.
To ...
Add a background image to
SynerGEE

Do This ...
a

Click Add.

Use the Select Tile dialog box to locate the background

image file that you want to add, and then click Open.
Tip:

Enable and disable

background images
Replace a background
image

Remove a background
image from SynerGEE

You can also add background images from the

DISPLAY tab of the SynerGEE ribbon bar. In
the Background group, click the Add Layer
button and then use the Connect Image editor
to select the image to load.

In the list of background images, select the check box for each
image that you want to show in the SynerGEE map display. Clear
the check box for each image that you want to hide.
a

In the list of background images, select the image that

you want to edit.

Click Browse.

Use the Select Tile dialog box to select a new path and
file for the background image, and then click Open.

In the list of background images, select the image that

you want to remove.

Click Remove.

Click OK to accept your changes and close the editor.

SCHEMATIC VIEW
As an alternative to the map view, a schematic provides a means of viewing a simplified version of your
model. Unlike a map, a schematic allows you to be very specific about which model items appear. You can
choose any combination of sections and devices from the model in memory to build a schematic. For
example, you can build a schematic to focus on specific items or analysis results. Then, like a map, you can
place results labels at strategic locations to monitor the desired parameters while running analyses.
Before using schematics, you should note the following:

Geography. Unlike a map, schematics do not have to be geography-based. You can essentially put
any item anywhere. The location of items in a schematic has no effect on the original source model
data.

Many-to-one relationship to model data. Because you choose the facilities that exist on a schematic,
you can create multiple schematics for any model. In fact, you can create any number of schematics
for any set of model data.

SynerGEE Electric 5.0

User Guide

234

Working with the Map Display

Editing capabilities. Like a map, you can launch device and section editors from the schematic
explorer. When you work in the SynerGEE editor, you are working on actual source model data. Any
data edits you make will be reflected in the original, source model.

Feeder selection. Current feeder selection is shared between maps and schematics. However,
feeder selection in schematics is only applicable to the schematic explorer. Unlike a map, feeder
selection in a schematic does not affect which sections and devices are shown.

Display settings. Certain display settings, such as section coloring and equipment symbology, are
shared between maps and schematics. When you alter these settings, it affects any open maps
and/or schematics simultaneously. Other display settings, such as view modes and flow arrows,
apply to open maps only.

Refer to the topics listed below for more information on working with schematics.

Using schematic templates on page 234

Creating a schematic on page 237

Opening a schematic on page 238

Working in the schematic on page 238

Editing device and section data in the schematic view on page 238

Editing the schematic grid on page 239

Using schematic templates

Schematic templates should be created before you begin working in the regular schematic window. A
schematic template creates the visual representation of the model. It consists of lines, items, and more, but
does not link to the model in any way. The schematic template is purely graphical.
The regular schematic binds objects to the model, so it more closely works with the model. For example, a
closed switch in the schematic would close the switch in the model. Multiple schematics can be created using
one template.
Refer to the topics listed below for more information on working with schematic templates.

Creating a schematic template on page 234

Editing a schematic template on page 235

Renaming a schematic template on page 236

Copying a schematic template on page 236

Deleting a schematic template on page 236

Creating a schematic template

Schematic templates build a basic outline to use with new schematics. The template could be a section in the
model, or objects that can be linked from the schematic to the map. Refer to the following procedure for more
information.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

235

TO CREATE A SCHEMATIC TEMPLATE

1

If you have not already done so, perform the following steps to open the Schematic Template
window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Schematics group, click Template.

On the Templates tab of the Schematic Template explorer, click Add. The Create Schematic
Template editor opens.

In the name area of the Create Schematic Template editor, type the name of the new template that
you want to create. If you type or select the name of an existing template, you will replace the
existing template with a new, blank template.

Click Finish. The new template is added to the list of templates in the Templates tab of the
schematic explorer. See Editing a schematic template on page 235 for information on editing the
template.

Editing a schematic template

In the CONTROLS tab of the SynerGEE ribbon bar, use the buttons in the Drawing group to add lines,
squares, and other shapes (collectively referred to as items) to the schematic template. To add an item,
simply click on the appropriate button and then click where you want the item to be placed in the Schematic
Template window, noting the following:

To add a line, click the left mouse button in the starting location for the line. Drag the mouse to a
new location and click the left mouse button to add a vertex point, or click the right mouse button to
end the line.

Use the Square tools to add node points to the end of the line.

Use the Vertex and Endpoint tools to add additional vertex points and endpoints to existing lines.

Use the Image tool to add an external image to the template.

Once you have added items to the Schematic Template, use the Default tool to drag the items to new
locations in the template window. You can also double-click any item to edit its associated properties. Each
item editor has four tabs:

General. Use the General tab to specify the name of the template item. To set up the template item
so it can be bound to a model object, type SID_ before the item name. The item will turn blue in the
template window, which identifies it as an item that can be bound.

Edit. Use the Edit tab to set up editing properties for the item, including whether it can be selected,
moved, rotated, and scaled.

Line. Use the Line tab to specify the color, style, and width of schematic lines.

Position and Size. Use the Position and Size tab to view read-only information on the size and
position of an item in the schematic template.

Fill. Use the Fill tab to set up the foreground and background colors and pattern for labels and
squares.

Text. Use the Text tab to specify the text that is included on text items, including the text alignment.

SynerGEE Electric 5.0

User Guide

236

Working with the Map Display

Font. Use the Font tab to select the font type, style, and size for the text that is included on text
items.

Labels. Use the Labels tab to configure the orientation of a label on a schematic line.

Renaming a schematic template

Perform the following procedure to rename a schematic template in your model.

TO RENAME A SCHEMATIC TEMPLATE

1

If you have not already done so, perform the following steps to open the Schematic Template
window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Schematics group, click Template. If the Template option is disabled, then the
Schematic Template window is already open.

From the Templates tab of the Schematic window, select the name of the template that you want to
rename.

Click Rename.

Type a new name for the template and then press Enter.

Copying a schematic template

Perform the following procedure to create a duplicate copy of a schematic template in your model.

TO COPY A SCHEMATIC TEMPLATE

1

If you have not already done so, perform the following steps to open the Schematic Template
window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Schematics group, click Template. If the Template option is disabled, then the
Schematic Template window is already open.

From the Templates tab of the Schematic window, select the name of the template that you want to
copy.

Click Copy. A duplicate copy of the template is created and added to the template list.

Deleting a schematic template

Perform the following procedure to delete a schematic template from your model.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

237

TO DELETE A SCHEMATIC TEMPLATE

1

If you have not already done so, perform the following steps to open the Schematic Template
window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Schematics group, click Template. If the Template option is disabled, then the
Schematic Template window is already open.

From the Templates tab of the Schematic window, select the name of the template that you want to
delete.

Click Delete.

Click Yes to confirm the deletion.

Creating a schematic
Perform the following procedure to create a schematic. You must have at least one schematic template
available before you can create a schematic. For more information on schematic templates, see Using
schematic templates on page 234.

TO CREATE A SCHEMATIC
1

If you have not already done so, perform the following steps to open the Schematic window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Schematics group, click Schematics. If the Schematics option is disabled, then the
Schematic window is already open.

In the Schematics window, select the Schematics tab.

Right-click in the left side of the Schematic window and select New. The Edit Schematic dialog
opens.

Use the Edit Schematic editor to do the following:

Next to Schematic ID, type a name for the new schematic.

Next to Template ID, select a schematic template whose settings will form the basis of the
new schematic.

Next to Feeder ID, select a feeder from your model to associate with the schematic.

Click OK to accept your changes and close the editor. The new schematic appears in the list of
schematics on the left side of the schematic window.

SynerGEE Electric 5.0

User Guide

238

Working with the Map Display

Opening a schematic
TO OPEN A SCHEMATIC
1

If you have not already done so, perform the following steps to open the Schematic window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Schematics group, click Schematics. If the Schematics option is disabled, then the
Schematic window is already open.

In the Schematics window, select the Schematics tab.

In the list of schematics on the left side of the window, select the schematic that you want to view
and drag it into the main viewing area on the right side of the window.

Working in the schematic

You can work in the schematic window and also make changes to the template, if necessary. Objects that
were set for binding in the template can be bound to specific items in the model. These items appear blue in
the schematic. To save a schematic, you need to save the actual model because it saves items to the
database.

TO BIND ITEMS TO THE SCHEMATIC

1

If you have not already done so, open the Schematic window and display the schematic that you
want to edit. See Opening a schematic on page 238 for more information.

Items that have been set up for binding in the schematic template are represented by blue colors in
the schematic window. Right-click on a blue item in the schematic window and select Edit Link.

Choose an object type from the Object Type options menu.

Select a particular item from the list. For example, if you chose Section from the Object Type menu,
a list of sections appears in the list. You can select one to be bound to the object in the schematic.

Click Apply. The schematic item is bound to the model item.

Editing device and section data in the schematic view

You can double-click on a schematic item or any item in the schematic explorer to produce its editor. Unlike
geographical manipulations, any data that you edit does apply to the source model as well. Always be aware
that any data editor actions may change the source data from which the schematic was generated or built.
You may find it convenient to perform operations such as switch operations in the schematic view. Again, you
should make the queried main aware that configuration changes affect the source model data, and will be
reflected in your map view as applicable.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

239

Editing the schematic grid

You can change certain settings associated the schematic grid, such as grid color, canvas size, and snap
properties. This procedure can be performed in both the schematic window and schematic template window.

TO CHANGE SCHEMATIC GRID PROPERTIES

1

Right-click in the Schematic window and select Grid Properties.

In the Grid Properties editor, select Grid Visible to display the grid in the schematic window. You
can also use the Color option to select the color for the grid.

Use the Measurements area to set the width, height, and spacing for the grid.

Select Snap to Grid to snap schematic items to the grid lines.

Click OK to accept your changes and close the editor.

GEOGRAPHY VIEW
The Geography view window provides a geographic-based view of your model, very similar to what you
would see in an ESRI application. The Geography window matches your model coordinates with real-world
coordinates from a selected projection file, and then displays the model on top of a selected basemap file that
can show geographic information, a road map network, or other such features.
When working in the Geography view, you can perform many of the same functions that you can in the
traditional Map view. You can pan and zoom, and you can double click objects in your model to open the
respective editor. Many (although not all) of the model explorer tabs and ribbon bar buttons function the same
in the Geography view window as they do in the Map view window.
Refer to the topics listed below for more information.

Setting up the Geography view on page 239

Viewing a model in the Geography view on page 241

Using the Geography view window on page 241

Synchronizing the Geography view and the Map view on page 241

Changing the basemap layer on page 242

Setting up the Geography view

To use the Geography window, you first need to select a coordinate projection file and a basemap layer to
use with your model. Both of these options are set in the Geography tab of the Map Settings editor.

Projection files. Your SynerGEE installation includes definition files for more than 4000 coordinate
systems. You will need to select the projection file that corresponds with the X,Y coordinates in your
model. For example, the projection file that is associated with the default model database that is
provided with SynerGEE is NAD 1927 StatePlane Colorado North FIPS 0501.
By default, SynerGEE looks for projection files in the GeoProjections folder in your SynerGEE
installation directory. However, you can change this folder from the Paths tab of the Preferences

SynerGEE Electric 5.0

User Guide

240

Working with the Map Display

editor, as described in Defining file paths on page 167.

Basemap layer files. Basemap layer files (*.lyr) can be downloaded at www.arcgis.com. The
basemap layer file configures the kind of basemap that you will view in the SynerGEE Geography
view, such as a street map or a topographic map.
By default, SynerGEE looks for basemap layer files in the GeoLayers folder in your SynerGEE
installation directory. However, you can change this folder from the Paths tab of the Preferences
editor, as described in Defining file paths on page 167.

Refer to the following procedure for more information.

TO SET UP THE GEOGRAPHY VIEW

1

Double-click anywhere in the map display to open the Map Settings editor.

Select the Geography tab.

Use the options in the Geography tab to set up options for viewing models in the Geography view
window. Refer to the following table for more information on the options that you can edit.

User Guide

Model and Map Projection

Specifies the map projection file that is in use with your model.
To change the map projection file, click Select and then navigate
to the map projection file that you want to use.

Default Layer

Select the default basemap layer for the Geography view. The
default layer will be activated if no other layers are active when
you start SynerGEE.

Active Layers

Select the check box for each layer that you want to make active
in the Geography view.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Working with the Map Display

241

Viewing a model in the Geography view

Perform the following procedure to open your model in the Geography view window.

TO VIEW A MODEL IN THE GEOGRAPHY VIEW

1

Use the Map Settings editor to select a coordinate file and coordinate system and basemap layer for
use in the Geography view. For more information, see Setting up the Geography view on
page 239.

In the SynerGEE Map view window, right-click and select Geographic View. After a few moments
the Geography view window will open, displaying the model and the selected basemap layer.

Using the Geography view window

You can use the Geography view window in a very similar manner as the Map view window. Operations that
you can use to navigate in the Map view window, including zooming and panning, work the same in the
Geography view. You can double-click sections to open the Section editor, and double-click devices to open
the respective device editor. You can also double-click in any empty space in the Geography view window to
open the Map Settings editor.
The model explorer in the Geography view window is also very similar to the model explorer in the Map view
window. In the Geography view model explorer, the MODEL, Asset, Query, and Feeders tabs are identical to
the respective tabs in the Map view. The Warehouse tab is also present in the Geography view, although you
cannot use it to add devices to your model. The Legend tab in the Geography view shows layer data that is
specific to the Geography view, while the Toolbox tab from the Map view window is not used in the
Geography view.
Likewise, the ribbon bar tabs in the Geography view are generally similar to the respective tabs in the Map
view. The common ribbon bar tabs that is, all tabs starting with the MODEL tab and ending with the
SUPPORT tab are identical no matter what window you are viewing in SynerGEE. The NAVIGATE and
DISPLAY tabs in the Geography view window are similar, although not exact, to the corresponding tabs in the
Map view window. Procedures for using ribbon bar options that are specific to the Geography view window
are described in the respective sections in this Online Help file User Guide.

Synchronizing the Geography view and the Map view

When you are working in the Map view window and the Geography view window at the same time, you will
likely perform certain zoom, pan, and other related tasks in one of the two windows and other zoom, pan, and
related tasks in the other window, thus leaving the two model views in an unsynchronized state. The Map
view window will show one view of your model, and the Geography view window will show another. You can
use special synchronize buttons in the SynerGEE ribbon bar to update the view of the model in the
Geography view window to match the view of the model in the Map view window, and vice versa. Refer to the
following procedures for more information.

TO SYNCHRONIZE THE GEOGRAPHY VIEW WITH THE MAP VIEW

1

Click the Geo tab to view the SynerGEE Geography view.

In the SynerGEE ribbon bar, select the NAVIGATE tab.

SynerGEE Electric 5.0

User Guide

242

Working with the Map Display

3

In the View group, click Synch to Map. The Geography view window will reposition itself to match
the current view in the Map view window.

TO SYNCHRONIZE THE MAP VIEW WITH THE GEOGRAPHY VIEW

1

Click the Map tab to view the SynerGEE map display.

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Zoom group, click Synch to Geography. The Map view window will reposition itself to match
the current view in the Geography view window.

Changing the basemap layer

Perform the following procedure to change the basemap layer file that you are currently viewing in the
Geography view window.

TO CHANGE THE BASEMAP LAYER

1

Double-click anywhere in the Geography view window to open the Map Settings editor.

Select the Geography tab.

Under Active Layer, select the check box for the basemap layer that you want to view. Clear the
check box for any basemap layers that you do not want to view.

Click Apply to accept your changes, and then click X to close the editor.

SHOW MANAGER
The Show Manager is a SynerGEE tool that you can use to highlight selected types of sections and devices
in the SynerGEE map display. The selected section and facility types will be marked with circle symbols in the
map display, and they will also be listed in the Show Manager. You can use the buttons in the Show Manager
to zoom to a selected section or device, and also to open the respective section or device editor.
The section and device types that you can highlight using the Show Manager include the following:

Generators, large customers, and section distributed generators that are configured for
photovoltaics

Any switches where the current state differs from the normal state

Throwover switches

Automatic switches

Sections that include projects

Sections that include spot loads

Refer to the following procedure for more information on using the Show Manager.

User Guide

SynerGEE Electric 5.0

Working with the Map Display

243

TO USE THE SHOW MANAGER

1

Perform the following steps to open the Show Manager:

a

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Viewers group, click Show Manager.

On the left side of the Show Manager, select the check box for each section or device category that
you want to highlight in the SynerGEE map display. Any sections or devices that meet the criteria in
the selected check boxes will also be listed on the right side of the Show Manager.

Use the list area in the Show Manager to perform the following tasks.

To ...

Do This ...

Edit a section or device

In the list area, select the section or device that you want to edit
and then click Edit.

Zoom to a section or device

In the list area, select the section or device that you want to view
in the SynerGEE map display and then click Zoom.

Click Hide or press F4 to close the Show Manager.

SynerGEE Electric 5.0

User Guide

244

User Guide

Working with the Map Display

SynerGEE Electric 5.0

CHAPTER

5
Building a Model
SynerGEE provides a user-friendly modeling interface designed to make modeling convenient and easy.
Using simple drag-and-drop functionality, SynerGEE allows you to quickly create models that accurately
depict your actual distribution system.
When you model new sections and equipment, SynerGEE assigns default values to certain parameters, such
as section phasing and equipment settings. Some of these default values are customizable and can be
edited directly from SynerGEE, which then saves the values in the Defaults file, named SynDefaults.xml. For
more information, see Editing Default Values for SynerGEE Devices on page 136.
Refer to the topics listed below for more information on building a model.

Modeling Feeders and Subtrans on page 245

Modeling Loads on page 253

Loops and Wandering Laterals on page 253

MODELING FEEDERS AND SUBTRANS

In SynerGEE, a feeder has a starting point (swing bus) or voltage source. The feeder corresponds to a point
of known voltage and source impedance. Typically, this is at the feeder breaker or recloser. There is no limit
to the number of feeders in a distribution system model.
You can tie feeders to substation models and analyze substations in SynerGEE. Substation calculations start
at the subtran node and branch out to all associated feeders. A subtran node represents a topological source
only, and does not contain any transformer data or components. However, you can use a separate
transformer device to model a substation transformer if desired. This is described in more detail in Subtran
details on page 252.
When modeling feeders and substations, it is important to be aware of how these two facilities interact when
they are selected, or not selected, for analysis. If a feeder is not connected to a substation, then the feeder
will always act like a source. When a feeder and a substation are connected and both the feeder and
substation are selected for analysis, then the load will pass through the feeder, just as it would pass through
a closed switch. If only the feeder is selected for analysis, then the feeder will act like a source. If only the
substation is selected, then its dependent feeders will still be considered during an analysis, even though the
feeders are not displayed. Any switchable device, such as a breaker, switch, meter, or transformer, that is
placed between a substation and a feeder will determine whether a feeder is fed or unfed. An open device will
cause the feeder to be unfed. This type of interaction imitates real world feeder/substation interaction.

SynerGEE Electric 5.0

User Guide

246

Building a Model
A feeder or subtran node is created in a model by converting a node, but it is important to note that the node
record is never eliminated, even though the feeder or subtran symbol replaces the node symbol. For
example, in the case of a feeder in Access, a record is created in the InstFeeders table, with the same ID as
the original node, while the node record is also preserved. The two records maintain an association, because
the node record contains important topological information, such as coordinates, that does not get copied to
the new feeder record. The association is based on IDs, so the node and feeder IDs must always remain the
same. As such, when you change the ID of a feeder or subtran, the ID of the original node is changed as well.
In the event that you convert a feeder back to a node, the feeder data is removed, and the node data
remains.
Because feeders are always associated with a node, they must adhere to node naming conventions, which
dictate that all node IDs must be unique.
It is important to keep in mind that although it is called a subtran in SynerGEE, a subtran record does not
contain data on the transformer itself. The actual transformer is handled as a separate device entity, if at all,
as shown in Figure 5-1. The subtran record only contains information such as voltage and source impedance,
much like a feeder record. This configuration allows SynerGEE to analyze high-side protection coordination.

Figure 5-1 Substation model with connecting feeders

Converting a node into a feeder or a substation node

Perform the following procedure to convert a node into a feeder or a substation node. Before you can begin
this procedure, you must be sure that node symbols are visible in your SynerGEE map display. Node
symbols could be hidden for a number of different reasons, as described in Working with Nodes on
page 264.
If loop creation is disallowed, you can convert any node to a feeder source, provided it would not feed an
existing feeder. On the other hand, you can convert a node fed by a subtran to a feeder, regardless of
settings. To create a substation, you must start with an unfed node and section. For more information on
allowing loop creation, see Loops and Wandering Laterals on page 253.

TO CONVERT A NODE INTO A FEEDER OR A SUBSTATION NODE

1

In the SynerGEE map display, locate the node that you want to convert.

Right-click on the node and select either Convert to Feeder or Convert to Substation Node.
or
Perform the following steps to convert the node from the SynerGEE ribbon bar:

User Guide

In the SynerGEE ribbon bar, select the BUILD tab.

In the Source group, click either Feeder or Substation.

SynerGEE Electric 5.0

Building a Model

247
c

Hover the mouse over the node that you want to convert. If the node is eligible to be
converted, the cursor symbol will change from a crosshair to a target symbol. Click the
mouse to complete the action.

In the Confirm Operation dialog box, click Yes.

TO CONVERT A FEEDER OR A SUBSTATION NODE TO A NODE

1

In the SynerGEE map display, locate the node that you want to convert.

Right-click on the node and select Convert to Node.

or
Perform the following steps to convert the node from the SynerGEE ribbon bar:

In the SynerGEE ribbon bar, select the BUILD tab.

In the Source group, Node.

Hover the mouse over the node that you want to convert. If the node is eligible to be
converted, the cursor symbol will change from a crosshair to a target symbol. Click the
mouse to complete the action.

In the Confirm Operation dialog box, click Yes.

Editing a feeder or subtran node

Perform the following procedure to edit a feeder or subtran node.

TO EDIT A FEEDER OR SUBTRAN NODE

1

In the SynerGEE map display or model explorer, double-click the feeder or subtran node that you
want to edit.

The Feeder editor and the Subtran editor are very similar and have almost identical options. On the
left side of the editor, select from the different tab names to edit data for the feeder or the subtran
node, respectively. The following topics describe the different tasks that you can perform:

Editing general data for a feeder or subtran node

Editing voltage levels and source impedance for a feeder/subtran node

Editing node data for a feeder/subtran node

Editing failure rates and the location link for a feeder/subtran node

Viewing analysis results for a feeder/subtran node

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

248

Building a Model

Editing general data for a feeder or subtran node

TO EDIT GENERAL DATA FOR A FEEDER/SUBTRAN NODE
1

In the SynerGEE map display or model explorer, double-click on the feeder or subtran node that you
want to edit.

In the Feeder editor, select the Feeder tab. Or, in the Subtran editor, select the Source tab. The
following table describes the different options that you can set.
Region

Optional name of a region that is associated with the feeder or

subtran. The Region field exists for reference purposes only. It is not
used during any SynerGEE analysis.
To enter a new region name, type the name in the Region text box or
expand the options list to select from any of the region names that
have already been created. If you enter a new Region name, that
name becomes available in the Region options list for all feeders and
subtrans.
The default value for the Region field is Unassigned.

Substation

Optional name of a substation that is associated with the feeder or

subtran. The Substation field exists for reference purposes only. It is
not used during any SynerGEE analysis, although it is used to
organize data in some of the analysis reports.
To enter a new substation name, type the name in the Substation text
box or expand the options list to select from any of the substation
names that have already been created. If you enter a new Substation
name, that name becomes available in the Substation options list for
all feeders and subtrans.
The default value for the Substation field is Unknown.

User Guide

Nominal KV

The rated high-side line-to-line voltage for the feeder or subtran at the
connecting bus.

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

AMS Link (Subtran

editor only)

Syntax to link the subtran to an Asset Management System.

Connection

Connection type.

Cont. Amp Rating

Continuous amp rating, for exception reporting only. This value does
not affect load-flow calculations. Exceptions are only reported if this
value is greater than zero.

Emer. Amp Rating

The emergency amp rating allows the setting of a continuous and

emergency loading level for feeders.

SynerGEE Electric 5.0

Building a Model

249

L-G Fault Ohms (R)

The assumed line-to-ground fault resistance in ohms. This value is

used for fault analysis if the line-to-ground resistance is specified as
zero in the fault analysis setup options. For more information on fault
analysis setup options, see Setting up a fault analysis on page 650.

Color

Color of the feeder or subtran.

Display on Load

Sets SynerGEE to add the feeder or subtran to the selection set

automatically when the model is loaded from disk, such that it
appears on the map. Any feeders or subtrans in the model that do not
have this setting checked will not be visible when the model is loaded,
until manually selected. For more information on feeder selection, see
Selecting Feeders on page 157.

Growth Curve

Sets the growth curve for the feeder or subtran. Select a curve from
the options menu if you check the growth curve box. The curves are
used in Forecasting. See Forecasting Analysis on page 556 for
more information.

Load Multiplier

Multiplier value used to simulate load growth on the feeder or subtran

for analysis purposes. Changing this number does not change any
actual load information in the model data, and it is not used unless
your growth options specifically designate as such. For more
information on load growth and growth options, see Load Growth on
page 801.

Hardened feeder
(Feeder editor only)

Select this check box to identify the feeder as a hardened feeder. This
check box is for reference purposes only. It is not used during any
SynerGEE analysis.

CVR feeder (Feeder

editor only)

Select this check box to identify the feeder as a CVR feeder. When
this check box is selected, a special CVR voltage limit will be used to
monitor for high voltage exceptions for the meter. The CVR voltage
limit is set on the Exceptions tab of the Model and Analysis Options
editor.

Tie to transmission
bus (Subtran editor
only)

Select this check box to tie the subtran node to a selected

transmission bus. This option is available for subtran nodes only.

Click Apply to accept your changes, and then click X to close the editor.

Editing voltage levels and source impedance for a feeder/

subtran node
Use the Volts/Ohms tab in the Feeder/Subtran editor to edit voltage levels and source impedance values for
a feeder or subtran node. Refer to the following procedure for more information.

SynerGEE Electric 5.0

User Guide

250

Building a Model

TO EDIT VOLTAGE LEVELS AND SOURCE IMPEDANCE FOR A FEEDER/SUBTRAN NODE

1

In the SynerGEE map display or model explorer, double-click on the feeder or subtran node that you
want to edit.

In the Feeder editor or Subtran editor, select the Volts/Ohms tab. The following table describes the
different tasks that you can perform.
To ...

Do This ...

Edit source impedance

values

Next to Positive Sequence and Zero Sequence, enter R and X

values as appropriate. At least one of the positive sequence
impedance values must be greater than zero for fault current values
to be calculated in fault analysis.

Specify voltage levels

Under Voltage Levels, select Use Balanced Voltage Level or Use

By-Phase Voltage Level and then specify the voltage levels as
required. SynerGEE limits voltages to between 60 and 180 volts on a
120-volt base.
If you choose the Use By-Phase Voltage Level option, SynerGEE
verifies that positive rotation exists. Also, be sure to check the angular
settings, which significantly affect power flow. The default angles for
phases A/AB, B/BC, and C/CA are 0,-120, and 120, respectively.

Click Apply to accept your changes, and then click X to close the editor.

Editing node data for a feeder/subtran node

Although feeders and subtran nodes are created by converting nodes in your model, it is important to note
that the node data is never eliminated. The feeder/subtran will share the same ID as the original node, and
the feeder/subtran will also retain the X and Y coordinates of the original node. In the event that you convert
a feeder or subtran back into a node, the feeder/subtran data is removed but and the node data remains.
Use the Node tab in the Feeder/Subtran editor to edit the feeder/subtrans node data. You can edit the X
and Y coordinates of the node that is associated with the feeder or subtran, and you can also view a list of all
sections that connect to the node. These fields correspond to the fields that you see in the Node tab in the
Node editor.
Refer to the following procedure for more information.

TO EDIT NODE DATA FOR A FEEDER/SUBTRAN NODE

1

In the SynerGEE map display or model explorer, double-click on the feeder or subtran node that you
want to edit.

In the Feeder editor or Subtran editor, select the Node tab. The following table describes the
different options that you can set.

User Guide

X Coordinate

X coordinate location of the feeder/subtran.

Y Coordinate

Y coordinate location of the feeder/subtran.

SynerGEE Electric 5.0

Building a Model

Incident Sections

251

Lists the names of all sections that are connected to the feeder/
subtran. This list is for informational purposes only and cannot be
edited.

Click Apply to accept your changes, and then click X to close the editor.

Editing failure rates and the location link for a feeder/subtran

node
Use the Rates tab in the Feeder editor and the Subtran editor to specify failure rate, cost, and time
parameters for reliability analyses. Generally, these numbers represent averages and estimates, because it
is unlikely that you will have exact figures for each individual device.
The Rates tab can also be used to define a location link for the feeder/subtran. Refer to the following
procedure for more information on editing feeder/subtran data on the Rates tab. For more information failure
rates and reliability analyses, see Devices and failure rates Reliability studies on page 685.

TO EDIT FAILURE RATES AND THE LOCATION LINK FOR A FEEDER/SUBTRAN NODE
1

In the SynerGEE map display or model explorer, double-click on the feeder or subtran node that you
want to edit.

In the Feeder editor or Subtran editor, select the Rates tab. The following table describes the
different options that you can set.

Sustained Failure
Rate

Sustained failure rate for the feeder/subtran.

Temporary Failure
Rate

Temporary failure rate for the feeder/subtran.

Failure Repair Time

Failure repair time for the feeder/subtran.

Location Link

Syntax to link the feeder/subtran to an external source, such as a file

or website. For more information, see Location Links on page 223.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a feeder/subtran node

The Results tab in the Feeder editor and the Subtran editor provides analysis results for the feeder or the
subtran, respectively. The Results tab can be very helpful if you are running multiple analyses and focusing
on a particular feeder/subtran. Since the settings update automatically with each analysis, you can run an
analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.

SynerGEE Electric 5.0

User Guide

252

Building a Model
Refer to the following procedure for more information on viewing analysis results for a feeder or subtran.

TO VIEW ANALYSIS RESULTS FOR A FEEDER/SUBTRAN NODE

1

In the SynerGEE map display or model explorer, double-click on the feeder/subtran node that you
want to edit.

In the Feeder editor or Subtran editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

About feeder and subtran demands

Feeders and subtrans do not contain demand data. To specify demands for load allocation purposes, you
can use a meter device. For more information, see Meters on page 356.
Tip:

Prior to SynerGEE Electric 3.6, demands were part of feeder and subtran records. Meter devices
have replaced this methodology, allowing you to place metered demand data anywhere in your
system. If you prefer to continue associating demands with feeders and/or subtrans, you can place
meter devices directly downstream from them. When you load a model from a version prior to 3.6,
SynerGEE performs this action automatically with any existing feeder/subtran data.

Subtran details
From a data perspective, a subtran instance is identical to a feeder source. It contains important source data
for fault and load-flow-based studies, including voltage and impedance. A subtran instance, despite the
name, does not contain any actual transformer data. If you wish to include the primary transformer
component in your model, you must add it as a separate device, usually just downstream from the subtran
node. If you do model a transformer, the nominal voltage and impedance in the subtran record should
represent the high-side. Otherwise, source data should represent the transformer low-side.
The primary reason for subtrans, therefore, is topological and categorical convenience. If you have
substations modeled during analysis, SynerGEE will use the subtran data for load-flow propagations and
largely bypass any feeder source data. At the culmination of analyses, the results are categorized and
summarized by feeder, but the model was analyzed as a substation network, not as independent feeders.
Also, modeling of substations and associated devices is necessary if you want to perform high-side
protection coordination with primary transformers.
In general, subtrans and substations may or may not be appropriate for your situation. They do add a
significant layer of complexity to the topology of your model and may make analysis results less intuitive. By
analyzing independent feeders with reliable source data, it may be easier to keep your results concise and
organized, facilitating better planning.
Prior to SynerGEE Electric 3.6, transformer data was merged with the subtran node, hence the legacy name
subtran. In these earlier models, therefore, transformer data was required. If you load a 3.5 or earlier model
into the current version of SynerGEE, SynerGEE automatically separates the transformer data into a
separate transformer instance and adds the device for you. After this conversion, you model should behave

User Guide

SynerGEE Electric 5.0

Building a Model

253

similarly to the earlier version. Note that the changes from version 3.5 to 3.6 were conducted primarily to
allow high-side protection coordination.
A substation can be added to SynerGEE using the Substation Wizard. Refer to the following procedure for
more information.

TO USE THE SUBSTATION WIZARD

1

Perform the following steps to open the Substation Wizard:

a

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Model group, click Substation Wizard.

On the first page of the Substation Wizard, next to Sub Node ID, type a name for the new substation
node. Click Next to continue.

On the next page of the wizard, select the feeders for the new substation. Click Next to continue.

On the last page of the wizard, select the device types for the substation and then click Finish. The
new substation is added to SynerGEE.

MODELING LOADS
Loads are usually modeled using a combination of options in the Section editor and also the settings for the
Load Allocation analysis. Load modeling can be an involved process. For detailed information, see Loads
and Load Analyses on page 493.

LOOPS AND WANDERING LATERALS

In general, SynerGEE is oriented for use with radial distribution systems. However, it has a variety of features
in place to handle looped situations, including transmission-style network analysis tools.
Analytically, SynerGEE identifies three general types of loops:

Basic loop. A basic loop is generally a simple loop without any phase changes. Figure 5-2 shows an
example of a basic loop.

Figure 5-2 Basic three-phase loop

SynerGEE Electric 5.0

User Guide

254

Building a Model

Wandering lateral. A wandering lateral is generally a single- or two-phase branch that leaves a
three-phase trunk, serves some load, and then rejoins the trunk downstream to serve further load.
Figure 5-3 shows an example of two wandering laterals.

Figure 5-3 Wandering lateral example

Meshed network. A meshed network model is a densely looped configuration that has little or no
radial qualities at all, such as those found in some urban feeders. Figure 5-4 shows an example of a
meshed network.

Figure 5-4 Meshed network model

SynerGEE can model all three of these loops types. Refer to the topics listed below for more information.

Modeling loops on page 254

Loop tie switches on page 255

Analysis considerations for loops and wandering laterals on page 256

Modeling loops
You must set up your SynerGEE preferences to allow you to model loops. Otherwise, SynerGEE will
recognize when you are creating a looped situation and prevent you from doing so. In addition, SynerGEE
will not let you close a switch that would form a loop.
After selecting the Allow Loop Creation option, it is up to your discretion to determine what types of loops you
need. In general, if you can maintain a radial model with isolated loops, it is preferable to use radial analyses
and avoid network analyses designed for densely meshed models.
Always keep in mind that certain analysis types, such as the contingency analysis, cannot operate on looped
systems. Prior to SynerGEE 3.6, this situation was overcome by the concept of loop tie switches, which is
described in Loop tie switches on page 255. However, loop tie switches are no longer the recommended

User Guide

SynerGEE Electric 5.0

Building a Model

255

approach to loop creation and you should make other provisions if you intend to run analyses that do not
support loops.

TO ALLOW LOOP CREATION IN A MODEL

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the SynerGEE tab.

Select the Allow Loop Creation check box.

Click OK to accept your changes and close the editor.

Loop tie switches

In SynerGEE versions 3.5 and earlier, the recommended approach to loop creation was to use a loop tie
switch or a wandering lateral tie switch. This approach worked as follows:
1

Draw a section that would form the loop, but leave one end unconnected.

Add any switch from the warehouse to the section, open it, and designate it as a tie switch.

Connect the open end of the section, forming the loop, with the connectivity broken by the open tie
switch.

In this manner, you could maintain a radial model according to map topologically, while SynerGEE could
simulate loops by considering tie switches as closed during loop-supporting analyses.
While loop tie switches are still supported, you are encouraged to avoid them if possible. SynerGEE now
automatically recognizes looped situations and performs calculations properly. During an analysis, when a
loop or wandering lateral is detected without a tie switch, SynerGEE automatically creates an internal break
and performs identical calculations at that point. This functionality can help keep your model less cluttered.
For more information on analysis and internal breaks, see Analysis considerations for loops and wandering
laterals on page 256.
Tip:

SynerGEE has a special coloring scheme for identifying loops and internal break points. For more
information, see Coloring by path type on page 216.

For more information on designating a switch as a tie switch, see Editing a switch on page 402. For more
information on switches in general, see Modeling Devices on page 317.

TO MODEL A LOOP WITH A LOOP TIE SWITCH

1

Model the sections in your loop, as described in Modeling Sections on page 258. Leave one
section disconnected to break connectivity.

Drag any switch from the Warehouse tab of the model explorer and place it on the disconnected
section, next to the disconnected node.

Double-click the switch to open the Switch editor, and then do the following:
a

Select the Switch tab.

Under Status, select Open to open the switch.

Select the Loop Tie switch check box.

SynerGEE Electric 5.0

User Guide

256

Building a Model
d
4

Click Apply to accept your changes, and then click X to close the editor.

Use the Reconnect Section tool, as described in Connecting and disconnecting sections on
page 260, to complete the loop.

TO MODEL A WANDERING LATERAL WITH A TIE SWITCH

1

Model the sections in your wandering lateral, as described in Modeling Sections on page 258.
Leave the last section disconnected from the trunk to break connectivity.

Drag any switch from the Warehouse tab of the model explorer and place it on the disconnected
section, next to the disconnected node.

Double-click the switch to open the Switch editor, and then do the following:

Select the Switch tab.

Under Status, select Open to open the switch.

Select the Wandering Lateral Tie check box.

Click Apply to accept your changes, and then click X to close the editor.

Use the Reconnect Section tool, as described in Connecting and disconnecting sections on
page 260, to rejoin the lateral with the trunk to complete the loop.

Analysis considerations for loops and wandering

laterals
SynerGEEs radial analysis engines require a topologically radial model. Internally, during radial analysis,
SynerGEE must break a loop somewhere to complete its calculations. The final results should be reliable for
the looped configuration; however, SynerGEE must break the loop to get those results. For an example of
how SynerGEE performs calculations across a break point to derive looped results, see Radial load-flow
with loops on page 517.
If you have tie switches in your model, these become the break point. If you do not, SynerGEE attempts to
select the most appropriate section for an internal break. Once established, internal breaks remain in place
during the current session. If the location of the internal break is not appropriate, you can override it by
placing a tie switch where you want the loop to be broken during analysis.
Tip:

SynerGEE has a special coloring scheme for identifying loops and internal break points. For more
information, see Coloring by path type on page 216.

If you have loops in your model, whether directly modeled or by using tie switches, they will be automatically
considered by any applicable analysis. That is, all tie switches are automatically considered closed if the
analysis supports loops. In SynerGEE 3.5 and earlier, you had to specify whether tie switches should be
considered closed or not. This option has been retired, and all switches are now automatically considered
closed as applicable during analysis.

User Guide

SynerGEE Electric 5.0

CHAPTER

6
Modeling Sections
SynerGEE has been designed to provide an outstanding line model without complicated data requirements. It
captures the effects of electric and magnetic field coupling by using the full set of Carsons equations, and its
methods incorporate the work of Carson, Wagner and Evans, and Kersting.
SynerGEEs by-phase impedance and admittance calculations and reduction techniques can handle coupling
between conductors, and between conductors and the earth. SynerGEE considers one-, two-, and threephase lines with and without a neutral return, and can handle bare overhead lines as well as cables.
Like most device models in SynerGEE, the spatial characteristics of a line model are defined in a section
instance contained in your model data (InstSection table, in Access). Each section record should also
reference one or more conductor types in your equipment data source, which define its electrical
characteristics (DevConductors table). In addition, if a section is configured to use detailed spacing, it also
references a configuration type in the equipment data source (DevConfig table, in Access).
Conductor data
(DevConductors
table, in Access)

Spacing data
(DefConfig table, in
Access)

Spatial data
(InstSection table, in
Access)

Section line
model
Figure 6-1 Data flow for building the electrical model of a section

This chapter of the documentation discusses the process of section modeling and contains detailed
information on impedance and admittance calculations. Information on SynerGEE Cable, the duct bank
modeling and amperage derating module, is contained in SynerGEE Cable on page 785.
Refer to the topics listed below for more information.

The SynerGEE Section Model on page 258

Modeling Sections on page 258

Working with Nodes on page 264

SynerGEE Electric 5.0

User Guide

258

Modeling Sections

Working with Graphic Points on page 278

Adding Sections on page 279

Editing Sections on page 279

Conductors on page 304

Conductor Configuration and Positions on page 310

Conductor Damage Curves on page 316

THE SYNERGEE SECTION MODEL

Figure 6-2 presents a high-level view of an entire section within SynerGEE. It shows the locations for device
placement on the section.

Nodes - Identify section endpoints

Section tie to node
Location of switches
Location of regulators, transformers, and protective devices
Basic line model including distributed load, and location of capacitors and generators

Figure 6-2 Section broken into areas where devices may be placed

This diagram demonstrates some important concepts related to devices and switches:

A section always lies between two nodes. Switches have no effect on the relationship between a
section and its nodes.

A switch either allows or prevents current flow into or out of a section.

With respect to other devices, switches are always located closest to nodes.

For more information on switches, see Switches on page 397.

MODELING SECTIONS
Sections are the basic building blocks of the distribution system model. A section represents an electrical
path between two end points (nodes), and can use vertices to form the geographic path of the line. Each
section is composed of an overhead or underground conductor segment and perhaps a group of devices
and/or loads. There are no limits to the length of a section, or to the number of sections in a system.
When a section is added, the section length is calculated based on the map views current unit of
measurement setting. If the new section connects to an existing section, the new section inherits a number of
attributes from the existing section, including the phase configuration, conductor type, phase spacing, load

User Guide

SynerGEE Electric 5.0

Modeling Sections

259

connection value, and equivalent height above ground. SynerGEE sets the neutral conductor to same as
phase rather than to the same conductor as the phase conductor.
Section IDs within a model must be unique. SynerGEE produces a default ID for new sections, based on
preferences that you can set in the SynerGEE tab of the Preferences editor. Your choices are to have
SynerGEE attempt to follow existing ID patterns, or to have SynerGEE generate random unique IDs. In either
case, SynerGEE first searches the model in memory to ensure that the default ID is unique. However, if you
are using an enterprise database system, you may not have the entire model in memory and this validation
process will be incomplete. Since unique IDs are critical, you should set your preferences to generate
random IDs if you are modeling sections on feeders that were checked out from an enterprise model. For
more information on setting the section ID preference, see Setting SynerGEE preferences on page 163. For
more information on enterprise databases, see Using an Enterprise Database System on page 114.
Once you have at least one section modeled, you can convert a node into a source and create a feeder or
subtran. For more information on converting a node to a source, see Converting a node into a feeder or a
substation node on page 246.
Refer to the sections listed below for more information on modeling with sections.

Adding a section on page 259

Moving a section on page 260

Connecting and disconnecting sections on page 260

Splitting a section on page 261

Reconductoring and rephasing sections on page 261

Changing a section ID on page 262

Deleting a section on page 263

About force-unfed sections on page 263

Adding a section
New sections are added to your model by entering the Add section mode and clicking on the node and
vertex positions that define the new section. Refer to the following procedure for more information on adding
a section to your model.

TO ADD A SECTION
1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Model group, click the Add Section button.

Note:

If the Add Section button is disabled, zoom in to your model until the button becomes
enabled.

Click once in the map display to begin drawing the new section. You can start the section by clicking
in any empty space in the map, or by clicking on an existing node if you want to attach the new
section to an existing section in your model.

Move the mouse in the desired direction for the new section. As you move the mouse, you can do
any of the following:

SynerGEE Electric 5.0

User Guide

260

Modeling Sections
-

Hold the Ctrl key as you drag the mouse to force vertical or horizontal lines.

Click the left mouse button to create vertex points, as needed.

Press the arrow keys on the keyboard to pan to different areas of the map display, as
needed.

Press Esc to cancel the current section and return to the Add Section mode.

Click the right mouse button to end the new section. You can end the new section in any empty
space in the map, or you can end the section on top of an existing node in your model. SynerGEE
will prevent you from creating any type of section that is not allowed, such as a loop.

In the Enter section ID dialog box, click OK to accept the section name that has been created by
SynerGEE, or type a new name for the section and then click OK.

Press F5 to return to Default mode. You will probably want to edit the new section you have created.
For more information, see Editing Sections on page 279.

Moving a section
You can move a section by moving the nodes and vertices associated with the section. For more information
on moving nodes, see Moving a node on page 266. For more information on moving vertices, see Moving
a graphic point on page 278.

Connecting and disconnecting sections

Once a section is modeled, you can connect it to or disconnect it from another section using the Reconnect
Section tool. All you have to do is select the section you want to edit, grab a node, and drag it to a new
location on the map. If you drop the node over top of an existing node, the sections become connected. If you
drag a node away from an existing connection, those sections become disconnected and a new node is
created.
SynerGEE allows sections to be connected only if there are no loop violations and if your preferences are set
to not allow loop violations. For more information on loops and loop creation, see Loops and Wandering
Laterals on page 253. For more information on disabling the Allow Loop Creation option in your SynerGEE
preferences, see Setting SynerGEE preferences on page 163.
Refer to the following procedure for more information on disconnecting and reconnecting sections.

TO DISCONNECT OR RECONNECT A SECTION

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Model group, click the Reconnect Section button.

Note:

If the Reconnect Section button is disabled, zoom in to your model until the button
becomes enabled.

In the SynerGEE map display, click on the section that you want to disconnect or connect. A valid
section will turn red when you click on it.

Click on one of the nodes for the section and then drag it to a new location in the map display.
Release the mouse button to complete the move.

User Guide

SynerGEE Electric 5.0

Modeling Sections
5

261

Press F5 to return to Default mode.

Splitting a section
You can split an existing section into two separate sections by inserting a node in the middle. The original
section will be located on the source end, and existing devices located on the original section will remain with
the original section. SynerGEE will recalculate the line lengths of both the existing section and the newly
created section.
The new node will be named according to the preferences that you set up in the SynerGEE tab of the
Preferences editor, as described in Setting SynerGEE preferences on page 163.

TO SPLIT AN EXISTING SECTION

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Model group, click the Add Node button.

Note:

If the Add Node button is disabled, zoom in to your model until the button becomes
enabled.

Move the cursor over any section in your model. The cursor will change to a cross symbol when you
are over a section. Use this change in cursor type to locate where in the section you want to insert
the node.

Click the left mouse button to insert the node.

In the Enter section ID dialog box, click OK to accept the default name for the new section that is
being created by SynerGEE as a result or your node insert action, or type a new name for the new
section and then click OK.

Press F5 to return to Default mode.

Reconductoring and rephasing sections

Use the Rephase and Reconductor Sections editor to change conductors, add new phases, and change
phasing for a section and its downstream sections. With the Reconductor option, you can change both the
Phase and Neutral conductors for the current section and all downstream sections, or only downstream
sections with the same phasing, or only downstream sections with the same phase conductor. With the
Rephasing and Add Phase options, all downstream sections will inherit the same change, provided that those
sections first meet the criteria for the Add Phase option. For example, if the selected section and all
downstream sections already use three phases, then the Add Phase option is disabled since there is nothing
you can add.
Refer to the procedures listed below for more information.

To change section conductors on page 262

To add a new phase on page 262

To change section phasing on page 262

SynerGEE Electric 5.0

User Guide

262

Modeling Sections

TO CHANGE SECTION CONDUCTORS

1

In the SynerGEE map display, locate the section that you want to work with.

Right-click on the section and select Rephase and Reconductor.

In the Rephase and Reconductor Sections editor, select the Reconductor check box.

Under Downstream Sections, select from one of the following options to indicate which sections you
want to edit:
-

All

Sections with same phasing

Sections with same phase conductor

Under New Conductors, select a conductor from your warehouse to apply as the new Phase
conductor and also the new Neutral conductor. Clear the appropriate check box if you do not want
to apply a change to one of the conductor categories.

Click Finish to apply your changes to the model and close the editor.

TO ADD A NEW PHASE

1

In the SynerGEE map display, locate the section that you want to work with.

Right-click on the section and select Rephase and Reconductor.

In the Rephase and Reconductor Sections editor, select the Add Phase check box and then select
the phase you want to add (A, B, or C). Note that the phase that you select will be applied to the
current section and all downstream sections, as applicable.

Click Finish to apply your changes to the model and close the editor.

TO CHANGE SECTION PHASING

1

In the SynerGEE map display, locate the section that you want to work with.

Right-click on the section and select Rephase and Reconductor.

In the Rephase and Reconductor Sections editor, select the Rephase check box.

Under the Rephase check box, change the section phasing as appropriate for the A, B, and C
phases. Note that the phase that you select will be applied to the current section and all downstream
sections, as applicable.

Click Finish to apply your changes to the model and close the editor.

Changing a section ID
Perform the following procedure to change the ID for a section.

User Guide

SynerGEE Electric 5.0

Modeling Sections

263

TO CHANGE A SECTION ID
1

In the SynerGEE map display or model explorer, locate the section whose ID you want to edit.

Right-click on the section and select Change ID.

In the ID Changing Utility editor, type the new ID for the section.

Click OK to accept the new section ID and close the editor.

Deleting a section
Perform one of the following procedures to delete a section from your model.

TO DELETE A SECTION FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the section that you want to delete.

Right-click on the section and select Delete.

Click Yes to confirm the deletion.

TO DELETE A SECTION USING DELETE SECTION MODE

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Model group, click the Delete Section button.

In the SynerGEE map display, click on the section that you want to delete.

Click Yes to confirm the deletion.

Press F5 to return to Default mode.

About force-unfed sections

In a SynerGEE model, sections with unfed phases are generally considered completely unfed, a condition
known as force-unfed. For analysis purposes, force-unfed sections are regarded the same as any unfed
section, normally dropped from the analysis altogether. Figure 6-3 shows a two-phase section that is forceunfed because the feeding section is single-phase.

Figure 6-3 A force-unfed section

Force-unfed sections are regarded as unfed until the source problem is fixed. SynerGEE analyses do not
attempt any temporary fixes for the purposes of completing analysis, because such actions would encourage
unreliable results due to inaccurate models.
The model cleanup application has a special command for fixing force-unfed situations in a model, 4012. For
more information, see Model Cleanup Scripts on page 718.

SynerGEE Electric 5.0

User Guide

264

Modeling Sections

WORKING WITH NODES

Nodes define the start and end points of a line section. Each section has two nodes, known as the from-node
and the to-node. In a radial model, these nodes can also be referred to as the source and load nodes.
SynerGEE assumes radial terminology if you have not set your preferences to allow loop creation, as
described in Loops and Wandering Laterals on page 253.
Refer to the topics listed below for more information.

Viewing nodes in the map display on page 264

Creating a node on page 265

Editing a node on page 265

Changing a node ID on page 265

Moving a node on page 266

Converting nodes to other device types on page 266

Deleting a node on page 266

Reducing the number of nodes on page 267

Viewing nodes in the map display

Nodes, like other symbols, can be hidden from the map display through several different methods, including
those listed below. If the nodes are hidden, you will not be able to perform a number of tasks related to not
only nodes but also sections, including adding sections and disconnecting and reconnecting sections.

Node symbols, along with most other display symbols, are hidden when you select to hide details in
the SynerGEE map display. You can hide map display symbols by clicking the Details button in the
DISPLAY tab of the SynerGEE ribbon bar. (The Details button is the same option as the Hide
Details check box in the Style tab of the Map Settings editor.)

Nodes can also be hidden as an individual symbol category. You can toggle the node symbols by
clicking the Nodes button in the DISPLAY tab of the SynerGEE ribbon bar, or by right-clicking in the
map display and selecting Toggle Nodes. You can also edit your map display symbol settings, as
described in Configuring map display symbols on page 213.
Take note that this option will be disabled, and thus nodes will be hidden, automatically each time
you start SynerGEE.

Nodes can be hidden based on your current zoom level. Zoom settings are often configured to hide
symbols when you are viewing your map display at a relatively high zoom level, thus reducing
clutter that may appear in the map display. Display symbols, including node symbols, will become
visible as you zoom in closer to the map display. For more information on this feature, see
Configuring visibility levels for map display symbols on page 214.

Take note that these options may sometimes override each other, particularly in the case of the Toggle
Nodes button. For example, if your map display is zoomed out to a level where node symbols are not
displayed, then clicking on the Toggle Nodes button will have no effect the nodes will be hidden regardless
of the status of the Toggle Nodes button. The same point is true when the map details are hidden (by clicking

User Guide

SynerGEE Electric 5.0

Modeling Sections

265

the Details button, as described above). If the Details button is disabled, then the nodes will remain hidden
even when the Nodes button is enabled.

Creating a node
In most cases, nodes are created automatically as you add sections to your SynerGEE model, as described
in Adding a section on page 259. If a section is created in isolation, then two nodes are created. If a line is
created between two existing nodes, then no nodes are created.
You can also create a node by inserting a node into an existing section in your model, essentially splitting the
existing section into two sections. This feature is described in Splitting a section on page 261.

Editing a node
Perform the following procedure to edit a node in your model. Before you can begin this procedure, you must
be sure that node symbols are visible in your SynerGEE map display. Node symbols could be hidden for a
number of different reasons, as described in Working with Nodes on page 264.

TO EDIT A NODE
1

In the SynerGEE map display or model explorer, double-click on the node that you want to edit.

In the Node editor, select the Node tab. The following table describes the different options that you
can set.

Description

Optional description for the node.

X Coordinate

X coordinate location of the node.

Y Coordinate

Y coordinate location of the node.

Incident Sections

Lists the names of all sections that are connected to the node. This
list is for informational purposes only and cannot be edited.

Select the Results tab. The Results tab lists pertinent analysis results for the node. The Results tab
can be very helpful if you are running multiple analyses and focusing on a particular node. Since the
settings update automatically with each analysis, you can run an analysis and watch the results
change in real time.
For more information, see Viewing results in the SynerGEE editor on page 156.

Click Apply to accept your changes, and then click X to close the editor.

Changing a node ID
Node IDs are created automatically by SynerGEE when each node is created, based in part on preferences
that you have set in the SynerGEE tab of the Preferences editor (as described in Setting SynerGEE
preferences on page 163). You can change the node ID by right-clicking on the node in the model explorer
or the SynerGEE map display. However, each node ID must be unique, and SynerGEE will prevent you from
creating duplicate ID names.

SynerGEE Electric 5.0

User Guide

266

Modeling Sections
Refer to the following procedure for more information.

TO CHANGE A NODE ID
1

In the model explorer or the SynerGEE map display, right-click on the node that you want to edit.

Select Change ID.

In the ID Changing Utility editor, type the new ID for the section.

Click OK to accept the new node ID and close the editor.

Moving a node
Perform the following procedure to move a node in your model.

TO MOVE A NODE
1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Model group, click the Move Node button.

Note:

If the Move Node button is disabled, zoom in to your model until the button becomes
enabled.

In the SynerGEE map display, click on the node that you want to move and then drag it to a new
location in the map. Repeat this step to move additional nodes, if desired.

Press F5 to return to Default mode.

Converting nodes to other device types

In the SynerGEE map display, you can right-click on a node and convert it to any of the following device
types:

Feeder. For more information, see Converting a node into a feeder or a substation node on
page 246.

Substation Node. For more information, see Converting a node into a feeder or a substation node
on page 246.

Pad Mount Gear. For more information, see Pad-mounted switch gear on page 408.

Deleting a node
SynerGEE does not allow you to delete nodes as an individual component of a SynerGEE model. In many
cases, the deletion of a node will result in the combination of two sections, which involves a serious
consideration of data issues. For example, loading levels and locations must be reconsidered, and any
associated equipment must be relocated and reconfigured.
To delete a node, you must delete an incident section and reconnect the remaining section, if required.
Before doing so, be sure that you configure the remaining section properly to prevent data loss.

User Guide

SynerGEE Electric 5.0

Modeling Sections

267

As an option for general optimization, SynerGEE provides a node reduction tool that can scan your model
and eliminate unnecessary nodes. The tool operates on a strict rule-base to prevent data loss such as that
mentioned above. For more information on this tool, see Reducing the number of nodes on page 267.

Reducing the number of nodes

Often, the number of nodes and vertices (or granularity) of a distribution model extends beyond the detail
needed for engineering analysis. An excessive number of nodes in a model can lead to a variety of problems,
including:

Data clutter

Slow analysis

Unwieldy reports

Difficulty spotting trends in voltage and loading

Hard-to-read results annotations on the map

SynerGEEs node reduction tool can reduce the number of nodes, vertices, and laterals in a model. The node
reduction options are highly flexible, allowing you to decide how closely the reduced model will match the
original. For example, you can reduce nodes only and set very tight constraints, resulting in a model that is
geo-spatially identical to the original full model with power flow, voltage, and fault values that nearly match the
values in the original model. Or, you can loosen the constraints if warranted by data issues, although perhaps
resulting in a model that is slightly different than the original.
Node reduction provides the following major features. Each of these features is either optional or flexible
according to your node reduction options:

Node and/or vertex reduction

Lateral and wandering lateral reduction or elimination

Loop detection and breaking

Pre-reduction model and data validation

User constraints and voltage limit checking

Topologically identical model before and after reduction

Refer to the topics listed below for more information on node reduction.

Setting up a node reduction on page 267

Performing a node reduction on page 270

Node reduction methodology on page 271

Setting up a node reduction

Perform the following procedure to set up options for a SynerGEE node reduction.

SynerGEE Electric 5.0

User Guide

268

Modeling Sections

TO SET NODE REDUCTION OPTIONS

1

Perform the following steps to open the Node Reduction Options editor:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click the text label Node Reduction and then select Settings.

Use the Node Reduction Options editor to set the following options:
General Operation

User Guide

Select any of the following options:

Reduce Nodes. Select this option to have SynerGEE

remove nodes during the analysis. The Node Reduction
Settings options will be enabled when this check box is
selected. For more information on this setting, see
Removing nodes on page 271.

Reduce Vertices. Select this option to have SynerGEE

remove vertices during the analysis. The Vertex Options
settings will be enabled when this check box is selected. For
more information on this setting, see Removing vertices on
page 276.

Open loops using elbows. Select this option to have

SynerGEE break topological loops by creating open elbows.
For more information, see Breaking loops with elbows on
page 277.

Bypass analysis-grade data checking. Select this option

to have SynerGEE ignore the standard data-checking
process performed by SynerGEE analyses. With this option
selected, reduction will be performed regardless of any data
errors, no matter how severe. In addition, you will not
receive any data warnings on the analysis report.

Rollup Laterals. Select this option to have SynerGEE

reduce all laterals or just reduce wandering laterals. The
Lateral Roll-Up Options settings will be enabled when this
check box is selected. A lateral is any non-three phase
section. Loads, large customers, capacitors, and projects
from laterals are added to the three-phase section at the
take-off point. Lateral rollup will not reduce sections that feed
a closed switch.

Reduce to switch path

Select this check box to reduce the model to only the sections that
are along the paths from transfer switches back to the feeders.

Vertex Options

This option is enabled when the Reduce Vertices check box is

selected. Use this option to set the percentage by which SynerGEE
judges whether a vertex should be removed. For more information on
this setting, see Removing vertices on page 276.

SynerGEE Electric 5.0

Modeling Sections

Lateral Roll-Up
Options

269

The Lateral Roll-up Options are enabled when you select the Rollup
Laterals check box. Select from one of the following:

Rollup 1Ph and 2Ph Laterals

Rollup All Laterals (including wandering laterals). Select

this option to set the c.kVA into values below your threshold.

Rollup Wandering Laterals & Dependents. Select this

option to only reduce wandering laterals and dependents.

Lateral must have

upstream fuse

This option is enabled when you select the Rollup Laterals check box.
Select this option to require that laterals have upstream fuses. When
selected, only paths downstream from a fuse can be rolled up with the
lateral rollup option.

Reporting

The Reporting options determine whether SynerGEE will provide you

with the opportunity to implement the recommended node reduction
edits or simply report the node reduction findings. Select from one of
the following options:

Ask Before Reducing Model. When this option is selected,

SynerGEE will prompt you to implement the edits
recommended by the node reduction. If you decline,
SynerGEE will simply provide a report of the analysis
findings.

Report Only (No Reduction). Select this option to have

SynerGEE produce a report on the analysis findings. You
will not be prompted to implement the edits recommended
by the analysis.

If you choose to produce a report only, note that the proposals

contained therein are estimations only. Since some changes are
dependent on previous changes, SynerGEE is unable to know the
exact details of the reduction until after it is performed. To find out all
of the specific reductions that node reduction recommends, you must
allow the changes to be made. You may find it helpful to create a
backup copy of your original model before performing a node
reduction.
Tip:

SynerGEE Electric 5.0

As long as you close the model without saving changes, you

can safely experiment with different node reduction
scenarios without affecting your original model.

User Guide

270

Modeling Sections

Node Reduction
Settings

The following options are enabled when you select the Reduce
Nodes check box:

Allow combining of unlike sections. Select this check box

to allow nodes to be removed between two sections with
different conductor, zones, and/or growth rate settings.

Use limits on combined sections. Select this check box to

enable maximum limits for combined sections. When this
option is selected, a node will not be deleted if the resulting
section violates any of the following user-defined limits:

Total Length. Maximum section length allowed

following a combination.

Connected kVA. Total connected load on a

combined section.

Connected kWH. Total connected load on a

combined section.

Combined Nodes. Maximum number of nodes

that can be eliminated on a combined section.

Limit by voltage drop. Select this option to limit the number

of sections that can be combined based on the maximum
total voltage drop allowable on a combined section.

Click Apply to accept your changes, and then click X to close the editor.

Performing a node reduction

Perform the following procedure to run a node reduction on your model. Node reduction runs according to the
options you have configured in the Node Reduction Options editor. It is very important for you to carefully
consider which options to set in order to produce the desired results. For example, one key option to consider
is the Reporting option. Depending on how this option is set, SynerGEE will either commit the node reduction
recommendations (following a user prompt) or simply report on the findings. For more information on node
reduction options, see Setting up a node reduction on page 267.

TO PERFORM A NODE REDUCTION

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click the Node Reduction icon.

If you have selected the Rollup Laterals option in the Node Reduction Settings editor, as described
in Setting up a node reduction on page 267, then you will be prompted to reduce laterals before
you continue with the analysis. These changes will be permanent, regardless of whether you select
to make the rest of the node reduction permanent, and must be committed before you can perform
other node reduction tasks. Select Yes to commit the lateral reduction changes and continue with
the analysis, or click No to cancel the analysis.

User Guide

SynerGEE Electric 5.0

Modeling Sections
4

271

If you have selected the Ask Before Reducing Model option in the Node Reduction Settings editor,
as described in Setting up a node reduction on page 267, then you will be prompted to make the
node reduction changes permanent. Click Yes to commit the changes to the model, or click No to
simply report on the analysis findings.
When the node reduction is complete, the Model Reduction report displays, summarizing the node
reduction results. The report includes a section titled Rule Summary, which explains why nodes
were not reduced in the model. A more detailed description of each rule that is listed in the Rule
Summary is provided in Node reduction rules on page 273.

Node reduction methodology

Node reduction is designed to reduce the number of sections by combination, moving from the smallest
sections to the largest. The resulting reduced model should have less clutter and the important areas should
be maintained.
Refer to the topics listed below for more information on the methodology used by the node reduction tool.

Removing nodes on page 271

Removing vertices on page 276

Breaking loops with elbows on page 277

Load handling on page 277

Removing nodes
When a node is removed, the two adjoining sections are combined. When this occurs, SynerGEE can do one
of two things, according to how your analysis options are set (as described in Setting up a node reduction
on page 267).
If your options are set to:

Then SynerGEE:

Reduce vertices

Eliminates the node completely and redraws the section between the
two nearest incident nodes and/or vertices. For more information, see
Eliminating a node completely on page 272.

Not reduce vertices

Eliminates the node and replaces it with a vertex. For more

information, see Replacing a node with a vertex on page 272.

Refer to the topics listed below for more information.

Eliminating a node completely on page 272

Replacing a node with a vertex on page 272

Detailed operation on page 273

Node reduction rules on page 273

Node reduction example on page 275

SynerGEE Electric 5.0

User Guide

272

Modeling Sections

Eliminating a node completely

To illustrate the complete elimination of a node without a vertex substitution, consider the following two
sections:
Node
Vertex

Section 2
Section 1

Figure 6-4 Two sections, candidates for combination

Assume that no other vertices are eliminated from the model during the reduction. If the node separating the
sections is eliminated, the combined section appears as follows:
Node
Vertex
Section 1

Figure 6-5 One section resulting from the reduction

Replacing a node with a vertex

To illustrate the replacement of a node with a vertex, consider the following two sections:
Node
Vertex

Section 2
Section 1

Figure 6-6 Two sections, candidates for combination

If the node separating the sections is replaced with a vertex, the combined section appears as follows:
Node
Vertex
Section 1

Figure 6-7 One section resulting from the reduction

The result is one section with the same shape as the original two.

User Guide

SynerGEE Electric 5.0

Modeling Sections

273

Detailed operation
When reducing nodes, node reduction performs the following steps.
1

Check model data.

Run load-flow.

Evaluate all nodes against rules.

Find shortest section incident to a reducible node.

Evaluate reducible node.

If node can be reduced, combine sections and loads, eliminate the node.

Repeat from step 4 until no more reduction is possible.

This algorithm is very simple and effective. The existing rule base is set up to be conservative in the
reduction, and reductions of 10% to 60% are normal. If you experience a reduction of more than 60%, you
may consider making your constraints more restrictive.

Node reduction rules

Node reduction is a rule-based application. When the application starts, all nodes are reduction candidates.
According to how your analysis options are set, some or all of the following rules may evaluated for each
node. If the node violates any of the applicable rules, it cannot be eliminated. Node reduction rules are
summarized in the Rule Summary section of the Model Reduction report.
Rule

Description

Notes

NRR_01

Miscellaneous reduction
constraint.

SynerGEE was unable to eliminate the node for some

unspecified reason.

NRR_02

Node incidence exceeds 2.

Nodes with more than two connected sections cannot

be eliminated. Only nodes with two incident sections
can be eliminated.

NRR_03

Node forms an edge.

Nodes tied to just one section cannot be eliminated.

NRR_04

Configuration change.

If the two sections connected by a node have different

phasing, spacing values, conductor names, or height,
the node is not eliminated.

NRR_05

Length limit of [value] would

be exceeded.

If elimination of the node would form a combined

section whose total length exceeds your specified
constraint, the node cannot be eliminated.

NRR_06

Connected kVA limit of

[value] kVA limit would be
exceeded.

If elimination of the node would form a combined

section whose total kVA exceeds your specified
constraint, the node cannot be eliminated.

NRR_07

Connected kWh limit of

[value] kWh limit would be
exceeded.

If elimination of the node would form a combined

section whose total kWh exceeds your specified
constraint, the node cannot be eliminated.

SynerGEE Electric 5.0

User Guide

274

Modeling Sections

Rule

Description

Notes

NRR_08

Voltage drop limit of [value]

V would be exceeded.

If elimination of the node would form a combined

section having a scalar voltage drop total that exceeds
your specified constraint, the node cannot be
eliminated.

NRR_09

Node combination limit of

[value] nodes would be
exceeded.

The number of eliminated nodes used to form combined

sections is tracked. If the elimination of the node would
cause the count for the combined section to exceed
your specified constraint, the node cannot be
eliminated.

NRR_10

Topology error.

Topology error prevents the elimination of the node.

NRR_11

Source nodes (feeders and

substation transformers)
cannot be reduced.

NRR_12

Nodes on sections with

equipment will not be
reduced.

If either section incident to the node holds devices, the

node is not eliminated.

NRR_13

Node ties multiple feeders.

If the node forms a tie point between multiple feeders, it

is not eliminated.

NRR_14

Percent I,Z,PQ values are

different.

Load model I, Z, and PQ values are checked on each

side of the node. If values vary by more than a fixed
1.5%, the node is not eliminated.

NRR_15

Load growth rates are

different.

If the load growth rate on either of the incident sections

differs by more than a fixed 0.15%, the node is not
eliminated.

NRR_16

Node along loop path.

NRR_17

Elbow adjacent to node.

NRR_18

Pad-mounted gear node.

NRR_19

Two sections sharing nodes.

SynerGEE does not eliminate nodes with potential

problems with node sharing. There are situations where
deleting a node may cause a new compound section to
share the same two nodes with an existing section. As a
result, the topology engine eliminates one of the two
sections sharing nodes. This rule looks for this potential
problem and prevents occurrence.

NRR_20

Area of interest adjacent to

node.

NRR_21

Nodes on sections with

areas of interest will not be
reduced.

User Guide

SynerGEE Electric 5.0

Modeling Sections

275

Rule

Description

Notes

NRR_22

Nodes on sections with

specified amp ratings will
not be reduced.

Prevents the deletion of nodes that are tied to an amprated section. For more information, see Editing
additional general settings for a section on page 283.

NRR_90

Don't allow any node

removal.

NRR_99

Unknown problem.

Node reduction example

Figure 6-8 shows a complete feeder generated from a GIS extraction. Although this model does not have
nodes for each pole, many models generated from a GIS do.

Figure 6-8 Full model before node reduction

Figure 6-9 shows the model after node reduction eliminated 35% of the nodes. Assume that the analysis was
set not to reduce vertices.

Figure 6-9 Updated model after node reduction

SynerGEE Electric 5.0

User Guide

276

Modeling Sections
Notice that the shape or spatial topology of the feeder is identical between the full and reduced model. In fact,
if node display is turned off, the reduced model lays precisely over the full model, as they are
indistinguishable. Naturally, if vertices are also reduced, this may not be the case.

Removing vertices
SynerGEE removes vertices based on a length percentage specified in your analysis options. This
percentage represents the following ratio:

Length of segment created by vertex

Total length of section

Eq 61

If the specified percentage is greater than this ratio for any given vertex, the vertex is removed. To determine
the numerator, Length of segment created by vertex, SynerGEE first performs a length trace from the vertex
towards the from-node end of the section. When it encounters the from-node or another vertex, the trace
stops and this length value is used in the calculations. In the following example, in a trace towards the fromnode, the length created by vertex A is 150 feet, and the length created by vertex B is 40 feet:
Total section length: 450 ft

Node
Vertex

A
D
20 ft
150 ft

40 ft

Figure 6-10 Section showing vertices

Therefore, if the total section length were 450 feet, you would need to specify a percentage of 34 or higher in
order for SynerGEE to eliminate vertex A. A percentage of 9 would be sufficient to eliminate vertex B, but
not A. Consider the following equation for vertex B:

Length of segment created by vertex B 40 ft

=
= .089
Total length of section
450 ft

Eq 62

After the from-node trace and removal of any qualifying vertices, the same process is repeated using a trace
towards the to-node. Note that any vertices removed during the from-node trace are no longer considered. As
an example, assume that vertices B and C were eliminated from the previous example during the fromnode trace. In this case, a percentage of 5 or higher would be sufficient to eliminate vertex D during the tonode trace:

User Guide

SynerGEE Electric 5.0

Modeling Sections

277

Total section length: 450 ft

Node
Vertex

A
D
20 ft
150 ft

Figure 6-11 Section with vertices B and C eliminated during the first trace

Length of segment created by vertex D 20 ft

=
= .044
Total length of section
450 ft

Eq 63

Note that regardless of whether or not vertices are eliminated, total section length is never recalculated.

Breaking loops with elbows

Node reduction can also break loops by automatically modeling an open elbow on one of the looped sections.
SynerGEE selects the section with the least amount of phasing for the elbow. After placing one elbow,
SynerGEE re-performs the trace and continues to place elbows as needed until all loops are broken.
Loop breaking is optional and can be controlled in the Node Reduction Options editor by selecting the Open
Loops Using Elbows option, as described in Setting up a node reduction on page 267. For more
information on elbows, see Elbows on page 408.

Load handling
When a section is eliminated in the process of reducing a node, the load, length, and other data for that
section is added to the combined section.
Figure 6-12 shows a group of sections with load values indicated:
20 kW

15 kW

10 kW

25 kW

Figure 6-12 Sections with individual loads

If the three center nodes are eliminated, the combined section yields:
70 kW

Figure 6-13 Combined sections with combined load

Distributed loads are modeled in the center of the section. Therefore, reduction can cause minor changes to
the model due to the combination of load and shifting of location. Nonetheless, extensive testing has shown
that loading and losses are nearly identical between the full and reduced models. The minimum and
maximum voltages on the feeder are also nearly identical between the full and reduced models.
Ideal models with evenly distributed constant current loads tend to have higher loss values in the reduced
model. However, the voltage drop to the end of the last line is the same after the reduction. The issue
becomes more complex when I, Z, PQ load models are introduced and when detailed by-phase analysis is

SynerGEE Electric 5.0

User Guide

278

Modeling Sections
performed with coupling. If you use SynerGEE in this manner, you should do further research before using
node reduction.

WORKING WITH GRAPHIC POINTS

Graphic points are used to show the geographic contour of a section. They allow you to create visual bends
in the line. For example, graphic points might be used to model a line section that bends around a curve in
the road. Graphic points are not visible on the map, except by the angles in the sections that they may form.
In addition, they have no effect on analysis results. Their purpose is solely to add shape to sections for a
more intuitive map display.
Graphic points are sometimes referred to as vertices or intermediate points. There is no limit to the number of
graphic points a section can contain.
Refer to the topics listed below for more information on working with graphic points.

Adding a graphic point on page 278

Moving a graphic point on page 278

Deleting a graphic point on page 279

Adding a graphic point

Perform the following procedure to add a graphic point to a section in your model.

TO ADD A GRAPHIC POINT

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Model group, click the Add Graphic Point button.

Move the cursor over any section in your model, in the location where you want to add the graphic
point. (The cursor will change to a crosshair symbol when you are over a section.)

Click the left mouse button to create a graphic point. Or, click and hold the left mouse button to add
a graphic point and also move the point to a new location in the map, thus reshaping the section
line. Repeat this step to add additional graphic points, as needed.

Press F5 to return to Default mode.

Moving a graphic point

Perform the following procedure to move a graphic point in your model.

TO MOVE A GRAPHIC POINT

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Model group, click the Move Graphic Point button.

User Guide

SynerGEE Electric 5.0

Modeling Sections

279

Move the cursor over any graphic point in your model. (The cursor will change to a crosshair symbol
when you are over a graphic point.)

Click and hold the left mouse button to select the graphic point, and then drag it to a new location
and release the mouse button. Repeat this step to move additional graphic points, as needed.

Press F5 to return to Default mode.

Deleting a graphic point

Perform the following procedure to delete a graphic point from your model.

TO DELETE AN EXISTING GRAPHIC POINT

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Model group, click the Delete Graphic Point button.

Move the cursor over the graphic point that you want to delete. (The cursor will change to a
crosshair symbol when you are over a graphic point.)

Click the left mouse button to delete the graphic point. Repeat this step to delete additional graphic
points, as needed.

Press F5 to return to Default mode.

ADDING SECTIONS
For information on adding sections, see Modeling Sections on page 258.

EDITING SECTIONS
Use the Section editor to edit an existing section in your model. Refer to the following procedure for more
information.

TO EDIT A SECTION
1

In the SynerGEE map display or model explorer, double-click the section that you want to edit.

On the left side of the Section editor, select from the different tab names to access the available
settings for the section. The following topics describe the different tasks that you can perform:
-

Editing general data for a section on page 280

Editing construction data for a section on page 281

Editing additional general settings for a section on page 283

Adding distributed loads to a section on page 284

Adding distribution transformers to a section on page 295

Adding spot loads to a section on page 287

SynerGEE Electric 5.0

User Guide

280

Modeling Sections

Setting up projects for a section on page 289

Assigning zones to sections on page 301

Editing graphic points for a section on page 303

Viewing analysis results for a section on page 304

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a section

TO EDIT GENERAL DATA FOR A SECTION
1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Section tab. The following table describes the different options that
you can set.

User Guide

Description

Optional description for the section.

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Loc. Link

Syntax to link the switch to an external source, such as a file, website,

or location in an Internet mapping software application. SynerGEEs
location link feature, as well as the syntax required to set up location
links, is described in Location Links on page 223.

AMS Link

Syntax to link the section to an Asset Management System.

Phasing

Section phasing.

Conductor Length

Specifies the section length used for analyses. It does not have to
match the calculated length based on map coordinates, so it does not
have to be to scale with the map. You can also use the Multiple Editor
to assign calculated conductor lengths for queried sections.

Hide Map Results

If selected, results for the section will not appear on the map.

Broadcast

Select this check box to include the section in the list of Marked
Facilities in SynerGEEs Broadcaster window. For more information
on the Broadcaster window, see Using the Broadcaster on
page 451.

Monitor Harmonic

Select this check box to include the section in a harmonic analysis.

For more information on harmonics, see Harmonic Analysis on
page 689.

SynerGEE Electric 5.0

Modeling Sections

Critical

281

Select this check box to mark the section as a critical section that can
be analyzed during a contingency analysis. To perform a contingency
analysis on critical sections, do the following:
a

In the Contingency Analysis Options editor, select the

Approach tab.

Under Batch run, select Section and then select Critical.

For more information, see Contingency Analysis on page 535.

Contingency

Select this check box to mark the section as a contingency section

that can be analyzed during a contingency analysis. To perform a
contingency analysis on contingency sections, do the following:
a

In the Contingency Analysis Options editor, select the

Approach tab.

Under Batch run, select Section and then select

Contingency.

For more information, see Contingency Analysis on page 535.

3

Click Apply to accept your changes, and then click X to close the editor.

Editing construction data for a section

Use the Construction tab in the Section editor to edit construction data for a section. You can also copy all
data on the Construction tab from one editor to another, by using SynerGEEs Copy Construction tool. Refer
to the procedures listed below for more information.

TO EDIT CONSTRUCTION DATA FOR A SECTION

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Construction tab. The following table describes the different options
that you can set.
Construction Model

Options for handling conductor spacing for impedance and

admittance calculations. For more information on these options, see
Conductor spacing options on page 310.

Conductor Types

Conductor or duct bank types for the different phases. Available

conductor types are stored in your equipment data source. For more
information on conductor types, see Conductors on page 304.

Grounded

Whether or not the neutral phase is multi-grounded. For more

information on the effects of grounds and earth resistivity, see the
SynerGEE Technical Reference.

SynerGEE Electric 5.0

User Guide

282

Modeling Sections

Equivalent Spacing
and Height

Values can be used if Equivalent Spacing is selected. If you have

selected Detailed Spacing, the Height to reference also serves as a
reference point for the specified configuration type. The values that
show up in these menus are customizable, using the Spacing tab in
the Preferences editor. For more information, see Setting values for
conductor spacing and height above ground on page 169.

Detailed Spacing

Information on configuration type and phase positions. This data is

applicable only if you have selected Detailed Spacing. For more
information on configuration types and detailed spacing, see
Conductor Configuration and Positions on page 310.

Click Apply to accept your changes, and then click X to close the editor.

TO COPY CONSTRUCTION DATA FROM ONE SECTION TO ANOTHER

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Model group, click the Copy Construction button (Figure 6-14).

Figure 6-14 Copy Construction button

In the SynerGEE map display, click on the section that you want to copy construction data from. The
selected section will turn red.

Click on the section that you want to copy construction data to.

Press F5 to return to the Default mode.

User Guide

SynerGEE Electric 5.0

Modeling Sections

283

Editing additional general settings for a section

TO EDIT ADDITIONAL GENERAL DATA FOR A SECTION
1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Properties tab. The following table describes the different options
that you can set.
Amp Rating for
Loading Calculations

Designates whether SynerGEE uses amperage ratings associated

with assigned conductor(s), or a manual override value that you
specify here. Conductor types are assigned in the Construction tab of
the Section editor. For more information on conductor types, see
Conductors on page 304.
A specified amp rating is a key indicator for circuit loading. If you have
this option activated, SynerGEE will not consider a specified amp
rating during node reduction. For more information, see Reducing
the number of nodes on page 267.
If you have this option set to use amperage from the duct bank, the
duct bank derated amps are used as the override value, in place a
manual override. If you specify From Duct Bank, you will notice that
the Amp Rating text box is disabled and can only be changed using
the duct bank evaluation. Essentially, the derated amperage value
from a duct bank works identically to a specified manual override,
except that you do not edit the value directly. When From Duct Bank
is selected, only the duct bank evaluation can update the override
value. For more information, see Duct Bank Evaluation on
page 798.
If you have this option set to From Conductor and also have a duct
bank applied, SynerGEE will ignore the duct bank conductors for
amperage ratings, using the conductors specified in the section
record instead. This situation will produce a warning on analysis
reports.

Elbows / Switch Gear

Settings to model an elbow at either or both section ends. For more

information on modeling elbows, see Elbows on page 408.

% Growth Rate/Year

The section growth rate. For more information on growth rates, see
Load Growth on page 801.

Connection

The load connection, which also applies to the generation component

of a large customer, if modeled. For more information on large
customers, see Large Customers and Distributed Generation on
page 503.

SynerGEE Electric 5.0

User Guide

284

Modeling Sections

Load Category

Load categories are an optional SynerGEE setting that you can use
to group common sections for reporting and mapping (color-by)
purposes. Load categories have no effect on analysis and do not
have any other impact on your model.
The available categories are defined in your SynerGEE preferences.
For more information on load categories and how to create them, see
Managing load categories on page 170.

Link to facilities
attached to this
section

If any facilities are placed on the section you are editing, click on the
Go To buttons located in this area to open the appropriate facility
editor. Any facility types that are not present on the current section will
be disabled.

Click Apply to accept your changes, and then click X to close the editor.

Adding distributed loads to a section

TO ADD DISTRIBUTED LOADS TO A SECTION
1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Load - Dist tab. The following table describes the different options
that you can set.
Description

User Guide

Specify an optional description for the distributed load. This field has
no effect on any SynerGEE analysis. You can use it to store any
pertinent data you may want to reference later.

SynerGEE Electric 5.0

Modeling Sections

Distributed Load/
Phase Values

285

Specify the actual load values for the distributed load.

Use the A, B, and C columns specify the load values for

each phase. The values that you enter for each phase will
be summed in the Totals column.

If you enter a value in the Totals column instead, that value

will be distributed proportionally among the three phases
based on the current values for each phase.

SynerGEE provides several other methods that you can use to edit
load values. For example, you can:

Click the Balance button (Figure 6-15) to divide the loads

equally among all three phases.

Figure 6-15 Balance button

Click the Load Graph button (Figure 6-16) to edit load values
using a graphical display. Click the Year button at the top of
the display to select a specific year to edit; select All to edit
load values for all years at once. Click anywhere outside of
the Load Graph editor to close the window.

Figure 6-16 Load Graph button

SynerGEE Electric 5.0

Use the load allocation analysis to populate values for KW

and kvar. For more information on load allocation analysis,
see Load Allocation Analysis on page 549.

User Guide

286

Modeling Sections

KW

Specify the distributed kW load on the section.

kvar

Specify the distributed kvar load on the section. The kvar demand
does not include the sections capacitors or cable capacitance.

Conn kVA

Specify the total kVA capacity of the transformers on each phase for
the section, excluding spot load connected kVA. This information is
required for load allocation analysis if you are allocating loads based
on connected kVA. If you do not have by-phase load information,
apply the load equally among the phases.

Conn kWh

Specify the total peak-month kWh usage in each phase of the

section, excluding spot load connected kWh. This information is
required if you wish to allocate loads based on kWh with load
allocation analysis. If you do not have by-phase load information,
apply the load equally among the phases.

Customers

Specify the total number of customers per phase for the section. A
single three-phase customer is represented by 0.3 in each phase.
Customer information is required if you are allocating loads based on
the RUS method with load allocation analysis. If you do not have byphase customer totals, apply the customers equally among the
phases.

Capacity Factor

Specify a factor that allows you to simulate under-utilized

transformers in your system. The factor, which can be from 0 (0%) to
1 (100%) or greater, is applied as a flat multiplier to connected kVA on
all phases during load allocation. For more information, see Capacity
Factors on page 502.

Use Customer Zone

Select this check box to assign customer zone load curves to the
distributed load. Then, use the Customer Zone option list to select the
name of the customer zone that you want to apply.
Additional information on customer zones and load curves is provided
in Customer Load Curves/Time-of-Day Analysis on page 808.

Spot Constant
Percent Load

Use the %I, %Z, and %PQ text boxes to specify the percentage of the
distributed load that is constant current, constant impedance, and
constant power, as appropriate. Since loads are never truly 100%
constant power, you can use these check boxes to more accurately
define the characteristics of the load, thus leading to more accurate
analysis results.
Optionally, you can select the Use %I, %Z, %PQ values from
customer classes check box to use the I, Z, and PQ values that are
defined in a selected customer zone. If you select this check box, the
text boxes to edit the I, Z, and PQ values for the distributed load will
be disabled.
For more information on I, Z, PQ, see Load %I, %Z, %PQ on
page 496.

User Guide

SynerGEE Electric 5.0

Modeling Sections
3

287

Click Apply to accept your changes, and then click X to close the editor.

Adding spot loads to a section

TO ADD SPOT LOADS TO A SECTION
1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Load - Spot tab. The following table describes the different options
that you can edit.
Spot Load Status

Specifies whether the spot load is considered or ignored during a

SynerGEE analysis. Select the Is On check box to enable the spot
load, or clear the check box to disable the spot load.

Spot Load Location

Specifies the location of the spot load relative to the section. Available
choices are From Node, Center, and To Node.

Description

Specify an optional description for the spot load. This field has no
effect on any SynerGEE analysis. You can use it to store any
pertinent data you may want to reference later.

SynerGEE Electric 5.0

User Guide

288

Modeling Sections

Spot Load/Phase
Values

Specify the actual load values for the spot load.

Use the A, B, and C columns specify the load values for

each phase. The values that you enter for each phase will
be summed in the Totals column.

If you enter a value in the Totals column instead, that value

will be distributed proportionally among the three phases
based on the current values for each phase.

SynerGEE provides several other methods that you can use to edit
load values. For example, you can:

Click the Balance button (Figure 6-17) to divide the loads

equally among all three phases.

Figure 6-17 Balance button

Click the Load Graph button (Figure 6-18) to edit load values
using a graphical display. Click the Year button at the top of
the display to select a specific year to edit; select All to edit
load values for all years at once. Click anywhere outside of
the Load Graph editor to close the window.

Figure 6-18 Load Graph button

User Guide

Use the SynerGEE Bulk Editor to edit spot loads for all
sections at once. For more information, see Using the Bulk
Editor on page 192.

SynerGEE Electric 5.0

Modeling Sections

289

KW

Specify the total metered kW per phase for the spot load. If you do not
have by-phase load information, apply the load equally among the
phases.

kvar

Specify the total kvar per phase for the spot load.

Conn. kVA and Conn.

kWh

Specify the total transformer connected KVA and connected kWh.

These values are optional and for reference purposes only, and may
be particularly useful if you generate your models directly from a GIS.
SynerGEE does not use it for any analysis. However, it may appear in
reports, such as the inventory report.

Customers

Specify the total customer load per phase in the spot load.

Capacity Factor

Specify a factor that allows you to simulate under-utilized

transformers in your system. The factor, which can be from 0 (0%) to
1 (100%) or greater, is applied as a flat multiplier to connected kVA on
all phases during load allocation. For more information, see Capacity
Factors on page 502.

Use Customer Zone

Select this check box to assign customer zone load curves to the spot
load. Then, use the Customer Zone option list to select the name of
the customer zone that you want to apply.
Additional information on customer zones and load curves is provided
in Customer Load Curves/Time-of-Day Analysis on page 808.

Spot Constant
Percent Load

Use the %I, %Z, and %PQ text boxes to specify the percentage of the
spot load that is constant current, constant impedance, and constant
power, as appropriate. Since loads are never truly 100% constant
power, you can use these check boxes to more accurately define the
characteristics of the load, thus leading to more accurate analysis
results.
Optionally, you can select the Use %I, %Z, %PQ values from
customer classes check box to use the I, Z, and PQ values that are
defined in a selected customer zone. If you select this check box, the
text boxes to edit the I, Z, and PQ values for the spot load will be
disabled.
For more information on I, Z, PQ, see Load %I, %Z, %PQ on
page 496.

Click Apply to accept your changes, and then click X to close the editor.

Setting up projects for a section

Projects allow you to set up multiple spot loads on a single section. Their use is optional, and they can be
used in conjunction with traditional spot loads, which are specified on the Load - Spot tab in the Section
editor. Projects allow you to selectively enable and disable individual loads on a single section, and
separately energize and retire individual loads during multi-year modeling.

SynerGEE Electric 5.0

User Guide

290

Modeling Sections
You can use the Load - Proj tab in the Section editor to add, edit, and delete projects for individual sections.
You can also use the Project worksheet to add, edit, and delete projects for all sections in your model at one
time.
The following table describes the fields that you can edit for each project. These fields are available from both
the Load - Proj tab in the Section editor and the Project worksheet.
Field Name

Description

Name

Project name, which must be unique for data storage and

identification purposes.

Multiplier

Multiplier value for the project years.

Description

Any description for organizational use only. The description is not

used by SynerGEE.

KW/kvar

Total project load value, for all phases. This value is always the total
load applied, whether to a single phase, or balanced between multiple
phases.

A, B, and C

Phases over which the total load is distributed. The total project load
is divided equally among all selected phases that are configured for
the respective section.

Code

A second field for organizational use. The code is intended for

smaller, categorical identifiers that may be particularly useful for
sorting and organizing projects in the Project View window. The code
is not used by SynerGEE.

Energize and Retire

Energize and retire years for multi-year analysis. Each project can
have individual settings. For more information, see Multi-Year
Analysis on page 579.

Refer to the sections listed below for information on setting up project loads for a section. More detailed
information on projects is provided in Projects (Load) on page 511.

Editing projects using the Section editor on page 290

Editing projects using the Project worksheet on page 292

Editing projects using the Projects Manager on page 293

Editing projects using the Section editor

The Load - Proj tab of the Section editor can be used to edit the projects that are associated with a single
section. The changes you make here are reflected in the Project worksheet for the respective project.
Refer to the following procedure for more information on working in the Section editor. For other methods of
editing projects, see Editing projects using the Project worksheet on page 292 and Editing projects using
the Projects Manager on page 293.

User Guide

SynerGEE Electric 5.0

Modeling Sections

291

TO EDIT PROJECTS USING THE SECTION EDITOR

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Load - Proj tab. The following table describes the different tasks that
you can perform.
To ...

Do This ...

Add a project

Click Add. A new project is added to the end of the existing

list.

Edit a project

Enable a project

Disable a project

Copy a project

Delete a project

Open the Project worksheet

In the list of project, select the project that you want

to edit.

Use the fields in the lower half of the Load - Proj tab
to edit the settings for the project. The individual
fields are described in Setting up projects for a
section on page 289.

In the list of projects, select the project that you

want to enable.

Select (check) the check box in the Enable column

of the projects list.

In the list of projects, select the project that you

want to disable.

Clear (uncheck) the check box in the Enable

column of the projects list.

In the list of project, select the project that you want

to copy.

Click Copy. A copy of the selected project is added

to the end of the existing list.

In the list of projects, select the project that you

want to delete.

Click Delete.

Click Worksheet. The Project worksheet opens, where you

can add, edit, and delete projects for the current section as
well as all other sections in your model. For more
information on using the Project worksheet, see Editing
projects using the Project worksheet on page 292.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

292

Modeling Sections

Editing projects using the Project worksheet

The Project worksheet provides a convenient method to edit all projects for the selected feeders in your
model. The changes you make here are reflected in the Load - Proj tab of the Section editor for each
respective project.
The upper half of the Project worksheet shows each project in the selected feeders in your model. The
worksheet includes fields such as the projects name, phasing, and energize and retire years. The lower half
of the Project worksheet includes data fields that you can use to edit the settings for a selected project, plus
toolbar buttons that you can use perform tasks such as adding, editing, and deleting projects. This area also
includes a table that shows multi-year data for the selected project, including kW and kVAR for each year.
The current year is highlighted in the multi-year table, and inactive years for the project are grayed out. The
propagation method is shown below the table, and summary data for all projects (such as the number of
projects and the number of active projects) is shown to the right of the table.
Refer to the following procedure for more information on working in the Project worksheet. For other methods
of editing projects, see Editing projects using the Section editor on page 290 and Editing projects using the
Projects Manager on page 293.

TO EDIT PROJECTS USING THE PROJECT WORKSHEET

1

Perform the following steps to open the Project worksheet:

a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Worksheets group, click Projects.

Use the options in the Project worksheet to do the following:

To ...
Add a project

Edit a project

Enable a project

User Guide

Do This ...
a

Click Add.

In the Sections editor, select the section where the new

project will be located.

Click OK to accept the selection. The new project is added

to the worksheet.

In the list of projects, select the project that you want to edit.

Double-click the project, or right-click and select Edit.

Use the fields in the lower half of the Project worksheet to

edit the settings for the project. The individual fields are
described in Setting up projects for a section on page 289.

Click Update to accept the changes and display them in the

worksheet.

In the list of projects, select the project that you want to

enable.

Click Enable, or select (check) the check box in the Enable

column of the worksheet.

SynerGEE Electric 5.0

Modeling Sections

To ...
Disable a project

Copy a project

Delete a project

Work with sections for a

project

Move a project from

one section to another

293

Do This ...
a

In the list of projects, select the project that you want to

disable.

Click Disable, or clear (uncheck) the check box in the

Enable column of the worksheet.

In the list of projects, select the project that you want to copy.

Click Copy. A copy of the selected project is added to the

worksheet.

In the list of projects, select the project that you want to

delete.

Click Delete.

Click Yes to confirm the deletion.

In the list of projects, select the project that you want to work
with.

Right-click and select from one of the following options:

-

Edit Section to open the Section editor for the

associated section

Zoom to zoom the map display to the location of

the associated section

Send to Query to send the associated section to

the Query tab

In the Project worksheet, select the project that you want to

move. Use the Shift or Ctrl keys to select multiple projects.

Select the Map window.

In the SynerGEE map display, right-click on the section that

you want to move the project to and select Move Project.
The project is moved to the new section.

Right-click on the Project Worksheet tab and select Delete to close the worksheet.

Editing projects using the Projects Manager

The Projects Manager provides a convenient method to move projects from one section to another. The left
side of the Projects Manager shows each project in the selected feeders in your model. The project list
includes the project name, section name, feeder name, and load. The lower-right side of the Projects
Manager is a buffer area. You can use this area to identify the projects that you want to move from one
section to another. The upper-right area shows the projects that are assigned to the most recently selected
section.

SynerGEE Electric 5.0

User Guide

294

Modeling Sections
To move a project from one section to another, you would to use the Projects Manager to identify the project
that you want to move, and then move that project to the project buffer. Then, you would select the section
that you want to move the project to; this section appears in the upper-right corner of the Projects Manager.
When you click the Apply button, the selected project in the buffer area will be transferred from the original
section to the selected target section.
The Projects Manager includes several toolbar buttons that you can use to interact with your sections. For
example, you can zoom to a selected section, and also open the Section editor. Refer to the following
procedure for more information on working in the Projects Manager. For other methods of editing projects,
see Editing projects using the Section editor on page 290 and Editing projects using the Project worksheet
on page 292.

TO EDIT PROJECTS USING THE PROJECTS MANAGER

1

Perform the following steps to open the Projects Manager:

a

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Managers group, click Projects Manager.

Use the options in the Projects Manager to do the following:

To ...
Move a project from
one section to another

Edit a project

User Guide

Do This ...
a

In any area of the Projects Manager, locate the name of the

project that you want to move.

Click Buffer. The project name will move from the All
Projects area of the Projects Manager to the Buffer area.

Use the SynerGEE map display to select the section that

you want to move the project to. That section will be listed in
the Section area of the Projects Manager. If any other
projects are associated with that section, those projects will
also be listed in the Section area.

In the Buffer area, select the name of the project that you
want to move, and then click Apply. The project will be
removed from its original section and added to the section
that is listed in the Section area.

In any area of the Projects Manager, select the name of the

project that you want to edit.

Click Edit. This will open the Section editor for the section
that is associated with the project.

Use the Load - Proj tab of the Section editor to edit the
settings for the project. For information on the fields you can
edit, see Setting up projects for a section on page 289.

SynerGEE Electric 5.0

Modeling Sections

To ...
Zoom to the location of
a project

295

Do This ...
a

In any area of the Projects Manager, select the name of the

project that you want to view.

Click Zoom. The SynerGEE map display window will zoom

to the location of the section that is associated with the
project.

Click Hide or press F4 to close the Projects Manager.

Adding distribution transformers to a section

Use the Load - DTran tab in the Section editor you to add, edit, and delete distribution transformers for
individual sections. You can also use the DTrans worksheet to add, edit, and delete distribution transformers
for all sections in your model at one time.
The following table describes the fields that you can edit for each distribution transformer. These fields are
available from both the Load - DTran tab and the DTrans worksheet.
Field Name

Description

TranID

Name of the distribution transformer.

Description

Description of the distribution transformer. This field is optional and

has no effect on any analysis.

A, B, and C

Phases to which the distribution transformer will be applied.

Demand kVA

Total metered kVa for the distribution transformer. SynerGEE does

not consider spot load information during load allocation analysis. For
more information on load allocation analysis, see Load Allocation
Analysis on page 549.

Connected kVA

Total kVA capacity of the distribution transformer, excluding spot load

connected kVA. This information is required for load allocation
analysis if you are allocating loads based on connected kVA.

Connected Cust

Total number of customers for the distribution transformer. Customer

information is required if you are allocating loads based on the RUS
method with load allocation analysis.

Connected kWh

Total peak-month kWh usage for the distribution transformer,

excluding spot load kWh. This is required if you wish to allocate loads
based on kWh with load allocation analysis.

Impedance %Z

Nameplate value expressed as a percent using the rated kVA as a

base. For more information on impedance, see the SynerGEE
Technical Reference.

Impedance X/R

Nameplate X/R. For more information on impedance, see the

SynerGEE Technical Reference.

SynerGEE Electric 5.0

User Guide

296

Modeling Sections

Field Name

Description

Coordinates

Transformer coordinates from the CMM import file.

Energize and Retire

Energize and retirement settings for multi-year modeling and

analysis. For more information, see Multi-Year Analysis on
page 579.

Refer to the following procedures for information on setting up distribution transformers loads for a section.

To edit distribution transformers using the Section editor on page 296

To edit distribution transformers using the DTran worksheet on page 297

TO EDIT DISTRIBUTION TRANSFORMERS USING THE SECTION EDITOR

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Load - DTran tab. The following table describes the different tasks
that you can perform.
To ...

Do This ...

Add a distribution transformer

Click Add. A new distribution transformer is added to the

end of the existing list.

Edit a distribution transformer

Copy a distribution transformer

Delete a distribution transformer

Open the Distribution

Transformer worksheet

User Guide

In the list of distribution transformers, select the

distribution transformer that you want to edit.

Use the fields in the lower half of the Load - DTran

tab to edit the settings for the distribution
transformer. The individual fields are described in
Adding distribution transformers to a section on
page 295.

In the list of distribution transformers, select the

transformer that you want to copy.

Click Copy. A copy of the selected distribution

transformer is added to the end of the existing list.

In the list of distribution transformers, select the

transformer that you want to delete.

Click Delete.

Click Worksheet. The DTrans worksheet opens, where you

can add, edit, and delete distribution transformers for the
current section as well as all other sections in your model.
For more information on using the DTrans worksheet, see
To edit distribution transformers using the DTran
worksheet on page 297.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Modeling Sections

297

TO EDIT DISTRIBUTION TRANSFORMERS USING THE DTRAN WORKSHEET

1

Perform the following steps to open the DTrans worksheet:

a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Worksheets group, click DTrans.

Use the options in the DTrans worksheet to perform the following tasks.
To ...
Add a distribution transformer

Edit a distribution transformer

Copy a distribution transformer

Delete a distribution transformer

SynerGEE Electric 5.0

Do This ...
a

Click Add.

In the Sections editor, select the section where the

new distribution transformer will be located.

Click OK to accept the selection. The new

distribution transformer is added to the worksheet.

In the list of distribution transformers, select the

distribution transformer that you want to edit.

Double-click the distribution transformer, or rightclick and select Edit.

Use the fields in the lower half of the DTrans

worksheet to edit the settings for the distribution
transformer. The individual fields are described in
Adding distribution transformers to a section on
page 295.

Click Update to accept the changes and display

them in the worksheet.

In the list of distribution transformers, select the

transformer that you want to copy.

Click Copy. A copy of the selected distribution

transformer is added to the worksheet.

In the list of distribution transformers, select the

transformer that you want to delete.

Click Delete.

Click Yes to confirm the deletion.

User Guide

298

Modeling Sections

To ...
Work with sections for a
distribution transformer

Do This ...
a

In the list of distribution transformers, select the

distribution transformer that you want to work with.

Right-click and select from one of the following

options:
-

Edit Section to open the Section editor

for the associated section

Zoom to zoom the map display to the

location of the associated section

Send to Query to send the associated

section to the Query tab

Right-click on the DTrans Worksheet tab and select Delete to close the worksheet.

Adding a distributed generator to a section

TO ADD A DISTRIBUTED GENERATOR TO A SECTION
1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Gen - Dist tab. The following table describes the different options
that you can set.
Generation Is On

Select this check box to enable the distributed generator on the

section.

Description

Specify an optional description for the sections distributed generator.

This field has no effect on any analysis.

Type

Select a generator type from your equipment warehouse to apply to

the section. Only generator types where the Section Distributed
Generation check box is selected on the Ratings tab of the
Generator Type editor will be available for selection from this list.
If the referenced generator type does not exist in the currently loaded
equipment warehouse, then the generator type will be displayed as
Unknown. If an analysis fails because of a missing equipment type,
the resulting report will specifically indicate the offending device(s).
The generator type association will be restored once a matching
equipment warehouse is opened.
For more information on generator types, see Managing generator
types in the equipment warehouse on page 348.

User Guide

SynerGEE Electric 5.0

Modeling Sections

Location

SynerGEE Electric 5.0

299

Select the location of the distributed generator on the section.

Available options are as follows:

From Node

Center

To Node.

User Guide

300

Modeling Sections

Specify rated output

Select this check box and then use the A, B, and C columns to specify
the following rated output values for the distributed generator. The
values that you enter for each phase will be summed in the Totals
column. If you enter a value in the Totals column instead, that value
will be distributed proportionally among the three phases based on
the current values for each phase.

Rated kW. Peak generation capacity.

Rated pf. Peak generation capacity.

Capacity Factor. Factor that relates the average output of

the generator to the rated output of the generator.

SynerGEE provides several other methods that you can use to edit
load values. For example, you can:

Click the Balance button (Figure 6-19) to divide the loads

equally among all three phases.

Figure 6-19 Balance button

Click the Load Graph button (Figure 6-20) to edit load values
using a graphical display. Click the Year button at the top of
the display to select a specific year to edit; select All to edit
load values for all years at once. Click anywhere outside of
the Load Graph editor to close the window.

Figure 6-20 Load Graph button

User Guide

SynerGEE Electric 5.0

Modeling Sections

Generator Output

Specify pf

301

Select from one of the following options:

Rated kW output.

Specify Output %. Select this option to specify the

percentage of steady-state contribution of the generator.
The value is the percent of the capacity of the generating
unit that is contributing toward the kW and kvar loading
requirements of the feeder.

Weather based performance.

Diurnal (hourly) curve. Select this option to specify that the

generators output is defined by the load curve of a selected
customer class. For more information on working with
customer classes, see Customer classes on page 810.

Select this check box to specify a power factor percentage specific to

this sections distributed generator. If the check box is cleared, the
rated power factor percentage for the associated generator type will
be used.

Click Apply to accept your changes, and then click X to close the editor.

Assigning zones to sections

TO ASSIGN ZONES TO SECTIONS
1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Zones tab. The following table describes the different options that
you can set.
Field

Description

Exposure Zone

Specifies the name of an exposure zone that is associated with the

section for reliability analyses. An exposure zone represents a preset
collection of failure data that can be applied directly to multiple
sections, so that you do not have to configure identical data for each
section. All sections assigned to a particular exposure zone share
common values for that zone.
For more information on exposure zones and reliability analyses, see
Exposure zones on page 679.

SynerGEE Electric 5.0

User Guide

302

Modeling Sections

Field

Description

Mitigation Zone

Specifies the name of a mitigation zone that is associated with the

section for reliability analyses. A mitigation zone is a collection of root
failure causes in your system, with a percentage of mitigation
effectiveness assigned to each. When you assign a mitigation zone to
a section, root causes are considered mitigated according to the
respective percentages. All sections assigned to a particular
mitigation zone share common values for that zone.
For more information on mitigation zones and reliability analyses, see
Mitigation zones on page 683.

Exposure Factors

Specifies the following exposure factors for the sections exposure

zone:

Permanent failures

Temporary failure rates

Repair times

For more information on exposure factors, see Exposure factors and

reliability studies on page 673.
Energize and Retire

Specifies energize and retire years for multi-year modeling and

analysis. For more information, see Multi-Year Analysis on
page 579.

Growth Curve

Specifies the name of a growth curve that is associated with the

section for single-year and multi-year modeling. Growth curves are
collections of annual growth rates that you can assign to sections as a
zone. All sections assigned to a particular growth curve share
common values for that zone.
For more information on growth curves, see Growth curves on
page 804.

Cost Zone

Specifies the name of a cost zone that is associated with the section.
Cost zones provide valuable information relevant to the Economic
analysis module. The cost zone editor includes maintenance cost
information for feeders and substations as well as cost multipliers for
fuses, equipment, distribution transformers, and customers. These
values are combined with performance metrics such as load factor,
utilization, and efficiency to determine the cost per MW or MWHr.
For more information on cost zones, see Managing Cost Zones on
page 851.

User Guide

SynerGEE Electric 5.0

Modeling Sections

303

Field

Description

Weather Zone

Specifies the name of a weather zone that is associated with the

section. Weather zones allow you to model the variation in cloud
cover in different parts of a system. For example, solar plants in
different sections may experience significant differences in cloud
cover. This could result in a large MVA input from one plant and a
substantial MVA drop in another. This power swing will affect flow and
regulator and LTC tapping.
For more information on weather zones, see Using Weather Zones
to Model Variations in Cloud Cover on page 834.

Click Apply to accept your changes, and then click X to close the editor.

Editing graphic points for a section

The Coordinates tab in the Section editor lists the XY coordinates for all nodes and graphic points that are
associated with the section. The node coordinates cannot be edited from this list, but you can add, edit, and
delete any of the graphics points. Refer to the following procedure for more information.

TO EDIT GRAPHIC POINTS FOR A SECTION

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Coordinates tab. The following table describes the different tasks
that you can perform.
To ...
Add a graphic point

Do This ...
a

If desired, select an existing graphic point in the current list

of graphic points. (The new graphic point will be inserted
before the selected point.)

Click Insert New. A new graphic point is inserted with a

default position of 0.000,0.000.

Edit a graphic point

coordinate

Double-click the coordinate that you want to edit.

Type a new value and then press Enter.

Change the order of

graphic points in the list

Select the graphic point that you want to move.

Click Move Up or Move Down, as appropriate, to rearrange

the order of the point. Note that this action does not
physically move the point that is, it does not change the XY
coordinates. It only moves the position of the graphic point in
the current list in the Coordinates tab.

Delete a graphic point

Select the graphic point that you want to delete.

Click Delete.

SynerGEE Electric 5.0

User Guide

304

Modeling Sections
3

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a section

The Results tab in the Section editor provides analysis results for the section. The Results tab can be very
helpful if you are running multiple analyses and focusing on a particular section. Since the settings update
automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a section.

TO VIEW ANALYSIS RESULTS FOR A SECTION

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

CONDUCTORS
SynerGEE provides a detailed conductor model. In SynerGEE, conductor type records are stored in your
equipment data source and treated much like equipment types.
The conductor table in the equipment data source (DevConductors, in Access) contains the required data for
standard conductors and cables. One record in the conductor file contains all the required data for one type
of conductor used in the system. These records are then referenced by section instances in the model.
Therefore, before you create a model, your equipment data source should be set up with the conductors that
you need. For more information on adding items to the equipment data source, see Creating a device type
on page 319.
The sample equipment database provided with your copy of SynerGEE contains a conductor table with many
of the commonly used conductors. Most values were taken from the Transmission and Distribution Reference
Book. You may use the information in the table or customize your own conductor models.
Refer to the topics listed below for more information.

Creating a conductor type on page 305

Editing a conductor type on page 305

Deleting a conductor type on page 308

Sorting conductor types on page 308

User Guide

SynerGEE Electric 5.0

Modeling Sections

305

Use of conductor data on page 309

Conductor spacing options on page 310

Creating a conductor type

Perform the following procedure to create a new conductor type in your equipment warehouse.

TO CREATE A CONDUCTOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Conductor.

In the Enter Device ID dialog box, type a name for the new device type and then click OK.

Use the Conductor Type editor to edit the settings for the conductor type. For more information on
the options you can set, see Editing a conductor type on page 305.

Editing a conductor type

To edit a conductor type, double-click the conductor type name in the Warehouse tab of the SynerGEE model
explorer. From the Construction tab in the Section editor, you can also click the edit button that is located next
to the name of a conductor that is selected in the Conductor Types area.
Refer to the following procedure for more information.

TO EDIT A CONDUCTOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Conductor (Base) or Conductors (Cable) and then double-click the name of the
conductor type that you want to edit.

In the Conductor Type editor, select the Ratings tab. The following table describes the different
options that you can set.
Description

Optional description for the conductor type.

Conductor Model

Specifies the type of conductor. The option that you select here will
enable and disable other options in the Conductor editor.
The available conductor model types are described in Types of cable
conductors on page 787.

Use specified
impedance

Sets SynerGEE to use the user-specified impedance values. Values

are entered in the Impedance area of the Conductor editor.

Calculate impedance

Sets SynerGEE to calculate its own values for impedance. Any

values that are specified in the Conductor editor will be ignored.

SynerGEE Electric 5.0

User Guide

306

Modeling Sections

Damage Factor

Key factor in the conductor damage curve equation. This parameter is

only used for plotting conductor damage curves on the TCC. For
more information on conductor damage curves, see Conductor
Damage Curves on page 316.

Color

Specifies the color that is used to represent the conductor in the

SynerGEE map display when your display settings are set to color the
map by conductor. For more information on the display settings, see
Customizing the Map Display on page 200.

Impedance: Ohms/MI
or uS/MI

User-specified conductor impedance and diameter. Some of these

fields may be disabled depending on your selections for Conductor
Model and Use specified impedance.

Continuous Amp
Rating

Continuous current rating. This value is used in analyses to calculate

the percent loading and for displaying regulator overload exceptions.
The value can be set for summer and winter, which is then used in
weather modeling.
For more information on conductors and weather modeling, see
Setting up conductors to use seasonal ratings on page 832.

Emergency Amp
Rating

Emergency current rating. This value is used in balanced and byphase analysis and capacitor placement to flag overloaded sections
and to display regulator overload exceptions. The value can be set for
summer and winter, which is then used in weather modeling.
For more information on conductors and weather modeling, see
Setting up conductors to use seasonal ratings on page 832.

Select the Cable tab. This information applies to cables only and the options will be enabled only if
you have not selected a cable-type conductor in the Ratings tab. In addition, much of the data in this
tab only applies to ampacity studies, and will be enabled only if you have selected the Use in
ampacity studies check box.
Refer to the following table for more information on the different options that you can set. For
diagrams that display many of the parameters you can set in this tab, see Concentric neutral cable
model on page 787 and Tape shield conductor model on page 788.

User Guide

Use in ampacity
studies

Allows you to enable the conductor for ampacity studies. This option
must be selected to enable the other options in the tab, including the
conductor material, insulation type, and jacket material.

Cable Material

Important data for impedance calculations, if you have chosen

SynerGEE to calculate impedance in the Ratings tab. For more
information on impedance calculations, see the SynerGEE Technical
Reference.

Conductor Material

Insulation Type

Jacket Material

SynerGEE Electric 5.0

Modeling Sections

307

Cable is three-core
type

Specifies that the conductor is a three-core cable type. For more

information, see Three-core cable model on page 789.

Cable data

Use the options in the Cable data area to specify the following:

Conductor diameter.

Insulation diameter.

Outside diameter.

Sheath thickness. For a Concentric neutral conductor

type, this option specifies the thickness of the sheath
between the insulation and the concentric neutral ring.
For a Tape shield conductor type, this option specifies the
thickness of the sheath between the insulation and the
shielding.

Data for impedance

calculations

Jacket thickness. Thickness of the outer cable jacket.

Core strand diameter. Diameter of one strand of the main

conductor.

Core strand count. Number of strands in the main

conductor.

Maximum temperature. Maximum rated temperature of the

main conductor.

Additional data for impedance calculations. SynerGEE only

calculates impedance if Calculate impedance is selected in the
Ratings tab.
For more information on impedance calculations, see the SynerGEE
Technical Reference.

SynerGEE Electric 5.0

User Guide

308

Modeling Sections

Concentric Neutral
Types

The following options only apply when you have selected Concentric
Neutral as your conductor model.

Strand Diameter. For concentric neutral cables, the

diameter of a single neutral strand.

Strand R. For concentric neutral cables, the resistance of a

single neutral strand.

Strand Count. Total number of strands in the concentric

neutral ring.

Diam to strand ring. The diameter of the concentric neutral

ring, measured from the center of the strands. This value
should be less than the outside diameter of the cable, but
greater than the insulation diameter.

Lay factor. For concentric neutral cables, a multiplier used

to compensate for neutral strands longer than the actual
cable length, due to lay. For example, a factor of 1.2
indicates that for every unit of cable length, there are 1.2
units of strand length within. Typical lay factor values range
from 1.1 to 1.2.

Click Apply to accept the changes.

Deleting a conductor type

Perform the following procedure to delete a conductor type from your equipment warehouse.

TO DELETE A CONDUCTOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Conductors (Bare) or Conductors (Cable) and then select the name of the conductor that
you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Sorting conductor types

In the Warehouse tab of the model explorer, the list of conductor types can be sorted alphabetically or by amp
rating size in either ascending or descending order. Refer to the following procedure for more information.

TO SORT CONDUCTOR TYPES

1

In the SynerGEE model explorer, select the Warehouse tab.

Select either Conductors (Bare) or Conductors (Cable).

User Guide

SynerGEE Electric 5.0

Modeling Sections
3

309

Right-click and select one of the following options:

-

Sort Order > Alphabetical

Sort Order > Size (Ascending)

Sort Order > Size (Descending)

Use of conductor data

The following table lists how some of the conductor data is used in calculations, and to which types of
conductor the data applies. For more information on conductor data, see Editing a conductor type on
page 305.

Data

Description

Simple Z

Bare
Cond.

R1 + jX1

Simple impedance values in

ohms/length unit

R1 + jX1

Positive sequence impedance

with conductors spaced at a 1'
or 1M GMD

Diameter
(conductor)

Distance across the conductor

Diameter
(insulation)

Diameter over insulation, under

strands or tape shield

Diameter
(outside)

Diameter across outside of

conductor

Diameter
(strand)

Diameter across one neutral

strand

Core R

Resistance of conductor (or

equivalent) in ohms/length unit

Core GMR

Geometric mean radius of

conductor (or equivalent) in feet
or meters

Strand R

Resistance of a single strand in

Ohms/length unit

Strand GMR

Geometric mean radius of a

single strand in feet or meters

R0 + jX0

Sep.
Neut.

Con.
Neut.

Tape
Shield

jB0
jB1

SynerGEE Electric 5.0

User Guide

310

Modeling Sections

Conductor spacing options

In the Section editor, you can choose how conductor spacing should be handled. Available options include
the following:

Equivalent spacing. SynerGEE uses a simple spacing model based on phase-to-phase and
phase-to-neutral distances specified below in the editor. All phases are assumed to have the same
conductor type, unless a detailed construction is setup in the base year.

Detailed spacing. Using configuration types, SynerGEE can perform complex analyses on detailed
conductor configurations. To use detailed spacing, you must have configurations defined in your
equipment data source. For more information on detailed spacing and configuration types, see
Conductor Configuration and Positions on page 310.

Duct Bank. Assigns a duct bank to the section and sets SynerGEE to use those conductor types for
impedance calculations. You should also specify a duct bank instance by entering text into the
Instance box, or remove an instance by deleting the text. SynerGEE sets the instance of the
sections duct bank using this text. Be sure to select a specific circuit from the bank and a
transposition value, at the bottom of the editor.

CONDUCTOR CONFIGURATION AND POSITIONS

SynerGEE provides detailed modeling for the line portion of a section and lets you model both overhead
conductors and underground cables. There are three methods for representing line configuration within
SynerGEE, allowing you to choose how detailed your model should be. The three methods are discussed in
the following sections:

Simple impedance on page 310

Conductor/equivalent spacing on page 311

Configuration types (detailed spacing) on page 311

The first two rely on solely on settings within the section and conductor type records. The third requires one
or more configuration type records, which are stored in the DevConfig table (in Access) in your equipment
data source, and referenced in the Section editor. For more information on configuration types, see
Configuration types (detailed spacing) on page 311.

Simple impedance
To use the simple impedance method on a section, you should first specify a conductor type as a simple
impedance conductor and then apply that conductor to a section. The simple impedance setting is found in
the Conductor Type editor. For more information on editing a conductor, see Editing a conductor type on
page 305.
For a simple impedance conductor, SynerGEE uses specified impedance values and does not perform
impedance calculations. In the Conductor Type editor, you can set positive and zero sequence values in perlength units for a simple impedance conductor. Afterward, appropriate rows and columns of the three-bythree impedance and admittance matrices are eliminated, as applicable.

User Guide

SynerGEE Electric 5.0

Modeling Sections

311

If you are using a simple impedance conductor on a section, you should have the equivalent spacing option
selected in the Section editor. Detailed spacing and configuration methods are inherently part of a calculated
impedance, which makes them incompatible with a simple impedance conductor model. If you inadvertently
combine a simple impedance conductor with a detailed spacing method, SynerGEE will produce an error on
analysis reports and use the specified simple impedance. For more information on editing a section, see
Editing Sections on page 279.

Conductor/equivalent spacing
This method uses conductor information from the conductor table (DevConductors) and the equivalent
spacing values of an individual section to calculate the section impedance and admittance. You can specify
both the conductor type and the spacing by editing a sections characteristics. This method is most applicable
to overhead lines.
For more information on line impedance calculations, see the SynerGEE Technical Reference. For more
information on cable impedance calculations, see the SynerGEE Technical Reference.

Configuration types (detailed spacing)

With this method, each section references a configuration type record in the spacings table (DevConfig),
which contains coordinate information about conductor positions for that configuration. With these positions,
SynerGEE determines the precise spacing of the phase and neutral conductors.
Keep in mind that configuration types are inherently incompatible with simple impedance conductors, since
simple impedance conductors are not intended for impedance calculations. For more information on simple
impedance conductors, see Simple impedance on page 310.
Refer to the topics listed below for more information.

About configuration types on page 311

Creating a configuration type on page 311

Editing a configuration type on page 312

Determining coordinates for configuration types on page 312

Usage of configurations on page 314

Configuration application examples on page 314

About configuration types

A configuration type is essentially a set of coordinates that specify the positions of the different phase
conductors. These positions, labeled 1, 2, 3, and N, are relative to a reference point. When you apply a
configuration to a section, you can specify which phase occupies which position. Then, during analysis,
SynerGEE transposes section phasing as specified and determines spacing based on the position
coordinates.

Creating a configuration type

Perform the following procedure to create a new configuration type.

SynerGEE Electric 5.0

User Guide

312

Modeling Sections

TO CREATE A CONFIGURATION TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Configuration.

In the Enter Device ID dialog box, type a name for the new device type and then click OK.

Use the Configuration Type editor to edit the settings for the configuration type. For more
information on the options you can set, see Editing a configuration type on page 312.

Editing a configuration type

To edit a configuration type, double-click the configuration type name in the Warehouse tab of the SynerGEE
model explorer. From the Construction tab in the Section editor, you can also click the edit button that is
located next to the name of the selected configuration type.
Refer to the following procedure for more information.

TO EDIT A CONFIGURATION TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Configurations and then double-click the name of the configuration type that you want to
edit.

Use the Configuration Type editor to enter X and Y cross-sectional coordinates for conductor
positions. The unit value of the coordinates is either feet or meters, based on the measurement
system specified in the Units tab of the Preferences editor. An illustration in the dialog shows you the
general positions of the conductors as you adjust the coordinates.

Click Apply to accept your changes, and then click X to close the editor.

Determining coordinates for configuration types

Figure 6-21 shows a sample configuration to demonstrate how position coordinates are determined. In this
example, English units of measurement are assumed, in which case the coordinates represent feet.
6 ft
9 ft
1

7 ft
N

2 ft

2 ft

Figure 6-21 Cross-section of a sample configuration

User Guide

SynerGEE Electric 5.0

Modeling Sections

313

To form a set of coordinates for this cross-section of conductors, you first need a reference point, or 0,0.
Since SynerGEE models self and mutual impedance and admittance values of lines, the horizontal reference
point can be arbitrary. However, the distance between conductors and the ground is important, so the vertical
reference point requires more consideration.
To maintain the proper conductor-to-ground distance for calculations, SynerGEE uses an additional heightto-reference setting in conjunction with configurations. Essentially, this height-to-reference value is added to
the vertical reference point that you choose, thereby establishing the proper heights for all the positions in the
configuration. Therefore, you can choose an arbitrary vertical reference point as well, provided that you set
the proper height-to-reference value so SynerGEE knows the exact distance between the conductors and the
ground.
Returning to the previous example, this configuration assumes that you chose your 0,0 reference point as
follows:
6 ft
9 ft
1

7 ft
2 ft

N
2 ft

0,0

Figure 6-22 Sample configuration with a reference point

This reference point is horizontally two feet below the neutral conductor, and vertically in line with position 1.
Using basic coordinates, the positions in the configuration are as follows.
Sample configuration
X (feet)

Y (feet)

Position 1

Position 2

Position 3

Neutral

You would type these coordinates into the Configuration Type editor (Figure 6-23) when defining the
configuration. For more information on using the editor, see Editing a configuration type on page 312.

SynerGEE Electric 5.0

User Guide

314

Modeling Sections

Figure 6-23 Configuration Type editor

Usage of configurations
Applying a configuration to a section is as simple as selecting it in the Section editor, once you have defined
it in the configurations table. However, remember that for SynerGEE to use a configuration, it must also
know:

The correct height-to-reference value, which is added to all vertical coordinates

Which phases occupy which positions

These two items are also specified in the Section editor, in the Construction tab.

Configuration application examples

Using the sample configuration presented earlier, assume that you have the following data applied to one of
your sections.
Section 1 data
Configuration type

Sample

Height-to-reference

20 feet

Phase positions

BAC

Applying these settings, the section would look like the following.

User Guide

SynerGEE Electric 5.0

Modeling Sections

315

Position 1 - Phase B (0,7)

Position 2 - Phase A (6,7)
Position 3 - Phase C (9,7)
Neutral (2,2)
Height-to-reference - 20 ft

N
27 ft

0,0

20 ft

Figure 6-24 Section using sample configuration

As another example, assume you had another two-phase section (B and C only), and set it up as follows.
Section 2 data
Configuration

Sample

Height-to-reference

35 feet

Phase positions

BCA

In this case, the section would appear as follows.

B

N
42 ft

0,0

35 ft

Figure 6-25 Section 2 with the same configuration

Note that the last position is simply ignored, since it is mapped to phase A, which does not exist. With the
capability to change phase positions and height-to-reference values, a small set of configurations should be
sufficient for a variety of constructions.

SynerGEE Electric 5.0

User Guide

316

Modeling Sections

CONDUCTOR DAMAGE CURVES

Current in conductors must be kept below values that would damage the tensile or conducting properties of
the conductors. In overhead lines, conductor annealing or tensile damage may be of concern (although with
todays larger loads, conductors are larger). A cable may be limited by the ability of its insulation to withstand
heat before being damaged, although in some cases, cable annealing may be the limiting factor instead of
cable insulation damage. In all cases, conductor damage curves are generated based on conductor material,
insulation, and temperature rise. For example, a conductor of a given material and insulation is allowed to
have a temperature rise of a given amount before damage occurs. Current flow over time causes the
temperature rise, so time relates directly to current in determining when damage may occur.
SynerGEE can plot conductor damage curves on the TCC graph. For more information on how to plot a
damage curve, see Plotting conductor damage curves on the TCC on page 612.

User Guide

SynerGEE Electric 5.0

CHAPTER

7
Modeling Devices
CREATING AND EDITING DEVICES
You can add devices to your SynerGEE model by dragging equipment types from the Warehouse tab of the
model explorer and dropping them onto sections in your model. Many equipment types include the initial
settings for the devices in your model, and the model devices also reference back to the equipment type.
Once a device has been placed, you can move, edit, copy, and delete it as needed.
Refer to the topics listed below for more information.

Adding a device on page 317

Editing a device on page 318

Moving a device on page 318

Copying a device on page 318

Deleting a device on page 319

Adding a device
Perform the following procedure to add a device to your model.

TO ADD A DEVICE
1

From the Warehouse tab in the SynerGEE model explorer, locate the device type that you want to
add to the model.

Drag the device from the model explorer and drop it onto the desired section, noting the following:
-

As you drag the device, the cursor symbol changes to indicate where you can or cannot
drop the device.

In some cases, if you drop the device on a section already containing that type of device,
the new device replaces the old one.

Your map display settings will determine what symbol is used once the device has been
placed in the model. For more information on equipment display settings, see Configuring
map display symbols on page 213.

SynerGEE Electric 5.0

User Guide

318

Modeling Devices

Editing a device
Devices can be edited using the device editor, as described in Using the SynerGEE Editor on page 151.
Multiple devices can be edited at one time by using the Multiple Editor, as described in Using the Multiple
Editor on page 177.

Moving a device
Perform the following procedure to move a device in your model. In some cases, you can move a device from
one location on a section to another. You can also move a device from one section to another, if such an
action is permitted by SynerGEE. For example, you cannot move a device from one section to another if a
device of that type already exists on the target section. You must first delete the device on the existing
section before you can move another device of the same type to that section.

TO MOVE A DEVICE
1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Devices group, click Move.

Move the cursor over any existing device to change the cursor to a cross symbol.

Click and drag the device to a new location, either on the other end of the current section or to
another section altogether.

Press F5 to return to Default mode.

Copying a device
Perform the following procedure to copy a device from one section and place it on another section. An exact
copy of the original device will be created on the new section, while the original device will not edited or
modified in any way.

TO COPY A DEVICE FROM ONE SECTION TO ANOTHER

1

In the SynerGEE ribbon bar, select the BUILD tab.

In the Devices group, click Copy.

On the map, move the cursor over any existing device. The cursor will change to a cross symbol
when it is over a valid device.

Click and hold the mouse button and then drag the mouse to another section. Release the mouse
button to add a copy of the device to the new section.

Click Yes to confirm the creation of a new device. An exact copy of the device is created on the new
section, while the original device is not edited or modified in any way.

Press F5 to return to Default mode.

User Guide

SynerGEE Electric 5.0

Modeling Devices

319

Deleting a device
Perform the following procedure to delete a device from the model.

TO DELETE A DEVICE FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the device that you want to delete.

Right-click on the device and select Delete.

Click Yes to confirm the deletion.

Tip:

You can also delete a device in Move Device mode by dragging and dropping the device
somewhere in empty space.

CREATING AND EDITING EQUIPMENT TYPES

In SynerGEE, an equipment type refers to a device type or property record stored as equipment data in your
equipment data source. These records contain nameplate and other static information about devices on the
model, and in many cases represent the inventory of device types available for modeling. For example, a
regulator on the model (stored in model data as an instance record) must reference a regulator type record in
the equipment data. Therefore, you can only model regulators that are included in your equipment data
inventory.
As such, you should be sure that your equipment data contains all the device types that you might need to
model to accurately simulate your actual system. SynerGEE is installed with a sample equipment database in
Access that contains a variety of common device types that you are welcome to use. However, it is likely that
you will want to customize your equipment data to suit your specific modeling needs.
Keep in mind that equipment data also contains records on certain property sets that are also referenced by
instance records and sometimes from within the equipment data itself. These property sets include items
such as customer zones and line configurations. For more information on the equipment data and its
relationship to the model data, see Equipment data on page 64.
Also keep in mind that any time you modify your equipment data, you must save the equipment data source
before your edits will be permanent. SynerGEE does not save equipment data automatically. For more
information on saving equipment data, see Saving equipment data on page 65.
Refer to the topics listed below for more information.

Creating a device type on page 319

Editing a device type on page 320

Copying a device type on page 320

Deleting a device type on page 320

Creating a device type

The following procedure provides a general overview of how to create a device type. Information on creating
specific device types is provided in the device chapters of this User Guide.

SynerGEE Electric 5.0

User Guide

320

Modeling Devices

TO CREATE A DEVICE TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > {device type}.

In the Enter Device ID dialog box, type a name for the new device type, and then click OK.

Use the device type editor to edit the settings for the device type. Press F1 from the editor to view
online help for the device type you are editing.

Editing a device type

The following procedure provides a general overview of how to edit a device type. Information on editing
specific device types is provided in the device chapters of this User Guide.

TO EDIT A DEVICE TYPE

1

In the Warehouse tab of the model explorer, double-click on the device type name that you want to
edit.

When the editor appears, edit the device type as desired.

Copying a device type

Perform the following procedure to create a duplicate copy of a device type in your equipment data source.

TO COPY A DEVICE TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Select the name of the device type that you want to copy.

Right-click and select Copy As.

In the Enter Device ID dialog box, type a name for the new device and click OK.

Deleting a device type

Perform the following procedure to create a delete a device type from your equipment data source.

TO DELETE A DEVICE TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Select the name of the device type that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

User Guide

SynerGEE Electric 5.0

Modeling Devices

321

BREAKERS
SynerGEE provides a sophisticated breaker/relay model which supports mechanical and multi-stage electromechanical relays. The breaker device itself is similar to any device type, which has a map symbol, ID, and
parent section. The device itself, however, can contain a virtually unlimited number of individual actuating
relays, all of which are fully integrated into SynerGEEs TCC and protection coordination tools.

Adding a breaker
Breakers are added to a model in the same manner as any other equipment, by dragging a breaker type from
the Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE map
display. Refer to the following procedure for more information. Additional information on working with
warehouse equipment types is provided in Modeling Devices on page 317.

TO ADD A BREAKER TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Breaker Types and then select the breaker type that you want to add to your model. Drag it
onto the map display and drop it onto the desired section.

Editing a breaker
Use the Breaker editor to edit an existing breaker in your model. Refer to the following procedure for more
information.

TO EDIT A BREAKER
1

In the SynerGEE map display or model explorer, double-click the breaker that you want to edit.

On the left side of the Breaker editor, select from the different tab names to access the available
settings for the breaker. The following topics describe the different tasks that you can perform:

Editing general data for a breaker on page 322

Setting up relays for a breaker on page 323

Viewing analysis results for a breaker on page 325

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

322

Modeling Devices

Editing general data for a breaker

TO EDIT GENERAL DATA FOR A BREAKER
1

In the SynerGEE map display or model explorer, double-click on the breaker that you want to edit.

In the Breaker editor, select the Breaker tab. The following table describes the different options that
you can set.

User Guide

Name

Breaker name or ID. This ID does not need to be unique.

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Disable Relay(s)
(phase or ground)

For the respective relay type, disables all relays, including all stages
of all groups. This setting is applicable to coordination studies only
and does not affect load-flow-based analysis.

Cutoff Amps (phase

or ground

A breaker-level setting indicating the maximum fault value for

coordinating the breaker. This value is considered by check
coordination analysis only if your check coordination options are set
to consider user-defined cutoffs. For more information, see Setting
up a check coordination analysis on page 623.

TCC color (phase or

ground

Color of the respective curve if plotted on the TCC. For more

information on the TCC, see Time Versus Current Coordination
(TCC) Graph on page 604.

Mech. Resp.

The time required for breaker contacts to open in a currentinterrupting capacity following a trip signal from one of its relays.
Check coordination analysis normally considers this factor,
depending on the type of coordination being considered and the
coordination direction. The TCC only considers this factor if your TCC
display options are set to display response curves, versus control
curves. For more information, see Changing TCC view display
properties on page 606.

Breaker rating

Amp rating for load-flow exception flagging.

Interrupt rating

Value that fault analysis compares to the maximum fault level seen by
the breaker.

Status

Breaker open/closed state. For more information on switchable

protective devices, see Switchable protective devices on page 600.

Group

Currently active relay group. For more information on groups, see

Relay groups on page 327.

SynerGEE Electric 5.0

Modeling Devices

323

Dont allow operation

from analysis

Certain types of analyses, such as optimal switching, contingency,

and reliability, simulate the operation of switches and protective
devices to accomplish the analysis objective. Select this option to
exclude the breaker from being controlled in this way during these
analysis types. If selected, this restriction only applies to the current
breaker in the editor.

Bypass

Select this check box to ignore the operational capability of the

breaker during check coordination analysis, reliability analysis, and
other applications.

Rates

Failure rate, cost, and time parameters for reliability analysis.

Generally, these numbers represent averages and estimates,
because it is unlikely that you will have exact figures for each
individual device. For more information on these items and reliability
analysis, see Devices and failure rates Reliability studies on
page 685.

Location Link

Syntax to link the breaker to an external source, such as a file or

website. For more information, see Location Links on page 223.

AMS Link

Syntax to link the breaker to an Asset Management System.

Year

Energize and retire years for multi-year analysis. For more

information, see Multi-Year Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

Setting up relays for a breaker

TO SET UP RELAYS FOR A BREAKER
1

In the SynerGEE map display or model explorer, double-click on the breaker that you want to edit.

In the Breaker editor, select the Relays tab. The following table describes the different tasks that
you can perform.
To ...

Do This ...

Add a relay

Next to Add/Delete, click the + button. A new relay is added to the

end of the current list.

Delete a relay

SynerGEE Electric 5.0

In the list of relays, select the relay that you want to delete.

Next to Add/Delete, click the - button. The relay is removed

from the list.

User Guide

324

Modeling Devices

To ...

Do This ...

Edit basic settings for a

relay

Select the relay that you want to work with and then edit any of the
following fields:

Assign a relay to a
group

Add the relay to a TCC

Open the editor for the

protecting device for the
breaker

User Guide

Type. Specify the relay type for the selected relay.

Description. Type an optional identifier for the selected

relay. This ID is for user convenience only and has no impact
on data storage or model topology. It does not need to be
unique.

Manufacturer and Model. For the selected relay, select

whether the relay is electro-mechanical or electronic, which
affects the settings available for configuring the stages.
These fields and associated data come directly from
protection data in memory, hence the importance of having
protection data loaded while editing breakers. For more
information, see Protection data on page 67.

Under Relays Group, select the relay group to which the selected
relay belongs. This setting does not affect which group is currently
active within the breaker. Note that if the relay list above is filtered by
group, and you change a selected relays group, it will disappear from
the current list. Therefore, it is recommended that you remove all
filtering before changing this setting.
a

In the list of relays, select the relay that you want to work
with.

Click Add to TCC. For more information on the TCC, see

Time Versus Current Coordination (TCC) Graph on
page 604.

Click the Protecting button.

SynerGEE Electric 5.0

Modeling Devices

325

To ...

Do This ...

Configure stages for a

relay

Select the check box next to the appropriate Stage number and then
edit the following fields as appropriate:

Operation (Rec). For the respective stage, the operation

type. If SynerGEE finds instantaneous curves for the
selected relay (based on manufacturer/model),
Instantaneous Curve type is available. Many mechanical
relays, and some electronic relays, have instantaneous
curves. For electronic relays, Instantaneous type operation
is also available.
The check box to the right indicates whether the stage is
reclosing or not. A recloser that is set for a single operation
will not reclose on downstream temporary faults. It will
effectively operate like a fuse.

Curve Family. For electronic breakers, the curve family.

Inst Curve. Instantaneous curve, for mechanical relays with

instantaneous interrupt capabilities.

Pickup Type. One of the following types of pickup:

-

Sec I. Secondary amps, requiring primary and

secondary CT amp ratings and a tap value

I(n). Requires CT turns ratio and a tap value

Prim I. Primary amps. CT information is not

required. SynerGEE evaluates the curve
information and attempts to establish a pickup point
to match this setting.

Time/Amp Multipliers and Adders. Independent adders

and multipliers by stage, applied directly to the curve. Units
are in seconds and amps, respectively.

Min. Resp. Time. This can usually be left at 0, especially for

inst curves. This sets the minimum time for the control curve
to operate during a stage. Curve values normally below this
value will flatten out at the minimum response time.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a breaker

The Results tab in the Breaker editor provides analysis results for the breaker. The Results tab can be very
helpful if you are running multiple analyses and focusing on a particular device. Since the settings update
automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and

SynerGEE Electric 5.0

User Guide

326

Modeling Devices
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a breaker.

TO VIEW ANALYSIS RESULTS FOR A BREAKER

1

In the SynerGEE map display or model explorer, double-click on the breaker that you want to work
with.

In the Breaker editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

Deleting a breaker
Perform the following procedure to delete a breaker from your model.

TO DELETE A BREAKER FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the breaker that you want to delete.

Right-click on the breaker and select Delete.

Click Yes to confirm the deletion.

Construction of the breaker model

Much like a real breaker device, a SynerGEE breaker is a collection of relays that can operate and contribute
individually to the applicable protection scheme. You can set certain parameters at the breaker level, such as
amp ratings and cutoff amps. However, most of the information that contributes to coordination studies and
TCC curves is normally found in the detailed data at the relay level.

Adding and removing relays

A breaker can contain any number of relays, all of which are managed within the Relays tab of the Breaker
editor. In the Relays tab, you can add and remove relays with the + and - buttons. Normally, a new relay is
created as a duplicate of the relay currently in the view.
Relays have their own table in a data source, and this tab in the editor is your access point to that data. All
relay data is considered model (or instance) data and has no inherent association with equipment data or the
equipment data source.

User Guide

SynerGEE Electric 5.0

Modeling Devices

327

Relay groups
Within a breaker model, you can organize relays in groups, with up to six groups permitted. These groups
operate similarly to an actual relay group, which can be switched in and out as needed. In SynerGEE, a
single group is active at any given time, and the other three are completely removed from the operation of the
breaker.
The use of groups is optional. If you have no need for multiple groups, you can define all your relays within
the first group and keep that group active at all times.

Relays, stages, and curves

Within any given breaker, SynerGEE can manage up to six independent curves, depending on the types of
relays that you configure. The six possible curves are generated from the following supported relay types,
each of which can operate in a non-reclosing (slow) or reclosing (fast) mode:

Phase

Ground

High impedance earth return (HIER)

For example, a non-reclosing phase relay (or set of relays) would generate a curve independently of a
reclosing phase relay. Likewise, when you plot a breaker on the TCC, you only see curves applicable to the
configured relays, not necessarily six curves every time. For example, if you have no emergency relays
configured, no emergency curves appear on the TCC.
In the case of multiple relays and/or stages, a TCC relay curve actually represents the composite of all
applicable curve data, with non-applicable sections automatically hidden. In essence, each point on the
plotted curve represents the lowest point at which one relay stage will operate. If any stage would operate
above that point, the curve data is not shown, because it is largely non-applicable. Therefore, a relay curve
on the TCC represents the overall behavior of the device as seen by the load current, but for any given point,
you may not know the precise stage that would operate.
Because of this flexibility, TCC work with breakers may require more consideration than other protective
devices. If you have multiple relays configured, your breaker curves could potentially be a complex mix of
different device behaviors, perhaps from different manufacturers. Always pay close attention to the active
relay group and the different relays and stages you may have modeled, and keep in mind that your curves
may represent the composite behavior of many different devices.

Breaker flexibility A word of caution

In SynerGEE, you are free to configure relays with a high degree of flexibility, which adds responsibility on
you to keep your device models realistic. You could potentially create device models which have no
counterpart in the real world, which may cause unexpected results during coordination studies. Therefore,
always use sound engineering judgment when modeling these devices in SynerGEE, as if you would design
and configure actual devices in your distribution system.

SynerGEE Electric 5.0

User Guide

328

Modeling Devices

Transitioning from older breaker models

In earlier versions of SynerGEE, breaker models supported data for one phase and one ground relay only,
and did not support detailed stage information. When you load an older breaker model into the current
version, therefore, SynerGEE performs a conversion process that may involve the following:

Establishment of a breaker operating with the first relay group.

Configuration of ground and phase relays within the first group.

Enabling and configuration of stages based on existing data, including consideration of inverse time
and optional instantaneous settings.

After the breaker is converted, you may add and edit relays like any other newer breaker.

CAPACITORS
Capacitors are widely used in distribution systems for voltage regulation and power factor correction.
Capacitor banks are usually placed near a load to provide reactive power locally so the current for the
reactive load does not have to be sent through the distribution system. The reduced amount of reactive
power flowing on the distribution lines between the source and capacitor bank allows a lower current flow and
improves the power factor. Line losses are smaller and thus the voltage becomes higher at the load.
Capacitor compensation is useful for fixed loads. Switched capacitors can be used to meet the demand of
time-varying loads. The switching of banks may cause considerable system transients. The level and
duration of these transients depends on the time constant associated with the line and capacitor. It should
also be noted that an operating capacitor bank makes a power system more sensitive to transients since a
large di/dt through the capacitor causes a large voltage spike.
SynerGEE supports section capacitor installations that consist of fixed units and up to three switched
modules. The installations can be connected in Wye, Delta, or Wye-Gnd configurations. The capacitors are
modeled as fixed impedance devices in the middle of sections. They are specified by their nominal kvar value
per phase. You can turn capacitors on or off using various operations in SynerGEE. You can place switched
units into manual or automatic modes.
Unlike most other equipment models in SynerGEE, specifications for capacitor installations are made entirely
within the Capacitor editor and stored in the model data. No equipment types exist in the equipment data
source for capacitors.
Refer to the topics listed below for more information on working with capacitors in SynerGEE.

The SynerGEE Capacitor Model on page 329

Controlling Switched Capacitor Modules on page 331

Managing Capacitors in the Model on page 334

Motor Analysis and Capacitors on page 342

Placement Analysis on page 342

User Guide

SynerGEE Electric 5.0

Modeling Devices

329

The SynerGEE Capacitor Model

The SynerGEE capacitor model consists of up to four modules. One module is a fixed unit and the other
three are switched units. This is illustrated in the following figure:
Source end
PT and CT at load end
Fixed unit

Switched modules, with

individual trip and close settings
Diagram of a switched capacitor model

Capacitor installations can be connected in Wye, Delta, or Wye-Gnd configurations. The diagram above
shows a Wye-Gnd configuration.
A module refers to a by-phase bank of capacitor units. The kvar values for the fixed module are specified per
phase. For the switched modules, you can specify an overall kvar value for a set of selected phases. You can
also activate or deactivate the individual switched modules as needed. Therefore, to model a fixed capacitor
only, you can simply leave the three switched modules deactivated, essentially making them non-existent.
The three switched modules are composed of identically rated capacitors, connected to each phase you
specify. Switches connect and disconnect the switched modules from the line section (close and trip,
respectively). You can control the switching yourself if the installation is in manual mode. Or you can choose
automatic mode, in which SynerGEE controls the switching based on the results of balanced or by-phase
analysis, or time of day. For analysis results, automatic mode can consider a variety of different criteria, such
as current, voltage, and kvar limits.
In summary:

The fixed kvar module is always connected to all of the phases of a section. If you want a particular
phase to have no fixed kvar applied, specify zero (0) for that phase.

When a switched module is closed, all applicable phases are connected. These phases are set in
the Settings tab of the Capacitor editor. The applicable phases set in the Settings tab apply to all
active switched modules.

Refer to the topics listed below for more information. For more information on configuring the switched and
fixed modules, see Editing a capacitor on page 335.

Fixed and switched capacitor units on page 329

Capacitor positioning relative to load on page 330

Capacitor kV rating on page 331

Fixed and switched capacitor units

Capacitor installation models in SynerGEE consist of two parts the fixed or base unit and three switched
modules. The following figure shows a Wye-Gnd installation with the fixed unit and one switched module:

SynerGEE Electric 5.0

User Guide

330

Modeling Devices

Fixed capacitor

Switched unit
a
b
c
n

A
B
C
N
KA
K1

K1

KB
KC

K1

Fixed and switched units in an installation

Notice that three distinct kvar values can be specified for the fixed portion of the installation. On the other
hand, each of the switched modules is made up of identical capacitor units. Open connections can be
achieved by specifying zero values for the fixed module or by deselecting switched phases for the switched
modules.
Switched and fixed units are defined in the Capacitor tab of the Capacitor editor. For more information, see
Editing general data for a capacitor on page 336.

Capacitor positioning relative to load

Capacitor installations are always placed at the center of a section with the distributed and possibly spot
loads. The following is a diagram of a model section with a capacitor.
Source end

Point A

Point B

Load end

Spot load

Spot load
Capacitor

Spot
load

Dist.
load

Section model with a capacitor

Note that this figure shows three spot loads, for demonstration purposes only. SynerGEE allows only one
spot load per section, at the source end, load end, or center of a section.
The capacitor kvar injection occurs at the same location as the distributed load and a spot load placed at the
center of the section. Capacitor metering is always at the center of the section. However, for flows metered
with the CT, metering is either right before or right after the capacitor and load terminals.
Type of control

Metering location

Kvar

Point A before capacitor installation

Amp

Point B after capacitor installation

Pf

Point A before capacitor installation

Voltage

Does not matter. An LDC meters after the installation.

Time

Does not matter. Time is used.

User Guide

SynerGEE Electric 5.0

Modeling Devices

331

Capacitor kV rating
You can specify the rated kV of a capacitor in the Capacitor tab of the Capacitor editor. If this value is not
zero, then before an analysis, SynerGEE will compare it to the section nominal voltage according to the
voltage mismatch tolerance, which is set in the Model tab of the Model and Analysis Options editor, as
described in Setting up general analysis options on page 441. If the voltage mismatch tolerance is violated,
the analysis will not proceed.
If the specified value is zero, SynerGEE uses the section nominal voltage as the rated kV instead. As such, if
you are applying a capacitor that is rated at a voltage other than the section voltage, you can either:

Specify the appropriate kV in the Capacitor editor to override the use of the section voltage
or

Allow SynerGEE to still use the section voltage, if you derate the kvar value of the capacitor as
follows:

kvarSynerGEE

kVRated
= kvarRated
kVCap Rated

Eq 71

For more information on setting the rated kV for a capacitor, see Editing general data for a capacitor on
page 336.

Controlling Switched Capacitor Modules

Each of the three available modules of a switched capacitor has uniformly sized kvar/phase values. For
example, selecting 100 kvar/phase for module 1 of a switched installation indicates that when that module is
on, each phase nominally injects 100 kvar into the system. Remember that the kvar value of the fixed part of
the installation is specified by phase and always connected (unless the capacitor is turned off).
The following represents a sample capacitor:
Fixed kvar

A=150, B=150, C=150

Metering phase

Active switch phases

A, C

Primary control

Voltage, Automatic

Module 1 (on)

75 kvar/ph, Close 118V, Trip 125V

PT Ratio

208.0

As such, the following values represent the capacitor kvar layout for the section, between 118 and 125 volts:
Phase A

Phase B

Phase C

150+75 = 225 kvar

150 kvar

150+75 = 225 kvar

SynerGEE Electric 5.0

User Guide

332

Modeling Devices
Phase B does not get the 75 kvar of switched capacitance because the B is not checked in the Active Switch
Phase area. The Active Switch Phase check boxes affect all switched modules in the same way. The value of
fixed kvar is always applied regardless of the Active Switch Phase settings. A value of zero can be specified
into the fixed kvar field for those phases not having fixed capacitors.
Refer to the topics listed below for more information.

Capacitor tripping and closing rules on page 332

Capacitor metering phase on page 333

Capacitor line-drop compensator on page 333

Capacitor voltage override on page 334

Manually turning on a capacitor switched module on page 334

Capacitor tripping and closing rules

Balanced and by-phase load-flow analyses open or close switched units based on the section conditions and
the settings of the switched capacitor. This action occurs for switched capacitors that are both on and in
automatic mode. SynerGEE never alters the switch state of switched capacitors in manual mode.
A module is turned on (the close setting is satisfied) by balanced or by-phase analysis if the following criteria
have been met:

The Control option is set to Var or Current, and the metered value of kvar or current exceeds the
close setting.

The Control option is set to Voltage or Power Factor, and the metered value of voltage or power
factor is less than the close setting.

The Control option is set to Temperature, and the temperature in SynerGEE rises above the close
setting in the Capacitor editor. The temperature values must be set in the Weather tab of the Time
and Weather Options editor. For more information, see Defining Weather Conditions on page 824.

Installation is in Automatic Mode.

Voltage Override settings are not violated.

A module is turned off (trip setting is satisfied) by balanced or by-phase analysis if the following criteria have
been met:

The Control option is set to Var or Current, and the metered value of kvar or current is less than the
trip setting.

The Control option is set to Voltage or Power Factor, and the metered value of voltage or power
factor exceeds trip setting.

The Control option is set to Temperature and the temperature in SynerGEE falls below the trip
setting in the Capacitor editor. The temperature values must be set in the Weather tab of the Time
and Weather Options editor. For more information, see Defining Weather Conditions on page 824.

Installation is in Automatic Mode.

Voltage Override is set to be used and voltage is outside of bandwidth.

User Guide

SynerGEE Electric 5.0

Modeling Devices

333

The following table summarizes the rules and operation ranges for a switched unit.
Switched capacitor operation rules
(g = metered value; ts = trip setting; cs = close setting)
Control

Metering

Verify

Close

No operation

Trip

kvar

g = kvar

cs > ts

g > cs

cs > g > ts

g < ts

amp

g = amps

cs > ts

g > cs

cs > g > ts

g < ts

voltage

g = volts

cs < ts

g < cs

cs < g < ts

g > ts

power factor

g = pf

cs < ts

g < cs

cs < g < ts

g > ts

Time

g = time

cs > ts

g > cs

cs > g

g > ts

Capacitor metering phase

You should select metering phase used by capacitor installation when you select switch modules for use.
This metering applies to module switch controls and to the voltage override mechanism. The chart below
gives the meter phase options for various capacitor installation connections.
Connection

Voltage control

Current control

PF or kvar control

Delta or Wye

A/B, B/C, or C/A

A, B, or C

Total of all phases.

Wye-Gnd

A, B, or C

A, B, or C

A, B, or C

The metering phase is specified in the Settings tab of the Capacitor editor. For more information on editing a
capacitor, see Setting up switch controls, location links, and energize and retire years for a capacitor on
page 339.

Capacitor line-drop compensator

SynerGEE uses the line-drop compensator (LDC) mechanism to alter the line voltage (as seen by the module
switch controllers) by dropping the line voltage through a user-specified impedance by the line current. The
LDC option is only available for voltage-controlled units. Voltage override does not utilize the LDC
mechanism. The controller for module switches is 120V based. The voltage seen by the voltage controller
when the LDC option is selected is as follows:

VCont =

1000 kVLine I Line

( RLDC + jX LDC )
PT
CT

Eq 72

where:
PT
CT
R, XLDC

=
=
=

SynerGEE Electric 5.0

PT Ratio
CT Rating
User-specified LDC drop values

User Guide

334

Modeling Devices
kVLine

Line voltage

ILine

Line current

VCont

Controller voltage

LDC information is specified in the Settings tab of the Capacitor editor. For more information, see Setting up
switch controls, location links, and energize and retire years for a capacitor on page 339.

Capacitor voltage override

The voltage override controller uses the voltage directly on the low-side of the installations PT. The voltage
override mechanism does not use the CT and R and X settings. If the capacitor installation is connected as a
Wye or Delta, the phase voltage is measured between the lines specified by the metering phase options and
passed through the PT. Voltage is measured from line to ground if the installation is connected Wye-Gnd. If
voltage override is used, the installation voltage is within its voltage override bandwidth when the following
relationship holds:

VTerm
VSet + 1 BW
2
PTRatio

Eq 73

If the installation is outside of its bandwidth, modules are tripped, one at a time, in the order of module 3 to
module 1.
Note that the voltage override switches modules on or off. If an installations voltage is below bandwidth,
modules are switched on by the voltage override mechanism (if the installation is in automatic mode). It
should also be noted that the line-drop compensations R and X are not contained in the voltage override
mechanism.
Voltage override information is specified in the Settings tab of the Capacitor editor. For more information on
editing a capacitor, see Setting up switch controls, location links, and energize and retire years for a
capacitor on page 339.

Manually turning on a capacitor switched module

The capacitance of a switched module is applied to a section when the following criteria are satisfied.

The section capacitors Turn Off check box is not checked.

The Mod 1, 2, or 3 check box is checked.

The module 1, 2, or 3 On check box is checked.

These options are set in the Capacitor tab of the Capacitor editor. For more information, see Editing general
data for a capacitor on page 336.

Managing Capacitors in the Model

Refer to the topics listed below for information on adding, editing, and deleting capacitors in your model.

User Guide

Adding a capacitor on page 335

SynerGEE Electric 5.0

Modeling Devices

335

Editing a capacitor on page 335

Deleting a capacitor on page 342

Adding a capacitor
Capacitors are added to a model in the same manner as any other equipment, by dragging a capacitor type
from the Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE map
display. The Warehouse tab contains a list of capacitor types, according to kvar. However, unlike other
device types, capacitor equipment types are not actually stored in your equipment data source, since
capacitors are represented entirely by model (instance) data. The equipment types in the Warehouse tab
simply represent shortcuts to add a capacitor when you drag the device from the warehouse. For example, if
you drag a 150 kvar capacitor from your Warehouse tab and drop it onto a section in the model, the resulting
capacitor is specified for 150 kvar, divided among applicable phases.
Refer to the following procedure for more information. Additional information on working with warehouse
equipment types is provided in Modeling Devices on page 317.

TO ADD A CAPACITOR TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Capacitor Types and then select the capacitor type that you want to add to your model.
Drag it onto the map display and drop it onto the desired section.

Editing a capacitor
Use the Capacitor editor to edit an existing capacitor in your model. Refer to the following procedure for more
information.

TO EDIT A CAPACITOR
1

In the SynerGEE map display or model explorer, double-click the capacitor that you want to edit.

On the left side of the Capacitor editor, select from the different tab names to access the available
settings for the capacitor. The following topics describe the different tasks that you can perform:

Editing general data for a capacitor on page 336

Setting up switch controls, location links, and energize and retire years for a capacitor on
page 339

Viewing analysis results for a capacitor on page 341

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

336

Modeling Devices

Editing general data for a capacitor

TO EDIT GENERAL DATA FOR A CAPACITOR
1

In the SynerGEE map display or model explorer, double-click on the capacitor that you want to edit.

In the Capacitor editor, select the Capacitor tab. The settings in the Capacitor tab allow you to
define general settings for the capacitor, and also to set up values for the fixed capacitor and up to
three switched capacitor modules. Use the options described in the following table to set up the
general settings for the capacitor. (Options for setting up fixed capacitors and switched capacitors
are described later in this procedure.)
To ...

Do This ...

Specify the capacitor

name

Next to Name, specify the name or ID for the capacitor.

Enable or disable the

capacitors effect on the
model

Select or clear the Turn Off check box, as appropriate. If the

capacitor is disabled, you can still edit the available settings but it will
not have any impact on the model or any analysis.
You can also disable capacitors directly from the model explorer or
SynerGEE map display. Right-click on the capacitor or capacitor
name and select Turn On or Turn Off, as appropriate. When you
perform this action, the Turn Off check box will be selected or cleared
to reflect the current status.

Specify the capacitors

connection type

Next to Connection, select Wye-Gnd, Delta, or Wye, as appropriate.

Specify the capacitors

rated kV

Next to Rated kV, specify the Capacitors rated kV value. If this value
is 0, SynerGEE uses the section nominal voltage as the rated kV. If
this value is not zero, then before an analysis, SynerGEE will
compare the capacitor rated kV to the section nominal voltage
according to the voltage mismatch tolerance, which is set in the
Model tab of the Model and Analysis Options editor (as described in
Setting up general analysis options on page 441). If the voltage
mismatch tolerance is violated, the analysis will not proceed.
For more information on capacitor rated kV, see Capacitor kV rating
on page 331.

User Guide

SynerGEE Electric 5.0

Modeling Devices
3

337

Use the options described in the following table to set up the fixed capacitor.
To ...

Do This ...

Set up the fixed

capacitor

Use the A, B, and C columns in the Fixed kvar area to specify the
following. The values that you enter for each phase will be summed in
the Totals column. If you enter a value in the Totals column instead,
that value will be distributed proportionally among the three phases
based on the current values for each phase.
The capacitance of these fields will be supplied to a section
regardless of the state of the switched modules. Valid values are
between 0 and 10,000. The Operation option (Automatic or Manual)
does not affect the Fixed kvar values.
You can also use the SynerGEE Bulk Editor to edit the fixed kvar
values for all capacitors at once. For more information, see Using the
Bulk Editor on page 192.

Disable the fixed

capacitor

You can disable the fixed capacitor installation by entering 0.0 in the
Fixed kvar text boxes. This allows you to use the three switched
capacitor modules, if desired, while not using the fixed capacitor.

Use the options described in the following table to configure up to the three switched capacitors.
The options are described here in the order that you would generally configure them. They are not
described in the order they are presented in the Capacitor editor.
Mod

In the Settings area, next to Mod, select the check box for each
switched capacitor that you want to configure. You must select at
least one Mod check box to enable the rest of the settings that are
described in this table, as well as most of the settings in the Settings
tab of the Capacitor editor (as described in Setting up switch
controls, location links, and energize and retire years for a capacitor
on page 339). If none of the Mod check boxes are selected, then
switched capacitors will not be used for this capacitor installation.
You can also use the SynerGEE Bulk Editor to edit the Mod values for
all capacitors at once. For more information, see Using the Bulk
Editor on page 192.

On

SynerGEE Electric 5.0

Select the On check box for each capacitor that you want to turn on
for the analysis. You can still edit settings for switched capacitor
modules that are not turned on, but they will not be considered during
any analysis. If none of the On check boxes are selected, then
switched capacitors will not be used for this capacitor installation.

User Guide

338

Modeling Devices

Operation

Use the Operation option to select whether SynerGEE should

automatically simulate the switching of switched modules, or allow
you to do so as a manual process. If you select Automatic, SynerGEE
controls the switching based on the results of balanced or by-phase
analysis, or time of day. For analysis results, Automatic mode can
consider a variety of different criteria, such as current, voltage, and
kvar limits. These settings are configured through the Control, Close,
and Trip options, as described later in this table.

Control

Use the Control option to indicate the type of metering used in the
capacitor installation. The same type of metering is used for all
switched modules for the capacitor. The capacitors Operation type
must be set to Automatic for the Control option to be enabled.
The following control options are available.

Current (Amps)

kvar

Power Factor (%)

Sub kvar

Sub pf (%)

Temperature (C)

Time of Day

Voltage (120V)

Off on Weekends

If you have selected Time of day as the Control option, select the
Off on Weekends check box to turn off the switched capacitors over
the weekends. Clear the check box to allow the switched capacitors
to operate during the weekends as well as during weekdays.

Seq

Radio-controlled feeder capacitors are controlled through a controller

at the substation and operated via radio. The Seq option allows you
to mimic that type of setup. Capacitors will be operated in order from
the lowest sequence number to the highest.
This text box is enabled when you select either Sub kvar or Sub pf
(%) as the Control type.

kvar/ph

For each switched capacitor, use the kvar/ph text box to specify the
nominal kvar rating per phase. Each phase selected in the Active
Switch Phase area (which is located in the Settings tab of the
Capacitor editor) is connected to the kvar specified in this field.
For more information on the Active Switch Phase option, see Setting
up switch controls, location links, and energize and retire years for a
capacitor on page 339.

User Guide

SynerGEE Electric 5.0

Modeling Devices

Close

339

For each switched capacitor, use the Close text box to specify a
value that determines when the module automatically closes, or
switches on. This value must be a six-digit decimal number. With the
exception of Time of Day control, the units that you will use amps,
volts (120V base), kvar, or percent power factor are based on the
option that you selected as the Control type, as described previously
in this table. This Close value will be compared against a metered
value to determine if the respective switched capacitor module is to
be switched on.
If the capacitor switching is based on time (Time of Day control), this
field refers to the time when the capacitor closes and enters the
system. Enter the time in 24-hour decimal format (for example, 1:00
p.m. = 13.000).
The capacitors Operation type must be set to Automatic for this text
box to be enabled.

Trip

For each switched capacitor, use the Trip text box to specify a value
that determines when the module automatically trips, or switches off.
This value must be a six-digit decimal number. With the exception of
Time of Day control, the units that you will use amps, volts (120V
base), kvar, or percent power factor are based on the option that
you selected as the Control type, as described previously in this table.
This Trip value will be compared against a metered value to
determine if the respective switched capacitor module is to be
switched off.
If the capacitor switching is based on time (Time of Day control), this
field refers to the time when the capacitor trips and isolates from the
system. Enter the time in 24-hour decimal format (for example, 1:00
p.m. = 13.000).
The capacitors Operation type must be set to Automatic for this text
box to be enabled.

Click Apply to accept your changes, and then click X to close the editor.

Setting up switch controls, location links, and energize and retire years
for a capacitor
The Settings tab in the Capacitor editor allows you to establish further settings for switched capacitors. The
switched capacitor options may or may not be enabled, based on how you have configured the switched
capacitor modules in the Capacitor tab of the Capacitor editor, as described in Editing general data for a
capacitor on page 336. Additional information on controlling switched modules is provided in Controlling
Switched Capacitor Modules on page 331.
The Settings tab can also be used to add a note for the capacitor, define a location link, and set the energize/
retire years. Refer to the following procedure for more information.

SynerGEE Electric 5.0

User Guide

340

Modeling Devices

TO SET UP SWITCH CONTROLS FOR A CAPACITOR

1

In the SynerGEE map display or model explorer, double-click on the capacitor that you want to edit.

In the Capacitor editor, select the Settings tab. The following table describes the basic options that
you can set from this tab.

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Location Link

Syntax to link the capacitor to an external source, such as a file or

website. For more information, see Location Links on page 223.

AMS Link

Syntax to link the capacitor to an Asset Management System.

Energize and Retire

Energize and retire years for multi-year analysis. For more

information, see Multi-Year Analysis on page 579.

Use the options described in the following table to configure settings for the switched capacitor
modules.
Metering Phase

Use this option to select the phase used for primary control of the
switched capacitor modules. The Metering Phase option is enabled
when the capacitors Operation type is set to Automatic.

Active Switch Phase

Use the three Active Switch Phase check boxes (A, B, and C) to
select the phase connection of switched modules. Fixed units are not
affected by these settings.

LDC

The LDC section specifies line-drop compensator values for switched

capacitor modules. SynerGEE uses the LDC mechanism to alter the
line voltage (as seen by the module switch controllers) by dropping
the line voltage through a user-specified impedance by the line
current.
The LDC options are enabled when the capacitors Control option is
set to Voltage. LDC is never applied to the voltage override controller.
The following LDC options are available:

R Dial. Line-drop compensation R setting in volts.

X Dial. Line-drop compensation X setting in volts.

For more information on line-drop compensators, see Capacitor linedrop compensator on page 333.

User Guide

SynerGEE Electric 5.0

Modeling Devices

Voltage Override

341

Select the Voltage Override check box to specify that voltage override
should be used. This option allows modules to be switched on or off if
the capacitor installation terminal voltage is too high or low.
After selecting the Voltage Override check box, specify the following
values:

Settings. Specifies the upper limit of acceptable voltage.

B.W. Specifies a bandwidth range where the voltage control

begins overriding the selected control type. For example, if
you have set the voltage override of 124 and a bandwidth of
2, the voltage range will be from 123 to 125.

For more information on voltage override, see Capacitor voltage

override on page 334.
Metering

Specify the following settings:

PT Ratio. Determines metered voltage for voltage override

and voltage for primary control. This can be a six-digit
decimal number.

CT Rating. Used if line-drop compensation is used for

voltage-controlled modules.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a capacitor

The Results tab in the Capacitor editor provides analysis results for the capacitor. The Results tab can be
very helpful if you are running multiple analyses and focusing on a particular device. Since the settings
update automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a capacitor.

TO VIEW ANALYSIS RESULTS FOR A CAPACITOR

1

In the SynerGEE map display or model explorer, double-click on the capacitor that you want to work
with.

In the Capacitor editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

SynerGEE Electric 5.0

User Guide

342

Modeling Devices

Deleting a capacitor
Perform the following procedure to delete a capacitor from your model.

TO DELETE A CAPACITOR FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the capacitor that you want to delete.

Right-click on the capacitor and select Delete.

Click Yes to confirm the deletion.

Motor Analysis and Capacitors

SynerGEE never switches switched modules in manual mode. Automatic modules are set up in the base run
of motor start analysis (MSA) or locked rotor analysis (LRA). In MSA, the state of switched capacitors is not
changed until the 100% speed point. In LRA, the state of switched capacitors is not changed until its Running
case.
For more information on motor start analysis, see Motor start analysis on page 377. For more information
on locked rotor analysis, see Locked rotor analysis on page 375.

Placement Analysis
SynerGEEs Capacitor Placement application is a comprehensive tool that helps you find locations for new
capacitor installations. The application can operate under a variety of placement objectives and provide
results on a feeder-by-feeder basis in a clear and concise manner.
For information on capacitor placement, see Capacitor Placement Analysis on page 562.

FUSES
SynerGEE supports a wide range of fuse types. Fuses are specified by manufacturer, model, and amp rating.
Current limiting fuses also require a voltage rating value. This information allows SynerGEE to find the
minimum-melt and the maximum-clear curves from the protection database. These curves are used for TCC
graphs and for coordination checking.

Adding a fuse
Fuses are added to a model in the same manner as any other equipment, by dragging a fuse type from the
Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE map display.
Refer to the following procedure for more information. Additional information on working with warehouse
equipment types is provided in Modeling Devices on page 317.

User Guide

SynerGEE Electric 5.0

Modeling Devices

343

TO ADD A FUSE TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Fuse Types and then select the fuse type that you want to add to your model. Drag it onto
the map display and drop it onto the desired section.

Editing a fuse
Use the Fuse editor to edit an existing fuse in your model. Refer to the following procedure for more
information.

TO EDIT A FUSE
1

In the SynerGEE map display or model explorer, double-click the fuse that you want to edit.

On the left side of the Fuse editor, select from the different tab names to access the available
settings for the fuse. The following topics describe the different tasks that you can perform:

Editing general data for a fuse on page 343

Setting failure rates, location links, and the energize and retire years for a fuse on
page 345

Viewing analysis results for a fuse on page 346

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a fuse

TO EDIT GENERAL DATA FOR A FUSE
1

In the SynerGEE map display or model explorer, double-click on the fuse that you want to edit.

In the Fuse editor, select the Fuse tab. The following table describes the different options that you
can set.
Name

Fuse name or ID.

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Manufacturer and
Model

Fuse manufacturer and model. These lists are populated based on

information in the protection database. For more information on the
protection database, see Protection data on page 67.

Amp and Volt Ratings

Fuse ratings.

Amp X and Time X

Amperage and time multiplier values. For more information on fuse

multipliers, see Fuse time and amp multipliers on page 346.

Amp+ and Time+

Amp adder and time delay, in seconds.

SynerGEE Electric 5.0

User Guide

344

Modeling Devices

Phasing

Fuse phasing.

Status

Fuse open/closed state. For more information on switchable

protective devices, see Switchable protective devices on page 600.

Add to TCC

Adds the fuse to the TCC. For more information on the TCC, see
Time Versus Current Coordination (TCC) Graph on page 604.

TCC color

Color of the fuse curve if plotted on the TCC. For more information on
the TCC, see Time Versus Current Coordination (TCC) Graph on
page 604.

Protecting

Click to open the editor for the protecting device for the fuse.

Fault Amps (Cutoff)

Cutoff amps.

Fuse saving scheme

When the Fuse saving scheme check box is selected and your
reliability analysis options have been configured to use individual fuse
settings for fuse/recloser coordination, then an event downstream
from the fuse will result in the operation of the nearest upstream
recloser. If a recloser or reclosing breaker or feeder does not exist
upstream, then the fuse will blow.
When the Fuse saving scheme check box is cleared, then the fuse
will always blow for an event directly downstream despite any
upstream reclosing capabilities.
The Fuse saving scheme check box will be ignored when your
reliability analysis options have been configured to use either Global
fuse saving or Global fuse blowing. For more information on the
reliability analysis settings and the Fuse/Recloser Coordination
option, see Setting up additional reliability analysis options on
page 665.

User Guide

Dont allow operation

from analysis

Certain types of analyses, such as optimal switching, contingency,

and reliability, simulate the operation of switches and protective
devices to accomplish the analysis objective. Select this option to
exclude the fuse from being controlled in this way during these
analysis types. If selected, this restriction only applies to the current
fuse in the editor.

Bypass

Select this check box to ignore the operational capability of the fuse
during check coordination analysis, reliability analysis, and other
applications.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Modeling Devices

345

Setting failure rates, location links, and the energize and retire
years for a fuse
The Rates tab in the Fuse editor specifies failure rate data for the fuse. You can specify a sustained failure
rate and temporary failure rate, as well as the failure repair time and cost. The Rates tab also contains
options to set a location link and an AMS link, and also to set the energize and retire years.
Refer to the following procedure for more information.

TO SET FAILURE RATES, LOCATION LINKS, AND THE ENERGIZE AND RETIRE YEARS FOR A FUSE
1

In the SynerGEE map display or model explorer, double-click on the fuse that you want to edit.

In the Fuse editor, select the Rates tab. The following table describes the different tasks that you
can perform.
To...

Do This...

Enter failure rate data

In the respective fields, enter values for the following parameters:

Sustained Failure Rate

Temporary Failure Rate

Failure Repair Time

Failure Repair Cost

Crew Oper./Reset

Generally, the numbers that you enter will represent averages and
estimates, because it is unlikely that you will have exact figures for
each individual device.

Set up a location link

Next to Location Link, type the correct syntax to link the device to an
external source, such as a file, website, or location in an Internet
mapping software application. SynerGEEs location link feature, as
well as the syntax required to set up location links, is described in
Location Links on page 223.

Set up an Asset
Management System
(AMS) link

Next to AMS Link, specify the link to your asset management

system.

Specify energize and

retire years for multiyear analyses

Under Year, select an appropriate year next to Energize and Retire.

For more information on multi-year modeling, see Multi-Year
Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

346

Modeling Devices

Viewing analysis results for a fuse

The Results tab in the Fuse editor provides analysis results for the fuse. The Results tab can be very helpful
if you are running multiple analyses and focusing on a particular device. Since the settings update
automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a fuse.

TO VIEW ANALYSIS RESULTS FOR A FUSE

1

In the SynerGEE map display or model explorer, double-click on the fuse that you want to work with.

In the Fuse editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

Deleting a fuse
Perform the following procedure to delete a fuse from your model.

TO DELETE A FUSE FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the fuse that you want to delete.

Right-click on the fuse and select Delete.

Click Yes to confirm the deletion.

Fuse time and amp multipliers

Fuses have time and amp multiplier factors that can be used to account for older, derated fuses. In time,
some fuses degrade, requiring less time or less amperage to blow. For more information on setting time and/
or amp multiplier factors, see Editing a fuse on page 343.
The multiplier factors do not alter the shape of the fuse curve. Rather, they simply shift it on the TCC graph as
applicable.

Fuse time multiplier factor

The time multiplier factor shifts a fuse curve upwards or downwards on the graph, changing the amount of
time it requires to blow at any given amperage. Any value less than one shifts the curve downwards,
indicating a derated fuse.

User Guide

SynerGEE Electric 5.0

Modeling Devices

347

The multiplier factor is multiplied against the normal time factor of a fuse curve. For example, a factor of 0.9
would reduce the time axis to 90% of the original on the graph. Likewise, 0.25 would indicate that at any
given amperage, the fuse would blow at only 25% of the normal time requirement.

Fuse amp multiplier factor

The amp multiplier factor shifts a fuse curve left or right on the graph, changing the amount of amperage it
requires to blow for any given amount of time. Any value less than one shifts the curve left, indicating a
derated fuse.
The multiplier factor is multiplied against the normal amp factor of a fuse curve. For example, a factor of 0.75
would reduce the amp axis to 75% of the original on the graph. Likewise, 0.5 would indicate that for any given
amount of time, the fuse would blow at only half the normal time requirement.

Fuse defaults and uprating

Naturally, the default value for multiplier factors is 1.0, but you can adjust them lower to make coordination
more conservative, perhaps to compensate for older equipment. Use caution when derating fuses in this
fashion, as the process will likely involve a significant amount of personal experience with your system and
perhaps some guesswork. SynerGEE also allows the factors to be greater than one, essentially uprating a
fuse. This feature is not associated with real-world situations of aging and derating. Rather, it is provided to
allow you flexibility with managing fuse curves.

GENERATORS
SynerGEE supports detailed by-phase models of generators. The following model types are available:

Synchronous. Series winding impedances and a back EMF are used to represent the machines
behavior. The machine responds to the voltage and output power settings in percent. For more
information on synchronous machines, see the SynerGEE Technical Reference.

Induction. The machine is modeled with passive components. A variable resistance represents the
electro-mechanical coupling through the notion of slip. The output power in kW can be specified. For
more information on induction machines, see the SynerGEE Technical Reference.

Photovoltaic (Inverter) PQ. The Inverter PQ model behaves just like a negative constant power load
and does not generate fault current contributions. For more information on PQ models, see the
SynerGEE Technical Reference.

Constant PQ. The Constant PQ model behaves just like a negative constant power load and does
not generate fault current contributions. For more information on PQ models, see the SynerGEE
Technical Reference.

The synchronous and induction models are referred to as active models because they respond to the byphase conditions of the distribution system as seen through their terminals. Depending on the distribution
system and other active devices, they may or may not be able to achieve the output values you specified.
Because the generator models were designed with real machines in mind, attention should be paid to the
operated or planned machine in cases when the SynerGEE model does not meet your kW or voltage
settings.

SynerGEE Electric 5.0

User Guide

348

Modeling Devices
PQ models do not actively respond to distribution system conditions. Their output power value will be the
user-specified value following a successful load-flow run.
Generators are always placed at the center of a section. Their terminals are driven from the voltage at the
center of the line and they inject current into the center of the line. For more information on the SynerGEE
section model, see The SynerGEE Section Model on page 258.
Refer to the topics listed below for more information on working with generators in SynerGEE.

Managing generator types in the equipment warehouse on page 348

Managing generators in the model on page 351

Scheduled, distributed generation on page 356

Additional notes on generators on page 356

Managing generator types in the equipment

warehouse
SynerGEE allows you to create a number of basic generator configurations known as generator types
that serve as a starting point for the generators in your model. Generator types are stored as equipment data
in the equipment warehouse. Equipment data allows you to associate common settings from a single
generator type with multiple generators in a model. In fact, you can associate a single generator type with
different generators in different models, as long as the same equipment data is opened with each model.
The generator type defines a number of key options, such as whether the generator is single phase or three
phase, and also the generator ratings. Therefore, it is very important that you properly configure the
generator types in your equipment data and then properly reference them from the generators in your model.
Like other equipment types, generator types are used to add new generators to your model. From the
Warehouse tab of the model explorer, simply find the generator type that you want to add, drag it into the map
display, and drop it onto the desired section. Once a generator has been created, you can change the
associated generator type from the Generator tab in the Generator editor. You should be aware that some
options in the Generator editor may enable and disable automatically based on the options you have selected
in the referenced generator type.
The topics listed below provide more information on working with generator types. For more information on
working with the equipment warehouse in general, see Equipment data on page 64.

Creating a generator type on page 348

Editing a generator type on page 349

Deleting a generator type on page 351

Creating a generator type

Perform the following procedure to create a new generator type in your equipment warehouse.

User Guide

SynerGEE Electric 5.0

Modeling Devices

349

TO CREATE A GENERATOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Generator.

In the Enter Device ID dialog box, type a name for the new device type and then click OK.

Use the Generator Type editor to edit the settings for the generator type. For more information on
the options you can set, see Editing a generator type on page 349.

Editing a generator type

To edit a generator type, double-click the generator type name in the Warehouse tab of the SynerGEE model
explorer. From the Generator tab in the Generator editor, you can also click the edit button that is located next
to the name of the selected generator type.
Refer to the following procedure for more information.

TO EDIT A GENERATOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Generator Types and then double-click the name of the generator type that you want to
edit.

In the Generator Type editor, select the Ratings tab. The following table describes the different
options that you can set.
Description

Specify an optional description for the generator type.

Type

Select one of the following as the generator type:

Conventional Synchronous

Conventional Induction

Wind Induction

Photovoltaic (Inverter) PQ

Constant PQ

Battery

For more information on the supported generator types, see the

SynerGEE Technical Reference.
Ratings

Specify the rated kW, kV, and %pf nameplate values for the generator
type. The rated pf is the power factor output of the machine at rated
kW and kV. Generators require a power factor range between 20%
and 100%.

Construction

Specify whether the generator type is single-phase or three-phase.

SynerGEE Electric 5.0

User Guide

350

Modeling Devices

Usage for this type

Select the appropriate check boxes to make the generator type

available for use with the following devices in SynerGEE:

Generator Instances

Large Customers

Section Distributed Generation

For example, if you select the check boxes for Generator Instances
and Large Customers, the generator type can be selected for use
with generators (as specified on the Generator tab of the Generator
editor) and large customers (as specified on the Generation tab of the
Large Customer editor). It could not, however, be selected for use
with a section (as specified on the Gen - Dist tab of the Section
editor).

Impedance

Specify the winding impedances that are used in unbalanced loadflow calculations specified in percent, based on the machines rating.
Xd" and X" are the subtransient reactances of synchronous and
induction machines respectively. These are the impedances seen
looking into the machine at the instance of a fault.

Exciter

Specify the ratio of the PT connected to the exciter. Available for

synchronous generators only.

Select the Wind/PV tab. Use the Wind/PV tab to add additional wind performance values and PV
performance values. These options become enabled when you select the Wind Induction or
Photovoltaic (Inverter) PQ generator types, respectively, on the Ratings tab of the Generator Type
editor.
Wind Performance

User Guide

The Wind Performance fields are enabled when you select Wind
Induction as the Generator Type. The following values may be
entered:

Cut-in speed. Minimum wind speed at which the

turbine will generate usable power.

Rated speed. Minimum wind speed at which the turbine

will generate its designated rated power, which typically
is its maximum power output.

Furling speed. Wind speed at which the turbine will

shut down to avoid damage. Also known as the cut-out
speed.

SynerGEE Electric 5.0

Modeling Devices

PV Performance

Induction Generators

351

The PV Performance fields are enabled when you select

Photovoltaic (Inverter) PQ as the Generator Type. The
following values may be entered:

Rated Irradiance. Power capacity rating for the

photovoltaic generator type, specified in Watts per
square meter.

Fault amps. Specifies the PV fault current as a

percentage of load current. For example, a value of 120
indicates that during a fault, the generator fault current
must be limited to 120% of the pre-fault generation
current.

The Induction Generators fields are enabled when you select

Wind Induction as the Generator Type. The following values
may be entered:

Battery

Fault factor.

The Battery fields are enabled when you select Battery as the
Generator Type. The following values may be entered:

Rating. Battery rating, specified in kilowatts per hour.

Select the Synch kvar tab. The Synch kvar tab includes two graphs that allow you to set the
minimum and maximum kvar output from the generator. This defines the amount of power that a
generator can deliver. You can set values in the range of 0 to 60% for the maximum kvar output, and
0 to -60% for the minimum. To set a value, simply click in the chart area for the value you want to
set. The precise values will appear as pop-up text as you hover your mouse over the graphs.

Click Apply to accept your changes, and then click X to close the editor.

Deleting a generator type

Perform the following procedure to delete a generator type from your equipment warehouse.

TO DELETE A GENERATOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Generator Types and then select the name of the generator type that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Managing generators in the model

Refer to the topics listed below for information on adding, editing, and deleting generators in your model.

Adding a generator on page 352

SynerGEE Electric 5.0

User Guide

352

Modeling Devices

Editing a generator on page 352

Deleting a generator on page 356

Adding a generator
Generators are added to a model in the same manner as any other equipment, by dragging a generator type
from the Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE map
display. Refer to the following procedure for more information. Additional information on working with
warehouse equipment types is provided in Modeling Devices on page 317.

TO ADD A GENERATOR TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Generator Types and then select the generator type that you want to add to your model.
Drag it onto the map display and drop it onto the desired section.

Editing a generator
Use the Generator editor to edit an existing generator in your model. Refer to the following procedure for
more information.

TO EDIT A GENERATOR
1

In the SynerGEE map display or model explorer, double-click the generator that you want to edit.

On the left side of the Generator editor, select from the different tab names to access the available
settings for the generator. The following topics describe the different tasks that you can perform:

Editing general data for a generator on page 352

Editing machine data and energize/retire years for a generator on page 355

Viewing analysis results for a generator on page 355

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a generator

TO EDIT GENERAL DATA FOR A GENERATOR
1

In the SynerGEE map display or model explorer, double-click on the generator that you want to edit.

In the Generator editor, select the Generator tab. The following table describes the different options
that you can set.
Name

User Guide

Generator name or ID.

SynerGEE Electric 5.0

Modeling Devices

Turn On

353

Select this check box to enable the generator. When a generator is

disabled, it will not have any effect on the model.
You can also enable and disable the generator by right-clicking on the
generator symbol in the SynerGEE map display, or on the generator
name in the Model tab of the SynerGEE model explorer, and
selecting Turn On or Turn Off, as appropriate.

Type

Select a generator type from your equipment warehouse to apply to

the generator. Only generator types where the Generator Instances
check box is selected on the Ratings tab of the Generator Type editor
will be available for selection from this list.
If the referenced generator type does not exist in the currently loaded
equipment warehouse, then the generator type will be displayed as
Unknown. If an analysis fails because of a missing equipment type,
the resulting report will specifically indicate the offending device(s).
The generator type association will be restored once a matching
equipment warehouse is opened.
For more information on generator types, see Managing generator
types in the equipment warehouse on page 348.

Synchronous
Generator Settings

SynerGEE Electric 5.0

Specify the following options. These options apply to synchronous

generators only.

Volt Setting. Desired output voltage based on the PT Ratio

value for the associated Generator Type.

Metering Phase. Phase to be used for metering. Available

for three-phase synchronous generator types only.

Pos. Seq. Indicates the use of positive sequence metering.

Positive sequence metering will average all three phases.
Selecting this check box will disable the metering phase
options.

User Guide

354

Modeling Devices

Generator Output

Select from one of the following options:

Rated kW output. Select this option to use the rated values

as specified on the associated Generator Type editor for the
generators output.

Specify Output %. Select this option to specify the

percentage of steady-state contribution of the generator for
the active section. The value is the percent of the capacity of
the generating unit that is contributing toward the kW and
kvar loading requirements of the feeder.
Tip:

User Guide

You can also turn on a generator from the model

explorer and SynerGEE map display, by rightclicking on the generator or generator name and
select Turn On.

Weather based performance.

Diurnal (hourly) curve. Select this option to specify that the

generators output is defined by the load curve of a selected
customer class. For more information on working with
customer classes, see Customer classes on page 810.

Negative PQ Load

For the PQ (constant power) load model only, this is the percent
power factor that will be implemented when the user selects to use
the PQ load model. The power factor can be set to -60 to -99 or 60 to
100. The default value is 100.

Use PQ Model

Select this check box to assign the PQ (constant power) load model
to the generator.

Specify pf

Select this check box to specify a power factor percentage specific to

this generator. If the check box is cleared, the rated power factor
percentage for the associated generator type will be used.

Single Ph Connect

Select the phase to use for connection (metering). This option is only
available when the generator type is single-phase construction, as
specified on the Ratings tab of the Generator Type editor.

Grounding Ohms

The grounding impedance is used for active generator models in both

load-flow and fault studies. Residue from unbalanced load current
and/or fault current has a direct effect on generator terminal voltage.
The grounding impedance also has the effect of reducing this current.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Modeling Devices

355

Editing machine data and energize/retire years for a generator

TO EDIT MACHINE DATA FOR A GENERATOR
1

In the SynerGEE map display or model explorer, double-click on the generator that you want to edit.

In the Generator editor, select the Machine tab. The following table describes the different options
that you can set.

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Loc. Link

Syntax to link the generator to an external source, such as a file or

website. For more information, see Location Links on page 223.

AMS Link

Syntax to link the generator to an Asset Management System.

Energize/Retire years

Energize and retire years for multi-year analysis. For more

information, see Multi-Year Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a generator

The Results tab in the Generator editor provides analysis results for the generator. The Results tab can be
very helpful if you are running multiple analyses and focusing on a particular device. Since the settings
update automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a generator.

TO VIEW ANALYSIS RESULTS FOR A GENERATOR

1

In the SynerGEE map display or model explorer, double-click on the generator that you want to work
with.

In the Generator editor, select Results.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

SynerGEE Electric 5.0

User Guide

356

Modeling Devices

Deleting a generator
Perform the following procedure to delete a generator from your model.

TO DELETE A GENERATOR FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the generator that you want to delete.

Right-click on the generator and select Delete.

Click Yes to confirm the deletion.

Scheduled, distributed generation

Using the large customer feature, you can set up scheduled, distributed generation and co-generation in your
model. For more information, see Large Customers and Distributed Generation on page 503.

Additional notes on generators

The following items pertain to generators and the SynerGEE model.

Fault analysis and generators

During fault analysis, induction and synchronous machines are seen as reactances tied to ground through
their grounding impedances. PQ generators do not contribute fault current during fault analysis. For more
information on fault analysis, see Fault Analysis on page 648.

Multiple generators
SynerGEE is a steady-state simulation tool. Because of this, there are no limits to the number of active
generators that can be modeled, with the exception that only one generator can be placed on a section. Keep
in mind that SynerGEE does not support frequency controls and complex exciter models.

Delta-connected generators
Although it is theoretically possible to build a generator with Delta-connected windings, it is not practical. This
type of generator would promote a high level of circulating current. Also, the windings would have to be
insulated to a much higher level with respect to the Wye-connected equivalent. This insulation would lead to
cooling problems.
SynerGEE does support ungrounded Wye connections.

METERS
Meter devices are simple data points that you can place anywhere in your model to represent demands or
metered values. From a modeling perspective, you interact with meters in the same way that you interact with
any other device. Their analytical effect, however, is somewhat different, in that they serve primarily as points
of data for load allocation analysis. They do not contribute to load flow-based system parameters, such as
voltage and losses.

User Guide

SynerGEE Electric 5.0

Modeling Devices

357

Because meters are modeled as section devices, it is possible to put metered values on every section.
However, too many meters will likely cause non-convergence of load allocation due to the granular load
groups between them. For best allocation results, you should use a limited number of metering points that
accurately represent demand data at strategic points, such as feeder sources. For more information on how
load allocation handles meters throughout a model, versus source demand meters, see About load
allocation demands and meters on page 550.
Meter data is multi-year compliant. Data can be specified on a yearly basis, according to the current year to
which the interface is set. Because section loads are also multi-year compliant, meters can facilitate multiple
annual load setups all within the same model, including independent load allocation by year. For more
information on multi-year modeling, see Multi-Year Analysis on page 579.
Refer to the topics listed below for more information on working with meters in SynerGEE.

Managing meters in the model on page 357

Meters and reliability studies on page 364

Metering points and load allocation on page 364

Managing meters in the model

Refer to the topics listed below for information on adding, editing, and deleting meters in your model.

Adding a meter on page 357

Editing a meter on page 357

Deleting a meter on page 364

Adding a meter
Meters are added to a model in the same manner as any other equipment, by dragging a meter type from the
Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE map display.
Unlike other device types, meter equipment types are not actually stored in your equipment data source,
since meters are represented entirely by model (instance) data. The single meter equipment type in the
Warehouse tab, General Meter, simply represents a shortcut to add a meter when you drag the device from
the warehouse.
Refer to the following procedure for more information. Additional information on working with warehouse
equipment types is provided in Modeling Devices on page 317.

TO ADD A METER TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Meters and then select the meter type that you want to add to your model. Drag it onto the
map display and drop it onto the desired section.

Editing a meter
Use the Meter editor to edit an existing meter in your model. Refer to the following procedure for more
information.

SynerGEE Electric 5.0

User Guide

358

Modeling Devices

TO EDIT A METER
1

In the SynerGEE map display or model explorer, double-click the meter that you want to edit.

On the left side of the Meter editor, select from the different tab names to access the available
settings for the meter. The following topics describe the different tasks that you can perform:

Editing general data for a capacitor on page 336

Setting up demands for a meter on page 359

Specifying reliability targets for a meter on page 362

Assigning default customer zones to a meter on page 363

Viewing analysis results for a meter on page 363

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a meter

TO EDIT GENERAL DATA FOR A METER
1

In the SynerGEE map display or model explorer, double-click on the meter that you want to edit.

In the Meter editor, select the Meter tab. The following table describes the different options that you
can set.
Name

Meter name or ID.

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Loc. Link

Syntax to link the meter to an external source, such as a file or

website. For more information, see Location Links on page 223.

AMS Link

Syntax to link the meter to an Asset Management System.

Use with Color by

Meter

When the map displays Color By option has been set to Meters, you
can select this check box to color all downstream sections with the
specified color. The color will be applied to all downstream sections
until another meter is encountered with this same option enabled, at
which point the section coloring will change to the new meters
designated color.
Color by options are set up in the Style tab of the Map Settings editor.
For more information, see Selecting a Coloring Scheme for Sections
on page 216.

User Guide

SynerGEE Electric 5.0

Modeling Devices

Current Rating

359

Specifies Continuous and Emergency current ratings for exception

reporting during load flow-based analyses. The editor also shows the
MVA emergency and continuous ratings for the meter, based on the
amp ratings and nominal kV seen by the meter.
The Continuous and Emergency current rating values can be
specified over multiple years for a multi-year analysis. To specify a
value for a specific year, select the desired year in SynerGEE and
then set the Continuous and Emergency values, as appropriate. As
you change the modeling year, the values will change in the dialog
box according to the ratings you have already set.
For more information, see Multi-Year Analysis on page 579.

Status

Specifies whether the meter is Open or Closed.

Use Demand As Load

Out Of Meter

If you set the meters status as Open, select this check box to have
the meter represent downstream load when the meter is at the
outward end of a section.

Energize/Retire years

Specifies the energize and retire years for multi-year analysis. For
more information, see Multi-Year Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

Setting up demands for a meter

TO SET UP DEMANDS FOR A METER
1

In the SynerGEE map display or model explorer, double-click on the meter that you want to edit.

In the Meter editor, select the Demands tab. The following table describes the different options that
you can set.
Do not use demands

Select this check box if you will not be using demands on this meter.
Many demand-related options in the Demands tab will be disabled
when this check box is selected.

Lock downstream
loads

Select this check box to prevent the updating of downstream loads

during a load allocation analysis. For more information on how load
allocation handles this setting, see About load allocation demands
and meters on page 550.

Type

Specifies whether the meter is Amps or kVA. Note that no automatic

conversion takes place when you switch between the two options.

Units

Specifies the units of measurement for non-amp meter values.

Conversion between these units is automatic.

SynerGEE Electric 5.0

User Guide

360

Modeling Devices

Overridden by
upstream meters

Select this check box to ignore the specified meter demands if there
is an active meter upstream from this one.
This option may be useful if you plan to allocate load by subtran
demands but still want to model feeder demands and perhaps use
them at other times. It also allows you to reset the specified demands
by using calculated demands from upstream meters. For more
information on how load allocation handles this setting in
consideration of subtran versus feeder demands, see About load
allocation demands and meters on page 550.

User Guide

SynerGEE Electric 5.0

Modeling Devices

Metered Values

361

Use the A, B, and C columns in the Metered Values area to specify

the actual demand values for phases A, B, and C.

If the meter Type is Amp, then the fourth column will show
the average of the Amp and % pf values from the A, B, and
C columns. If you enter a value in the Average column, the
value will be distributed proportionally among the first three
phases, based on the current values for each phase.

If the meter Type is kVA and the Units is kw kvar, then the
fourth column will show the total of the kw and kvar values
from the A, B, and C columns. If you enter a value in the
Total column, the value will be distributed proportionally
among the first three phases, based on the current values
for each phase.

If the meter Type is kVA and the Units is kva %pf, then the
fourth column will show the total of the kVA values and the
average of the % pf values from the A, B, and C columns. If
you enter a value in the Total & Average column, the value
will be distributed proportionally among the first three
phases, based on the current values for each phase.

These values can be specified over multiple years for a multi-year

analysis. To specify a value for a specific year, select the desired year
in SynerGEE and then set the demand values, as appropriate. As you
change the modeling year, the values will change in the dialog box
according to the demands you have already set.
If desired, you can also click the Load Graph button to edit load
values using a graphical display. Click the Year button at the top of
the display to select a specific year to edit; select All to edit load
values for all years at once. Click anywhere outside of the Load
Graph editor to close the window.

Load Graph button

SynerGEE Electric 5.0

User Guide

362

Modeling Devices

Balance the loads

button

Click this button to balance the specified demands across all phases.

Balance the Loads button

Replace with Results

After running a load allocation analysis, click this button to replace the
current demand values with the demand results from the analysis.

Allocation scaling

Use the two text boxes in the Allocation scaling area to specify a
minimum and maximum percentage for the demand at the meter.
These values specify the range of demands that you would expect to
see at the meter. Later, when you are setting up a Load Allocation
analysis, you can use an option in the Load Allocation Options editor
to adjust the demands toward these minimum or maximum values.
For more information on setting up a Load Allocation analysis, see
Setting up a load allocation analysis on page 552.

Growth Curve

Select this check box to specify a growth curve for the meter. Growth
curves are used to perform forecasting analyses, as described in
Forecasting Analysis on page 556.

Click Apply to accept your changes, and then click X to close the editor.

Specifying reliability targets for a meter

Use the Reliability tab in the Meter editor to specify expected reliability indices for SAIFI, SAIDI, and MAIFI.
These values work with exposure factors during the reliability analysis to calibrate target values for SAIDI,
SAIFI, and MAIFI. When these targets are set, SynerGEE will adjust the section-based exposure factors to
achieve these specified indices.
Refer to the following procedure for more information on specifying reliability targets for a meter. For
additional information, see Exposure factors and reliability studies on page 673.

TO SPECIFY RELIABILITY TARGETS FOR A METER

1

In the SynerGEE map display or model explorer, double-click on the meter that you want to edit.

In the Meter editor, select the Reliability tab.

Select the Active Targets check box to enable the reliability targets for the meter.

Specify reliability targets as appropriate for the following options:

-

User Guide

SAIFI

SynerGEE Electric 5.0

Modeling Devices

363

SAIDI

MAIFI

Click Apply to accept your changes, and then click X to close the editor.

Assigning default customer zones to a meter

Use the Zones tab in the Meter editor to apply customer zones to a meter. Different customer zones can be
set as the default zones for any distributed or spot loads that are downstream from the meter. This default
zone will be used for any downstream loads used unless a downstream section is specifically set up for a
particular customer zone. In this case, the section-based zone will override the meter-specified default.
Refer to the following procedure for more information.

TO ASSIGN DEFAULT CUSTOMER ZONES TO A METER

1

In the SynerGEE map display or model explorer, double-click on the meter that you want to edit.

In the Meter editor, select the Zones tab.

Select the Default for distributed loads and/or Default for spot loads check boxes, as
appropriate, to enable default customer zones for the meter. For each option, select a zone name
from the related options list.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a meter

The Results tab in the Meter editor provides analysis results for the meter. The Results tab can be very
helpful if you are running multiple analyses and focusing on a particular device. Since the settings update
automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a meter.

TO VIEW ANALYSIS RESULTS FOR A METER

1

In the SynerGEE map display or model explorer, double-click on the meter that you want to work
with.

In the Meter editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

SynerGEE Electric 5.0

User Guide

364

Modeling Devices

Deleting a meter
Perform the following procedure to delete a meter from your model.

TO DELETE A METER FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the meter that you want to delete.

Right-click on the meter and select Delete.

Click Yes to confirm the deletion.

Meters and reliability studies

Meters can be an extremely useful tool for reliability studies. For more information, see Using meters for
reliability studies on page 671.

Metering points and load allocation

Load allocation can consider metering points during the allocation process to accurately apply the distributed
load. During load allocation, SynerGEE adjusts the downstream load to meet the specified amp flow on
metered sections. Loads on all sections directly fed through a metering point are adjusted. If a metering point
feeds a second metering point, the load between the two points is adjusted to meet the flow through the first
point, and all downstream load is adjusted to meet the flow through the second point.
Because metering point values are assigned at the section level, it is possible to put metered values on every
section. However, too many metering points may result in non-convergence of load allocation due to the
granular load groups between metering points. For best allocation results, you should use a limited number of
metering points in conjunction with realistic feeder demands.
If you allocate load using substation models, metering points may be necessary to properly configure your
source demands. Because the subtran source and the actual transformer are two different entities, the
demands that you specify in the source generally represent those on the primary of the transformer, not the
secondary. If your known demands values represent secondary demands, you should place them in a
metering point directly following the transformer to circumvent the effects of transformer loss.
Tip:

Metering points are considered by load allocation only if you have your load allocation options set to
consider them. For more information, see To set load allocation options on page 552.

MOTORS
SynerGEE supports a detailed motor model, which is fully considered by analyses such as load-flow and any
load-flow based applications. In addition, if you have motors modeled, SynerGEE provides two motor-specific
analyses: locked rotor analysis (LRA) and motor start analysis (MSA).
Like all model equipment, motors are attached to sections. Once modeled, the motor and motor service loads
are considered to be at the center of a section, similar to an equivalent constant impedance spot load. Only
one motor may be placed per section, and the section ID serves as the unique identifier. Motors can be
modeled on substation buses.

User Guide

SynerGEE Electric 5.0

Modeling Devices

365

For detailed information on motor start analysis, see Motor start analysis on page 377. For detailed
information on locked rotor analysis, see Locked rotor analysis on page 375.
Refer to the topics listed below for more information on working with motors in SynerGEE.

Managing motor types in the equipment warehouse on page 365

Managing motor curve types in the equipment warehouse on page 368

Managing motors in the model on page 369

Motor analyses on page 375

Managing motor types in the equipment warehouse

SynerGEE allows you to create a number of basic motor configurations known as motor types that serve
as a starting point for the motors in your model. Motor types are stored as equipment data in the equipment
warehouse. Equipment data allows you to associate common settings from a single motor type with multiple
motors in a model. In fact, you can associate a single motor type with different motors in different models, as
long as the same equipment data is opened with each model.
The motor type defines a number of key options, such as whether the motor is single phase or three phase,
and also the rated horsepower, rated voltage, and full load efficiency for the motor. Therefore, it is very
important that you properly configure the motor types in your equipment data and then properly reference
them from the motors in your model.
Like all equipment data, motor types are used to add new motors to your model. From the Warehouse tab of
the model explorer, simply find the motor type that you want to add, drag it into the map display, and drop it
onto the desired section. Once a motor has been created, you can change the associated motor type in the
Motor tab of the Motor editor. You should be aware that some options in the Motor editor may enable and
disable automatically based on the options you have selected in the referenced motor type.
The topics listed below provide more information on working with motor types. For more information on
working with the equipment warehouse in general, see Equipment data on page 64.

Creating a motor type on page 365

Editing a motor type on page 366

Deleting a motor type on page 367

Creating a motor type

Perform the following procedure to create a new motor type in your equipment warehouse.

TO CREATE A MOTOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Motor.

In the Enter Device ID dialog box, type a name for the new device type and then click OK.

Use the Motor Type editor to edit the settings for the motor type. For more information on the
options you can set, see Editing a motor type on page 366.

SynerGEE Electric 5.0

User Guide

366

Modeling Devices

Editing a motor type

To edit a motor type, double-click the motor type name in the Warehouse tab of the SynerGEE model
explorer. From the Motor tab in the Motor editor, you can also click the edit button that is located next to the
name of the selected motor type.
Refer to the following procedure for more information.

TO EDIT A MOTOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Motor Types and then double-click the name of the motor type that you want to edit.

In the Motor Type editor, select the Ratings tab. The following table describes the different options
that you can set.

User Guide

Description

Optional description for the motor type.

Rated horsepower

Maximum horsepower for the motor type. For more information, see
the SynerGEE Technical Reference.

Rated voltage

Maximum voltage for the motor type. For more information, see the
SynerGEE Technical Reference.

Full load efficiency

Maximum efficiency for the motor type. For more information, see the
SynerGEE Technical Reference.

Type

Specifies whether the motor type is single-phase or three-phase.

Characteristics

Specifies whether you will enter Nameplate Data or specify Motor

Amp and Pf Curves for the motor type. Refer to the options
described below for more information.

Locked Rotor Kva/HP

kVA per horsepower under locked rotor conditions. This option is

enabled when you have selected Nameplate Data as the
Characteristic type.

Full Load Power

Factor

Motor power factor at full speed, rated load, and rated voltage. This
option is enabled when you have selected Nameplate Data as the
Characteristic type.

Starting Power Factor

Power factor of the motor during starting conditions. This option is

enabled when you have selected Nameplate Data as the
Characteristic type.

Motor Amp Curve

Motor amp curve, as referenced from the equipment data in your

equipment warehouse. This option is enabled when you have
selected Motor Amp and PF Curves as the Characteristic type. For
more information on motor curves, see Managing motor curve types
in the equipment warehouse on page 368.

SynerGEE Electric 5.0

Modeling Devices

Motor Pf Curve

367

Motor performance curve, as referenced from the equipment data in

your equipment warehouse. This option is enabled when you have
selected Motor Amp and PF Curves as the Characteristic type. For
more information on motor curves, see Managing motor curve types
in the equipment warehouse on page 368.

Select the Starting tab. Use the Starting tab to edit the starting attributes for the motor. The
following table describes the different options that you can set.
Synchronous Speed

Speed at which an induction motor rotating field and rotor have no

relative motion or the speed at which the motor stops producing
torque.

Full Load Speed

Rated full load speed of the motor.

Motor Inertia

Motor inertia is the weight of the motor and has a direct bearing on
the starting time calculated within a motor start analysis. It is the
machine inertia constant which includes the Wk2 of the motor with the
Wk2 of the mechanical coupling or any gearing included. If total Wk2
values are not available, the motor Wk2 value can be used by itself.
Motor inertia is combined with the load inertia (which is specified in
the motor editor) during a motor start analysis. A non-zero value is
required.
Motor inertia can be entered directly or calculated by SynerGEE, as
follows:

Motor Torque Curve

Have SynerGEE calculate Motor Inertia. Select this check

box to have SynerGEE calculate an approximate value
using an equation published in the SynerGEE Technical
Reference.

Motor Inertia. Use the motor inertia text box to directly

specify the motor inertia for the motor type. The maximum
allowable value is 500,000,000 lb-ft2.

Motor torque curve, as referenced from the equipment data in your

equipment warehouse. For more information on motor curves, see
Managing motor curve types in the equipment warehouse on
page 368.

Click Apply to accept your changes, and then click X to close the editor.

Deleting a motor type

Perform the following procedure to delete a motor type from your equipment warehouse.

SynerGEE Electric 5.0

User Guide

368

Modeling Devices

TO DELETE A MOTOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Motor Types and then select the name of the motor type that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Managing motor curve types in the equipment

warehouse
All motors in your model reference a motor curve type. Motor types in the equipment warehouse also
reference at least one, and often several, motor curve types. Motor curve types are stored in the equipment
warehouse, which allows you to reuse motor curves with multiple motors and motor types.
The topics listed below provide more information on working with motor curve types. For more information on
working with the equipment warehouse in general, see Equipment data on page 64.

Creating a motor curve type on page 368

Editing a motor curve type on page 368

Deleting a motor curve type on page 369

Creating a motor curve type

Perform the following procedure to create a new motor curve type in your equipment warehouse.

TO CREATE A MOTOR CURVE TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Motor Curve.

In the Enter Device ID dialog box, type a name for the new device type and then click OK.

Use the Motor Curve Type editor to edit the settings for the motor curve type. For more information
on the options you can set, see Editing a motor curve type on page 368.

Editing a motor curve type

TO EDIT A MOTOR CURVE TYPE
1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Motor Curve Types and then double-click the name of the motor curve type that you want
to edit.

User Guide

SynerGEE Electric 5.0

Modeling Devices
3

369

Use the Motor Curve Type editor to set up the curve type, data points, and optional description. The
following table provides more information on each of these options.
Description

Type an optional description for the motor curve.

Curve Type

Select the type of curve you are editing. Available choices are
Torque, Amp, Pf, and Load. For more information on these options,
see the SynerGEE Technical Reference.

Data Points

Specify the data points for the motor curve. Double-click an existing
value in the Point column to enter a new value. Curve information
should generally be available in your manufacturer data sheets.

Click Apply to accept your changes, and then click X to close the editor.

Deleting a motor curve type

Perform the following procedure to delete a motor curve type from your equipment warehouse.

TO DELETE A MOTOR CURVE TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Motor Curve Types and then select the name of the motor curve type that you want to
delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Managing motors in the model

Refer to the topics listed below for information on adding, editing, and deleting motors in your model.

Adding a motor on page 369

Editing a motor on page 370

Deleting a motor on page 375

Adding a motor
Motors are added to a model in the same manner as any other equipment, by dragging a motor type from the
Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE map display.
Refer to the following procedure for more information. Additional information on working with warehouse
equipment types is provided in Modeling Devices on page 317.

SynerGEE Electric 5.0

User Guide

370

Modeling Devices

TO ADD A MOTOR TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Motor Types and then select the motor type that you want to add to your model. Drag it
onto the map display and drop it onto the desired section.

Editing a motor
Use the Motor editor to edit an existing motor in your model. Refer to the following procedure for more
information.

TO EDIT A MOTOR
1

In the SynerGEE map display or model explorer, double-click the motor that you want to edit.

On the left side of the Motor editor, select from the different tab names to access the available
settings for the motor. The following topics describe the different tasks that you can perform:

Editing general data for a motor on page 370

Editing service data for a motor on page 371

Selecting a motor starting method on page 373

Editing load torque data for a motor on page 374

Viewing analysis results for a motor on page 374

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a motor

TO EDIT GENERAL DATA FOR A MOTOR
1

In the SynerGEE map display or model explorer, double-click on the motor that you want to edit.

In the Motor editor, select the Motor tab. The following table describes the different options that you
can set.
Name

Motor name or ID.

Type

Reference to a motor type in your equipment warehouse. If the

referenced motor type does not exist in the currently loaded
equipment warehouse, then the motor type will be displayed as
Unknown. If an analysis fails because of a missing equipment type,
the resulting report will specifically indicate the offending device(s).
The motor type association will be restored once a matching
equipment warehouse is opened.
For more information on motor types, see Managing motor types in
the equipment warehouse on page 365.

Connection

User Guide

Specifies whether windings are connected in a star or delta

configuration.

SynerGEE Electric 5.0

Modeling Devices

371

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Loc. Link

Syntax to link the motor to an external source, such as a file or

website. For more information, see Location Links on page 223.

AMS Link

Syntax to link the motor to an Asset Management System.

Status

Specifies the motor state. Available choices are Off, Starting, and
Running. For more information on motor states and analysis, see the
SynerGEE Technical Reference.

Phasing at Service Tie

Phases associated with the tie points. This setting is used for
optimization studies.

Single Phase Motor

Connection

Phase connection for single-phase motor.

Energize/Retire years

Energize/retire years for multi-year analysis. For more information,

see Multi-Year Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

Editing service data for a motor

TO EDIT SERVICE DATA FOR A MOTOR
1

In the SynerGEE map display or model explorer, double-click on the motor that you want to edit.

In the Motor editor, select the Service tab. The following table describes the different options that
you can set.
Line from Section to
Transformer

Use the following options to set up a conductor that spans from the
section to the optional distribution transformer serving the motor.

Conductor. Select the name of a conductor type from your

equipment warehouse.

Spacing. Specify the equivalent conductor spacing. The

values that you can select from are defined in the Spacing
tab of the Preferences editor, as described in Setting values
for conductor spacing and height above ground on
page 169.

Length. Specify the conductor length. The default value is 1

foot.

For more information on conductor types and the equipment

warehouse, see Conductors on page 304.

SynerGEE Electric 5.0

User Guide

372

Modeling Devices

Use Transformer

Line from
Transformer to Starter

Select this check box to set up an optional transformer on the motor.

Once selected, the following options become enabled:

Type. Select the name of a transformer type from your

equipment warehouse.

High Connect and Low Connect. Specify the high-side and

low-side transformer connection types. If you have selected
a three-phase transformer type, the option will be disabled
(since the connection type is specified in the Transformer
Type editor). If you have selected a single-phase
transformer type, then you can set the connection types
here.

High Side Near Section. Select this check box to orient the
high-side winding near the section, meaning that the lowside winding feeds the motor. If this option is not selected,
then the low-side winding is near the section, meaning that
the high-side feeds the motor. Note that this setting is not
related to the physical location of the transformer.

Use the following options to set up a conductor that spans from the
optional distribution transformer to the motor.

Conductor. Select the name of a conductor type from your

equipment warehouse.

Spacing. Specify the equivalent conductor spacing. The

values that you can select from are defined in the Spacing
tab of the Preferences editor, as described in Setting values
for conductor spacing and height above ground on
page 169.

Length. Specify the conductor length. The default value is 1

foot.

For more information on conductor types and the equipment

warehouse, see Conductors on page 304.
3

User Guide

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Modeling Devices

373

Selecting a motor starting method

TO SELECT A MOTOR STARTING METHOD
1

In the SynerGEE map display or model explorer, double-click on the motor that you want to edit.

In the Motor editor, select the Starter tab. The following table describes the different options that you
can set.
Starting Method

Select a starting method for the motor. The following choices are
available. Each option is described in the SynerGEE Technical
Reference.

Full voltage

Autotransfer

Capacitor

Series Resistance

Series Reactance

Partial Winding

Wye/Delta

Solid State Red. Volt

Settings

Specify additional settings that are related to some of the starting

method that are available under Starting Methods. The Settings
options that appear, if any, depend on the Starting Method that you
selected.

Start Delay

Specify the motor starting delay.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

374

Modeling Devices

Editing load torque data for a motor

TO EDIT LOAD TORQUE DATA FOR A MOTOR
1

In the SynerGEE map display or model explorer, double-click on the motor that you want to edit.

In the Motor editor, select the Load tab. The following table describes the different options that you
can set.
Load Inertia

Load inertia is the weight of the load driven by the motor. It is

combined with the motor inertia (which is specified in the motor type
editor) during a motor start analysis. Load inertia is modeled
independently of motor inertia so that common motors can drive
various loads like pumps, impellers, or fans.
Load inertia can be entered directly or calculated by SynerGEE, as
follows:

Load Torque Curve

Have SynerGEE calculate Load Inertia. Select this check

box to have SynerGEE calculate an approximate value
using an equation published in the SynerGEE Technical
Reference.

Load Inertia. Use the load inertia text box to directly specify
the load inertia for the motor.

Reference to a motor load curve in your equipment warehouse. If the

referenced motor curve does not exist in the currently loaded
equipment warehouse, then the motor curve type will be displayed as
Unknown. The motor curve type association will be restored once a
matching equipment data source is opened.
For more information on motor curves, see Managing motor curve
types in the equipment warehouse on page 368.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a motor

The Results tab in the Motor editor provides analysis results for the motor. The Results tab can be very
helpful if you are running multiple analyses and focusing on a particular device. Since the settings update
automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a motor.

User Guide

SynerGEE Electric 5.0

Modeling Devices

375

TO VIEW ANALYSIS RESULTS FOR A MOTOR

1

In the SynerGEE map display or model explorer, double-click on the motor that you want to work
with.

In the Motor editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

Deleting a motor
Perform the following procedure to delete a motor from your model.

TO DELETE A MOTOR FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the motor that you want to delete.

Right-click on the motor and select Delete.

Click Yes to confirm the deletion.

Motor analyses
SynerGEE allows you to perform two different motor analysis types: Locked rotor analysis (LRA) and motor
start analysis (MSA). LRA is typically used to determine starting or worst-case effects of a starting motor on
the entire feeder. MSA is designed to study a specific motor or motors in detail. You can use MSA to set up a
motors starter or to set up the minimum delay time between the sequenced starting of two motors.
Refer to the topics listed below for more information.

Locked rotor analysis on page 375

Motor start analysis on page 377

Locked rotor analysis

Locked rotor analysis (LRA) uses the SynerGEE motor model and the motor service to simulate the initial
starting conditions of one or more motors. In locked rotor mode, motors are modeled as constant
impedance loads. They are served through cables, distribution transformers, and starters specified in the
Motor editor. The service and motor are attached to the center of their parent section. For more information
about the motor models and the service, see the SynerGEE Technical Reference. The methods used to
represent locked rotor motors comply with those discussed in IEEE Std. 399.
The highest current draw for a motor typically occurs during its locked rotor state. A motor is in its locked rotor
state when starting voltage is applied to its terminals and the rotor has not yet begun to turn. No coupling
exists between the stator and rotor, and the source sees a fault across the motors stator impedance. As a
result, the large starting current from a locked rotor can cause a serious voltage drop. SynerGEE uses the
motors starting kVA/HP, the section voltage, and a starting power factor to calculate locked rotor effects.
Motor power factor and amp curves can also be used to set up the locked rotor condition. Locked rotor

SynerGEE Electric 5.0

User Guide

376

Modeling Devices
analysis lets you evaluate the feeders response at various sections. This is a tremendous advantage for
design, reliability, and system integrity. Using LRA, the kW and kvar contribution of all the motors can be seen
along with the impact to their respective feeder or feeders, and substation. When loops are present, each
feeder will generate a before/during/after report to show voltage variations during the analysis.
LRA is available for substation analysis and can examine the voltage drop at each substation bus and the
connected feeders. Motors can be placed on substation buses; however, this would be unusual. You can see
the effect of motors placed on feeders by running LRA with a substation model displayed. If LRA is run from a
substation model, the feeders associated with the appropriate substation transformer that feeds the starting
motor are listed in the output. The drop through the substation transformers and the substation source
impedance is accounted for.

Locked rotor analysis and the motor model

When modeling motors, there are certain issues that you should consider with regards to locked rotor
analysis.

Converting a motor to a load

Motors are independent devices within the model data, like any other device. There may be occasions,
however, in which a spot load is preferable to a motor model. A motor can be converted to a kW and kvar
load and be manually combined with the other spot loads of a section by using the rated HP efficiency and
running power factor of the motor as follows:

S Motor =

HP ( 0.746 )
1
1 (kVA)
1 + j
2
Efficiency
pf

Eq 74

In this fashion, you could apply a spot load to the applicable section and remove the motor instance
altogether. For more information on applying a spot load to a section, see Editing Sections on page 279.

Motor starters and service and locked rotor analysis

Motor starters are used in locked rotor calculations in the initial state. The service cable, autotransformer (if
any), and starter are all used to model each motor installation during a run. Series R and X starters,
autotransformer starters, and reduced voltage starters have an effect on a motor during LRA. For more
information on specifying starters and service, see Editing a motor on page 370.

Performing a locked rotor analysis

Perform the following procedure to run a locked rotor analysis.

TO PERFORM A LOCKED ROTOR ANALYSIS

1

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the Locked Rotor icon.

User Guide

SynerGEE Electric 5.0

Modeling Devices

377

Motor start analysis

Starting large motors can cause severe disturbances to the motor, nearby loads, and loads throughout the
feeder. SynerGEEs motor start analysis (MSA) evaluates the effects of starting large motors on distribution
systems. It enables you to examine voltage drop at the feeder, service, and terminals of the motor after it is
switched onto the system and throughout its start. The analysis is a dynamic analysis resulting in time
domain-based results.
By performing a motor start analysis, you can determine and analyze the following:

Motor speed and torque versus acceleration time

Motor terminal voltage and current draw versus time

kW and kvar into service versus time

Service drop versus time

Effects of various types of starters

The speed-torque/accelerating time study can help to verify that starting times are within acceptable limits. It
can also help determine the best sequence for starting motors and the minimum delay required between the
successive starting of multiple motors.

Performing a motor start analysis

Perform the following procedure to run a motor start analysis.

TO PERFORM A MOTOR START ANALYSIS

1

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the Motor Studies icon.

RECLOSERS
SynerGEE distinguishes between hydraulic and electronic reclosers. Hydraulic reclosers are defined by
manufacturer, model, and coil rating. Electronic reclosers are defined by manufacturer, model, and pickup.
Electronic reclosers typically have a phase and ground unit, whereas hydraulic reclosers have a phase or
ground unit.
Phase and ground units each have two available response curves.

Fast

Time delay (or slow)

The operation count or number of shots for each response curve can be specified. The sum of the fast and
time delay shots must be four or less.
Adders and multipliers can be used to independently modify the fast and time delay response curves for
electronic reclosers. These values should come from settings on your recloser controller. Mechanical recloser
response curves cannot be modified with adders and multipliers.

SynerGEE Electric 5.0

User Guide

378

Modeling Devices

Adding a recloser
Reclosers are added to a model in the same manner as any other equipment, by dragging a recloser type
from the Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE map
display. Refer to the following procedure for more information. Additional information on working with
warehouse equipment types is provided in Modeling Devices on page 317.

TO ADD A RECLOSER TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Recloser Types and then select the recloser type that you want to add to your model. Drag
it onto the map display and drop it onto the desired section.

Editing a recloser
Use the Recloser editor to edit an existing recloser in your model. Refer to the following procedure for more
information.

TO EDIT A RECLOSER
1

In the SynerGEE map display or model explorer, double-click the recloser that you want to edit.

On the left side of the Recloser editor, select from the different tab names to access the available
settings for the recloser. The following topics describe the different tasks that you can perform:

Editing general properties for a recloser on page 378

Editing the recloser setup on page 380

Editing primary and alternate settings for a recloser on page 381

Setting failure rates, location links, and the energize and retire years for a recloser on
page 381

Viewing analysis results for a recloser on page 382

Click Apply to accept your changes, and then click X to close the editor.

Editing general properties for a recloser

TO EDIT GENERAL PROPERTIES FOR A RECLOSER
1

In the SynerGEE map display or model explorer, double-click on the recloser that you want to edit.

In the Recloser editor, select the Recloser tab. The following table describes the different options
that you can set.
Name

User Guide

Recloser name or ID.

SynerGEE Electric 5.0

Modeling Devices

379

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Manufacturer, Model,
and Amp Rating

Recloser identification. These lists are populated based on

information in the protection database. For more information on the
protection database, see Protection data on page 67.

Add to TCC

Click this button to add the recloser to the TCC. For more information
on the TCC, see Time Versus Current Coordination (TCC) Graph on
page 604.

Protecting

Click to open the editor for the protecting device for the recloser.

Interrupt Rating

Interrupt rating for the recloser.

Dont allow operation

from analysis

Certain types of analyses, such as optimal switching, contingency,

and reliability, simulate the operation of switches and protective
devices to accomplish the analysis objective. Select this option to
exclude the recloser from being controlled in this way during these
analysis types. If selected, this restriction only applies to the current
recloser in the editor.

Bypass

Select this check box to ignore the operational capability of the

recloser during check coordination analysis, reliability analysis, and
other applications.

Status

Recloser open/closed state. For more information on switchable

protective devices, see Switchable protective devices on page 600.

Phasing

Recloser phasing.

Operation

Select from the following options:

Disable Ground. Select this check box to prevent the display

of ground curves in the TCC view and curve legend.
Selecting this option will also disable the Ground settings
on the Primary and Alternate tabs of the Recloser editor.

Single Phase Operation.

Mech. response time

Sets the mechanical response time for electronic reclosers. Defaults

to Unknown.

Operation Time

Sets the operation time for mechanical reclosers. This option allows
downstream devices to be coordinated with the control curve of the
upstream recloser. This curve is calculated from the published
response curve using the new operation time.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

380

Modeling Devices

Editing the recloser setup

TO EDIT THE RECLOSER SETUP
1

In the SynerGEE map display or model explorer, double-click on the recloser that you want to edit.

In the Recloser editor, select the Setup tab. The following table describes the different options that
you can set.
Settings

Transfer Scheme

Select an option to determine whether the recloser will use the

settings that you have configured on the Primary tab of the editor or
the Alternate tab of the editor, or whether the settings will be selected
automatically based on the feeder direction (for example, for a midpoint recloser). The available options are as follows:

Primary

Alternate

Auto (From -> To)

Auto (To -> From)

Safety / hot work

Select from one of the following options:

Non-Transfer

Sectionalizing

Mid-Point

Tie

If you select the Mid-Point or Tie transfer schemes, you also have the
option of specifying a Switching Group ID. This ID is used to identify
switches and reclosers that work together during an automatic feeder
switching (AFS) analysis. Once you specify an ID for one switch type
or recloser type, that ID will become an available selection for other
switch types and recloser types. Each switch type and recloser type
may only belong to one switching group at a time.
For more information on the automatic feeder switching (AFS)
analysis, see Automatic Feeder Switching (AFS) Analysis on
page 534.

User Guide

Color

Color of the phase curve if plotted on the TCC. For more information
on the TCC, see Time Versus Current Coordination (TCC) Graph on
page 604.

Safety/Hot Work

Specify the Safety Interrupt and Safety Pickup for both Phase and
Ground.

K Factors

Values to account for cumulative heating of fuse links associated with

coordination of reclosers and fuses.

SynerGEE Electric 5.0

Modeling Devices
3

381

Click Apply to accept your changes, and then click X to close the editor.

Editing primary and alternate settings for a recloser

Use the Primary tab and the Alternate tab to set up a group of primary and alternate phase and ground
settings for the recloser. Whether the primary or alternate settings are used is determined by your selection
for the Settings option on the Setup tab of the Recloser editor. For more information on the Settings option,
see Editing the recloser setup on page 380.
In addition, the Ground settings will be disabled if you have selected the Disable Ground check box on the
Recloser tab of the editor. For more information on this option, see Editing general properties for a recloser
on page 378.

TO EDIT PRIMARY AND ALTERNATE SETTINGS FOR A RECLOSER

1

In the SynerGEE map display or model explorer, double-click on the recloser that you want to edit.

In the Recloser editor, select either the Primary tab or the Alternate tab. The following table
describes the different options that you can set.

Curve

Specifies the curve type for phase or ground. See your manufacturer
documentation for more information.

Shot

Specifies the shot number for phase or ground. See your

manufacturer documentation for more information.

Electronic Recloser

Specifies electronic settings from the recloser controller. See your

manufacturer documentation for more information.

Click Apply to accept your changes, and then click X to close the editor.

Setting failure rates, location links, and the energize and retire
years for a recloser
The Rates tab in the Recloser editor specifies failure rate data for the recloser. You can specify a sustained
failure rate and temporary failure rate, as well as the failure repair time and cost. The Rates tab also contains
options to set a location link and an AMS link, and also to set the energize and retire years.
Refer to the following procedure for more information.

SynerGEE Electric 5.0

User Guide

382

Modeling Devices

TO SET FAILURE RATES, LOCATION LINKS, AND THE ENERGIZE AND RETIRE YEARS FOR A
RECLOSER

In the SynerGEE map display or model explorer, double-click on the recloser that you want to edit.

In the Recloser editor, select the Rates tab. The following table describes the different tasks that you
can perform.
To ...

Do This ...

Enter failure rate data

In the respective fields, enter values for the following parameters:

Sustained Failure Rate

Temporary Failure Rate

Failure Repair Time

Failure Repair Cost

Crew Oper./Reset

Generally, the numbers that you enter will represent averages and
estimates, because it is unlikely that you will have exact figures for
each individual device.

Set up a location link

Next to Location Link, type the correct syntax to link the device to an
external source, such as a file, website, or location in an Internet
mapping software application. SynerGEEs location link feature, as
well as the syntax required to set up location links, is described in
Location Links on page 223.

Set up an Asset
Management System
(AMS) link

Next to AMS Link, specify the link to your asset management

system.

Specify energize and

retire years for multiyear analyses

Under Year, select an appropriate year next to Energize and Retire.

For more information on multi-year modeling, see Multi-Year
Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a recloser

The Results tab in the Recloser editor provides analysis results for the recloser. The Results tab can be very
helpful if you are running multiple analyses and focusing on a particular device. Since the settings update
automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a recloser.

User Guide

SynerGEE Electric 5.0

Modeling Devices

383

TO VIEW ANALYSIS RESULTS FOR A RECLOSER

1

In the SynerGEE map display or model explorer, double-click on the recloser that you want to work
with.

In the Recloser editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

Deleting a recloser
Perform the following procedure to delete a recloser from your model.

TO DELETE A RECLOSER FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the recloser that you want to delete.

Right-click on the recloser and select Delete.

Click Yes to confirm the deletion.

Recloser mechanical response times

Mechanical response times can be added to the fast, slow, and accumulated response time. For the
accumulated response, the fast and slow control curves are determined first and then the mechanical delays
are added. Thus, the accumulated time has the delay added only once.

REGULATORS
Regulators are used to step-up or step-down the voltage at or downstream of the voltage regulator so that the
customer voltage levels are within limits. They are designed to raise or lower the voltage magnitude at and
beyond some remote location. Regulators are very common and useful devices within power distribution
systems.
To help you determine regulator settings, SynerGEE provides a special analysis tool called the regulator
setting tool. Use of the tool is optional. For more information on this tool, see Regulator Setting power tool
on page 745.
Refer to the topics listed below for more information on working with regulators in SynerGEE. More detailed
information on regulators is provided in the SynerGEE Technical Reference. The Technical Reference
includes a discussion of the basic regulator model and the more detailed model with shunt and series
impedance values. The Technical Reference also describes how regulator tap positions are analytically
changed and how voltage drop and losses are determined following the load-flow convergence.

Managing regulator types in the equipment warehouse on page 384

Managing regulators in the model on page 386

SynerGEE Electric 5.0

User Guide

384

Modeling Devices

Managing regulator types in the equipment warehouse

SynerGEE allows you to create a number of basic regulator configurations known as regulator types that
serve as a starting point for the regulators in your model. Regulator types are stored as equipment data in the
equipment warehouse. Equipment data allows you to associate common settings from a single regulator type
with multiple regulators in a model. In fact, you can associate a single regulator type with different regulators
in different models, as long as the same equipment data is opened with each model.
The regulator type defines a number of key options, such as whether the regulator is single-phase or threephase, and also the rated KVA and rated voltage of the regulator. Therefore, it is very important that you
properly configure the regulator types in your equipment data and then properly reference them from the
regulators in your model.
Like all equipment data, regulator types are used to add new regulators to your model. From the Warehouse
tab of the model explorer, simply find the regulator type that you want to add, drag it into the map display, and
drop it onto the desired section. Once a regulator has been created, you can change the associated regulator
type from the Regulator tab of the Regulator editor. You should be aware that some options in the Regulator
editor may enable and disable automatically based on the options you have selected in the referenced
regulator type.
The topics listed below provide more information on working with regulator types. For more information on
working with the equipment warehouse in general, see Equipment data on page 64.

Creating a regulator type on page 384

Editing a regulator type on page 384

Deleting a regulator type on page 386

Creating a regulator type

Perform the following procedure to create a new regulator type in your equipment warehouse.

TO CREATE A REGULATOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Regulator.

In the Enter Device ID dialog box, type a name for the new device type, and then click OK.

Use the Regulator Type editor to edit the settings for the regulator type. For more information on the
options you can set, see Editing a regulator type on page 384.

Editing a regulator type

To edit a regulator type, double-click the regulator type name in the Warehouse tab of the SynerGEE model
explorer. From the Regulator tab of the Regulator editor, you can also click the edit button that is located next
to the name of the selected regulator type.
Refer to the following procedure for more information.

User Guide

SynerGEE Electric 5.0

Modeling Devices

385

TO EDIT A REGULATOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Regulator Types and then double-click the name of the regulator type that you want to edit.

Use the Regulator Type editor to edit the following settings.

Rated KVA

Nameplate rating of the regulator in kVA. It is the product of the rated

load amps and the rated range of regulation. This product is
multiplied by three for three-phase regulators. For more information
on regulator kVA handling in SynerGEE, see the SynerGEE
Technical Reference.

Rated Voltage

If the regulator is a three-phase unit, this is the rated line-to-line

voltage of the regulator. Otherwise, this is the voltage rating of the
shunt winding for a single-phase regulator.

Z on Reg. Base

Regulator impedance based on its rated kVA and voltage. Zero is

acceptable.

X/R Ratio

Ratio of the series reactance to resistance of the regulator. Zero is

acceptable.

No-load losses

Losses that are used along with the regulators ratings to determine
the value of shunt conductance which simulate core loss. The loss is
for either a three-phase unit or a single-phase regulator depending on
the factory connection setting. Zero is acceptable.

Range

Range of regulation. This is a positive value and represents the

maximum buck or boost of the device. For example, you would use
10 for regulators having +/-10% regulation. Standard regulators have
a regulation range of +/- 10% divided into 32 (5/8%) or 16 (11/4%)
steps. Zero is acceptable.

Total # Steps

Total number of steps for a regulator. For example, a value of 32 is

used for a +/- 10% regulator with a 5/8% step size since the regulator
has 16 buck and 16 boost steps.

Factory Unit

Regulator phase capacity.

Connection

Regulator connection type for three-phase units. For single-phase

units, the connection type is specified at the regulator instance using
the Regulator editor, as described in Editing general data for a
regulator on page 387.

Type A or Type B

Regulator type. Detailed information on the differences between Type

A and Type B regulators are provided in the SynerGEE Technical
Reference.

SynerGEE Electric 5.0

User Guide

386

Modeling Devices

Summer Rating
(Amps) and Winter
Rating (Amps)

Continuous and emergency values can be set for typical summer and
winter conditions and then used in the model with the Weather
feature, which models based on seasonal changes, as described in
Configuring Seasonal Weather Modeling on page 831. SynerGEE
uses the summer ratings as the default values.

Continuous. The Continuous value is used in analyses to

calculate the percent loading and for displaying regulator
overload exceptions.

Emergency. The Emergency value is used in balanced and

by-phase analyses and capacitor placement to flag
overloaded sections and to display regulator overload
exceptions.

PT Ratio

PT Ratio of the device. The regulator output voltage is reflected

through the turns ratio of the PT to supply a voltage signal on a 120V
base to the regulator controller.

CT Rating

CT Rating of the device. The regulator output current is reflected

through the CT to supply a current on a 0.2A base to the line-drop
compensator portion of the regulator controller.

Click Apply to accept your changes, and then click X to close the editor.

Deleting a regulator type

Perform the following procedure to delete a regulator type from your equipment warehouse.

TO DELETE A REGULATOR TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Regulator Types and then select the name of the regulator type that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Managing regulators in the model

Refer to the topics listed below for information on adding, editing, and deleting regulators in your model.

Adding a regulator on page 387

Editing a regulator on page 387

Deleting a regulator on page 393

User Guide

SynerGEE Electric 5.0

Modeling Devices

387

Adding a regulator
Regulators are added to a model in the same manner as any other equipment, by dragging a regulator type
from the Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE map
display. Refer to the following procedure for more information. Additional information on working with
warehouse equipment types is provided in Modeling Devices on page 317.

TO ADD A REGULATOR TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Regulator Types and then select the regulator type that you want to add to your model.
Drag it onto the map display and drop it onto the desired section.

Editing a regulator
Use the Regulator editor to edit an existing regulator in your model. Refer to the following procedure for more
information.

TO EDIT A REGULATOR
1

In the SynerGEE map display or model explorer, double-click the regulator that you want to edit.

On the left side of the Regulator editor, select from the different tab names to access the available
settings for the regulator. The following topics describe the different tasks that you can perform:

Editing general data for a regulator on page 387

Editing line-drop compensation data for a regulator on page 388

Editing reverse mode, first-house, and tap limiter data for a regulator on page 390

Setting failure rates, location links, and the energize and retire years for a regulator on
page 392

Viewing analysis results for a regulator on page 392

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a regulator

TO EDIT GENERAL DATA FOR A REGULATOR
1

In the SynerGEE map display or model explorer, double-click on the regulator that you want to edit.

In the Regulator editor, select the Regulator tab. The following table describes the different options
that you can set.
Name

SynerGEE Electric 5.0

Regulator name or ID.

User Guide

388

Modeling Devices

Turn Off

Select this check box to disable the regulators effect on the model. If
the regulator is disabled, you can still edit the available settings but it
will not have any impact on the model or any analysis.
You can also disable regulators directly from the model explorer or
SynerGEE map display. Right-click on the regulator or regulator name
and select Turn On or Turn Off, as appropriate. When you perform
this action, the Turn Off check box will be selected or cleared to
reflect the current status.

Type

Reference to a regulator type in your equipment warehouse. If the

referenced regulator type does not exist in the currently loaded
equipment warehouse, then the regulator type will be displayed as
Unknown. If an analysis fails because of a missing equipment type,
the resulting report will specifically indicate the offending device(s).
The regulator type association will be restored once a matching
equipment warehouse is opened.
For more information on regulator types, see Managing regulator
types in the equipment warehouse on page 384.

Connection

Regulator connection for single-phase units. For three-phase units,

the connection type is defined in the equipment warehouse using the
Regulator Type editor, as described in Editing a regulator type on
page 384.

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Phasing

Regulator phasing.

Tap Positions

Tap position for each phase of the regulator bank or unit. Values can
be positive, negative, or zero. The numerical absolute value of the tap
position cannot be greater than half the number of taps specified in
the regulators table record.

Tap Operation

Tap operation mode.

Direction - (Taps
are ...)

Location of the regulator taps, either near the section source or load
end (or from-node or to-node in network models).

Click Apply to accept your changes, and then click X to close the editor.

Editing line-drop compensation data for a regulator

Use the LDC tab of the Regulator editor to specify line-drop compensation settings. To apply LDC settings,
you must first select the Automatic Operation option in the Regulator tab, as described in Editing general
data for a regulator on page 387. The specific forward and reverse settings that are available for edit are
based on you selections for the Reverse Mode option and the Gang Metering Phase option, as described in
Editing reverse mode, first-house, and tap limiter data for a regulator on page 390.

User Guide

SynerGEE Electric 5.0

Modeling Devices

389

Refer to the following procedure for more information on editing LDC settings for a regulator. Additional
information on line-drop compensation is provided in the SynerGEE Technical Reference.

TO EDIT LDC DATA FOR A REGULATOR

1

In the SynerGEE map display or model explorer, double-click on the regulator that you want to edit.

In the Regulator editor, select the LDC tab.

Under Forward Set Point and LDC Settings and under Reverse Set Point and LDC Settings,
specify the following values. The specific forward and reverse settings that are available for edit are
based on you selections for the Reverse Mode option and the Gang Metering Phase option, as
described in Editing reverse mode, first-house, and tap limiter data for a regulator on page 390.
-

Voltage. Specifies the voltage set point.

R Dial. Specifies the line-drop compensation R setting in volts.

X Dial. Specifies the line-drop compensation X setting in volts.

B.W. Dial. Specifies the bandwidth of the voltage set point. For example, if you have set
the voltage set point to 124 and a bandwidth of 2, then voltage range will be from 123 to
125.

The voltage base (100V or 120V) for the forward and reverse set points and LDC settings is set as
the PT Secondary option on the Units tab of the Preferences editor. For more information, see
Setting units of measurement on page 165.
4

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

390

Modeling Devices

Editing reverse mode, first-house, and tap limiter data for a regulator
TO EDIT REVERSE MODE, FIRST-HOUSE, AND TAP LIMITER DATA
1

In the SynerGEE map display or model explorer, double-click on the regulator that you want to edit.

In the Regulator editor, select the Settings tab. The following table describes the different options
that you can set.
Reverse Mode

Mode that governs the behavior of the regulator while experiencing

reverse power flow. The following choices are available:

No Reverse Mode. Regulator responds to voltage at

terminals with no regard for power flow direction.

Locked Forward. Regulator operates normally when power

flow direction is forward. Any reverse power flow causes
regulator to lock at last tap.

Locked Reverse. Regulator operates in reverse when

power flow direction is reverse. Any forward power flow
causes regulator to lock at last tap.

Reverse Idle. This mode is the same as the Locked

Forward mode, except that reverse power flow has no effect
when regulator current is below the Threshold Percent. This
mode allows small (typically 2 to 5%) reverse flow current.

Bi-Directional. Forward or reverse power flow through the

regulator with a current magnitude less than the Threshold
Percent locks the regulator. Otherwise, forward power flow
puts the regulator into forward operation and reverse power
flow puts the regulator into reverse operation.

Neutral Idle. Forward or reverse power flow through the

regulator with a current magnitude less than the Threshold
Percent locks the regulator. Forward current above the
threshold allows the regulator to operate normally. Reverse
current above the threshold causes the regulator to park
(move to neutral).

Co-Generational. Forward or reverse power flow through

the regulator with a current magnitude less than the
Threshold Percent locks the regulator. Otherwise, the
regulator operates normally except that reverse LDC values
are used with reverse power flow.

For more information, see the SynerGEE Technical Reference.

Threshold Percent

User Guide

Bandwidth beyond which the reverse flow controller activates.

SynerGEE Electric 5.0

Modeling Devices

First House

Tap Limits (Tap)

391

Select the Active check box to enable First House protection for the
regulator. Once enabled, you can edit the following settings:

High. Upper voltage limit (120V based) at the regulator

output terminal with First House protection turned on.

Low. Low voltage limit (120V based) at the regulator output

terminal with First House protection turned on.

Select the Active check box to enable tap movement limits for the
regulator. Once enabled, you can edit the following settings:

High. Upper limit of tap movement during regulation. The

value can be positive, negative, or zero. The numerical
absolute value of the tap position cannot be greater than half
the number of tap positions specified in the Regulator tab.

Low. Lower limit of tap movement during regulation. The

value can be positive, negative, or zero. The numerical
absolute value of the tap position cannot be greater than half
the number of tap positions specified in the Regulator tab.

By default, when you enter a High value, SynerGEE will automatically

add a symmetrical Low value. If you want to enter non-symmetrical
values, enter the Low value first, click Apply, and then enter the High
value.
Gang Metering Phase

Configures gang operation. When a regulator is set for gang

operation, all units move to the same tap. The metering phase
indicates the regulator unit that meters voltage and current flow. The
regulator on the metering phase raises or lowers its tap in response to
its metered conditions. Taps on the other regulator units move to
match the tap of the regulator on the metered phase.

Nominal Voltage
Multiplier

Specifies a forward-direction multiplier that will be applied to the

nominal voltage. If the regulator is back-fed, then the multiplier
inverse will be used.

Time delay

This value is used when the regulator control is out of bandwidth.

When this occurs, the regulator will wait for the specified number of
seconds before operating.
If the regulator moves into bandwidth, then the time delay is reset.

Tap change delay

Specifies a pause issued between tap changes while the regulator

remains out of bandwidth.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

392

Modeling Devices

Setting failure rates, location links, and the energize and retire years
for a regulator
Use the Rates tab in the Regulator editor to specify failure rate data for the regulator. You can specify a
sustained failure rate and temporary failure rate, as well as the failure repair time and cost. The Rates tab
also contains options to set a location link and an AMS link, and also to set the energize and retire years.
Refer to the following procedure for more information.

TO SET FAILURE RATES, LOCATION LINKS, AND THE ENERGIZE AND RETIRE YEARS FOR A
REGULATOR

In the SynerGEE map display or model explorer, double-click on the regulator that you want to edit.

In the Regulator editor, select the Rates tab. The following table describes the different tasks that
you can perform.
To ...

Do This ...

Enter failure rate data

In the respective fields, enter values for the following parameters:

Sustained Failure Rate

Temporary Failure Rate

Failure Repair Time

Failure Repair Cost

Generally, the numbers that you enter will represent averages and
estimates, because it is unlikely that you will have exact figures for
each individual device.

Set up a location link

Next to Location Link, type the correct syntax to link the device to an
external source, such as a file, website, or location in an Internet
mapping software application. SynerGEEs location link feature, as
well as the syntax required to set up location links, is described in
Location Links on page 223.

Set up an Asset
Management System
(AMS) link

Next to AMS Link, specify the link to your asset management

system.

Specify energize and

retire years for multiyear analyses

Under Year, select an appropriate year next to Energize and Retire.

For more information on multi-year modeling, see Multi-Year
Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a regulator

The Results tab in the Regulator editor provides analysis results for the regulator. The Results tab can be
very helpful if you are running multiple analyses and focusing on a particular device. Since the settings
update automatically with each analysis, you can run an analysis and watch the results change in real time.

User Guide

SynerGEE Electric 5.0

Modeling Devices

393

Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a regulator.

TO VIEW ANALYSIS RESULTS FOR A REGULATOR

1

In the SynerGEE map display or model explorer, double-click on the regulator that you want to work
with.

In the Regulator editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

Deleting a regulator
Perform the following procedure to delete a regulator from your model.

TO DELETE A REGULATOR FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the regulator that you want to delete.

Right-click on the regulator and select Delete.

Click Yes to confirm the deletion.

SECTIONALIZERS
A sectionalizer is specified through an actuating current and a count number, mimicking the operation of a
real device. Typically, the sectionalizer should have at least one recloser upstream (SynerGEE does not yet
support reclosing relays). Also, the minimum fault current through the sectionalizer should exceed the
actuating current. The amp rating of a sectionalizer is used to calculate a value for percent loading and to
find overload exceptions.
Sectionalizers have no curves in the protection database. As such, coordination analysis checks their
settings against reclosers paired to the sectionalizer.

Adding a sectionalizer
Sectionalizers are added to a model in the same manner as any other equipment, by dragging a sectionalizer
type from the Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE
map display. Refer to the following procedure for more information. Additional information on working with
warehouse equipment types is provided in Modeling Devices on page 317.

SynerGEE Electric 5.0

User Guide

394

Modeling Devices

TO ADD A SECTIONALIZER TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Sectionalizer Types and then select the sectionalizer type that you want to add to your
model. Drag it onto the map display and drop it onto the desired section.

Editing a sectionalizer
Use the Sectionalizer editor to edit an existing sectionalizer in your model. Refer to the following procedure
for more information.

TO EDIT A SECTIONALIZER
1

In the SynerGEE map display or model explorer, double-click the sectionalizer that you want to edit.

On the left side of the Sectionalizer editor, select from the different tab names to access the
available settings for the sectionalizer. The following topics describe the different tasks that you can
perform:

Editing general data for a sectionalizer on page 394

Setting failure rates, location links, and the energize and retire years for a sectionalizer on
page 395

Viewing analysis results for a sectionalizer on page 396

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a sectionalizer

TO EDIT GENERAL DATA FOR A SECTIONALIZER
1

In the SynerGEE map display or model explorer, double-click on the sectionalizer that you want to
edit.

In the Sectionalizer editor, select the Sectionalizer tab. The following table describes the different
options that you can set.

User Guide

Name

Sectionalizer name or ID.

Model

Sectionalizer model (or mode). The following options are available:

Sectionalizer mode uses an actuating current and a count

number, which is used in check coordination analysis. The
sectionalizer curves are drawn as straight lines at the
actuating current.

Fault indicator mode uses a trip value and a trip response

time. The device is displayed on a TCC graph as a vertical
line at the trip value and a horizontal line at the trip response
time.

SynerGEE Electric 5.0

Modeling Devices

395

Actuating Current/
Number Counts

Sectionalizer actuating criteria.

Amp Rating

Maximum amp rating.

Phasing

Sectionalizer phasing.

Status

Sectionalizer open/closed state. For more information on switchable

protective devices, see Switchable protective devices on page 600.

Add to TCC

Adds the sectionalizer to the TCC. For more information on the TCC,
see Time Versus Current Coordination (TCC) Graph on page 604.

TCC color

Color of the sectionalizer curve if plotted on the TCC. For more

information on the TCC, see Time Versus Current Coordination
(TCC) Graph on page 604.

Protecting

Click to open the editor for the protecting device for the sectionalizer.

Dont allow operation

from analysis

Certain types of analyses, such as optimal switching, contingency,

and reliability, simulate the operation of switches and protective
devices to accomplish the analysis objective. Select this option to
exclude the sectionalizer from being controlled in this way during
these analysis types. If selected, this restriction only applies to the
current sectionalizer in the editor.

Bypass

Select this check box to ignore the operational capability of the

sectionalizer during check coordination analysis, reliability analysis,
and other applications.

Click Apply to accept your changes, and then click X to close the editor.

Setting failure rates, location links, and the energize and retire
years for a sectionalizer
The Rates tab in the Sectionalizer editor specifies failure rate data for the sectionalizer. You can specify a
sustained failure rate and temporary failure rate, as well as the failure repair time and cost. The Rates tab
also contains options to set a location link and an AMS link, and also to set the energize and retire years.
Refer to the following procedure for more information.

SynerGEE Electric 5.0

User Guide

396

Modeling Devices

TO SET FAILURE RATES, LOCATION LINKS, AND THE ENERGIZE AND RETIRE YEARS FOR A
SECTIONALIZER

In the SynerGEE map display or model explorer, double-click on the sectionalizer that you want to
edit.

In the Sectionalizer editor, select the Rates tab. The following table describes the different tasks that
you can perform.
To...

Do This...

Enter failure rate data

In the respective fields, enter values for the following parameters:

Sustained Failure Rate

Temporary Failure Rate

Failure Repair Time

Failure Repair Cost

Crew Oper./Reset

Generally, the numbers that you enter will represent averages and
estimates, because it is unlikely that you will have exact figures for
each individual device.

Set up a location link

Next to Location Link, type the correct syntax to link the device to an
external source, such as a file, website, or location in an Internet
mapping software application. SynerGEEs location link feature, as
well as the syntax required to set up location links, is described in
Location Links on page 223.

Set up an Asset
Management System
(AMS) link

Next to AMS Link, specify the link to your asset management

system.

Specify energize and

retire years for multiyear analyses

Under Year, select an appropriate year next to Energize and Retire.

For more information on multi-year modeling, see Multi-Year
Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a sectionalizer

The Results tab in the Sectionalizer editor provides analysis results for the sectionalizer. The Results tab can
be very helpful if you are running multiple analyses and focusing on a particular device. Since the settings
update automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.

User Guide

SynerGEE Electric 5.0

Modeling Devices

397

Refer to the following procedure for more information on viewing analysis results for a sectionalizer.

TO VIEW ANALYSIS RESULTS FOR A SECTIONALIZER

1

In the SynerGEE map display or model explorer, double-click on the sectionalizer that you want to
work with.

In the Sectionalizer editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

Deleting a sectionalizer
Perform the following procedure to delete a sectionalizer from your model.

TO DELETE A SECTIONALIZER FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the sectionalizer that you want to delete.

Right-click on the sectionalizer and select Delete.

Click Yes to confirm the deletion.

SWITCHES
SynerGEE allows you to model switches within your feeder models. These switches can be used to
reconfigure your feeder connectivity.
The following rules apply when you are modeling switches in SynerGEE:

Switches are located on line sections. There can be only one switch per section.

Switches are always located closest to the node, before any other loads or equipment. They can be
located at either the source end or the load end of the section.

With the exception of network models, a switch cannot be closed to form a loop. You must use a tie
switch, which is an open switch with tie calculation capability.

Switches only connect those phases that are present on both sides of the switch. This is the case for
balanced and by-phase looped analyses.

During balanced or by-phase analysis, the current through a switch is compared with the amp rating
listed in the equipment data for that switch. If the current is too high, an exception will be indicated in
the Results tab in the Section editor. For more information on the Results tab, see Viewing results
in the SynerGEE editor on page 156.

In SynerGEE, network topology is governed solely with nodes and sections. Topology as well as the position
and status of switches govern connectivity, or electrical flow.

SynerGEE Electric 5.0

User Guide

398

Modeling Devices
Protective devices are also switchable. For more information on switching protective devices, see
Switchable protective devices on page 600.
Current (in amps) through switches is displayed on reports, along with the name of the switch type. Sections
with switches have a special area in the Results tab in the Section editor that displays either the balanced or
by-phase current flow. The color of the switch numbers in the listing may reflect an overloaded switch. For
more information on the Results tab, see Viewing results in the SynerGEE editor on page 156.
Refer to the topics listed below for more information on working with switches in SynerGEE.

Switch configuration and connectivity on page 398

Special switch types and functions on page 400

Managing switch types in the equipment warehouse on page 400

Managing switches in the model on page 402

Modeling auto-transfer switches on page 407

Pad-mounted gear and elbows on page 408

Switch plans on page 411

Contingency and optimal switching analysis on page 415

Switch configuration and connectivity

SynerGEE allows one switch to be placed on every section, either at the inward end or the outward end.
Complex switch gears can be effectively modeled by placing and operating these switches. The examples
that follow show different switch configurations and how they affect connectivity.

Switch connectivity example 1

In example 1, the open switch is located on the outward end of Section 1. All of the devices and load on
Section 1 are fed, but the open switch leaves Sections 2 and 3 as unfed islands. Sections 2 and 3 may be fed
if another feed path can be established to those sections or to the node at the outward end of Section 1.
Section 2

Section 1
Section 3
Example 1 Open switch on outward end of section

Switch connectivity example 2

In example 2, the switch is on the inward end of Section 1. Because the switch is open, no loads or devices
on Sections 1, 2, or 3 will be included in the analysis. All sections are completely unfed.

User Guide

SynerGEE Electric 5.0

Modeling Devices

399

Section 2
Section 1

Section 3
Example 2 Open switch on inward end of a section

Sections 1, 2, and 3 would all be fed if the outward end of Section 3 or Section 2 were connected to a fed
section. This is shown below as Section 4.
Section 2
Section 1

Section 3
Section 4

Example 2 Connecting a new feed path

In this case, all sections are fed. However, device feed directions and the load-flow reference directions on
Sections 1 and Section 3 are reversed. Other than voltage level changes, devices on Section 2 would see no
change in the modified feed direction.

Switch connectivity example 3

In example 3, the switch on Section 3 isolates the section while allowing Section 1 to feed Section 2. No
devices on Section 3 receive power.
Section 2

Section 1
Section 3
Example 3 Inward switch isolating a branch

Switch connectivity example 4

In example 4, the switch at the end of Section 2 has no effect on the model. The switch opens the section at
its outward end, but there are no loads or devices past that point. All loads and devices on Sections 1, 2, and
3 receive power.
Section 2
F

Section 1
Section 3
Example 4 Inward switch isolating an outward end

SynerGEE Electric 5.0

User Guide

400

Modeling Devices

Special switch types and functions

Switches can perform several different functions in a SynerGEE model. All switches are initially added as
manual (basic) switches. Once in the model, you can change a switch to any of the following types:

Basic switch. The basic switch is the normal switch. Opening the switch creates an island, and
closing the switch restores connectivity and typically picks up load.

Loop tie switch. The loop tie switch can be used to model loops in a radial network. It resides on the
model as an open switch, but SynerGEE considers it closed during analysis. Loop tie switches are
optional and SynerGEE can consider loops without them. For more information, see Loops and
Wandering Laterals on page 253.

Wandering lateral tie switch. The wandering lateral tie switch can be used to reconnect branching
single-phase lines back to a three-phase trunk, serving three-phase loads downstream. It resides on
the model as an open switch, but SynerGEE considers it closed during analysis. Wandering lateral
tie switches are optional and SynerGEE can consider wandering laterals without them. For more
information, see Loops and Wandering Laterals on page 253.

Automatic switch. The automatic switch simulates real devices that automatically close to pick up
load in the event of an outage or a drop in voltage. You can set your contingency analysis options to
Prefer Auto Switches, in which case automatic switches are operated first, regardless of the
switching objective. Also, automatic switches may have a reduced operation time in reliability
analysis. For more information on contingency analysis options, see Setting up a contingency
analysis on page 537. For more information on reliability analysis options, see Setting up a
Reliability Analysis on page 662.

Auto-transfer switch. Auto-transfer switches simulate real devices that automatically transfer a
critical load to an alternate feed path in the event of an outage. In SynerGEE, these switches are
modeled as a pair of regular switches located on either side of the node that serves a critical load.
Both switches are set as Auto-Transfer switches in the Switch editor. For more information on
modeling an auto-transfer switch pair, see Modeling auto-transfer switches on page 407.

Pad-mounted switch gear and elbows. SynerGEE supports the modeling of elbows and padmounted switch gear. For more information on these items, see Pad-mounted gear and elbows on
page 408.

Managing switch types in the equipment warehouse

SynerGEE allows you to create a number of basic switch configurations known as switch types that serve
as a starting point for the switches in your model. Switch types are stored as equipment data in the
equipment warehouse. Equipment data allows you to associate common settings from a single switch type
with multiple switches in a model. In fact, you can associate a single switch type with different switches in
different models, as long as the same equipment data is opened with each model.
The switch type defines a number of key options, including the current ratings and voltage rating. Therefore,
it is very important that you properly configure the switch types in your equipment data and then properly
reference them from the switches in your model.
Like all equipment data, switch types are used to add new switches to your model. From the Warehouse tab
of the model explorer, simply find the switch type that you want to add, drag it into the map display, and drop
it onto the desired section. Once a switch has been created, you can change the associated switch type from

User Guide

SynerGEE Electric 5.0

Modeling Devices

401

the Switch tab in the Switch editor. You should be aware that some options in the Switch editor may enable
and disable automatically based on the options you have selected in the referenced switch type.
The topics listed below provide more information on working with switch types. For more information on
working with the equipment warehouse in general, see Equipment data on page 64.

Creating a switch type on page 401

Editing a switch type on page 401

Deleting a switch type on page 402

Creating a switch type

Perform the following procedure to create a new switch type in your equipment warehouse.

TO CREATE A SWITCH TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Switch.

In the Enter Device ID dialog box, type a name for the new device type and then click OK.

Use the Switch Type editor to edit the settings for the switch type. For more information on the
options you can set, see Editing a switch type on page 401.

Editing a switch type

To edit a switch type, double-click the switch type name in the Warehouse tab of the SynerGEE model
explorer. From the Switch tab in the Switch editor, you can also click the edit button that is located next to the
name of the selected switch type.
Refer to the following procedure for more information.

TO EDIT A SWITCH TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Switch Types and then double-click the name of the switch type that you want to edit.

Use the Switch Type editor to edit the following settings.

Continuous Current
Rating

Continuous current rating. This value is used in analyses to calculate

the percent loading and for displaying switch overload exceptions.

Emergency Current
Rating

Emergency current rating. This value is used in balanced and byphase analysis and capacitor placement to flag overloaded sections
and to display switch overload exceptions.

Voltage Rating

Switch voltage rating.

Operation

Select the appropriate check box to set up the switch type as a gangoperated or load break switch. Note that these two fields are not
currently used by any SynerGEE analysis.

SynerGEE Electric 5.0

User Guide

402

Modeling Devices
4

Click Apply to accept your changes, and then click X to close the editor.

Deleting a switch type

Perform the following procedure to delete a switch type from your equipment warehouse.

TO DELETE A SWITCH TYPE FROM THE EQUIPMENT DATA SOURCE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Switch Types and then select the name of the switch type that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Managing switches in the model

Refer to the topics listed below for information on adding, editing, and deleting switches in your model.

Adding a switch on page 402

Editing a switch on page 402

Deleting a switch on page 407

Adding a switch
Switches are added to a model in the same manner as any other equipment, by dragging a switch type from
the Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE map
display. For more information, see Modeling Devices on page 317.

TO ADD A SWITCH TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Switch Types and then select the switch type that you want to add to your model. Drag it
onto the map display and drop it onto the desired section and in the desired location in relation to the
sections nodes.

Editing a switch
Use the Switch editor to edit an existing switch in your model. Refer to the following procedure for more
information.

TO EDIT A SWITCH
1

In the SynerGEE map display or model explorer, double-click the switch that you want to edit.

On the left side of the Switch editor, select from the different tab names to access the available
settings for the switch. The following topics describe the different tasks that you can perform:
-

User Guide

Editing general data for a switch on page 403

SynerGEE Electric 5.0

Modeling Devices

403

Setting failure rates, location links, and the energize and retire years for a switch on
page 406

Viewing analysis results for a switch on page 407

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a switch

The Switch tab in the Switch editor controls several key options for the switch. You can use the options in the
Switch tab to manually set the switch status as Open or Closed, and to set the switch type as Manual,
Automatic, or Auto-Transfer. You can also specify whether the switch is a Loop Tie switch or a Wandering
Lateral Tie, and you can select which switch type from your equipment warehouse is associated with the
switch.
Refer to the following procedure for more information.

TO EDIT GENERAL DATA FOR A SWITCH

1

In the SynerGEE map display or model explorer, double-click on the switch that you want to edit.

In the Switch editor, select the Switch tab. The following table describes the different options that
you can set.
Name

Switch name or ID.

Type

Reference to a switch type in your equipment warehouse. If the

referenced switch type does not exist in the currently loaded
equipment warehouse, then the switch type will be displayed as
Unknown. If an analysis fails because of a missing equipment type,
the resulting report will specifically indicate the offending device(s).
The switch type association will be restored once a matching
equipment warehouse is opened.
For more information on switch types, see Managing switch types in
the equipment warehouse on page 400.

Note

SynerGEE Electric 5.0

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

User Guide

404

Modeling Devices

Status

Specifies the Open or Closed status of the switch. If Open, you can
also specify whether the switch is a Loop Tie switch or Wandering
Lateral Tie.

Loop tie switch. A loop tie switch can be used to model

loops in a radial network. It resides on the model as an open
switch, but SynerGEE considers it closed during analysis.

Wandering lateral tie switch. A wandering lateral tie switch

can be used to reconnect branching single-phase lines back
to a three-phase trunk, serving three-phase loads
downstream. It resides on the model as an open switch, but
SynerGEE considers it closed during analysis.

For more information, see Loops and Wandering Laterals on

page 253.

User Guide

SynerGEE Electric 5.0

Modeling Devices

Switching Model

405

Specifies whether the switch is operated manually, automatically, or

as an automatic transfer.

Manual. Manual switch refers to the normal switch

operation where you manually open and close the switch
using the Switch editor. Opening a switch creates an island,
and closing a switch restores connectivity and typically picks
up load.

Automatic. An automatic switch simulates a real device that

automatically closes to pick up load in the event of an
outage or a drop in voltage. If you select the Prefer Auto
Switches option in the Contingency Analysis Options editor,
automatic switches will be operated first during a
contingency analysis, regardless of the switching objective.
Also, during a reliability analysis, automatic switches may
have a reduced operation time.
If you select the Automatic switching model, you also have
the option of specifying a Switching Group ID. This ID is
used to identify switches and reclosers that work together
during an automatic feeder switching (AFS) analysis. Once
you specify an ID for one switch type or recloser type, that ID
will become an available selection for other switch types and
recloser types. Each switch type and recloser type may only
belong to one switching group at a time.
For more information on the automatic feeder switching
(AFS) analysis, see Automatic Feeder Switching (AFS)
Analysis on page 534.

Dont allow operation

from analysis

Auto-transfer. An auto-transfer switch simulates a real

device that automatically transfers a critical load to an
alternate feed path in the event of an outage. In SynerGEE,
these switches are modeled as a pair of regular switches,
marked as Auto-Transfer, and located on either side of the
node that serves a critical load. For more information on
setting up auto-transfer switches, see Modeling autotransfer switches on page 407.

Certain types of analyses, such as optimal switching, contingency,

and reliability, simulate the operation of switches and protective
devices to accomplish the analysis objective. Select this option to
exclude the switch from being controlled in this way during these
analysis types.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

406

Modeling Devices

Setting failure rates, location links, and the energize and retire years
for a switch
The Rates tab in the Switch editor specifies failure rate data for the switch. You can specify a sustained
failure rate and temporary failure rate, as well as the failure repair time and cost. The Rates tab also contains
options to set a location link and an AMS link, and also to set the energize and retire years.
Refer to the following procedure for more information.

TO SET FAILURE RATES, LOCATION LINKS, AND THE ENERGIZE AND RETIRE YEARS FOR A
SWITCH

In the SynerGEE map display or model explorer, double-click on the switch that you want to edit.

In the Switch editor, select the Rates tab. The following table describes the different tasks that you
can perform.
To ...

Do This ...

Enter failure rate data

In the respective fields, enter values for the following parameters:

Sustained Failure Rate

Temporary Failure Rate

Failure Repair Time

Failure Repair Cost

Crew Oper./Reset

Generally, the numbers that you enter will represent averages and
estimates, because it is unlikely that you will have exact figures for
each individual device.

User Guide

Set up a location link

Next to Location Link, type the correct syntax to link the device to an
external source, such as a file, website, or location in an Internet
mapping software application. SynerGEEs location link feature, as
well as the syntax required to set up location links, is described in
Location Links on page 223.

Set up an Asset
Management System
(AMS) link

Next to AMS Link, specify the link to your asset management

system.

Specify energize and

retire years for multiyear analyses

Under Year, select an appropriate year next to Energize and Retire.

For more information on multi-year modeling, see Multi-Year
Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Modeling Devices

407

Viewing analysis results for a switch

The Results tab in the Switch editor provides analysis results for the switch. The Results tab can be very
helpful if you are running multiple analyses and focusing on a particular device. Since the settings update
automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a switch.

TO VIEW ANALYSIS RESULTS FOR A SWITCH

1

In the SynerGEE map display or model explorer, double-click on the switch that you want to work
with.

In the Switch editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

Deleting a switch
Perform the following procedure to delete a switch from your model.

TO DELETE A SWITCH FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the switch that you want to delete.

Right-click on the switch and select Delete.

Click Yes to confirm the deletion.

Modeling auto-transfer switches

Auto-transfer switches simulate real devices that automatically transfer a critical load to an alternate feed
path in the event of an outage. In SynerGEE, these switches are modeled as a pair of regular switches,
marked as Auto-Transfer, and located on either side of the node that serves a critical load. The Auto-Transfer
status is an option you can set in the Switch tab of the Switch editor, as described in Editing general data for
a switch on page 403.
To create a valid auto-transfer switch pair, one switch must be open and the other switch must closed, such
that the node only receives power from one source (the load can be placed on a third section connected to
that node). Once modeled, you can toggle the switches as a pair to alternate the feed source. Contingency
analysis operates the switches together, and reliability analysis may use the switches to reduce a sustained
interruption to a momentary one for load served by the auto-transfer switch pair.

SynerGEE Electric 5.0

User Guide

408

Modeling Devices

Auto-transfer switch pair

To be valid, both auto-transfer switches must be placed on fed sections. In addition, they cannot be
separated by a feeder source.

TO TOGGLE AN AUTO-TRANSFER SWITCH PAIR

Right-click on a valid auto-transfer switch pair and select Toggle ATS.

Pad-mounted gear and elbows

SynerGEE supports the modeling of elbows and pad-mounted switch gear. The switching of these devices is
manual only, and they are not considered by any analysis type.
Refer to the topics listed below for more information.

Elbows on page 408

Pad-mounted switch gear on page 408

Elbows
Elbows are modeled through the Section editor. There is not a specific equipment type for elbows in your
model, nor is there an elbow symbol that appears on the map. An elbow remains assigned to a particular
section due to the fact that it is created as a part of the section.
Topologically in SynerGEE, elbows act just like switches. They are considered to be modeled at the end of a
section. When opened, they isolate the parent section from all downstream sections. In a radial model, all
loop creation rules that apply to switches also apply to elbows.

TO MODEL AN ELBOW
1

In the SynerGEE map display or model explorer, double-click the section that you want to edit.

In the Section editor, select the Properties tab.

Under Elbows/Switchgear, select an elbow status for both the to-node end and the from-node end
of the section. Available status options are No Elbow, Open, and Closed.

Click Apply to accept your changes, and then click X to close the editor.

Pad-mounted switch gear

Pad-mounted switch gear is switching equipment that controls a junction of multiple line sections. In
SynerGEE, you model this type of equipment by converting a node to pad-mounted gear. Once converted,

User Guide

SynerGEE Electric 5.0

Modeling Devices

409

each adjoining section is assigned a bay that can be independently opened or closed. In a radial model, all
loop creation rules that apply to switches also apply to pad-mounted gear.
At the data level, SynerGEE sees pad-mounted gear as a collection of elbows. Consider the following
example, where a node has been converted to a pad-mounted switch gear:

Sample pad-mounted gear

From a data perspective, SynerGEE sees the following:

Pad-mounted gear from a data perspective

When you open and close bays within the switch gear editor, you are actually opening and closing elbows on
the respective sections. If you open the bay to a particular section in the PM Gear editor, you can open the
Section editor for that section and see that the appropriate elbow has been marked as Open. Likewise, if you
change an elbow setting within a Section editor, an identical change will be reflected in any attached padmounted gear.
Refer to the topics listed below for more information on creating and editing pad-mounted switch gear.

Converting a node to pad-mounted switch gear on page 409

Editing pad-mounted switch gear on page 410

Converting a node to pad-mounted switch gear

TO CONVERT A NODE TO PAD-MOUNTED SWITCH GEAR
1

In the SynerGEE map display, locate the node you would like to convert to pad-mounted switch
gear.

Right-click on the node and select Convert to Pad Mount Gear.

or
Perform the following steps to convert the node from the SynerGEE ribbon bar:

SynerGEE Electric 5.0

User Guide

410

Modeling Devices
a

In the SynerGEE ribbon bar, select the BUILD tab.

In the Source group, click PM Gear.

Hover the mouse over the node that you want to convert. If the node is eligible to be
converted, the cursor symbol will change from a crosshair to a target symbol. Click the
mouse to complete the action.

Editing pad-mounted switch gear

In the PM Gear editor, you can open and/or close individual switch gear bays, as well as assign an amperage
limit for each individual bay. Since the pad-mounted switch gear is a type of node, you can also edit the same
data you can edit for a node, including the X and Y coordinates.
Refer to the following procedure for more information on editing pad-mounted switch gear.

TO EDIT PAD-MOUNTED SWITCH GEAR

1

In the SynerGEE map display or model explorer, double-click on the pad-mounted switch gear that
you want to edit.

In the PM Gear editor, select the PMG tab. The following table describes the different options that
you can set.

User Guide

Description

Optional description for the pad-mounted gear.

Bay

Identifies the Section ID for each section that is attached to the padmounted gear. You cannot edit this field.

Status

Status for the elbow at each section. Set the status to Open or
Closed, as desired. Any changes that you make here will be updated
automatically in the Properties tab of the Section editor, and viceversa.

Amp Rating

Amp rating for the elbow at each section. Any changes that you make
here will be updated automatically in the Properties tab of the Section
editor, and vice-versa.

Select the Node tab. The following table describes the different options that you can set.
X Coordinate

X coordinate location of the pad-mounted switch gear.

Y Coordinate

Y coordinate location of the pad-mounted switch gear.

Incident Sections

Lists the names of all sections that are connected to the pad-mounted
switch gear. This list is for informational purposes only and cannot be
edited.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Modeling Devices

411

Switch plans
A switch plan is a SynerGEE tool that systematically opens and closes switches in a specific order and then
analyzes the plan with a load flow analysis. You can create and save numerous plans and then recall and
load them at any time. Changes to the model can be made permanent or unapplied.
Switch plans are controlled by the Switch Plan editor. The editor allows you to create a switch plan by
recording your actions of opening and closing switches in the model. You can then rearrange the switching
order, change the type of plan, open a Switch editor, and apply changes.
Refer to the topics listed below for more information.

Creating a switch plan on page 411

Editing a switch plan on page 411

Deleting a switch plan on page 413

Using the Switch Plan Manager on page 413

Creating a switch plan

Perform the following procedure to create a switch plan for a section in your model.

TO CREATE A SWITCH PLAN

1

In the SynerGEE map display, right-click on a section where you wish to create a switch plan.

Select Add Switch Plan.

Use the Switch Plan editor to configure the switch plan. For more information on using this editor,
see Editing a switch plan on page 411.

Editing a switch plan

Perform the following procedure to edit a switch plan for a section in your model.

TO EDIT A SWITCH PLAN

1

In the SynerGEE model explorer, select the Model tab.

Expand Locations/Groups and select Switch Plans. Double-click on the name of the switch plan
that you want to edit.

Use the Switch Plan editor to record the sequence of switch control actions and to set other options
related to the plan. Refer to the following table for more information on the specific tasks that you
can perform.
To ...

Do This ...

Specify the switch

plans name

Next to Description, type the name of the switch plan. By default, the
switch plan name uses the name of the feeder where the switch plan
was created.

SynerGEE Electric 5.0

User Guide

412

Modeling Devices

To ...

Do This ...

Specify the switch

plans description

Next to Note, type an optional description for the switch plan.

Add switch control

actions

Edit actions in the

switch plan

Review details for

individual actions in the
plan

Click Record.

In the SynerGEE map display, locate the switch that you

want to add to the switch plan. Right-click on the switch and
select Open Device or Close Device, as appropriate. The
action is added to the end of the list of switch actions in the
Switch Plan editor.

Repeat step b to add additional switch actions to the switch

plan.

Click Stop to end the recording of switch actions.

Select the action that you want to edit and then do any of the
following:

Clear the check box to disable the action.

Click the Up or Down buttons to change the order of the

action.

Next to Plan, change the operation of the switch to Open ->

Closed or Closed -> Open, as appropriate.

The list of switch actions includes several key pieces of information

for each switch action that is added to the plan, including the actions
enabled/disabled status, the switch name, the planned action (open
to closed, or closed to open), the switchs current status, and the
amps and volts associated with the switch.
When you select an action in the plan, the Individual Switch Action
area provides the switch name, the name of the section associated
with the switch, the planned action (which can be edited from this
area), and the switchs current status. In addition, buttons are
provided that you can use to perform the following tasks:

User Guide

Edit the selected switch.

Toggle the switchs current status (from open to closed, or

closed to open the current status is shown in the Status
text box).

Zoom to the location of the selected switch.

Remove the selected switch from the plan.

SynerGEE Electric 5.0

Modeling Devices

413

To ...

Do This ...

Process Forward/
Process Reverse

Works in conjunction with the status field to indicate how the switch
plan can be processed. If the plan is inconsistent, you can set the
system to the initial or final state of the plan. Consistent plans can be
processed forward or in reverse.

or
Set to Initial State/Set
to Final State

Plan is/is NOT

consistent

Keeps track of the consistency of the switch plan.

Must be consistent to
operate

If a switch plan is inconsistent, then this check box will determine how
the plan can be applied.

Analyze

Click the Analyze button to run a load-flow on your model using the
proposed switch plan. When the analysis is complete, SynerGEE will
display a Switch Plan Summary report, which shows more detailed
information on the impact the switch plan will have on your model.

Click Apply to accept your changes, and then click X to close the editor.

Deleting a switch plan

Perform the following procedure to delete a switch plan from your model.

TO DELETE A SWITCH PLAN

1

In the SynerGEE model explorer, select the Model tab.

Expand Locations/Groups and select Switch Plans. Select the name of the switch plan that you
want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Using the Switch Plan Manager

The Switch Plan Manager provides a single location where you can view your switch plans and perform a
variety of management tasks, including editing, analyzing, and deleting individual switch plans. As you select
different plans and switches in the Switch Plan Manager, the SynerGEE map display will update to show the
impact that the selected plan or switch operation will have on the model.
The Switch Plan Manager includes the switch plans that you have created directly in SynerGEE as well as
any switch plans that have been generated by a contingency analysis. After performing a contingency
analysis, you can use the Switch Plan Manager to select the switch plan that is most appropriate for your
model and then save that plan as a part of the model.
Refer to the following procedure for more information on using the Switch Plan Manager.

SynerGEE Electric 5.0

User Guide

414

Modeling Devices

TO USE THE SWITCH PLAN MANAGER

1

Perform the following steps to open the Switch Plan Manager:

a

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Managers group, click Switch Plan Manager.

The Switch Plan Manager can also be opened automatically following a contingency analysis. For
more information, see Contingency Analysis on page 535.
2

In the Source area of the Switch Plan Manager, select the source of the switch plans that you want
to work with. For example, a source of Model indicates that the switch plans were created
manually for a model following the instructions provided in Creating a switch plan on page 411.
Cntgcy indicates switch plans that were created as a result of a contingency analysis, as described
in Contingency Analysis on page 535.

In the Plan area, select the specific switch plan that you want to work with, and then perform any of
the following tasks:
To ...

Do This ...

Edit the selected switch plan

Select the switch plan that you want to edit, and then click Edit.
For more information on editing a switch plan, see Editing a
switch plan on page 411.

User Guide

Run a load-flow analysis

using the selected switch
plan

Select the switch plan that you want to analyze, and then click
Analyze. SynerGEE will run a load-flow analysis based on the
proposed switch plan and then display a Switch Plan Summary
report, showing more detailed information on the impact the
selected switch plan will have on your model.

Delete the selected switch

plan

Select the switch plan that you want to delete, and then click
Delete.

Zoom to a switch location

In the Switch Steps area, select the step that includes the switch
that you want to view, and then click Zoom.

Save a contingency analysis

switch plan to the model

Select the switch plan that you want to save to the model, and
then click -> Model.

Remove all switch plans that

are not saved with the model
from the Switch Plan
Manager

Click Clear non-model plans.

Restore the model

Click Restore Model, or click Restore and Close to restore the

model and also close the Switch Plan Manager.

Click Close to close the Switch Plan Manager.

SynerGEE Electric 5.0

Modeling Devices

415

Contingency and optimal switching analysis

For information on contingency analysis, see Contingency Analysis on page 535. For information on optimal
switching analysis, see Optimal Switching Analysis on page 529.

TRANSFORMERS
Primary transformers are modeled in SynerGEE to be an accurate representation of real transformer banks
and units operating in a three-phase unbalanced distribution system.
Refer to the topics listed below for more information on working with transformers in SynerGEE.

Transformer model on page 415

Managing transformer types in the equipment warehouse on page 422

Managing transformers in the model on page 425

Transformer model
Transformers can be modeled in detail within an unbalanced load-flow package by considering the windingto-winding relationships between those transformer windings on the primary and secondary sides of the bank
or unit. The method used in this modeling schema breaks up the transformer bank into three parts, as shown
below.

Inward winding

Connection

Outward winding

Connection

Three parts of a transformer bank model

The center portion of the model consists of three ideal transformer models. The relationship between the
voltage and current across these windings is academic:

I In , j =

I Out , j
aww

VOut , j =

VIn , j

Eq 75

aww

where:
IIn, IOut, VIn, and VOut

inward and outward currents and voltages

aww

winding-winding turns ratio of transformers

The point of using this type of modeling is to modularize the very complicated behavior of transformers
associated with the various transformer connections. The effects of transformer impedance, grounding, and
no-load losses upon the unbalanced voltages and currents of the bank are modeled. These effects, as well

SynerGEE Electric 5.0

User Guide

416

Modeling Devices
as the essential effects of the transformer connection, are included in the inward winding connection and
outward winding connection portion of the model. The method for handling these transformer connections is
described in detail in the topics listed below.

Tertiary transformer windings on page 416

Transformer connection models on page 418

Network protectors on page 420

Tertiary transformer windings

As an option, you can model tertiary windings and connections. A single transformer can have only one
tertiary winding, but you can make multiple connections to it, and specify different connection types for singlephase units.
Refer to the topics listed below for more information.

Basic steps for modeling a tertiary winding on page 416

Specifying secondary versus tertiary connections on page 416

Basic steps for modeling a tertiary winding

Modeling a tertiary winding requires a few basic steps:
1

Create or edit a transformer equipment type that has the tertiary winding feature enabled. This
setting is specified in the Taps/Tertiary tab of the Transformer Type editor, as described in Editing a
transformer type on page 422.

Add a transformer to the model using the transformer type that was enabled for tertiary winding. For
more information, see Adding a transformer on page 425.

Specify where the secondary and tertiary windings should be connected. These options are set on
the Tertiary tab of the Transformer editor, as described in Setting up tertiary windings for a
transformer on page 429.

Specifying secondary versus tertiary connections

Transformer tertiary connections are specified in the Transformer editor, but are not visible on the model.
Connections are specified by section, and eligible sections for connection are determined by the closest
node.
To help illustrate this concept, consider the following example:

User Guide

SynerGEE Electric 5.0

Modeling Devices

417

The transformer is closest to the node with incident sections Sect_02, Sect_03, and Sect_04. Therefore,
these three sections will be available for secondary and/or tertiary connections in the Transformer editor. In
the Tertiary tab of the editor for this transformer, you might see the following:

Each section connected to the closest node is listed, along with its specified connection type. To change
between secondary and tertiary, click the down arrow; the connection type will change automatically. Once
this option has been set, the entire section is considered to be attached to the specified transformer
connection. In the example shown above, Sect_04 is specified as the tertiary connection, while Sect_02 and
Sect_03 are secondary connections. By default, all connections are set as secondary until manually
changed.
While modeling tertiaries, be aware of the following:

Tertiary connections must be enabled in the applicable transformer equipment type before the
options in the Tertiary tab shown above will become enabled. In addition, all nameplate data
associated with tertiary windings is specified in the equipment type. Transformer equipment types
are discussed in Managing transformer types in the equipment warehouse on page 422.

The parent section of a transformer is always considered the primary connection and cannot be
specified otherwise.

On the model, a tertiary connection must always be facing out of the section. That is, you must
specify that the high side is away from the node where the tertiary connections will be made. In the
example shown above, if the junction node were the to-node, the transformer must be specified
with the high-side near the from-node.

SynerGEE Electric 5.0

User Guide

418

Modeling Devices

Transformer connection models

SynerGEE models transformers and their connections in great detail. Three-phase transformer units and
banks of single-phase transformers are constructed from connections of the single winding transformer
model shown below.
Iin
+
Vin

Iout

a:1

Zs

Vout

Gc

Single-winding transformer

The model has a series or winding impedance and a conductance representing the core losses. In
SynerGEE, the transformer impedance values are actually spread across on the source and load side
windings. The source side can be connected into one of the four general schemes shown below.
B
A

Zw
1

IN

Zn

I w2

2
Vw
Y -

Gw3

Zw3

IC

Zw

+ Vw3 -

Gw1

+ V
w

Gw2

Wye-Gnd source side connection

B
A

Zw
1

Gw2

Gw1

Vw
1

Zw3

IC

V w2

+ Vw3 -

Y -

Gw3

Zw

I w2

Wye source side connection

User Guide

SynerGEE Electric 5.0

Modeling Devices

419

I
A A
1
Zw

Gw1

C
B

Zw
3

Gw3

IC

Zw2
Gw2

IB

Delta source side connection

I
A A
3

+ V
w
Zw
3

IC

1
Vw

1
Zw

Gw1
Gw3

IB

Open-Delta source side connection

A number of other connections are related to these. Open-Delta AB and CA connections are available. OpenWye connections can also be formed by eliminating windings from the Wye-Gnd connection.
These same connections are available for the load side of transformer banks.
a

Z tn

b
1

I w2
w2
-V

+ Vw3 -

+ V
w

Ic

Wye-gnd load side connection

a
b
1

+ Vw3 -

+ V
w

I w2

V w2

Ic

Wye load side connection

SynerGEE Electric 5.0

User Guide

420

Modeling Devices

+ V
w

1
Vw

b
- Vw2 +
c
Delta load side connection

+ V
w

1
Vw

b
c
Open-Delta BC

The source and load side connections are used together to form the high- and low-side connections of the
transformer bank or three-phase unit. For example, choosing a Wye-Gnd connection for the source side and
a Delta connection for the load side of a transformer bank or unit would result in the following model.
B
A

IC

+ Vw3 -

2
Vw
Y -

I w2

IN

+ V
w

Model resulting from Wye-Gnd/Delta connection

Currents and voltages within the windings and at the transformer terminals are consistent with the
transformer model presented above and Kirchhoffs laws. These banks can be built using the equipment
tables and the section records.

Network protectors
Network protectors are an essential part of the secondary network systems. They open and isolate the
primary feeder from the network in the event of a fault, avoiding a service outage for the load at the
secondary network. In addition, if the primary feeder is de-energized when the feeder breaker opens, the
network protector will also open to protect the load.
A short circuit on any one of the primary feeders will cause all the network protectors on that feeder to open
on reverse energy, provided the total power on the three-phase feeder is in the reverse direction. The other

User Guide

SynerGEE Electric 5.0

Modeling Devices

421

primary feeders carry the load until the faulted cable is repaired and returned to service. When the feeder is
clear of all faults and the transformer voltage is greater than that of the network, the network protectors close.
In a secondary network system, the system is looped or meshed and is supplied by several primary feeders.
These systems are often used in metropolitan areas or other areas with high load density and provide a
better continuity of service as compared to a radial distribution system. Other advantages include less
voltage sagging (since each load is supplied from at least two directions) and a possible reduction in
transformer capacity because the demand is diversified across large number of circuits.

Tripping and closing the network protectors

SynerGEE will apply the tripping and closing characteristics to the network protector if it is in Automatic mode
and Network load flow or Network fault analysis is run.

The network protector trips automatically if the net three-phase power flow goes from the
transformer to the network.

The network protector will close automatically if the net three-phase watt flows into the network from
the transformer and remains the same after the network protector closes.

Sample model
All the primary sections are shown as red (using Color by Results and selecting nominal kV) and the
distribution network sections are shown as blue. All the transformers have network protectors that are
enabled and automatic. SynerGEE determines and sets the appropriate status of the network protectors
when network load flow is run.

SynerGEE Electric 5.0

User Guide

422

Modeling Devices

Managing transformer types in the equipment

warehouse
SynerGEE allows you to create a number of basic transformer configurations known as transformer types
that serve as a starting point for the transformers in your model. Transformer types are stored as equipment
data in the equipment warehouse. Equipment data allows you to associate common settings from a single
transformer type with multiple transformers in a model. In fact, you can associate a single transformer type
with different transformers in different models, as long as the same equipment data is opened with each
model.
The transformer type defines a number of key options, such as whether the transformer is single-phase or
three-phase, and also the high-side and low-side voltage for the transformer. The transformer type is also
used to enable tertiary winding and load-tap changer for any transformers that are associated with the
equipment type. Therefore, it is very important that you properly configure the transformer types in your
equipment data and then properly reference them from the transformers in your model.
Like all equipment data, transformer types are used to add new transformers to your model. From the
Warehouse tab of the model explorer, simply find the transformer type that you want to add, drag it into the
map display, and drop it onto the desired section. Once a transformer has been created, you can change the
associated transformer type from the Transformer tab in the Transformer editor. You should be aware that
some options in the Transformer editor may enable and disable automatically based on the options you have
selected in the referenced transformer type.
The topics listed below provide more information on working with transformer types. For more information on
working with the equipment warehouse in general, see Equipment data on page 64.

Creating a transformer type on page 422

Editing a transformer type on page 422

Deleting a transformer type on page 424

Creating a transformer type

Perform the following procedure to create a new transformer type in your equipment warehouse.

TO CREATE A TRANSFORMER TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Transformer.

In the Enter Device ID dialog box, type a name for the new device type and then click OK.

Use the Transformer Type editor to edit the settings for the transformer type. For more information
on the options you can set, see Editing a transformer type on page 422.

Editing a transformer type

To edit a transformer type, double-click the transformer type name in the Warehouse tab of the SynerGEE
model explorer. From the Transformer tab in the Transformer editor, you can also click the edit button that is
located next to the name of the selected transformer type.

User Guide

SynerGEE Electric 5.0

Modeling Devices

423

Refer to the following procedure for more information.

TO EDIT A TRANSFORMER TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Transformer Types and then double-click the name of the transformer type that you want
to edit.

In the Transformer Type editor, select the Ratings tab. Use the Ratings tab to edit rating data for the
transformer. The following table describes the different options that you can set.
Description

Optional description for the transformer type.

Name Plate Ratings

Name plate ratings for the transformer type. Specify the following
values:

High-Side Settings
and Low-Side Settings

SynerGEE Electric 5.0

Rated KVA. Operating rating of the transformer. For singlephase transformers, specify the transformer single-phase
nameplate rating. For three-phase transformers, specify the
total three-phase nameplate rating.

Impedance. The series or winding impedance is the

nameplate value expressed as a percent using the rated
kVA as a base. For more information on impedance, see the
SynerGEE Technical Reference.

Resistance. The resistance is the nameplate value

expressed as a percent using the rated kVA base of the
transformer. Zero is acceptable.

No Load Losses.

High-side and low-side voltage settings for the transformer type.

Specify the following values:

KV. Rated kV.

Connection. Transformer connection type. For three-phase

transformers, the connection type is specified here, in the
transformer equipment type editor. For single-phase
transformers, the type is specified in the transformer or
substation editor. For more information on the Transformer
editor, see Editing a transformer on page 425. For more
information on the Substation editor, see Editing a feeder or
subtran node on page 247.

Optional Nominal Voltage. For low-side settings, specifies

a nominal voltage that can be optionally applied to the
transformer type. This value is applied to a transformer
when the Low-Side Nominal Voltage option is set to From
Type in the Transformer tab of the respective Transformer
editor.

User Guide

424

Modeling Devices

Factory Unit

Transformer phase capacity. Specify whether the transformer type is

Single Phase or Three Phase.

Summer KVA Ratings

and Winter KVA
Ratings

Specify Continuous and Emergency ratings for typical summer and

winter ratings. These values are used with SynerGEEs weatherbased modeling, as described in Configuring Seasonal Weather
Modeling on page 831. SynerGEE uses the summer ratings as the
default values.
The Continuous and Emergency rating is also used for exception
coloring in the map display. For more information on coloring the map
display, see Selecting a Coloring Scheme for Sections on page 216.

Select the Taps/Tertiary tab. Use the Taps/Tertiary tab to enable load-tap changer and tertiary
windings for the transformer type. Enabling these features for the transformer type will enable the
corresponding features for any transformer instance that references the transformer type.
To ...
Enable load-tap
changer (LTC)

Enable tertiary windings

Do This ...
a

Select the Enable Load-Tap Changer check box.

Select the On-load tap changer on primary windings

check box to enable the tap changers on the primary
windings. Leave the check box cleared to enable the tap
changers on the secondary windings.

Enter LTC nameplate data for the following values: Tap size,
Min tap, Neutral tap, Max tap, PT Ratio, and CT Rating.

Select the Enable Tertiary Winding check box.

Enter tertiary winding nameplate data for the following

values: Rated KVA and Impedance.

Next to KV, enter the tertiary output voltage for the

transformer type.

Next to Connection, select a connection type for threephase units. This option will be disabled if you have set the
transformer type to Single Phase in the Ratings tab of the
editor. (The connection for single-phase units is specified in
the Tertiary tab of the Transformer editor.)

Click Apply to accept your changes, and then click X to close the editor.

Deleting a transformer type

Perform the following procedure to delete a transformer type from your equipment warehouse.

User Guide

SynerGEE Electric 5.0

Modeling Devices

425

TO DELETE A TRANSFORMER TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Transformer Types and then select the name of the transformer type that you want to
delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Managing transformers in the model

Refer to the topics listed below for information on adding, editing, and deleting transformers in your model.

Adding a transformer on page 425

Editing a transformer on page 425

Deleting a transformer on page 431

Adding a transformer
Transformers are added to a model in the same manner as any other equipment, by dragging a transformer
type from the Warehouse tab of the model explorer and dropping it onto an existing section in the SynerGEE
map display. Refer to the following procedure for more information. Additional information on working with
warehouse equipment types is provided in Modeling Devices on page 317.

TO ADD A TRANSFORMER TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Transformer Types and then select the transformer type that you want to add to your
model. Drag it onto the map display and drop it onto the desired section.

Editing a transformer
Use the Transformer editor to edit an existing transformer in your model. Refer to the following procedure for
more information.

TO EDIT A TRANSFORMER
1

In the SynerGEE map display or model explorer, double-click the transformer that you want to edit.

On the left side of the Transformer editor, select from the different tab names to access the available
settings for the transformer. The following topics describe the different tasks that you can perform:
-

Editing general data for a transformer on page 426

Setting up a load-tap changer (LTC) for a transformer on page 427

Setting up tertiary windings for a transformer on page 429

Enabling a network protector for a transformer on page 429

SynerGEE Electric 5.0

User Guide

426

Modeling Devices

Setting failure rates, location links, and the energize and retire years for a transformer on
page 430

Viewing analysis results for a transformer on page 431

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a transformer

TO EDIT GENERAL DATA FOR A TRANSFORMER
1

In the SynerGEE map display or model explorer, double-click on the transformer that you want to
edit.

In the Transformer editor, select the Transformer tab. The following table describes the different
options that you can set.
Name

Transformer name or ID.

Tap Setting (PU)

Value that allows for transformers set on fixed taps above or below
the rated voltage. SynerGEE multiplies this value by the rated high
voltage when calculating transformer turns ratios. If transformer taps
are not used, enter 1.0, which indicates that the transformer is
operating at nameplate value.

Type

Specifies a transformer type from the equipment warehouse, and

indicates whether the transformer type is a single-phase or threephase unit. If the referenced transformer type does not exist in the
currently loaded equipment warehouse, then the transformer type will
be displayed as Unknown. If an analysis fails because of a missing
equipment type, the resulting report will specifically indicate the
offending device(s). The transformer type association will be restored
once a matching equipment warehouse is opened.
For more information on transformer types, see Managing
transformer types in the equipment warehouse on page 422.

Note

User Guide

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

SynerGEE Electric 5.0

Modeling Devices

High-side settings and

Low-side settings

Impedance from
warehouse type

427

High-side and low-side voltage settings for the transformer. Values

that are disabled are specified in the referenced transformer type.

Near From / Near To. Specify the direction of the primary

transformers high-side winding. The transformer can be a
step-up transformer with the high-side winding on the load
side of the section, or a step-down transformer with the highside winding on the source side of the section. The high-side
direction is not related to the actual location of the
transformer on the section.

Connection. Transformer connection type. For singlephase transformers, the connection type is specified here, in
the Transformer editor. For three-phase transformers, the
type is specified in the referenced transformer type.

Nominal Voltage. Nominal voltage for the transformer, as

specified in the referenced transformer type.

Gnd Ohms. For Wye-Gnd connections, specify the

grounding resistance and reactance for the high side and
low side of the transformer bank.

Select the Override check box if you want to apply custom

Impedance and Resistance values to the transformer. If the check
box is cleared, then the Impedance and Resistance values from the
transformers warehouse type will be used.
For information on editing these values in the warehouse, see
Editing a transformer type on page 422.

Low-Side Nominal
Voltage

Use this option to specify how output nominal voltage is determined

for the transformer.

Calculate. The nominal voltage is calculated by SynerGEE

based on transformer windings, primary tap, etc.

Specify. The nominal voltage is specified at the transformer

by the user.

From Type. The nominal voltage will use the Optional

Nominal Voltage as specified at the transformers
warehouse type. The warehouse nominal kV is listed in this
tab (for example, 13.2 kV from type).

Click Apply to accept your changes, and then click X to close the editor.

Setting up a load-tap changer (LTC) for a transformer

Transformers, especially primary transformers, may include a regulator LTC component. To set up an LTC for
a transformer, you must first enable the LTC option for the transformer type that is associated with your
transformer. If the LTC option is not enabled in the transformer type, as described in Editing a transformer
type on page 422, then the LTC options will be disabled in the LTC tab of the Transformer editor.

SynerGEE Electric 5.0

User Guide

428

Modeling Devices
Refer to the following procedure for more information on setting up an LTC for a transformer.

TO SET UP AN LTC FOR A TRANSFORMER

1

In the SynerGEE map display or model explorer, double-click on the transformer that you want to
edit.

In the Transformer editor, select the LTC tab. The following table describes the different options that
you can set.
Voltage and LDC
Settings

Specify the following values:

Taps. Specifies the initial tap settings for analysis. These

taps will be maintained unless you set the Tap Control to
Automatic.

Voltage. Specifies the voltage set point.

R Dial. Specifies the line-drop compensation R setting in

volts.

X Dial. Specifies the line-drop compensation X setting in

volts.

B.W. Dial. Specifies the bandwidth of the voltage set point.

For example, if you have set the voltage set point to 124 and
a bandwidth of 2, then voltage range will be from 123 to 125.

The voltage base (100V or 120V) for the voltage and LDC settings is
set as the PT Secondary option on the Units tab of the Preferences
editor. For more information, see Setting units of measurement on
page 165.
Tap Control

User Guide

Select from one of the following options:

Automatic. SynerGEE is permitted to change tap positions

during analysis in response to system conditions, simulating
the actual behavior of the regulator component.

Manual. The specified taps are maintained.

First House

If enabled, first house protection for upper and lower voltage limits at
the regulator output terminals.

Tap limits

High and low limits of tap movement during regulation. This option is
only applicable if the Tap Control is set to Automatic. The value can
be positive, negative, or zero. The numerical absolute value cannot
be greater than half the number of taps specified in the transformer
equipment type. For more information on transformer types, see
Editing a transformer type on page 422.

Gang Metering Phase

Activates and configures gang operation. When the Gang Operated

check box is selected, all phase units move to the same tap during
tap changes, according to the metering phase.

SynerGEE Electric 5.0

Modeling Devices

429

Time delay

This value is used when the regulator control is out of bandwidth.

When this occurs, the regulator will wait for the specified number of
seconds before operating.
If the regulator moves into bandwidth, then the time delay is reset.

Tapping delay

Specifies a pause issued between tap changes while the regulator

remains out of bandwidth.

Click Apply to accept your changes, and then click X to close the editor.

Setting up tertiary windings for a transformer

SynerGEE supports transformer tertiary windings. Note that the tertiary winding must be enabled at the
equipment data level; that is, the selected transformer type in the Transformer tab must have the tertiary
enabled. If the tertiary is not enabled in the transformer type, the settings in this tab will be disabled. For more
information, see Editing a transformer type on page 422.
For more information on modeling tertiaries, see Tertiary transformer windings on page 416.

Enabling a network protector for a transformer

A network protector isolates the network from primary feeder fault and can be included in the SynerGEE
enhanced transformer model. Network protectors in SynerGEE are discussed in detail in Network
protectors on page 420.
Network protectors are set up in the Net Protector tab of the Transformer editor. Refer to the following
procedure for more information.

TO ENABLE A NETWORK PROTECTOR FOR A TRANSFORMER

1

In the SynerGEE map display or model explorer, double-click on the transformer that you want to
edit.

In the Transformer editor, select the Net Protector tab.

Select the Has Network Protector check box to enable the network protector.

Under Operation Mode, specify whether the network protector operates automatically or manually.
-

Automatic. Under Automatic operation, SynerGEE will automatically connect the

associated transformer to the network under positive power flow conditions, and
disconnect the transformer from the network under reverse power flow conditions.

Manual. Under Manual operation, the network protector will open and close like a normal
switch. The network protector will not react to reverse power flow conditions.

Under Status, specify whether the network protector is Open or Closed.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

430

Modeling Devices

Setting failure rates, location links, and the energize and retire years
for a transformer
The Rates tab in the Transformer editor specifies failure rate data for the transformer. You can specify a
sustained failure rate and temporary failure rate, as well as the failure repair time and cost. The Rates tab
also contains options to set a location link and an AMS link, and also to set the energize and retire years.
Refer to the following procedure for more information.

TO SET FAILURE RATES, LOCATION LINKS, AND THE ENERGIZE AND RETIRE YEARS FOR A
TRANSFORMER

In the SynerGEE map display or model explorer, double-click on the transformer that you want to
edit.

In the Transformer editor, select the Rates tab. The following table describes the different tasks that
you can perform.
To ...

Do This ...

Enter failure rate data

In the respective fields, enter values for the following parameters:

Sustained Failure Rate

Temporary Failure Rate

Failure Repair Time

Failure Repair Cost

Generally, the numbers that you enter will represent averages and
estimates, because it is unlikely that you will have exact figures for
each individual device.

User Guide

Set up a location link

Next to Location Link, type the correct syntax to link the device to an
external source, such as a file, website, or location in an Internet
mapping software application. SynerGEEs location link feature, as
well as the syntax required to set up location links, is described in
Location Links on page 223.

Set up an Asset
Management System
(AMS) link

Next to AMS Link, specify the link to your asset management

system.

Specify energize and

retire years for multiyear analyses

Under Year, select an appropriate year next to Energize and Retire.

For more information on multi-year modeling, see Multi-Year
Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Modeling Devices

431

Viewing analysis results for a transformer

The Results tab in the Transformer editor provides analysis results for the transformer. The Results tab can
be very helpful if you are running multiple analyses and focusing on a particular device. Since the settings
update automatically with each analysis, you can run an analysis and watch the results change in real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a transformer.

TO VIEW ANALYSIS RESULTS FOR A TRANSFORMER

1

In the SynerGEE map display or model explorer, double-click on the transformer that you want to
work with.

In the Transformer editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

Deleting a transformer
Perform the following procedure to delete a transformer from your model.

TO DELETE A TRANSFORMER FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the transformer that you want to delete.

Right-click on the transformer and select Delete.

Click Yes to confirm the deletion.

SynerGEE Electric 5.0

User Guide

432

User Guide

Modeling Devices

SynerGEE Electric 5.0

CHAPTER

8
SynerGEE Analyses
SynerGEE supports a wide range of powerful analyses that you can use to evaluate and optimize your
system with accuracy and precision. With a variety of options and settings available, you can customize
SynerGEE to analyze in a manner that best suits your needs.
Refer to the topics listed below for more information.

Setting Up an Analysis on page 433

Performing an Analysis on page 449

Viewing Analysis Results on page 449

SynerGEE Reports on page 456

SynerGEE Charts on page 479

What-If Analysis on page 484

Uncertainty Analysis on page 487

System Status Analysis on page 489

R&D Analysis on page 489

Concepts View on page 490

SETTING UP AN ANALYSIS
Before you perform an analysis, make sure you have properly configured SynerGEEs many analysis
options. Refer to the topics listed below for more information.

Setting a section for analysis on page 434

Selecting the analysis year and time of day on page 434

Setting model and analysis options on page 436

Setting analysis output options on page 444

Setting analysis cost options on page 446

SynerGEE Electric 5.0

User Guide

434

SynerGEE Analyses

Setting a section for analysis

Some analysis types require that you set a section for analysis before performing the analysis. For example,
the fault flow analysis simulates a fault on one particular section and then calculates current flow throughout
the rest of the model. Therefore, SynerGEE needs to know which section you want to be faulted. As another
example, the regulator setting tool needs to know which regulator to evaluate. In both cases, you must
provide this information by setting a section for analysis.

TO SET A SECTION FOR ANALYSIS

1

In the SynerGEE map display or model explorer, locate the section that you want to set for analysis.

Right-click on the section and select Set for Analysis.

The section that is set for analysis appears highlighted on the map, using a color that you can
specify in the Color tab in the Map Settings editor.

TO ZOOM TO THE ANALYSIS SECTION

1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Analysis Section group, click Zoom.

TO EDIT TO THE ANALYSIS SECTION

1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Analysis Section group, click Edit.

TO CLEAR THE ANALYSIS SECTION

1

In the SynerGEE ribbon bar, select the NAVIGATE tab.

In the Analysis Section group, click Clear.

Note:

You can also locate the analysis section in the SynerGEE map display, right-click on the
section, and select Unset for Analysis.

Selecting the analysis year and time of day

Use the Hour/Day tab in the Time and Weather Options editor to select the analysis year and the time of day.
This time-of-day option is only applicable if you have implemented customer load curves in your model. For
more information, see Customer Load Curves/Time-of-Day Analysis on page 808.

TO SELECT THE ANALYSIS YEAR AND TIME OF DAY

1

User Guide

Perform the following steps to open the Time and Weather Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Time & Weather.

SynerGEE Electric 5.0

SynerGEE Analyses
2

435

In the Time and Weather Options editor, select the Hour/Day tab. The following table describes the
different tasks that you can perform.
To ...

Do This ...

Specify the analysis

year

Under Year for Analysis, select the year you want to analyze.

Specify the time of day

adjustment

Under Time of day adjustment, select one of the following options:

SynerGEE Electric 5.0

Tip:

You can also change the analysis year by clicking on the

year option on the right side of the SynerGEE status bar or
by using the year indicator above the SynerGEE model
explorer.

Do not adjust for time of day. Select this option to ignore

the time of day. Customer load curves are not used. Section
load is determined from 100% of the load values (along with
growth rates). You should use this option for standard peak
day analysis.

Peak load. Select this option to have SynerGEE

automatically find and use a peak load point for a selected
time period. Available choices (Overall, Summer, Winter, or
Month) are described in the next table row.

Minimum load. Select this option to have SynerGEE

automatically find and use a minimum load point for a
selected time period. Available choices (Overall, Summer,
Winter, or Month) are described in the next table row.

Specified time. Select this option to use a specific month,

hour, and type of day (weekday, weekend, or peakday) as
the time of day. Optionally, you can select to always use the
current system time, specified in terms of month, time, and
day type (weekday or weekend).

User Guide

436

SynerGEE Analyses

To ...

Do This ...

Specify the peak or

minimum time period

If you select Peak load or Minimum load as one of the Time of day
adjustment options, use the Peak/Minimum area to select the time
period that will be considered for determining the peak or minimum
load. The following options are available:

Select peak and

minimum calculation
options

Overall. Select this option to have SynerGEE find and use

the yearly peak or minimum load point.

Summer. Select this option to have SynerGEE find and use

the peak or minimum load point from summer months.
Summer months are defined by the Summer Start and End
months in the Hour/Day tab.

Winter. Select this option to have SynerGEE find and use

the peak or minimum load point from winter months. Winter
months are considered to be the months that are not defined
by the Summer Start and End months in the Hour/Day tab
that is, the remaining months of the year.

Month. Select this option to have SynerGEE find and use

the peak or minimum load point for one specific month.
When you select this option, the Month option in the
Specified time area of the Hour/Day tab will become
enabled, thus allowing you to select the month that you want
to use.

If you select Peak load or Minimum load as one of the Time of day
adjustment options, use the Peak Calculation area to select the
how peak or minimum loads will be calculated by SynerGEE. The
following options are available:

Coincident. SynerGEE will find peaks and minimums for the

entire model.

Non-coincident zone peaks. SynerGEE will find peaks and

minimums from zones only.

Non-coincident zone peaks. SynerGEE will find peaks and

minimums from classes only.

If desired, select the Include peak days option to have SynerGEE

consider peak days, weekdays, and weekends. If the option is
cleared, only weekdays and weekends will be considered.
3

Click Apply to accept your changes, and then click X to close the editor.

Setting model and analysis options

SynerGEE provides a host of options that control how SynerGEE treats the model during analysis. These
options are global; that is, they are not specific to any particular model.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

437

It is critically important that you set your model and analysis options correctly, since they can have a
significant effect on analysis results. SynerGEE remembers these settings from session to session. Once
they are set, they will not change unless you change them yourself.
Model and analysis options are included in application settings when you load or save an application settings
file. For more information, see Settings Groups and Settings Files on page 189.

TO SET MODEL AND ANALYSIS OPTIONS

1

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

On the left side of the Model and Analysis Options editor, select from the different tab names to
access the available model and analysis options. The following sections describe the different tasks
that you can perform:
-

Defining exception load limits on page 437

Setting up general model options on page 438

Setting up general analysis options on page 441

Options, errors, and warnings in reports on page 460

Enabling automatic fixes during an analysis on page 442

Setting up multi-year analysis options on page 442

Setting up model costs on page 443

Click Apply to accept your changes, and then click X to close the editor.

Defining exception load limits

Use the Exceptions tab in the Model and Analysis Options editor to define exception loading limits for both
continuous and emergency loads. SynerGEE highlights exceptions in places like analysis reports and the
editors Results tab, according to the ranges you specify here. Continuous and emergency loading limits are
calculated from the ratings of the device and the load on it. As the exception loading limits change, there will
be no change in the continuous and emergency loading percentage on the device itself. In other words, if a
125A device is loaded to 165A, it will be loaded to 132% regardless of the exception loading limits. You will
see a warning if the continuous exception loading limit is set below 132%. You will see an emergency
exception if the emergency limit is set below 132%. If you routinely operate a device at a percent load above
100%, then you should enter the actual percent as the continuous rating and expect to see the device loaded
in SynerGEE with no indications of loading problems. Values that exceed the exception limits are typically
highlighted in red in the Results tab of the SynerGEE editor and also in analysis reports.

TO DEFINE EXCEPTION LOAD LIMITS

1

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

SynerGEE Electric 5.0

User Guide

438

SynerGEE Analyses
2

In the Model and Analysis Options editor, select the Exceptions tab. The following table describes
the different options that you can set.
Exception Loading
Limits

Sets the continuous and emergency loading limits that will trigger an
exception.

Limits Reserve Amps

If you want the reserve amps to be limited by the exceptions, make

sure the check box is selected.

Voltage exceptions

Sets the exception values for voltage.

Seasonal ratings

Sets whether summer rating values or winter rating values will be

used as the ratings exceptions for conductors, regulators, and
transformers. Winter and summer ratings are only used if weather
modeling is turned on.
For more information on seasonal modeling, see Configuring
Seasonal Weather Modeling on page 831.

Click Apply to accept your changes, and then click X to close the editor.

Setting up general model options

TO SET UP GENERAL MODEL OPTIONS
1

User Guide

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

SynerGEE Electric 5.0

SynerGEE Analyses
2

439

In the Model and Analysis Options editor, select the Model tab. The following table describes the
different options that you can set.
General Options

Switched Capacitor
Options

SynerGEE Electric 5.0

Select any of the following options:

Tran. Taps Affect Nominal Volts. Select this check box to

set the nominal voltage to be divided by transformer taps
during the outward propagation. This has a significant
impact on loads, fault values, and so on (loads only operate
at rated kW/kvar when the voltage is nominal). However, the
impact may be subtle on reports since the voltages are listed
on a user base rather than in kV.

Ignore Line Capacitance. Select this check box to ignore

line charging requirements of overhead lines during
analysis.

Ignore Motor Loads. Select this check box to ignore

running motors during load-flow analysis.

Exclude Spot Loads. Select this check box to ignore spot

loads during analysis.

Average (balance) Loads. Select this check box to balance

loads across phases during analysis and ignore by-phase
values.

No Capacitor Low Volt Exception. Select this check box to

suppress low voltage exceptions on capacitors. This option
will apply to capacitors having nominal voltage specified in
their editors. It examines the capacitors rated kV against the
operating voltage on a feeder and keeps exceptions from
being generated when the rated kV is too high.

Select one of the following options:

Controlled by SynerGEE. Select this option to control the

closed/tripped state of capacitors during analysis, using the
trip parameters assigned in the individual capacitor records.

Hold Current State. Select this option to hold all switched

capacitors in their current closed/tripped state during
analysis, as determined by system conditions just prior to
the analysis.

All On (Closed). Select this option to hold all switched

capacitors as closed during analysis.

All Off (Tripped). Select this option to hold all switched

capacitors as tripped during analysis.

User Guide

440

SynerGEE Analyses

Switched Capacitor
Start Options

Overhead conductor
resistance

Regulator Options

User Guide

Select one of the following options:

Leave in Current State. Select this option to set all

switched capacitors to remain in their current tripped/closed
state prior to starting an analysis. During analysis, capacitor
behavior is controlled according to the Switched Capacitor
Options described above.

Close. Select this option to close all active switched

capacitor modules prior to starting an analysis. During
analysis, capacitor behavior is controlled according to the
Switched Capacitor Options described above.

Trip. Select this option to trip all active switched capacitor

modules prior to starting an analysis. During analysis,
capacitor behavior is controlled according to the Switched
Capacitor Options described above.

Select one of the following options to set the temperature setting for
overhead conductor resistance:

Nameplate resistance. Select this option to calculate

impedances at nameplate resistance. This is the default and
negates the use of temperatures.

Calculate [value] C. Select this option to specify the

temperature for conductor resistance.

Use [value] C over ambient. Select this option to specify

the temperature over ambient. If this option is selected, the
temperature in the Weather tab of the Time and Weather
Options editor needs to be enabled. For more information,
see Weather on page 823.

Select one of the following options. Note that these options apply to
regulator devices only, and not the active LTC components of
transformers.

Controlled by SynerGEE. Select this option to adjust

regulator taps as needed during analysis, simulating actual
behavior under changing conditions.

Hold Current Taps. Select this option to hold all regulators

at their current taps during analysis, as determined by model
conditions just prior to the analysis.

Max Taps. Select this option to hold all regulators at their

maximum taps during analysis.

Min Taps. Select this option to hold all regulators at their

minimum taps during analysis.

Neutral Taps. Select this option to hold all regulators at their

neutral taps during analysis.

SynerGEE Electric 5.0

SynerGEE Analyses

441

Regulator Start
Options

Select one of the following options. Note that these options apply to
regulator devices only, and not the active LTC components of
transformers.

Leave at Current Tap. Select this option to set all regulators

to remain at their current tap prior to starting an analysis.
During analysis, regulator behavior is controlled according to
the Regulator Options described above.

Move to Minimum Tap. Select this option to move all

regulators to their minimum taps prior to starting an analysis.
During analysis, regulator behavior is controlled according to
the Regulator Options described above.

Move to Maximum Tap. Select this option to move all

regulators to their maximum taps prior to starting an
analysis. During analysis, regulator behavior is controlled
according to the Regulator Options described above.

Move to Neutral. Select this option to move all regulators to

their neutral taps prior to starting an analysis. During
analysis, regulator behavior is controlled according to the
Regulator Options described above.

Click Apply to accept your changes, and then click X to close the editor.

Setting up general analysis options

TO SET UP GENERAL ANALYSIS OPTIONS
1

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

In the Model and Analysis Options editor, select the Analysis tab. The following table describes the
different options that you can set.
Iteration Limit

Maximum number of iterations SynerGEE uses to reach convergence

during analysis.

Convergence
Tolerance

Tolerance used by various analyses to determine completion. The

parameters to which this tolerance applies vary among the
applications. The valid range is from 0.01 to 10.

Voltage Mismatch
Tolerance

Maximum difference in nominal voltage and rated voltage that

SynerGEE allows between adjacent devices, between 0.1% and
80%.

SynerGEE Electric 5.0

User Guide

442

SynerGEE Analyses

Earth Resistivity

Measures the resistivity of earth (or ground) connections with respect

to safety aspects of power distribution and use. The default setting is
100 and can be set as high as 5000 Ohm-meters.

Lock Regulators After

Specifies after how many iterations you want the regulators to lock.

Lock Switched
Capacitors After

Specifies after how many interactions you want the switched

capacitors to lock.

Click Apply to accept your changes, and then click X to close the editor.

Enabling automatic fixes during an analysis

Use the Fixes tab in the Model and Analysis Options editor to enable automatic corrections that you want to
be made to your model during analysis runs. The selected options will make permanent edits to common
data issues that could be present in your model.

TO ENABLE AUTOMATIC FIXES DURING AN ANALYSIS

1

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

In the Model and Analysis Options editor, select the Fixes tab.

Select the check box for each automatic correction that you want to enable during your analysis
runs. The automatic corrections that you can enable include the following:

Set loads to LL connection on delta lines

Use 20 height on overhead lines with negative height

Reconnect YGnd capacitors as delta on underground lines

Balance meter phase demand if one is less than 0.5

Click Apply to accept your changes, and then click X to close the editor.

Setting up multi-year analysis options

TO SET UP MULTI-YEAR ANALYSIS OPTIONS
1

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

In the Model and Analysis Options editor, select the Multi-Year tab. The following table describes
the different options that you can set.
Current Year Only

User Guide

Changes are applied to only the current year.

SynerGEE Electric 5.0

SynerGEE Analyses

443

Copy Forward

Changes are applied to the current year and copied ahead to all
future years.

Increment Forward

Changes are applied to the current year and the delta between the
new value and the old is applied to each successive year. For
example, if the current year has a value of 1 and you change it to 2,
the current years value will be set to 2, the next year will be set to 3,
and so on.

Proportion Forward

Changes are applied to the current year. The new value is divided by
the old and that result is multiplied to each successive year. For
example, if the current year has a value of 2 and it is changed to 4,
the next year becomes 8, the year after that becomes 16, and so on.

All Years

Changes are applied to all years with the new values.

Click Apply to accept your changes, and then click X to close the editor.

Setting up model costs

TO SET UP MODEL COSTS
1

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

In the Model and Analysis Options editor, select the Costs tab. The following table describes the
different options that you can set.
Detailed cost list

A MiddleLink-format cost file that contains the cost data pertinent to

the analysis you intend to run. For more information, see Cost files
on page 447.

Power and Energy

Costs

Edit the following settings:

SynerGEE Electric 5.0

Utility kWh Cost. Cost to the utility per kWh delivered. This
value is ultimately used to determine the cost of losses.

Peak Charge. Peak charge to the utility per kW purchased,

generally during a time of peak demand.

User Guide

444

SynerGEE Analyses

Factors for
Calculating Energy

Preferred Approach
for Energy & Min Load

Edit the following settings:

Light Run Factor. Multiplier used for the peak load to

simulate a minimum load condition for the light load-flow
run. For more information on this factor, see Performance
Comparison on page 589.

Average Load Factor. Multiplier used to determine the

average load, for cost calculations. For more information on
this factor, see the SynerGEE Technical Reference.

Secondary Loss Factor. Multiplier used to determine the

percentage of total loss represented by secondary loss. For
more information on this factor, see Secondary losses on
page 593.

Each utility uses its own method to perform economic analyses. Daily
load curves are also known as customer zones. For more information,
see Customer zones on page 815.

Click Apply to accept your changes, and then click X to close the editor.

Setting analysis output options

The settings in SynerGEEs Output Options editor control how results are output after an analysis is run. For
example, you can specify whether reports will be generated after an analysis is complete, and whether
coloring and annotation results will be updated in the SynerGEE map display. You can also select which
attributes are shown in the facility editor Results tables, and which are shown in the Results Viewer. You can
also set options regarding how reports are generated and whether the user will be prompted to enter notes
before each analysis is run.

TO SET ANALYSIS OUTPUT OPTIONS

1

User Guide

Perform the following steps to open the Output Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Output.

On the left side of the Output Options editor, select from the different tab names to access the
available analysis output options. The following procedures describe the different tasks that you can
perform:
-

Selecting which attributes are available in the Results Viewer on page 445

Selecting which attributes are available in the Results tab on page 445

Generating analysis reports on page 457

Configuring report options on page 459

Adding notes to reports on page 460

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

SynerGEE Analyses

445

Selecting which attributes are available in the Results Viewer

Use the Results Viewer tab in the Output Options editor to enable and disable the attributes that are available
in the Results Viewer. For more information on the Results Viewer, see Using the Results Viewer on
page 451.

TO SPECIFY WHICH ATTRIBUTES ARE AVAILABLE IN THE RESULTS VIEWER

1

Perform the following steps to open the Output Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the settings group, click Output.

In the Output Options editor, select the Results Viewer tab. Use the check boxes to select which
items you want to include and exclude from the Results Viewer. Selected (checked) attributes will be
visible in the viewer, and cleared attributes will be hidden.
The following table describes additional ways that you can select and clear check boxes.
To ...

Do This ...

Select (highlight) all item names

Click the Select All button, or use the Ctrl and Shift keys on
the keyboard to select ranges of item names.

Select All button

Enable all selected (highlighted)

item names

Click the Enable Selected Items button.

Enable Selected Items button

Disable all selected (highlighted)

item names

Click the Disable Selected Items button.

Disable Selected Items button

Toggle the status of all selected

(highlighted) item names

Click the Toggle Status button.

Toggle Status button

Click Apply to accept your changes, and then click X to close the editor.

Selecting which attributes are available in the Results tab

Use the Editor Results tab in the Output Options editor to select which attributes are shown in the Results tab
of the section, feeder, and device editors. You can show and hide individual result types, such as Amps Into
and Volts Out, and you can also show and hide entire result categories, such as Fault results, Capacity
results, and Reliability results. In addition, you can select which power units are used to display the results.

SynerGEE Electric 5.0

User Guide

446

SynerGEE Analyses
The Output Options editor is described in more detail in Selecting which attributes are available in the
Results tab on page 445.
For more information on the Results tab, see Viewing results in the SynerGEE editor on page 156.

TO SELECT WHICH ATTRIBUTES ARE AVAILABLE IN THE RESULTS TAB

1

Perform the following steps to open the Output Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Output.

In the Output Options editor, select the Editor Results tab. Use the check boxes to specify which
attributes will be displayed in the Results tab of the section, node, and device editors. Selected
(checked) result types and result categories will be visible in the Results tab, and cleared
(unchecked) result types and result categories will be hidden.
The following table describes additional ways that you can select and clear check boxes.
To ...

Do This ...

Select individual result types to

show or hide

In the result types list, select the check box for each result
type that you want to show. Clear the check box for each
result type that you want to hide. You can also use the
toolbar buttons at the top of the editor to select (highlight) all
result types, select (check) and clear (uncheck) selected
result types, and reverse the status of selected result types.
Note that even though you select a result type to show,
result types may still be hidden in the Results tab if you have
hidden the result category to which the result type belongs.

Select result categories to show

or hide

Under Show by category, select the check box for each

result category that you want to show. Clear the check box
for each result category that you want to hide.
Note that even though you select a result category to show,
individual result types within that category must still be
selected in the result types list in order to be shown in the
Results tab.

Select which power units are

displayed in the Results tab
3

Under Power Units, select the power unit type that you want
to use in the Results tab.

Click Apply to accept your changes, and then click X to close the editor.

Setting analysis cost options

Some SynerGEE analyses, such as performance comparison and facility selection, include a financial
evaluation component. To perform these financial evaluations, SynerGEE naturally requires cost data.
Cost data is specified in the Costs tab of the Model and Analysis Options editor and normally applies to all
analyses. Therefore, before running an analysis that considers costs, you need to be sure that your model is

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

447

configured with the correct cost data. For more information on setting cost options, see Setting up model
costs on page 443.
Refer to the topics listed below for more information.

Cost files on page 447

Global costs on page 449

Cost files
Some cost data is specified directly in SynerGEE, through the Costs tab of the Model and Analysis Options
editor. Other cost data, however, is specified through external MiddleLink-formatted text files, known as cost
files. These text files are necessary for the detailed, item-by-item cost parameters required by certain
applications, such as facility selection.
The topics listed below contain information specifically on cost files. For more information on specifying other
cost data, see Global costs on page 449.

Cost file format on page 447

Creating a cost file on page 448

Editing a cost file on page 448

Selecting a cost file for analysis on page 448

Cost file format

Cost files are text files created in the MiddleLink format. A cost file typically contains MiddleLink records in the
7000 range, which is reserved for cost data.
The following example is a sample record from a MiddleLink cost file:
7001, 1/0 ACSR, , 3, 300, 60, 0.0, 0.0

In the MiddleLink schema, you can see that a 7001 record specifies the costs associated with a new line of a
certain conductor type. The sample record above indicates that the installation of a 1/0 ACSR three-phase
line costs $300,000 per mile for materials, and $60,000 per mile for installation costs, assuming English units.
No data is specified for recovery or maintenance costs.
Note that the monetary figures are in kilodollars-per-length units. The length component is represented by a
SynerGEE long unit of length (LUL), which is a mile in English units, and a kilometer in metric. Therefore, if
your interface is set to metric units, your cost data should also reflect metric units. Although dollar amount will
always be labeled as dollars in the interface, you could use any currency that fits your needs, provided that
it is used consistently throughout all of your cost data.

TO VIEW THE COST FILE SCHEMA

1

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, click Schemas and then select Supporting Data > Cost.

SynerGEE Electric 5.0

User Guide

448

SynerGEE Analyses

Creating a cost file

Because cost files use a text file format, you can create and edit them in any text editor. However, you may
find it more convenient to create and edit these cost files in SynerGEE. An auto-generated cost file normally
contains an extensive collection of sample lines that are commented out, so that you can uncomment the
applicable lines and follow the example to finish the data entry.

TO CREATE A COST FILE

1

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

In the Model and Analysis Options editor, select the Costs tab.

Under Detailed cost list, type a name for the cost file that you want to create.

Click Edit.

Click Yes to confirm that you want to create a new cost file. The new cost file is saved in your
Settings file directory, and opened in the SynerGEE Script Editor.
For information on locating and editing your Settings file directory, see Defining file paths on
page 167.

Use the SynerGEE Script Editor to modify the sample cost file that was created by SynerGEE. For
more information on using the Script Editor, see Using the Script Editor on page 725.

Editing a cost file

Perform the following file to edit an existing cost file.

TO EDIT A COST FILE

1

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

In the Model and Analysis Options editor, select the Costs tab.

Under Detailed cost list, if the cost file that you want to edit is not already shown, click the Browse
button to locate the file.

When the correct cost file is listed in the Detailed cost list, click Edit.

Use the SynerGEE Script Editor to modify the sample cost file that was created by SynerGEE. For
more information on using the Script Editor, see Using the Script Editor on page 725.

Selecting a cost file for analysis

The active cost file is selected in the Cost tab of the Model and Analysis Options editor. For more information,
see Setting up model costs on page 443.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

449

Global costs
Some costs, such as utility power and energy costs, are global in the model and do not require detailed itemby-item specifications. These costs are specified in the Costs tab of the Model and Analysis Options editor,
and should use units that are consistent with any applied detailed cost file. For more information, see Setting
up model costs on page 443.

PERFORMING AN ANALYSIS
In general, when SynerGEE performs an analysis, it performs the following steps:
1

Evaluates the model for data integrity and compliance. If there are data problems that might affect
the accuracy of analysis results, SynerGEE issues warnings as appropriate. If the problems are
severe enough, the analysis may be terminated altogether.

Performs the analysis. Depending on the complexity of the analysis, the size of your model, and the
speed of your computer, an analysis may take a few minutes, or it might only be a few seconds.

Produces analysis results. Analysis results are produced depending on how you have configured
your output options. For example, they might be presented in a report, or they may simply appear on
the map as annotations. For more information on analysis output options, see Setting analysis
output options on page 444.

In many cases, an analysis runs on selected feeders only. However, there are some exceptions, such as
contingency analysis which may look to adjacent, non-selected feeders for switching options. In addition, if a
subtran is selected, all connected feeders are included for analysis.

Re-running an analysis
SynerGEE allows you to re-run a previous analysis. The subsequent analysis run uses the current feeder/
section selection and analysis options and generates a new report, if enabled. Only the analysis type and
certain limited variations are remembered from the previous analysis.

TO RE-RUN AN ANALYSIS
1

In the SynerGEE ribbon bar, select the CONTROLS tab.

In the Report group, click Re-Run.

VIEWING ANALYSIS RESULTS

SynerGEE provides a number of tools for presenting analysis results. You can use these flexible and
powerful tools in a variety of configurations to suit nearly any presentation requirement.
The following tools are available for displaying results:

Reports. SynerGEE reporting is comprehensive and customizable. Written in HTML, analysis

reports are easy to read and navigate. And, because they are automatically saved to disk as HTML
files, they are portable, presentable, and printable. For more information, see SynerGEE Reports
on page 456.

SynerGEE Electric 5.0

User Guide

450

SynerGEE Analyses

Results import/export. SynerGEE provides a comprehensive results import/export feature. For more
information, see Importing and exporting analysis results on page 452.

Results tab. Most device editors include a Results tab, which provides a tabular view of current
analysis results for that device. For more information on the Results tab, see Viewing results in the
SynerGEE editor on page 156.

Map annotation. You can place results as annotation directly in the map display, allowing a more
topological view of results. For more information on configuring map annotation, see Adding section
and device annotation to the map display on page 207.

Map coloring. You can color sections in the map display based on ranges of analysis results. Map
coloring can be especially convenient for seeing a quick, overall view of model conditions. It can
also help you present technical results to a non-technical audience. For more information on
coloring the map, see Selecting a Coloring Scheme for Sections on page 216.

Results Viewer. You can view results for any analysis and for any facility with the Results Viewer.
The Results Viewer is a separate window that displays the results fields of your choice. For more
information on the Results Viewer, see Using the Results Viewer on page 451.

Broadcaster. The Broadcaster is a stand-alone SynerGEE window that shows results for a selected
category type such as Feeders, Large Customers, or Meters and a selected results type such
as Volts Into, Volts Out, or Pct Pf. For more information on the Broadcaster window, see Using the
Broadcaster on page 451.

Refer to the topics listed below for more information.

Suggestions for viewing analysis results on page 450

Using the Results Viewer on page 451

Using the Broadcaster on page 451

Importing and exporting analysis results on page 452

Suggestions for viewing analysis results

SynerGEE provides you with a number of options to configure and combine result output tools to best suit
your needs. The following table provides some suggestions that will give you an idea of the many available
possibilities. Of course, you are free to configure analysis results in any way that serves your objectives.
Situation

Suggestion

You are performing a study for

which your organization requires
a hardcopy record.

Turn on the reporting option in your output options, and print analysis
reports after they are generated. If the report type is HTML, it may
help to generate it without frames. For even greater accountability,
consider saving the report electronically in some archive. For more
information on managing report files, see SynerGEE Reports on
page 456.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

451

Situation

Suggestion

You are performing load-flow,

reliability, or other studies and
you want an overall view of
poorly performing areas.

Turn off the reporting option in your output options and set your
display settings to color the map by the desired index. As you run the
analysis, you will be able to see the colors update on the map, and
using the legend you will be able to determine what they mean. For
more information on coloring the map by results, see Selecting a
Coloring Scheme for Sections on page 216.

You are running multiple

analyses in between
configuration changes, and your
focus is on the behavior of one
particular regulator.

Turn off the reporting option in your output options and open the
editor for the regulator. Select the Results tab and you can watch the
regulator results update with each analysis run, such as tap positions.
For more information on the Results tab, see Viewing results in the
SynerGEE editor on page 156.

You are performing multiple

load-flow analyses in between
configuration changes and your
focus is on loading in a particular
area.

Turn off reporting in your output options and set your map to display
annotations of the applicable load-flow results parameters that
interest you. If your model is large, you can improve performance by
having annotations appear on queried sections only. For more
information on results annotations, see Adding section and device
annotation to the map display on page 207. For more information on
using the query set, see Using the Query Set on page 173.

Using the Results Viewer

The Results Viewer is a useful tool for browsing around the map display and in grid-formatted reports to see
fundamental results for all sections, equipment, and facilities. When you hover the mouse over any spot on
the map display or over any row in the grid-style report, the Results Viewer will display the analysis results for
that facility. Results fields can be selected in the Editor Results tab of the Output Options editor, as described
in Selecting which attributes are available in the Results Viewer on page 445.

TO OPEN THE RESULTS VIEWER

1

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Viewers group, click Results Viewer.

Tip:

You can also press F4 on the keyboard to open the Results Viewer.

Using the Broadcaster

The Broadcaster is a special SynerGEE window that shows results for multiple facilities in one location.
When using the Broadcaster, you first select the category type such as Feeders, Large Customers, or
Meters and then you select the results type such as Volts Into, Volts Out, or Pct Pf. Other options are
available from the Broadcaster window to zoom to and edit selected facilities.
Refer to the following procedure for more information on working with the Broadcaster window.

SynerGEE Electric 5.0

User Guide

452

SynerGEE Analyses

TO USE THE BROADCASTER

1

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Viewers group, click Broadcaster.

Use the Broadcaster window to perform the following tasks:

To ...

Do This ...

Select which results to view

in the Broadcaster

Use the options list in the upper-left side of the Broadcaster

window to select the category type that you want to view for
example, Feeders, Large Customers, or Meters. Then, use the
options list on the right side of the window to select the result
type that you want to view for example, Volts Into, Volts Out, or
Pct Pf.
The Marked Facilities category will show results for any
sections where you have selected the Broadcast check box in
the Section tab of the Section editor. For more information, on
selecting this option for a section, see Editing general data for a
section on page 280.

Only list facilities that are

visible in the map display
window

Select Just items in map view. The list of facilities will update
automatically as you zoom and pan in the SynerGEE map
display.

Highlight listed facilities with

circles in the map display
window

Select Show circles.

Edit a facility in the results

list

Select the facility that you want to edit, and then click Edit.

Zoom to a facility in the

results list

Select the facility that you want to zoom to, and then click Zoom.
If desired, you can select the Auto check box to automatically
zoom to each facility as you select it in the list.

Click the Hide button or press F4 to close the Broadcaster window.

Importing and exporting analysis results

SynerGEE provides an import/export tool for a wide variety of analysis results. Using this tool, you can import
and export analysis results with any supported database format, including enterprise databases. This feature
allows you to perform activities such as:

Transport analysis results to another application, such as drafting software, for viewing.

Collect results for custom queries, forms, and reporting.

Import results from another application or source into SynerGEE, perhaps to leverage SynerGEEs
flexible coloring and annotation features for viewing.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

453

In older versions of SynerGEE, you could have certain analyses automatically generate a results database.
This functionality has been retired and replaced with the newer import/export feature. The import/export
feature provides greater flexibility, a wider range of available results, and an architecture that is better
prepared for future expansion.
Refer to the topics listed below for more information.

Important information on results handling on page 453

Getting started with results import/export on page 453

Setting up DSAs for results import and export on page 454

Exporting results on page 455

Importing results on page 455

Reporting on results on page 456

Enterprise databases and results import/export on page 456

Important information on results handling

In SynerGEE, results are generated any time an analysis is run, and these results show up in places like your
map settings for coloring and annotation. Results are categorized by set, with each set containing relevant
results parameters. For example, LFlow_Balanced is a default load-flow results set that contains items such
as Amps_In and Volts_Out. In your map settings, then, you would see items such as LFlow_Balanced:
Amps_In and LFlow_Balanced: Volts_Out.
These results and their sets are all stored in binary files in your Output folder, and retrieved whenever
requested. They are not stored in memory. In the Output folder, each set has an associated BRF file with the
same name as the set. When you access these results though the interface, the appropriate BRF file is found
and read. For example, if you select to color by LFlow_Balanced: Amps_In, SynerGEE finds the
LFlow_Balanced.BRF file in your Output folder and retrieves the values for coloring. Otherwise, the values
are stored in these files only, and not in memory.
Therefore, when you import or export results, it is not a transaction with SynerGEEs memory. Rather, it is a
transaction between the results binary files in your Output folder, and the database involved with the import/
export. For example, when you import results, the data is written to a BRF file in the Output folder, which
SynerGEE can then access the next time you launch your map settings.
Importing results can overwrite an existing file or create a new one, depending on how you set your import
options.

Getting started with results import/export

The following general steps illustrate how you might conduct a results export and then an import. This
document makes no assumption about how you might use exported results, so these steps are broad in
nature and may vary according to your needs. You may not need to export results at all, if you are only
interested in importing, and have some means of preparing results outside of SynerGEE.

SynerGEE Electric 5.0

User Guide

454

SynerGEE Analyses
1

Set up DSAs for the export and/or import. For more information, see Setting up DSAs for results
import and export on page 454.

Run an analysis to produce some results. If you do not run at least one analysis, the applicable
results will not be available. For example, if you have not run any fault analyses, no fault results will
be available for export.

Export results. For more information, see Exporting results on page 455.

Manipulate, store, or otherwise manage the results outside of SynerGEE, however suits your needs.

Import results. For more information, see Importing results on page 455.

Produce a results report to verify the import. For more information, see Reporting on results on
page 456.

Annotate and/or color the map with the new results. For more information, see Adding annotation
based on analysis results on page 208.

Setting up DSAs for results import and export

Like all data import/export functions, SynerGEE uses DSAs to communicate with your external results
databases. For general information on DSAs, including how to create them, see Data Source Aliases
(DSAs) on page 75.
The type of DSA differs between exporting and importing, as follows:

Export. To export results, you should have a Results type DSA. During DSA creation, you should
specify a DSA name, a database format as the provider, and Results as the contents.

Import. To import results, you must have a Custom type DSA. A custom data source is any
database that has a table with a SectionId column. During DSA creation, you should specify a DSA
name, database format as the provider, Custom as the contents, and the specific table from which
you plan to import results.
Tip:

The database table name is important. When you import results with the DSA, you cannot
select a different table from the database. All results must come from this table, for this
particular DSA.

The reason for these two different DSAs for the same type of data is flexibility. The custom DSA for importing
allows you to import results generated from any source, not just SynerGEE. The only requirement is that the
source table has a SectionId column. For more information on creating DSAs to use custom content, see
Creating DSAs with custom content on page 80.
Tip:

User Guide

A DSA can have multiple content types. For example, you could create a single DSA to a certain
database called MyResults.mdb and specify its contents as both Results and Custom.

SynerGEE Electric 5.0

SynerGEE Analyses

455

Exporting results
TO EXPORT RESULTS
1

Perform the following steps to open the Export Results editor:

a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Results group, click Export.

Use the Export Results editor to edit the following settings:

Results set to export

The specific set of results to export. If you do not see the desired set
in the list, you may need to run the applicable analysis first to produce
some results.
Tip:

The items in this list reflect the BRF files found in your
Output folder. For more information on BRF files, see
Important information on results handling on page 453.

Data source to export

into

The DSA of the target file where the results should be written. For
more information, see Setting up DSAs for results import and export
on page 454.

Target table

The database table to receive the results, within the target file.

Writing options

Select from one of the following options to specify how to handle the
results table:

Append to table. Appends exported results to the end of

the target table. If a section ID within the exported data
matches a section ID already in the table, the data is
replaced, rather than appended.

Empty table if it exists. Before writing results, removes any

previous SynerGEE results. However, it does not remove
any other data, such as custom fields and columns you
might have in the table.

Replace table. Replaces the target table entirely. This

option will delete any customized data you might have in the
target table.

Click Finish to export the results.

Importing results
TO IMPORT RESULTS
1

Perform the following steps to open the Import Results editor:

a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Results group, click Import.

SynerGEE Electric 5.0

User Guide

456

SynerGEE Analyses
2

Use the Import Results editor to edit the following settings:

Data source to import
from

The DSA of the source file that contains the results. For more
information, see Setting up DSAs for results import and export on
page 454.

Target results set

The target results set. Upon import, SynerGEE will create a BRF file
in your Output folder that reflects this name, and the results contained
therein will be available for coloring and annotation.
It is important to understand that these results are moving to a binary
results file, not SynerGEEs memory. For a discussion on this
concept, see Important information on results handling on page 453.

Click Finish to import the results.

Reporting on results
The results manager includes a reporting mechanism to display the current results sets in memory. The
report contains all the results sets in memory, current with any imports you performed.

TO REPORT ON RESULTS
1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Results group, click Report.

Use the Report Results editor to select the result set that you want to view in the report.

Click Finish to close the editor and view the report.

Enterprise databases and results import/export

If you are using an enterprise database format for import/export, such as Oracle or SQL Server, the process
is mostly identical to that described in Getting started with results import/export on page 453. However, you
should be aware that when exporting results, SynerGEE will append the model name to the table name
specified in the export wizard. For example, if your enterprise model DSA specifies the model MyModel, and
the export wizard specifies the MyExportedResults target table, the target table will ultimately be called
MyModel_MyExportedResults. Therefore, if you are exporting results to an enterprise database, you should
remain conscious of the actual model that the DSA points to.

SYNERGEE REPORTS
SynerGEEs analysis reports are generally provided in two formats: a static HTML report style and a more
interactive grid-style report. The Output Options editor in SynerGEE provides you with several options to
control how the reports are generated.

User Guide

Grid-style reports. Grid-style reports provide a variety of options to customize the appearance and
content of the report. Most notably, you can control where in SynerGEE the report will appear
either docked on a specific side of the SynerGEE display, or free-floating in a window independent

SynerGEE Electric 5.0

SynerGEE Analyses

457

of SynerGEE, or in a tabbed window in the SynerGEE environment. You can select which data
columns are shown in the report, and you can use filtering tools to control what data is shown in the
report. Grid-style reports can be saved to HTML, CSV, or Excel, or database formats, where further
data manipulation can be done for a truly powerful reporting package.

HTML reports. HTML reports can only be displayed in a tabbed SynerGEE window. HTML reports
can also be generated with or without frames. Frame reports are generally better for online
navigation, while non-frame reports are better for printing and archiving. Although these reports are
static and cannot be modified from within SynerGEE, they can be viewed in any web browser and
can easily be copied to other file locations without the need to perform a specific save as or export
operation.

Many SynerGEE analysis reports include charts embedded in the chapters of the report. For example,
SynerGEEs time-based analyses, including the Summer and Winter Ratings analysis and the Single-Year
analysis, use charts instead of tables to show the results of the analysis. These report-based charts use the
same charting software as the stand-alone chart types that are discussed in SynerGEE Charts on
page 479.
As each report is generated, the report data is saved in your Output folder, which by default is a subfolder in
your SynerGEE documents folder. It is important to note that all existing files are automatically deleted from
the Output folder each time you start SynerGEE. If you want to save a report of any type, use the Save and
Export options that are available in SynerGEE when you are viewing the report. As long as you do not save
the report in the Output folder, the report will be available for future use outside of SynerGEE.
Refer to the topics listed below for more information on working with SynerGEE reports.

Generating analysis reports on page 457

Configuring report options on page 459

Adding notes to reports on page 460

Printing reports on page 460

Options, errors, and warnings in reports on page 460

Dockable reports on page 462

Grid-style reports on page 467

HTML reports on page 477

Non-analysis reports on page 477

Generating analysis reports

Use the Output tab in the Output Options editor to enable or disable the generation of analysis reports. Once
enabled, analysis reports will generate automatically with each new analysis.
If you select to generate reports, you can also specify how the reports are generated. For most reports, you
can select whether the reports are generated in dockable format or whether they are generated as traditional
tabbed windows in the SynerGEE environment. You can also control whether the reports are generated as
grid-style reports or as HTML reports, either with or without frames. HTML reports, however, can only be
generated as tabbed SynerGEE windows. They are not compatible with the dockable report feature.

SynerGEE Electric 5.0

User Guide

458

SynerGEE Analyses
Take note that some SynerGEE analyses and tools will always generate a report, even if you have disabled
the reporting option.
You can also use the Output tab of the Output Options editor to select whether to automatically update
annotation and coloring in the map display after an analysis is complete.
Refer to the following procedure for more information.

TO SELECT THE ANALYSIS REPORT FORMAT

1

Perform the following steps to open the Output Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Output.

In the Output Options editor, select the Output tab. The following table describes the different
options that you can set.
Generate Report

Select this option to have SynerGEE generate a report for all analysis
types. If this option is not selected, SynerGEE produces no analysis
reports at all. Take note that, because some analyses such as
contingency analysis have no value without the report, you should
take care when disabling the Generate report option.
Tip:

You can also toggle the Generate report option by clicking

on the light bulb indicator that located at the top of the
SynerGEE model explorer. When the light bulb is on
(yellow), reports will be generated. When the light bulb is
off (white), reports will not be generated.

If you select the Generate report option, you must also select the type
of report that SynerGEE will generate. The report types are described
in the table rows that follow.
For more information on SynerGEE reports, see SynerGEE Reports
on page 456.

User Guide

Prefer Grid Style (if

available)

Select this option to generate analysis reports in an interactive, gridstyle format. This format, which is available for most report types, is
described in detail in Grid-style reports on page 467. If you select
this option and a grid-style report is not available for a generated
report type, an HTML With Frames report will be generated.

Dockable Report
Window

Select this option to generate analysis reports in SynerGEEs

dockable window format. This check box is enabled when the Prefer
Grid Style option has been selected. The dockable report format,
which is available for most analysis reports, is described in detail in
Dockable reports on page 462.

HTML With Frames

Select this option to generate reports in an HTML format that uses

framed windows. This format is described in detail in HTML reports
on page 477.

SynerGEE Electric 5.0

SynerGEE Analyses

459

HTML Without Frames

Select this option to generate reports in an HTML format that does not
use framed windows. This format is described in detail in HTML
reports on page 477.

Update Coloring and

Annotation Results

Select this option to have SynerGEE update the map display after an
analysis is complete. You should leave this option selected under
most circumstances.

Click Apply to accept your changes, and then click X to close the editor.

Configuring report options

Use the Options tab in the Output Options editor to configure several options related to the generation of
SynerGEE reports. Refer to the following procedure for more information.

TO CONFIGURE REPORT OPTIONS

1

Perform the following steps to open the Output Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Output.

In the Output Options editor, select the Options tab. The following table describes the different
options that you can set.
Repeat table heading
every rows

For HTML tables, SynerGEE will reinsert the heading after the
number of rows specified here. Repeating the table heading row
allows you to scroll through long tables without losing track of what
data is contained in each column.
This option does not apply to grid-style reports.

Show Reports in the

Default Internet
Browser

Select this option to generate SynerGEE reports in an external

window using your default Internet browser.

Only Show Items with

Exceptions

Select this option to only show records in analysis reports that include
exceptions.

This option does not apply to grid-style reports.

When this option is selected, SynerGEE grid-style reports will include

the phrase Showing chapters with exceptions above the reports
table of contents. Although HTML-style reports will not include this
phrase, they will show the same exceptions-only data as the gridstyle reports.
When this option is not selected, you can still toggle individual gridstyle reports to show exception data only. For more information, see
Managing the content of a grid-style report on page 470.
3

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

460

SynerGEE Analyses

Adding notes to reports

Use the Notes tab of the Output Options editor to create messages that you would you would like to appear
with each analysis report. You can set up a default note that will appear in all analysis reports, or you can
have SynerGEE prompt you to create or modify the note with each analysis run. The note appears as the last
line in the Run Summary section of the report.

TO ADD NOTES TO REPORTS

1

Perform the following steps to open the Output Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Output.

In the Output Options editor, select the Notes tab. The following table describes the different options
that you can set.
To ...

Do This ...

Add a default note to

each SynerGEE report

Click the Show Notes check box.

Use the text area to type the note that you want to include
with each analysis report.

Prompt the user to

create a note for each
SynerGEE report

Click the Show Notes check box and also click the Prompt
For Notes Before Each Analysis check box.

If desired, use the text area to type default text for your
analysis report notes. You will be given the opportunity to
modify this text when you start an analysis.

Click Apply to accept your changes, and then click X to close the editor.

Printing reports
Reports can be printed in the same way as any other SynerGEE view. To print a report or to configure your
printing options for tabbed-window reports, click on the Pole icon at the left end of the ribbon bar and select
the Print option. To print a report or to configure your printing options for dockable reports, click the Printer
icon in the report toolbar and select the appropriate option.
Printed reports may not always appear exactly as they do on the screen or as they do during a print preview.
This may occur for several reasons, including the differences between printers and configurations.
For more information on printing in SynerGEE, see Printing on page 178.

Options, errors, and warnings in reports

At the beginning of HTML and grid-style reports, SynerGEE normally lists:

Errors, warnings, and messages

Pertinent options affecting the analysis

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

461

This information can be useful for tracking down problems. It can also help you remember the conditions
under which an analysis was performed, especially if you are viewing the report again at a later date.

Figure 8-1 Top portion of a report, showing warnings and messages

Use the Warnings tab in the Model and Analysis Options editor to suppress selected warning types from your
analysis reports. Refer to the following procedure for more information.

TO SUPPRESS REPORT WARNINGS

1

Perform the following steps to open the Model and Analysis Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

In the Model and Analysis Options editor, select the Warnings tab.

Select the check box for each warning type that you want to disable in your analysis reports. The
warnings that you can disable include the following:

Missing capacitor nominal voltage

Single ph grounded line feeding delta

Open switch tied to unfed node

Section is less than 5 ft long (network only)

Loop tie point at end of section

Section length

Section height

Could not find neutral conductor in warehouse

Unspecified neutral conductor

Recloser missing manuf. model or rating data

Actual impedance line on detail configured section

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

462

SynerGEE Analyses

Dockable reports
SynerGEEs dockable reports allow you to anchor grid-style reports inside the SynerGEE environment in any
location that you prefer -- at the top of the application window, or the bottom, or the left side or the right side,
or in any combination of these positions when you are viewing multiple reports. Figure 8-2 shows a typical
dockable report configuration, where two reports have been docked on the right-side of the SynerGEE
window and the SynerGEE map display is shown on the left. Unlike traditional reports, the dockable report
feature allows you to see both report content and the map display at the same time. You can move the
borders of the docked windows to resize and reposition the report areas and the map display area to best suit
your personal preferences.

Figure 8-2 SynerGEE dockable reports

Only grid-style reports can be viewed in the dockable report environment, and the full functionality of gridstyle reports, as described in Grid-style reports on page 467, is available in the dockable format. The
following sections describe several topics that are specific to working with dockable reports.

Enabling dockable reports on page 462

Docking analysis reports on page 463

Using the auto-hide feature on page 466

Enabling dockable reports

Dockable reports are enabled from the Output tab of the Output Options editor. Refer to the following
procedure for more information.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

463

TO ENABLE THE DOCKABLE ANALYSIS REPORTS

1

Perform the following steps to open the Output Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the settings group, click Output.

In the Output Options editor, select the Output tab.

Select Generate Report, and then Prefer Grid Style, and then Dockable Report Windows.

Click Apply to accept your changes, and then click X to close the editor.

Docking analysis reports

Perform the following procedure to dock an analysis report, or to change the docking position of an analysis
report. Note that SynerGEE remembers your docking position as you generate and close reports, and close
and restart SynerGEE. Once you have docked a report in a preferred location, additional reports will be
generated in that same location using multiple report window tabs.

TO DOCK AN ANALYSIS REPORT

1

Generate the report that you want to dock.

Click and hold the title bar of the report, or the reports tab name if you have multiple reports
generated and you only want to move one report. Anchor position symbols will appear in the
SynerGEE application, indicating the various positions where you can dock the report. This is shown
in Figure 8-3.

Figure 8-3 Anchor positions for a dockable report

SynerGEE Electric 5.0

User Guide

464

SynerGEE Analyses
3

Drag the report on top of one of the anchor positions and release the mouse button.

Any additional reports are generated in the same area where you last docked a report, with each
report separated by tabs. You can move any report at any time to any docking position, or move the
report to a free floating window. Figure 8-4, for example, shows the anchor positions when one
report has already been docked in the right-side of SynerGEE and a second report is being dragged
to a new location.

Figure 8-4 Anchor positions for a second dockable report

Note in Figure 8-4 that there are four external anchoring positions located around the edges of the
screen, as well as a single anchor control in the middle of the existing report area. The four external
positions are used to anchor the report relative to the entire SynerGEE window. Figure 8-5 shows
the result when the second report is docked using the single anchor control at the bottom of the
screen, where the report spans the entire bottom of the entire application.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

465

Figure 8-5 Multiple Docked Reports Example 1

By comparison, Figure 8-6 shows the result when the second report is anchored using the bottom
position in the center anchor control. In this case, the second report is docked immediately below
the first report, but not below the map window.

Figure 8-6 Multiple Docked Reports Example 2

SynerGEE Electric 5.0

User Guide

466

SynerGEE Analyses

Using the auto-hide feature

The auto-hide feature for dockable reports allows you to expand and collapse the reports simply by hovering
the mouse over the report name. When the report is expanded, you can work in the report just like you would
with any other grid-style dockable report. When the report is collapsed, you have the benefit of using the
SynerGEE map display and other traditional tabbed windows within the full available space of the
SynerGEE application.
Refer to the following procedure for information on enabling and disabling the auto-hide feature.

TO AUTO-HIDE A DOCKED REPORT

1

On the right end of the title bar for a docked report, click the pin icon, as shown in Figure 8-7.

Figure 8-7 Pin button, dockable report window

When in pin mode, the report will automatically collapse against the appropriate side of the
SynerGEE window, as shown in Figure 8-8. To expand the report, move the mouse cursor over top
of the report name. Once expanded, you can work in the report as you normally would. The report
will collapse when you click anywhere outside of the report area.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

467

Figure 8-8 Report tab name for collapsed dockable report

To exit auto-hide mode, expand the report and click the pin icon.

Grid-style reports
Grid-style reports provide a number of interactive features that you can use to customize the report. They are
designed to appear similar to the HTML reports, but unlike HTML reports, you have significant control over
the appearance and content of a grid-style report, and you can use the customization features to configure
each individual report chapter as necessary to best suit your needs. For example, you can:

Customize the physical appearance of the report by editing colors and fonts, and saving those
settings to chapter-based template files.

Arrange, sort, filter, and show and hide individual data columns in many reports.

Use right-click menu shortcuts to edit, zoom to, and highlight devices and sections included in the
report.

Use right-click menu shortcuts to open and close switches directly from the report view.

Save the reports as HTML, CSV, and XLS (Microsoft Excel) formats.

Export specific chapters from the report to a database for further manipulation or sharing.

Refer to the topics listed below for more information.

Editing the appearance of a grid-style report on page 468

Managing the content of a grid-style report on page 470

Coloring report data in the SynerGEE map display on page 472

SynerGEE Electric 5.0

User Guide

468

SynerGEE Analyses

Using grid-style reports to generate a scatter-plot graph on page 473

Saving a grid-style report on page 473

Exporting a grid-style report to Microsoft Excel on page 474

Exporting a grid-style report to a database on page 475

Working with sections and devices included in grid-style reports on page 476

Editing the appearance of a grid-style report

You can customize many aspects of a reports physical appearance, including its colors, fonts, and line
styles, using the reports Chapter Properties editor. These settings are saved in report template files. Each
chapter of each report has an individual template file, and a master template also exists that can be applied to
any chapter report.
In the Chapter Properties editor, you select whether you want to apply the master template or the chapter
template to the report. You can then use the Chapter Properties editor to customize the appearance of the
report, but whether those settings get saved with the template depend on which of the templates you are
editing.

Master template. If you apply the master template to a report and then edit settings for that report,
the new settings are applied to the current report. But they are not saved automatically to the master
template, nor are they applied automatically to other report chapters that also reference the master
template. You must specifically save the settings to the master template file and then regenerate the
report window before you see your changes take effect. If you do not save the master template, the
modified settings will be lost when you close the report window.
The master template is saved by default as an XML file in your Settings file directory. The name of
the master template file is Default_ReportSet.xml.
For information on locating and editing your Settings file directory, see Defining file paths on
page 167.

Chapter template. If you apply the chapter template to a report and then edit settings for that report,
the new settings are applied to the current report only. The modified settings are saved to the
chapter template file as soon as you close the report window, and they are reapplied to that report
chapter as long as the Use Chapter Template option is selected in the Chapter Properties editor.
The chapter template is saved by default as an XML file in your Settings file directory. Each report
chapter has a 5-digit number that is associated with the report; that number can be seen in the
upper-right corner of the report that you are viewing. The name of the chapter template file is
12345_ReportSet.xml, where 12345 is the 5-digit number that is associated with each report
chapter.
For information on locating and editing your Settings file directory, see Defining file paths on
page 167.

You should note that some chapter reports have subchapters, and that subchapters do not have their own
template files. For example, the load-flow report includes a Balanced Results chapter, and the Balanced
Results chapter includes different subchapters for each analyzed feeder. In this case, all subchapters use the
same report settings as the main chapter template. You can see this because each subchapter has the same
5-digit number associated with it 42000. Thus, if you modify the settings for one subchapter, you are
actually modifying the settings for all subchapters. However, keep in mind that the chapter template is not

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

469

saved until you close the report window. Therefore, even though you may edit the settings for one of these
subchapters, you will not see those changes take effect for the other subchapters until you close and
regenerate the report window.
Refer to the procedures listed below for more information.

To edit and save a chapter report template on page 469

To edit and save a master report template on page 469

To restore a chapter report template to the master template defaults on page 470

To restore the master report template to the original SynerGEE defaults on page 470

TO EDIT AND SAVE A CHAPTER REPORT TEMPLATE

1

Display the report and report section that you want to edit.

Right-click and select Properties.

In the Chapter Properties editor, select Use Chapter Template.

Use the Fonts, Colors, and Miscellaneous tabs in the Chapter Properties editor to edit the color
properties, font properties, and line settings for the report chapter that you are viewing. The options
that you can edit are self-explanatory and thus not repeated here. The preview display in the
Chapter Properties editor shows the change that each edit will make to the report.

Click OK to accept your changes and close the editor.

Close the report window. Note that the changes you made to the report chapter will not be saved to
the template until you close the report window.

TO EDIT AND SAVE A MASTER REPORT TEMPLATE

1

Display the report and report section that you want to edit.

Right-click and select Properties.

In the Chapter Properties editor, select Use Master Template.

Use the Fonts, Colors, and Miscellaneous tabs in the Chapter Properties editor to edit the color
properties, font properties, and line settings for the report chapter that you are viewing. The options
that you can edit are self-explanatory and thus not repeated here. The preview display in the
Chapter Properties editor shows the change that each edit will make to the report.

Click OK to accept your changes and close the editor.

In the SynerGEE ribbon bar, select the CONTROLS tab.

In the Master Template group, click Save.

Tip:

You can also right-click in the report window of the desired report chapter and select Save
to Master Template.

Note that the changes will not be reflected in other report chapters until you close and regenerate
the report window. Only those chapters that are assigned to use the master template (in the Chapter
Properties editor) will be updated to use the new master template edits. Reports that are assigned to
use the chapter report template will still use the chapter-specific settings.

SynerGEE Electric 5.0

User Guide

470

SynerGEE Analyses

TO RESTORE A CHAPTER REPORT TEMPLATE TO THE MASTER TEMPLATE DEFAULTS

The chapter report template is saved by default as an XML file in your Settings file directory. Each report
chapter has a 5-digit number that is associated with the report; that number can be seen in the upper-right
corner of the report that you are viewing. The name of the chapter template file is 12345_ReportSet.xml,
where 12345 is the 5-digit number that is associated with each report chapter.
For information on locating and editing your Settings file directory, see Defining file paths on page 167.
To restore a chapter report template to its original settings, you can locate the XML file for the report chapter
template and delete it from your Settings directory. When you next view the report, SynerGEE will apply the
master template settings, since no chapter template can be found.

TO RESTORE THE MASTER REPORT TEMPLATE TO THE ORIGINAL SYNERGEE DEFAULTS

1

Display the report and report section that you want to edit.

Right-click and select Master Template > Reset.

Managing the content of a grid-style report

SynerGEE provides for a limited amount of control over the content of a grid-style report, even after the report
is generated. For example, you can:

Customize which data columns are displayed in the report

Filter the data that is included in the report

Add your own content to the report, including mathematical expressions

Refer to the following procedure for more information.

TO MANAGE THE CONTENT OF A GRID-STYLE REPORT

1

Run the analysis that generates the grid-style report that you want to view, and then select the name
of the report chapter that you want to edit.

Perform any of the following tasks.

To ...
Hide and restore data
columns

Resize a data column

User Guide

Do This ...
a

Right-click on any column header in the report you want

to edit.

Use the check boxes in the resulting list to select which

columns you want to display and hide.

Place the mouse cursor between two column headers. The

cursor will change to a two-sided arrow. Click and drag the
mouse to create the new column width, and then release the
mouse button.

SynerGEE Electric 5.0

SynerGEE Analyses

471

To ...

Do This ...

Filter data

Click in the filter area and type the text to filter for, and then click
the Filter button. Delete the text you typed and click the Filter
button again to remove the filter. The filter field is not casesensitive.

Sort data

Add a custom row

Open and close switches

SynerGEE Electric 5.0

< or > will filter for items greater or less than the given
value.

!= will filter for items that do not equal the given value.

* is a wildcard filter that will filter for results that contain

the given syntax anywhere in its name or value.

Click on a column header to sort the data on that column. The

data will be sorted alphabetically or numerically, depending on
the data that is contained in the column. Click the column header
again to reverse the sort order.
a

Right-click on any row in the report you want to edit.

Select Insert Row.

Enter the desired information in the new row, noting the

following:
-

Custom information is not saved. It will not

appear in future reports.

Grid-style reports support spreadsheet-type

mathematical expressions. For example, to
add the first 19 items of column A, you might
enter something like =SUM(A2,A20). To assist
you with these expressions, you can hover the
mouse over any cell and read the cell name in
the status bar, located in the lower-left corner
of the SynerGEE window.

Open the switches report and select a switch from the

list.

Click the Switch Device button. The switch opens or

closes, as appropriate.

User Guide

472

SynerGEE Analyses

To ...

Do This ...

View exception data only

From a tabbed SynerGEE report window:

a

In the SynerGEE ribbon bar, select the EDIT tab.

In the Format group, click Only Show Exceptions.

From a dockable SynerGEE report window:

a

Click the General Report Operations toolbar button.

Figure 8-9 General Report Operations toolbar button

Select Only Show Exceptions.

You can also use the Output Options editor to generate reports
that show exception data only. The phrase Showing chapters
with exceptions will appear above the reports table of contents
when this global option is selected. Take note that when you
generate a report in this manner, toggling the Only Show
Exceptions option described here in this table row will have no
effect on the report. In other words, it will not toggle the report to
show all data, since only exception data was generated in the
first place.
For more information on setting the global Only Show Items with
Exceptions option, see Configuring report options on
page 459.

Coloring report data in the SynerGEE map display

From a grid-style report, you can right-click on a selected group of cells in a column and select Map Selected
Cells. This option will color those sections and devices in the SynerGEE map display, based on the values in
those cells. For example, if you select a group of cells in the Amps (Bal) column of a load-flow report, any
sections applicable to those selected values will be automatically colored according to those values.
When you perform this function, SynerGEE creates a results set from the selected values and changes your
map settings to Color By Results. It also automatically sets up the ranges for the coloring based on the
selected values, and applies colors as defined in the Theme tab of the Map Settings editor. Any sections not
included in the selection set will receive the Out Of Range color. If you have cells in multiple columns
selected, SynerGEE creates a results set for each affected column, and applies coloring based on the first
(leftmost) column.
For information about results and results sets, see Important information on results handling on page 453.
To get an idea of how SynerGEE alters your map settings after selecting Map Selected Cells, look at the
Theme tab of the Map Settings editor after performing this procedure.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

473

TO USE A GRID-STYLE REPORT TO APPLY COLOR TO THE MAP DISPLAY

1

Run the analysis that generates the grid-style report that you want to view, and then select the name
of the report chapter that you want to view.

From the report window, use the mouse to highlight the data cells that you want to view in the map
display.

Right-click and select Map Selected Cells.

Using grid-style reports to generate a scatter-plot graph

You can generate scatter-plot graphs from the content of a grid-style report. The resulting graph depends
somewhat on the nature of the selected cells. If a single column is selected, the values of the column are
plotted on the Y axis, with row numbers on the X axis. If multiple columns are selected, SynerGEE generates
a composite graph that incorporates all ranges of selected values, and provides a legend to help you see
what the plots represent. Composite graphs are generally useful for simple trend visualization, rather than a
detailed view of the results.
The order of data in a graph depends on the order of the data in the report. Keep in mind that grid-style
reports provide many features for reordering data, including showing, hiding, and moving columns, and
sorting and filtering data.
Graphs cannot be saved. To preserve a graph image, use the print screen feature on your computer to
capture an image of the graph and paste it in a graphics editor.

TO CREATE A SCATTER-PLOT GRAPH FROM A GRID-STYLE REPORT

1

Run the analysis that generates the grid-style report that you want to view, and then select the name
of the report chapter that you want to view.

From the report window, use the mouse to highlight the data cells that you want to graph.

Right-click and select Graph Selected Cells.

Saving a grid-style report

To preserve report data for later use, you can save the report to HTML or CSV file format. Refer to the
following procedures for more information.

TO SAVE A GRID-STYLE REPORT

1

Perform the following steps to open the Report Export editor:

From a tabbed SynerGEE report window:
a

In the SynerGEE ribbon bar, select the CONTROLS tab.

In the File group, click Export.

From a dockable SynerGEE report window:

SynerGEE Electric 5.0

User Guide

474

SynerGEE Analyses
a

Click the Open and Export Reports toolbar button.

Figure 8-10 Open and Export Reports toolbar button

Select Export.

In the Report Export editor, use the list area to select the report chapters that you want to export.
The report chapter that you were viewing when you clicked the Export button will be automatically
selected.

You can save the report to HTML format, CSV format, or both HTML and CSV formats at the same
time. Refer to the following table for more information.
To ...
Save the report to HTML
Format

Save the report to CSV

Format

Do This ...
a

Select the HTML check box.

Select the Use Frames check box if you want to save

the HTML files using the HTML frames concept.
Selecting this option will save multiple HTML output
files. To locate the main HTML file, look for the HTML
file named [report].html, where [report] is the name that
you specify in the Path text box. If you want to copy the
HTML report to another directory or computer,
remember to copy all associated HTML files along with
the main HTML file.

If you are not saving a frame-style HTML report, select

the Include Table of Contents check box if you want to
add an HTML table of contents to the saved HTML file.
If you are exporting multiple report chapters, the Table
of Contents can be helpful in navigating to the different
sections of report data.

Use the Path text box to specify the location and file
name of the saved HTML file.

Select the CSV check box.

Use the Path text box to specify the location and file
name of the saved CSV file.

Click Finish to export the report to the specified file formats.

Exporting a grid-style report to Microsoft Excel

Perform the following procedure to export a grid-style report directly to Microsoft Excel. SynerGEE will create
an XLS file in your Output file directory with a default file name. In Excel, you can perform a Save As action

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

475

to rename the file and move it to a new folder location. Only the active report chapter can be exported to
Excel in this manner.
For information on locating and editing your Output file directory, see Defining file paths on page 167.

TO EXPORT A GRID-STYLE REPORT DIRECTLY TO MICROSOFT EXCEL

From a tabbed SynerGEE report window:
1

In the SynerGEE ribbon bar, select the CONTROLS tab.

In the File group, click Open in Excel.

From a dockable SynerGEE report window:

1

Click the Open and Export Reports toolbar button.

Figure 8-11 Open and Export Reports toolbar button

Select Open in Excel.

Exporting a grid-style report to a database

Grid report chapters can be exported directly to a database table, enabling you to move large amounts of
data directly from SynerGEE to an external database table, such as Access. This gives you the ability to
manipulate data within the database environment and allows you to use and share the database table for
other tasks.
You must have a DSA configured as a Results data source to export the report data to a database. For
more information, see Data Source Aliases (DSAs) on page 75.

TO EXPORT TO A DATABASE
1

Perform the following steps to open the Report Export editor:

From a tabbed SynerGEE report window:
a

In the SynerGEE ribbon bar, select the CONTROLS tab.

In the File group, click Export to Database.

From a dockable SynerGEE report window:

a

Click the Open and Export Reports toolbar button.

Figure 8-12 Open and Export Reports toolbar button

SynerGEE Electric 5.0

User Guide

476

SynerGEE Analyses
b

Select Export to Database.

In the Export Report editor, select the DSA that you want to use to export the data. If desired, you
can click the ... button to specify a new database file. SynerGEE will prompt you to create a DSA if
you select this option.

Under Writing options, select from one of the following:

-

Append to table. Select this option to append new data to the end of an existing table in
the database.

Empty table. Select this option to add the new data into an empty table if there is one
available.

Replace table. Select this option to replace an existing table with the new data.

Use the Target Table text box to specify the name of the database table that you want to append,
create, or replace.

Click Finish to export the data to the specified database.

Working with sections and devices included in grid-style

reports
Many fields in the grid-style reports offer shortcuts for editing, navigating to, and interacting with sections and
devices in your model. To access these shortcuts, simply right-click on any section or device name in a
report. The available shortcuts will vary according to where you performed the right-click, and they can be
used for a variety of useful reasons. For example, you could:

Open the editor for an overloaded fuse on a report, perhaps to check the rating.

Quickly step through a suggested recovery plan produced by contingency analysis to evaluate its
feasibility.

Quickly zoom to a section or device listing in an error or warning to find and correct the problem.

The following list provides some of the options that are available from the right-click menu of a grid-style
report.

Find. Use this option to search for other occurrences in the report of the selected text (that is, the
text where you right-clicked). Take note that this option does not provide access to the SynerGEE
search tool.

Copy. Use this option to copy the selected text in a report and add it to the clipboard.

Edit. Use this option to open the editor for the selected section or device.

Zoom. Use this option to automatically switch to the map display window and zoom to the location
of the selected section or the parent section of the selected device.

Add to Query. Use this option to add the selected section to the query list.

Zoom Feeder. Select this option to automatically switch to the map display window and zoom to the
boundary of the feeder that contains the selected section or device.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

477

Add {section or device} to TCC. Select this option to add the conductor damage curve (or device
protective curve) to the TCC window. If the TCC window is not currently open, SynerGEE will create
a new one.

HTML reports
HTML reports are area always generated for some SynerGEE reports, and can optionally be generated for all
SynerGEE reports. When HTML reports are generated, they are stored automatically in your Output folder,
which by default is a subfolder of your SynerGEE documents folder. The HTML files can easily be copied to
other file locations and can be viewed in any web browser, independent of SynerGEE.
You can use the Output tab of the Output Options editor to specify whether SynerGEE will generate HTML
reports with or without frames. Frames are an HTML feature that allow multiple windows within a particular
frameset, with individual contents in each frame. SynerGEE HTML reports typically have a frame on the left
side of the screen that provides links to the report content, which is displayed in a frame on the right side of
the screen. Frame reports are generally better for online navigation, but non-frame reports are better for
printing and archiving.
Whether you view the HTML report with or without frames, keep in mind you are viewing a static HTML
window, no different than if you are viewing an HTML page in a web browser. Therefore, the HTML reports do
not offer any of the customization options that are available with the grid-style reports.

Non-analysis reports
SynerGEE includes a collection of miscellaneous reports designed to help you manage your model and its
associated data. Refer to the topics listed below for more information.

Breaker Zone 1 report on page 477

Digest report on page 478

Feeder Tie Path report on page 478

Line construction report on page 479

Zones report on page 479

Breaker Zone 1 report

The Breaker Zone 1 report lists all protective devices fed by a breaker. These zone 1 devices have their
name & section, voltage, load current, impedance values, and fault levels listed.
Perform the following procedure to view the Breaker Zone 1 report.

TO VIEW THE BREAKER ZONE 1 REPORT

1

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Tools group, click Breaker Zone 1.

SynerGEE Electric 5.0

User Guide

478

SynerGEE Analyses

Digest report
The SynerGEE Digest report is a comprehensive reporting mechanism for topology, construction, and data
issues in your model. The report is divided into a number of subreports, which in turn are divided into a
number of chapters. You can view the subreports and chapters by clicking on the names on the left side of
the report window. The Digest report includes the following subreports:

Inventory. The Inventory subreport provides a complete inventory of your facilities, including certain
key data items about them.

Topology. The Topology subreport provides a comprehensive look at your model from a topology
and connectivity standpoint. You can see node information, equipment locations, section
orientation, and much more.

Check Data. The Check Data subreport provides a detailed sweep of your model for data issues.
This report is your best resource for locating and fixing data problems that may be causing analyses
to fail or under perform. For more information on the check data report, see Check Data report on
page 137.

Loads. The Loads subreport provides a summary of loads in the model, including distributed, spot,
large customers, and projects load.

Results. The Results subreport provides a summary of analytical results for sections and
equipment. These reports require that you run the applicable analysis first, normally a load-flow and/
or fault analysis. They present much of the same information as a normal analysis report, except in
a more summarized format.

Multi-Year. The Multi-Year subreport displays brief comparative summaries of multi-year data
results. Useful in comparing overall construction and performance over the course of the modeled
years.

Feeder Details. The Feeder Details subreport displays feeder and subtran information, such as
amp rating, positive sequence rating, and more in one centralized location.

Prot. Curve Defs. The Protection Curve Definitions subreport provides a detailed tabular view of all
the curves contained in the SynerGEE protection database. Organized by device type, the report
includes items such as model numbers, ratings, and curve types for each item in the database.
Since the protection database includes over 10,000 curves, this report can be quite large.

Perform the following procedure to view the Digest report.

TO VIEW THE DIGEST REPORT

1

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Worksheets group, click Digest.

Feeder Tie Path report

The Feeder Tie Path report lists the switching summary, transfer path, and conductor paths for the feeder.
Perform the following procedure to view the Feeder Tie Path report.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

479

TO VIEW THE FEEDER TIE PATH REPORT

1

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Reports group, click Feeder Tie Path.

Line construction report

The Line Construction report provides detailed information on the various conductor configurations in your
model. Based on the conductors assigned by phase and spacing values throughout the model, the report
evaluates each possible different configuration for admittance and impedance characteristics. It also reports
the total distance of each configuration, along with how many sections are included and what they are.
Perform the following procedure to view the Line Construction report.

TO VIEW THE LINE CONSTRUCTION REPORT

1

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Model QA group, click Line Construction.

Zones report
The Zones report provides a detailed look at zone characteristics and implementation in your model. The
report includes the following items:

Total distance and makeup of each exposure zone

Overall root cause contributions

Total distance of each customer zone

Total kVA assigned to each customer class

Perform the following procedure to view the Zones report.

TO VIEW THE ZONES REPORT

1

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Model QA group, click Zones.

SYNERGEE CHARTS
SynerGEEs custom chart feature can be used to create charts showing data from any results set or any
results type that is available in the SynerGEE editor. You can customize a wide variety of chart features, from
the title name to the font sizes to the use of color and axis lines.
Take note that in addition to the custom reports described in this section, many SynerGEE analysis reports
also include charts embedded in the chapters of the report. For example, SynerGEEs time-based analyses,
including the Summer and Winter Ratings analysis and the Single-Year analysis, use charts to show the
results of the analysis. These report-based charts use the same charting software as the stand-alone chart

SynerGEE Electric 5.0

User Guide

480

SynerGEE Analyses
types and can be modified, exported, and printed following the same instructions discussed in the topics
listed below.
Refer to the topics listed below for more information.

Opening the chart window on page 480

Creating custom charts on page 480

Modifying a chart on page 483

Exporting a chart image on page 483

Printing a chart on page 483

Closing an individual chart on page 484

Closing the chart window on page 484

Opening the chart window

All charting tasks are performed from the chart window. Refer to the following procedure for instructions on
how to open the chart window.

TO OPEN THE CHART WINDOW

1

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Chart.

Creating custom charts

Custom charts allow you to create bar, pie, line, and scatter charts that show data from any results set or any
results type that is available in the SynerGEE editor. Custom charts can be saved as XML files in your
Settings file directory, organized by a user-specified group category and then by chart name. The file name
format for the custom chart file is <groupname>__<chartname>__ChartSet.xml. For information on locating
and editing your Settings file directory, see Defining file paths on page 167.
Refer to the procedures listed below for more information on creating and editing custom charts.

To create or edit a custom chart on page 480

To save a custom chart on page 482

To load a custom chart on page 482

To delete a custom chart on page 482

TO CREATE OR EDIT A CUSTOM CHART

1

User Guide

If you have not already done so, perform the following steps to open the chart window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Chart.

SynerGEE Electric 5.0

SynerGEE Analyses

481

If you are editing an existing chart, use the Groups and Charts fields in the upper-left corner of the
chart window to select and load the chart you want to edit. For more information, see To load a
custom chart on page 482.

Use the fields on the left side of the Chart window to configure the custom chart. The following table
describes the process for setting up each custom chart type.
Bar Chart

Pie Chart

Line Chart

Scatter Chart

Select the Bar Chart icon.

Under Category, select the results type or device type

that you want to view in the custom chart.

Under Data, select the data type that you want to view
in the custom chart.

If desired, use the Min and Max range to customize the

range of data for each bar within the bar chart. By
default, the Min and Max range will be pre-populated
with an even distribution of values ranging from the
minimum to maximum value for the selected data type.

Select the Pie Chart icon.

Under Category, select the results type or device type

that you want to view in the custom chart.

Under Data, select the data type that you want to view
in the custom chart.

If desired, use the Min and Max range to customize the

range of data for each wedge within the pie chart. By
default, the Min and Max range will be pre-populated
with an even distribution of values ranging from the
minimum to maximum value for the selected data type.

Under Type, select the Line Chart icon.

Under Category, select the results type or device type

that you want to view in the custom chart.

Under X Axis and Y Axis, select the data type that you
want to view on the X-axis and Y-axis of the custom
chart.

Under Type, select the Scatter Chart icon.

Under Category, select the results type or device type

that you want to view in the custom chart.

Under X Axis and Y Axis, select the data type that you
want to view on the X-axis and Y-axis of the custom
chart.

If you are creating a new chart, click New. A new chart window will open showing the edits you have
made.

SynerGEE Electric 5.0

User Guide

482

SynerGEE Analyses
or
If you are updating an existing chart, click Update. The current chart window will be updated to
reflect the edits you have made.

TO SAVE A CUSTOM CHART

1

If you have not already done so, perform the following steps to open the chart window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Chart.

Use the fields on the left side of the chart window to create a custom chart. See Creating custom
charts on page 480 for more information.

In the upper-left corner of the chart window, next to Groups, select the name of an existing group if
you want to save the custom chart to that group, or type the name of a new group if you want to
save the custom chart to a new group. (The group is a simple way to help you organize your saved
charts.)

Next to Charts, type the name of the chart you want to save, or select an existing saved chart if you
want to replace that chart.

Click Save. If you are replacing a saved chart, click Yes to confirm the action.

TO LOAD A CUSTOM CHART

1

If you have not already done so, perform the following steps to open the chart window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Chart.

In the upper-left corner of the chart window, next to Groups, select the name of the group that
includes the saved chart that you want to load. (The group is a simple way to help you organize your
saved charts.)

Next to Charts, select the name of the chart that you want to load.

Click Load. The saved chart will load in a new chart window, identified by the tab name on the right
side of the chart.

TO DELETE A CUSTOM CHART

1

If you have not already done so, perform the following steps to open the chart window:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Chart.

In the upper-left corner of the chart window, next to Groups, select the name of the group that
includes the saved chart that you want to delete.

Next to Charts, select the name of the chart that you want to delete.

Click Delete, and then click Yes to confirm the deletion. If you delete the last chart in a group, the
group will be deleted as well.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

483

Modifying a chart
SynerGEEs charting windows allows for a variety of ways that you can modify a chart. Some of these options
are available from the CONTROLS tab in the SynerGEE ribbon bar, while a larger number of options are
accessible through the right-click menu on the Chart window, or the chart Properties editor.
This User Guide does not attempt to document all of the options that are available, nor all of the ways you
can set them. Most of the options are self-explanatory. For example, the Font Size option can be used to
change the size of all fonts in the current Chart view. The Font Size option is available in the CONTROLS tab
of the SynerGEE ribbon bar, in the in the chart window right-click menu, and in the General tab of the chart
Properties editor. Other charting options allow you to modify the charts title, colors, and axis settings.

Exporting a chart image

Perform the following procedure to export an image of the current SynerGEE chart. You can export the chart
to a file (using the EMF, WMF, BMP, JPG, or PNG file formats) or to the clipboard.

TO EXPORT A CHART IMAGE

1

Perform the following steps to open the chart export editor:

a

In the SynerGEE ribbon bar, select the CONTROLS tab.

In the Appearance group, click Properties.

In the Properties editor, click Export.

In the Export editor, under Export Destination, select either Clipboard or File. If you select File, click
the Browse button to specify the name and location of the file you want to save.

Under Export Size, specify the size of the file that you are exporting. You can specify measurement
units in Millimeters, Inches, or Points.

Click Export.

Printing a chart
Perform the following procedure to print the current SynerGEE chart.

TO PRINT A CHART IMAGE

1

On the right-side of the SynerGEE chart window, select the tab for the chart that you want to print.

Perform the following steps to open the chart Export editor:

a

In the SynerGEE ribbon bar, select the CONTROLS tab.

In the Appearance group, click Properties.

In the Properties editor, click Export.

In the Export editor, under Export Destination, select Printer.

Under Export Size, specify the size of the file that you are exporting. You can specify measurement
units in Millimeters, Inches, or Points.

SynerGEE Electric 5.0

User Guide

484

SynerGEE Analyses
5

Click Print.

In the Print editor, select the printer where you want to send the chart. You can also edit the Printing
Style and the DPI setting from this editor. If desired, you can also click Setup to access your printer
settings editor.

When your printer settings are ready, click OK. SynerGEE sends the chart to the selected printer.

Closing an individual chart

Perform the following procedure to close an individual chart in the SynerGEE chart window.

TO CLOSE AN INDIVIDUAL CHART

1

On the right-side of the SynerGEE chart window, select the tab for the chart that you want to close.

In the CONTROLS tab of the SynerGEE ribbon bar, click Remove Tab.

Closing the chart window

Perform the following procedure to close the SynerGEE chart window.

TO CLOSE THE CHART WINDOW

1

Underneath the SynerGEE ribbon bar, locate the tab for the chart window.

Right-click and select Close.

WHAT-IF ANALYSIS
The what-if analysis is a script-based tool that allows you to propose changes to the model and then view the
outcome of these changes without actually applying them. This can be immensely helpful to planners and
engineers for evaluating alternative load values, switching plans, regulator settings, and model changes in
order to weigh the benefits and costs of a proposed change to your system.
The what-if scripts rely on the MiddleLink format and operate in the same way as most other script-building
modules. Scripts can be written for load data, outage events, equipment data, cost records, and countless
other scenarios.
Most analysis types in SynerGEE can be run with what-if scenarios, including load-flow, check coordination,
reliability, and motor studies. SynerGEE will initiate and invoke the changes when an analysis is run, and then
undo them when the analysis is finished. This is a non-committal way of testing out new plans for your model.
Unlike partials or subsets, which cannot be undone, what-ifs give you the ability to modify your model for
analysis without making a permanent change.
Refer to the topics listed below for more information.

Managing What-If scripts on page 485

Sample what-if scripts on page 487

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

485

Managing What-If scripts

The What-If Options editor is where what-if scripts can be created, edited, deleted, and enabled. It is
important to note that What-If scripts can be organized by groups. If you plan on building several different
what-if scenarios or running several scripts at the same time, groups can be a useful method to establish
these relationships between different scripts.
Refer to the following procedure for more information.

TO MANAGE WHAT-IF SCRIPTS

1

Perform the following steps to open the What-If Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click What-If.

On the What-Ifs tab of the What-If Options editor, select What-Ifs Are On. You must select this
check box to edit any other settings in the What-If Options editor. Selecting the What-Ifs Are On
check box will also enable the What-Ifs feature for any analyses that you perform. However, you can
use the editor to individually enable and disable what-if scripts, as described later in this procedure.
When you are done editing the scripts, you can also clear the What-Ifs Are On check box to
disable the running of What-If scripts. Although disabled, the edits that you make will be retained for
future use.

Use the What-If Options editor to create and edit scripts, enable scripts, and delete scripts. Refer to
the following table for more information on the tasks that you can perform.
To ...
Create a new what-if script

SynerGEE Electric 5.0

Do This ...
a

In the What-If Options editor, select the Scripts tab.

Click New.

In the New What-If editor, next to Group, select or type

a group name that you can use to help organize your
what-if scripts. Next to Name, type the name of the new
what-if script.

Click OK.

User Guide

486

SynerGEE Analyses

To ...
Edit a what-if script

Rename a what-if script or

change the scripts group
name

Enable and disable

individual what-if scripts

Delete a what-if script

User Guide

Do This ...
a

In the What-If Options editor, select the Scripts tab.

In the list of scripts, select (highlight) the name of the

script that you want to edit.

To edit the script in SynerGEE: Click Script Editor. The

SynerGEE script window opens, where you can add
and delete commands from the script. The What-If
Options editor remains open during this time; you can
simply move it to the side of the screen, edit the script in
the Script Editor window as required, and then return to
the What-If Options editor when you have finished
editing the script.

To edit a script in Notepad: Click Notepad. The CMM

script in will open in the Notepad application. Edit the
script in the Script Editor window as required, and then
return to the What-If Options editor when you have
finished editing the script.

In the What-If Options editor, select the Scripts tab.

In the list of scripts, select (highlight) the name of the

script that you want to rename.

Click Rename.

In the Rename What-If editor, next to Group, select or

type a new group name for the what-if scripts. Next to
Name, type a new name for the what-if script.

Click OK.

In the What-If Options editor, select the Scripts tab.

In the list of scripts, select the check box next to each

script that you want to enable to be run during a
SynerGEE analysis. Clear the check box for each script
that you do not want to run.

In the What-If Options editor, select the Scripts tab.

In the list of scripts, select (highlight) the name of the

script that you want to delete.

Click Delete.

Click Yes to confirm the deletion.

Click OK to accept your changes and close the editor.

SynerGEE Electric 5.0

SynerGEE Analyses

487

Sample what-if scripts

What-if scripts can be run with Middle Link records for any number of scenarios. Below are some sample
scripts based on capacitors and fuses.

Add a new 1200 kvar capacitor on section 52536:

701, 52536, TryCap1, 7, Yg, 1200

Present value cost for a capacitor:

7010, Capacitor Installation, 50.0

Set the capacitor on section 51871 to 300 kvar:

701, 51871, TryCap1, 7, Yg, 300

Add fuses to a section:

901, 51915, LargeFuse, 1, 0
901, 21501, OtherFuse, 1, 0

UNCERTAINTY ANALYSIS
The uncertainty analysis can be used to test several different components of a system by placing percentage
variations on key parameters. Percentage variations can be based on your own estimations and hunches, or
on arbitrary numbers that you want to test on your model. There are no recommended levels of uncertainty;
all test numbers are chosen based on your needs. The analysis can be run as many times as you like.
The uncertainty analysis uses load-flow to generate the results, which are confidence intervals broken into
the following chapters:

Summary

Amps

Volts

kW

kvar

Z1

Z0

The uncertainty analysis can be run at any time and for several different reasons. The end goal is to
determine the confidence intervals, or values or variance, for several different key components in your model:
Distributed load kVA, spot load kVA, distributed load I, Z, PQ (captures the impact of a load with voltage
change), line length, line height, and conductor spacing. Based on the results, you may decide to make
changes to your plans and/or structure.
Refer to the topics listed below for more information.

Setting up an uncertainty analysis on page 488

SynerGEE Electric 5.0

User Guide

488

SynerGEE Analyses

Performing an uncertainty analysis on page 488

Setting up an uncertainty analysis

Perform the following procedure to set up an uncertainty analysis.

TO SET UP AN UNCERTAINTY ANALYSIS

1

Perform the following steps to open the Uncertainty Analysis Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Uncertainty and then select Settings.

In the Parameter Variation section of the Uncertainty Analysis Options editor, enter percentage
values in as many or as few of the parameter variation fields as you choose. Each parameter
variation will affect the percentage variation of its proper components.

In the Number of Analysis Runs section, select a small, medium, or large sample size. The analysis
will run 50, 100, or 200 load-flows, respectively.

Click Apply to accept your changes, and then click X to close the editor.

Performing an uncertainty analysis

Perform the following procedure to fun an uncertainty analysis. When the analysis is complete, the analysis
report will display. The uncertainty analysis report uses load-flow to generate the data within the different
report chapters.
The Uncertainty Summary chapter contains the minimum and maximum range for both single and threephase sections, as well as an average range.
The Amps, Volts, kW, kvar, Z1, and Z0 chapters display results in bar chart form. The example chart below
reflects the results of a 25% variation entered in Distributed load kVA. This chart shows that approximately
40% of the model will contain a + or - 20-30% variation in amps. Approximately 25% of the model will contain
a 10-20% variation. If other parameters are given variations, the results could fluctuate. For more information,
see Setting up an uncertainty analysis on page 488.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

489

TO PERFORM AN UNCERTAINTY ANALYSIS

1

If you have not already done so, use the Uncertainty Analysis Options editor to configure options
related to the analysis. For more information, see Setting up an uncertainty analysis on page 488.

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the Uncertainty icon.

SYSTEM STATUS ANALYSIS

The System Status analysis provides a quick overview of the feeders in your session. The analysis generates
results from the Load-flow, Fault, and Reliability analyses and arranges the results, along with various model
trace parameters, in the System Status Analysis report.

TO PERFORM A SYSTEM STATUS ANALYSIS

1

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Fundamentals group, click the System Status icon.

R&D ANALYSIS
The R&D analysis is an area where special research and development efforts are developed and tested by
GL Noble Denton. These tools, when available, are launched through R&D scripts, which generally are not
provided as a part the SynerGEE Electric installation. GL Noble Dentons Technical Support team will provide
you with further instructions if you need to use this area of SynerGEE.

SynerGEE Electric 5.0

User Guide

490

SynerGEE Analyses

CONCEPTS VIEW
The Concepts View provides support for the demonstration of fundamental SynerGEE modeling calculations.
It acts as a window into the analysis engine so that engineers are better able to understand how SynerGEE
determines analysis results. This tool is not connected in any way to your SynerGEE model or database.
Therefore, any experimental calculations or adjustments to the components of the Concepts View will not
affect the model or any other function of SynerGEE.
Refer to the topics listed below for more information.

Opening the Concepts View on page 490

Impedance Concepts View on page 490

Harmonics Concepts View on page 491

Opening the Concepts View

Perform the following procedure to open the Concepts View.

TO OPEN THE CONCEPTS VIEW

1

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Calculators group, click Concepts.

On the left side of the Concepts View window, select from the available tab names to view the
different Concepts View applications. Refer to the following topics for more information:
-

Impedance Concepts View on page 490

Harmonics Concepts View on page 491

Impedance Concepts View

The Impedance tab of the Concepts View provides a basic utility pole diagram with movable phases. You can
click and drag a phase anywhere on the pole while seeing a change on a particular phases impedance and
admittance values, as well as on the phases voltage values. The Impedance tab of the Concepts View also
contains the following features:
Earth Resistivity

Sets the resistivity of earth in ohm-meters.

Length

Adjusting the cable length will cause a change in the voltage values on the
phases in the pole diagram as well as in the impedance and admittance
calculations.

Volts

Allows a specific value, based on a 120 volt base. This value affects the
voltage values on the phases in the pole diagram.

Amps

Adjusting the slides on the amp values affects the voltage values on the
phases in the pole diagram.

User Guide

SynerGEE Electric 5.0

SynerGEE Analyses

491

Conductors

You can select the conductor type for each phase which (most likely) yields a
change in the voltage values, as well as the impedance and admittance
calculations.

Impedance

Shows the calculations used by SynerGEE to arrive at the impedance value for
each phase. These calculations are affected by changes made elsewhere in
the Concepts View.

Admittance

Shows the calculations used by SynerGEE to arrive at the admittance value for
each phase. These calculations are affected by changes made elsewhere in
the Concepts View.

Harmonics Concepts View

The Harmonics tab of the Concepts View can help provide an understanding of how SynerGEE considers
harmonic calculations.
You will find two charts that show primary and secondary harmonic curves. The curves can be adjusted by
changing the amp levels on phases and harmonic levels on the 3rd, 5th, 7th, 9th, or 11th. These troublesome
harmonics are called triplens because they are all in phase with each other. Triplens add, rather than cancel,
on the neutral conductor of a three-phase, four-wire system. On a shared neutral, it may carry twice the
phase current. Most neutral conductors are the same or smaller than the phase conductor.
Triplens also cause circulating currents on the delta winding of a delta-wye transformer configuration. When
triplen harmonics on the neutral of a three-phase, four-wire system reach the transformer, they are reflected
to the delta connected primary where they circulate. The result is transformer heating similar to that produced
by unbalanced three-phase current.
For more information on harmonics and how SynerGEE considers it during analysis, see Harmonic Analysis
on page 689.

SynerGEE Electric 5.0

User Guide

492

User Guide

SynerGEE Analyses

SynerGEE Electric 5.0

CHAPTER

9
Loads and Load
Analyses
SynerGEE provides a detailed load model that can be configured in a variety of different ways, with a variety
of different options. In addition, SynerGEE can apply distributed loads throughout your model automatically,
using metered data such as feeder and/or subtran demands and load allocation analysis.
Refer to the topics listed below for more information.

Setting up Loads on page 493

About Loads Versus Model Types on page 495

Load %I, %Z, %PQ on page 496

Capacity Factors on page 502

Large Customers and Distributed Generation on page 503

Projects (Load) on page 511

Load-Flow Analysis on page 512

Network Load-Flow Analysis on page 524

Scale Manager on page 527

SETTING UP LOADS
Loads in SynerGEE are represented by the standard real and reactive components, kW and kvar, at the
section level. Once properly set up, load handling is generally straightforward and intuitive.
However, setting up loads can be a detailed process, especially depending on how accurate and complex
you wish to be. There is no single method or solution for all models. Setting up loads can be a multi-step and
ongoing process, one that requires careful thought and good engineering decisions.
SynerGEE provides a detailed load model that can be configured in a variety of different ways, with a variety
of different options. In addition, SynerGEE can apply distributed loads throughout your model automatically,
using metered data such as feeder and/or subtran demands and load allocation analysis.
Refer to the topics listed below for more information.

Load types on page 494

SynerGEE Electric 5.0

User Guide

494

Loads and Load Analyses

Getting started with load modeling on page 494

Load types
In general, SynerGEE identifies five types of load models. In many cases, these different models have a
strong overlap in analytical effect and are distinguished largely by how you create and interact with them.

Distributed loads. Distributed load is the normal, non-itemized load on your system. Distributed
load data is normally calculated for you by load allocation analysis, often using transformer
connected kVA. Usually, distributed load in a model represents a good averaging of system loading,
but the accuracy may vary according to your allocation method and supporting data.

Spot loads. Spot loads are special, stable loads that you assign in addition to distributed load. A
spot load often represents a predictable and substantial large load, such as an industrial customer,
that you have accurate information about and would not be properly represented by distributed load.
Spot loads can be assigned and turned on and off individually, by section.

Projects. Projects are a means of placing multiple, itemized spot loads on a single section.
Analytically, they behave similarly to spot loads, but they provide a variety of features for more
comprehensive management. For more information, see Projects (Load) on page 511.

Large customers. Large customers are also similar to spot loads, except that they can also model
a scheduled, distributed load component. Unlike most other load models, large customers are
handled similar to devices, with map symbols and independent editors. As such, you can leverage
SynerGEEs search, zoom, and explorer features to manage them. For more information, see
Large Customers and Distributed Generation on page 503.

Areas of interest. An area of interest provides a means of applying a simple, spatial load to the
model and assign it to a section. Analytically, areas of interest load behaves identically to a spot
load. For more information, see Areas of Interest on page 217.

In summary, all loads generally have a similar, if not identical, analytical effect, with respect to their locations
on sections. The differences primarily involve how the loads are applied to the model and how the data is
managed afterward.

Getting started with load modeling

Spot load modeling is frequently a manual process, where you have metered data that you can calculate and
apply directly to the applicable sections. Distributed loads, however, are a much different situation. Most
users do not have metered data readily available that can be easily associated with sections in the model.
Therefore, for distributed loads, generally the first step to setting up loads is providing some preliminary data
to SynerGEE, and allowing load allocation to generate the kW and kvar components. This information usually
includes:

Feeder and subtran demands, by means of meter devices modeled downstream from the sources

Distribution transformer connected kVA, by section

Other metered data, if available, by means of meter devices

With this information, load allocation can produce a functional model, capable of reliable analysis. In many
cases, the resulting model may be sufficient for your needs. However, load allocation is limited to certain

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

495

basic assumptions and while the model can produce useful results, there are many more ways to improve the
accuracy of your model. These include the following:

Load I,Z,PQ. One of the easier means of improving load accuracy is to adjust your load constant
%I, %Z, and %PQ. No load is ever truly 100% of any component, and SynerGEE provides a variety
of tools for determining and settings these values within your model. For more information, see
Load %I, %Z, %PQ on page 496.

Customer load curves. In SynerGEE, you can implement 24-hour daily load curves to conduct
very precise, off-peak analyses. For more information, see Customer Load Curves/Time-of-Day
Analysis on page 808.

Load growth and growth curves. To simulate a future increase (or decrease) in load, you can use
growth factors as simple multipliers against current load. For more information, see Load Growth
on page 801.

Capacity factors. Capacity factors can be specified at the section level to indicate the percent
effect of the specified load. Capacity factors can be useful for compensating for oversized/underutilized transformers, which caused load allocation to allocate an excessive amount of load,
compared to the real values that are known to you. For more information, see Capacity Factors on
page 502.

In general, all load modeling methods and tools can be combined in a variety of ways to achieve your desired
result. It is up to you to evaluate your needs, versus the data available to you, to determine a workflow
appropriate for your situation.

ABOUT LOADS VERSUS MODEL TYPES

During analysis, loads are handled differently depending whether the model is a radial or network model. The
type of model is determined by the Allow Loop Creation option in the SynerGEE tab of the Preferences
editor.
SynerGEE provides a detailed load model that can be configured in a variety of different ways, with a variety
of different options. In addition, SynerGEE can apply distributed loads throughout your model automatically,
using metered data such as feeder and/or subtran demands and load allocation analysis.
Refer to the topics listed below for more information.

Radial model loads on page 495

Network model loads on page 496

Radial model loads

In a SynerGEE radial model, loads are placed in the center of the section model. This is done for two
reasons.

Placing loads in the center of the section avoids ambiguity during switching. SynerGEE allows
extensive switching actions. Because switches are placed at the ends of sections, load modeling at
nodes would make it difficult to determine how loads would be fed during switching operations. The
assignment of loads is clear with the loads in the center and the switches at the ends of sections.

SynerGEE Electric 5.0

User Guide

496

Loads and Load Analyses

It can be shown that the modeling of a load in the center of the section more accurately simulates a
distributed load with respect to voltage drop. Losses are also closely modeled in this manner.
Studies and simulations show that the SynerGEE approach to load placement and modeling is very
well-suited for distribution system simulation.

Each section may contain a by-phase spot and by-phase distributed load. Distributed load is generally
calculated through load allocation analysis and does not necessarily represent the exact real-world load on
each section. Spot loads, on the other hand, are considered to be known loads with metered demands. As
such, they are not altered by SynerGEE load allocation. In the end, all distributed and spot loads combined
should match the demands specified by applicable upstream meter devices, a process handled by load
allocation analysis. For more information on load allocation analysis, see Load Allocation Analysis on
page 549.
Loads can only be entered into valid phases of a line section. Consider a line section containing conductors
A, B, and a neutral. Loads can be entered for phase A and phase B. If the load were connected line-line, only
the phase AB field could contain load. Both kW and kvar values must be entered for loads. Entering only kW
implies that the load has a power factor of 100%.
Only the load values for kW and kvar are used during load-flow analysis. Values for kWh, kVA, and
customers are not utilized during load-flow calculations. For more information on load-flow analysis, see
Load-Flow Analysis on page 512.

Network model loads

Loads are handled differently during network analyses than radial analysis. For more information on load
handling in a network model, see Network Load-Flow Analysis on page 524.

LOAD %I, %Z, %PQ

All loads within a distribution system are comprised of a constant current (%I), constant impedance (%Z), and
constant power (%PQ) component. The ratio of these components can vary widely depending on the type of
load, and very rarely is a load a full 100% of any single component. Because the makeup of loads has an
impact on power flow throughout a system, SynerGEE allows precise modeling of loads, based on I,Z,PQ
composition.
SynerGEE provides a special tool to help you determine I,Z,PQ values, called the I,Z,PQ Calibrator. The tool
can be found in your power tools suite. Use of the tool is optional. For more information on the I,Z,PQ
calibrator, see I,Z,PQ Calibration power tool on page 748.
For more detailed information on these three components and the SynerGEE load model, see I,Z,PQ load
model details on page 497.

TO ASSIGN I, Z, PQ PERCENTAGES TO LOADS

There are two places that you can assign I, Z, PQ percentages:

User Guide

Sections. In the Section editor, you can assign percentages directly in the Load - Dist and Load Spot tabs. Percentages assigned to sections only apply to those respective sections. For more
information, see Adding distributed loads to a section on page 284 and Adding spot loads to a
section on page 287.

SynerGEE Electric 5.0

Loads and Load Analyses

497

Section editor, specifying SynerGEE to use %I, %Z, %PQ from the assigned customer class

Customer classes. In the Customer Class editor, you can assign I, Z, PQ values to the class. A
section uses these values instead of its own if the section uses that customer class, via its customer
zone, and the option to use values from the customer class is checked in the Section editor, in the
Load - Dist tab and/or Load - Spot tab.

Customer Class editor, %I, %Z, %PQ values

To assign I, Z, PQ values to customer classes, you must use the Customer Class editor. However, with
sections, you have the option of using the Multiple Editor to assign values to large areas at once. For more
information on using the Multiple Editor, see Using the Multiple Editor on page 177.
For more information on editing a customer class, see Editing a customer class on page 811.

I,Z,PQ load model details

SynerGEE supports the mixed modeling of three load types for distributed and spot loads. These types
include:

Constant real and reactive power (PQ)

Constant current (I)

Constant impedance (Z)

Each of these three general load models is used frequently. For each model, the fundamental concept is the
determination of a function that relates current to voltage in terms of the nominal value of power and the
nominal voltage of the load. For example, assume that the following is given:
SNom

Real and reactive portion of load at nominal voltage

kVNom

Nominal voltage of load

SynerGEE Electric 5.0

User Guide

498

Loads and Load Analyses

and that the determination of SLT is desired in the following:

S LT = f ( kV , S Nom , kVNom )
I=

Eq 91

*
S LT
kV *

where:
LT
I

=
=

Load type
Load current with applied kV

The sections listed below outline the determination of SLT for constant I, Z, and PQ loads.

Constant real and reactive power load model on page 498

Constant current load model on page 498

Constant impedance load model on page 499

Current/voltage relationship Loads on page 499

Power/voltage relationship Loads on page 500

The combination load model on page 501

Example calculations with different I, Z, PQ components on page 501

Constant real and reactive power load model

This model maintains independent constant values of the real and the reactive portions of a load. The model
should not be referred to as a constant load or constant power model because these imply that the vector
sum of the real and imaginary portions of a load is held constant. In the constant PQ model, the nominal real
and reactive load power never change. Thus:

S PQ = S Nom

Eq 92

Constant current load model

In this model, the value of current is independent of the voltage applied to the load. The load current at
nominal voltage in amps is:

I Nom =

User Guide

*
S Nom
kVNom

Eq 93

SynerGEE Electric 5.0

Loads and Load Analyses

499

As the load voltage changes, the load power needed to maintain this value of current is:

*
S I = kV I Nom
= kV

kV
S Nom
= S Nom

kVNom
kVNom

Eq 94

Equation 95

The expression of SI based on the loads applied and nominal voltage is sufficient to represent the constant
current load model.

Constant impedance load model

The expression for load current at nominal voltage was found in the previous section (Constant current load
model on page 498). The load impedance must, therefore, be the following:

Z Nom =

2
103 kVNom 103 kVNom
=
*
I Nom
S Nom

Eq 96

As the load voltage changes, the current consumed by the constant impedance model is:

IZ =

*
103 kV kV S Nom
=
2
Z Nom
kVNom

Eq 97

And, the value of load power needed to maintain this load impedance as the load voltage changes is:

kV
kV 2 S Nom
S Z = kV I =
= S Nom

2
kVNom
kVNom
*
Z

Eq 98

Once again, a factor is derived based on load voltage that modifies the nominal load to a corresponding
value, so the constant impedance load model is maintained.

Current/voltage relationship Loads

At nominal section voltage, these loads are indistinguishable. However, the loads differ by the current/voltage
relationship that they exhibit. The plot below shows this relationship for the three types.

SynerGEE Electric 5.0

User Guide

500

Loads and Load Analyses

Co

nst
a

nt P
Q

typ

Constant current type

Current

s ta
on

nt

im

an c
pe d

e ty

pe

Voltage

Voltage/current curves for load models

The curves have been normalized and the scale of the independent axis represents a 20% variation in
voltage. Although all of the curves appear linear, the constant PQ load curve is actually hyperbolic. It is nearly
linear over the practical voltage range used here. Notice how all of the curves intersect at the nominal voltage
point. This shows that the nominal voltage and nominal current correspond to the nominal load power that
has been specified as the same for all three loads in this plot. This intersection is also important to the
creation of the combination model.

Power/voltage relationship Loads

The combination load model allows a nominal load to be specified in kW and kvar (the intersection point).

Power

Constant PQ type
type
rrent
u
c
t
tan
Cons
pe
e ty
c
n
a
ped
im
t
n
a
ns t
Co

Voltage

Voltage/power curves for the different load types

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

501

The combination load model

The three ideal load models can be combined to represent a single load. A percentage weight is given to
each of the three components of that load as follows:

SCM

kV
kV
= S Nom % PQ + % I
+ %Z
0.01

kVNom
kVNom
where:% PQ + % I + % Z = 100%

Eq 99

The factors %PQ, %I, and %Z represent the portion of load that is treated as each of the basic types. The
equation requires that the sum of the three factors be 100%. For more information on load I,Z,PQ and
assigning percentages, see Load %I, %Z, %PQ on page 496.
This equation shows how the effective load is determined from the sections nominal spot or distributed loads,
the sections center voltage, the sections center nominal voltage, and the load weighting factors. The load
becomes a quadratic function of section voltage. The three load types are directly observable in the following
equation:

f ( S Spot Nom , kV , kVNom , % I Spot , % Z Spot )

I Spot =

kV *

Eq 910

f ( S Dist Nom , kV , kVNom , % I Dist , % Z Dist )

kV *

I Dist =

The load current for spot and distributed loads is determined during each iteration of the SynerGEE loadflows. Spot and distributed loads are averaged in balanced analysis and applied per-phase in by-phase
analysis. Both types of analysis acknowledge the line-line or line-ground connectivity of the load.

Example calculations with different I, Z, PQ components

A feeder with an 8MVA load was modeled using various combinations of load model parameters. The results
for a single feeder are listed in the table below, with all loads modeled using parameters listed in the left
column.
Load Model

Amps

kVA Demand

Loss

Min. Volts

Max. Ld

100% PQ

367

8115

2.6%

118.3

69%

100% Z

356

7877

2.5%

119.1

67%

100% I

361

7988

2.5%

118.6

68%

40%,40%,20%

360

7965

2.5%

118.7

68%

It can be seen that the impact on losses and loading for this particular feeder is not heavily dependent on the
load models used. The minimum voltage on the feeder does vary by nearly a volt over the load models

SynerGEE Electric 5.0

User Guide

502

Loads and Load Analyses

tested. Other feeders with longer lines (this model is dense suburban) may see a much greater impact from
load models.

Sample I, Z, PQ values
Listed below are sample values for load I, Z, PQ based on the type of load. These values represent typical
percentages, and a section load may be a complex mix of loads like these and others.
Load Type

PF%

%PQ

%Z

%I

Resistance heaters, water heaters, ranges

100

50

50

Heat pumps, air conditioning, refrigeration

80

15-35

20-40

45

Clothes dryers

99

100

Televisions

77

100

Incandescent lighting

100

45

35

20

Fluorescent lighting

90

50

50

Pumps, fans, motors

87

40

40

20

Arc furnace

72

30

70

Large industrial motors

90

60

40

Large agricultural water pumps

85

75

25

Power plant auxiliaries

80

40

40

20

CAPACITY FACTORS
For distributed loads and spot loads, you can specify a capacity factor, which allows you to simulate underutilized transformers in your system. The factor, which can be from 0 (0%) to 1 (100%) or greater, is applied
as a flat multiplier to connected kVA on all phases during load allocation. If you know that certain
transformers are consistently under-utilized, capacity factors can help you achieve a more accurate
representation of actual load following allocation.
The basic by-phase equation used during load allocation is as follows, where kcapacity is the capacity factor:
: ph
kVAallocation
= kVA: ph kcapacity

Eq 911

Capacity factors are intended to alleviate the manual process of adjusting connected kVA before load
allocation, especially if your connected kVA information is imported and periodically overwritten from another
data source. You could also establish a process that imports capacity factors themselves, perhaps through a
MiddleLink data import. For more information on MiddleLink data import, see Importing GIS Data Using
MiddleLink on page 100.

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

503

Capacity factors apply to load allocation by connected kVA only. All other analyses use the allocated kW and
kvar load components as specified. In addition, the global usage of capacity factors during load allocation is
optional, as controlled in your load allocation options. For more information on setting load allocation options,
see Setting up a load allocation analysis on page 552.

LARGE CUSTOMERS AND DISTRIBUTED GENERATION

SynerGEE provides a special load model to handle distributed generators, co-generators, and large
customers, known collectively as the large customer. A large customer may also be used to model
manholes and vaults.
On the map, large customers are similar to devices because they use their own map symbols and separate
editors. On a functional level, a large customer is similar to a spot load and/or a modeled generator. Large
customers provide the following features, which may determine whether you use them or a different load
model:

Identifiable map entity with a symbol. At its simplest level, a large customer may be functionally
identical to a spot load. However, the large customer provides a symbol on the map, a listing in the
SynerGEE model explorer, and easier management through tools such as reports.

Combined generation/load. With a large customer, you can combine the generation and load
aspects of a customer into a single entity. In addition, you can apply the simple negative PQ
generation component without the overhead of a normal generator device, with its required
equipment type.

Better integration of load curves. A large customer can incorporate 24-hour load curves into its load
component, similar to a normal spot load. However, a large customer can extend the curve
functionality to the generation side as well, allowing two independent curve sets for each. In this
manner, you can set up precise 24-hour scheduling for the load and generation components, at a
granular percentage level.

SynerGEE provides a detailed load model that can be configured in a variety of different ways, with a variety
of different options. In addition, SynerGEE can apply distributed loads throughout your model automatically,
using metered data such as feeder and/or subtran demands and load allocation analysis.
Refer to the topics listed below for more information.

Adding a large customer to the model on page 503

Editing a large customer on page 504

Customer load curves and large customers (scheduling) on page 511

Adding a large customer to the model

Large customers are added to a model in the same manner as equipment types, by dragging a large
customer type from the Warehouse tab of the model explorer and dropping it onto an existing section in the
SynerGEE map display. Refer to the following procedure for more information. Additional information on
working with warehouse equipment types is provided in Modeling Devices on page 317.

SynerGEE Electric 5.0

User Guide

504

Loads and Load Analyses

TO ADD A LARGE CUSTOMER TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Large Customers and then select the large customer type that you want to add to your
model. Drag it onto the map display and drop it onto the desired section.

Editing a large customer

Use the Large Customer editor to edit an existing large customer in your model. Refer to the following
procedure for more information.

TO EDIT A LARGE CUSTOMER

1

In the SynerGEE map display or model explorer, double-click the large customer that you want to
edit.

On the left side of the Large Customer editor, select from the different tab names to access the
available settings for the large customer. The following topics describe the different tasks that you
can perform:

Editing general data for a large customer on page 504

Editing load data for a large customer on page 506

Editing generation data for a large customer on page 508

Viewing analysis results for a large customer on page 510

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a large customer

TO EDIT GENERAL DATA FOR A LARGE CUSTOMER
1

In the SynerGEE model explorer, select the Model tab.

Expand Facilities and then select Large Customers. Double click on the name of the large
customer that you want to edit.

In the Large Customer editor, select the Large Cust tab. The following table describes the different
options that you can set.
Name

User Guide

Name of the large customer.

SynerGEE Electric 5.0

Loads and Load Analyses

Turn Off

505

Select this check box to disable the large customers effect on the
model. If the large customer is disabled, you can still edit the available
settings but it will not have any impact on the model or any analysis.
You can also disable large customers directly from the model explorer
or SynerGEE map display. Right-click on the large customer or large
customer name and select Turn On or Turn Off, as appropriate. When
you perform this action, the Turn Off check box will be selected or
cleared to reflect the current status.

Note

Optional note that includes any additional information that you want to
provide. Notes can be shown on the map display as annotated text.
For more information, see Adding section and device annotation to
the map display on page 207.

Location

Location of the large customer on the section. Available options are

From End, Center, or To End.

Energize and Retire

Energize and retire years for multi-year analysis. For more

information, see Multi-Year Analysis on page 579.

Category

For categorical purposes, SynerGEE allows you to select between

different types of large customer devices. The category selection
affects map symbology and model explorer listing only, and any type
can be configured in any manner. In general, though, it is assumed
that the different types mean the following:

Large customer load. Similar to a spot loads, a device with

a load component only.

Co-Generator. A device with both a load and generation

component.

Distributed generator. A device with a generation

component only.

Vault. Vault, possibly with a load component.

Manhole. Manhole, possibly with a load component.

Handhole. Handhole, possibly with a load component.

Location Link

Syntax to link the large customer to an external source, such as a file

or website. For more information, see Location Links on page 223.

AMS Link

Syntax to link the large customer to an Asset Management System.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

506

Loads and Load Analyses

Editing load data for a large customer

TO EDIT LOAD DATA FOR A LARGE CUSTOMER
1

In the SynerGEE model explorer, select the Model tab.

Expand Facilities and then select Large Customers. Double click on the name of the large
customer that you want to edit.

In the Large Customer editor, select the Load tab. The following table describes the different options
that you can set.
On/Off/Scheduled

Controls whether the large customer load component is active. If it is

on a scheduled basis, a customer class must be selected to control its
effect. For more information, see Customer load curves and large
customers (scheduling) on page 511.
If the large customer is set to On, use the % of rated text box to
specify the percentage effect of the specified load component.

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

kW, kvar, Customers,

conn. KVA, conn. kWh
and Connection

507

Actual load data, generally representing peak loads for the large
customer. Use the A, B, and C columns in the loads area to specify
the load values for phases A, B, and C. The values that you enter for
each phase will be summed in the Totals column. If you enter a value
in the Totals column instead, that value will be distributed
proportionally among the first three phases based on the current
values for each phase.
These values can be specified over multiple years for a multi-year
analysis. To specify a value for a specific year, select the desired year
in SynerGEE and then set the load values, as appropriate. As you
change the modeling year, the values will change in the dialog box
according to the loads you have already set.
SynerGEE provides several other methods that you can use to edit
load values. For example:

You can use the SynerGEE Bulk Editor to edit spot loads for
all sections at once. For more information, see Using the
Bulk Editor on page 192.

Click the Load Graph button to edit load values using a

graphical display. Click the Year button at the top of the
display to select a specific year to edit; select All to edit
load values for all years at once. Click anywhere outside of
the Load Graph editor to close the window.

Load Graph button

Capacity Factor

SynerGEE Electric 5.0

Factor that allows you to simulate under-utilized transformers in your

system. The factor, which can be from 0 (0%) to 1 (100%) or greater,
is applied as a flat multiplier to connected kVA on all phases during
load allocation. For more information, see Capacity Factors on
page 502.

User Guide

508

Loads and Load Analyses

Balance the loads

button

When load data is entered into any of the fields, click the Balance the
loads button to distribute the data evenly across the A, B, and C
columns.

Balance the Loads button

Harmonic Profile

Contains all of your harmonic profiles which you can associate with a
large customer. Click the Edit button to open the Harmonic Curve
editor.

Edit the Harmonic Curve button

Click Apply to accept your changes, and then click X to close the editor.

Editing generation data for a large customer

TO EDIT GENERATION DATA FOR A LARGE CUSTOMER
1

In the SynerGEE model explorer, select the Model tab.

Expand Facilities and then select Large Customers. Double click on the name of the large
customer that you want to edit.

In the Large Customer editor, select the Generation tab. The following table describes the different
options that you can set.
Generation On

User Guide

Select this check box to enable the distributed generator on the large
customer.

SynerGEE Electric 5.0

Loads and Load Analyses

Type

509

Select a generator type from your equipment warehouse to apply to

the large customer. Only generator types where the Large
Customers check box is selected on the Ratings tab of the Generator
Type editor will be available for selection from this list.
If the referenced generator type does not exist in the currently loaded
equipment warehouse, then the generator type will be displayed as
Unknown. If an analysis fails because of a missing equipment type,
the resulting report will specifically indicate the offending device(s).
The generator type association will be restored once a matching
equipment warehouse is opened.
For more information on generator types, see Managing generator
types in the equipment warehouse on page 348.

Specify rated output

Rated kW and Pf%. Peak generation capacity for the large

customer. Use the A, B, and C columns to specify the peak
values for phases A, B, and C. The values that you enter for
each phase will be summed in the Totals/Average column
for Rated kW, and averaged in the Totals/Average column
for Pf %.
-

If you enter a value in the Rated kW Totals/

Average column, that value will be distributed
proportionally among the first three phases based
on the current values for each phase.

If you enter a value in the Pf% Totals/Average

column, that value will be set as the value for each
active phase. It will not be applied proportionally as
is done with the Rated kW values.

These values can be specified over multiple years for a

multi-year analysis. To specify a value for a specific year,
select the desired year in SynerGEE and then set the peak
values, as appropriate. As you change the modeling year,
the values will change in the dialog box according to the
values you have already set.
You can also use the SynerGEE Bulk Editor to edit the rated
kw values for all large customer generators at once. For
more information, see Using the Bulk Editor on page 192.

Voltage Setting

SynerGEE Electric 5.0

Capacity Factor. Factor that relates the average output of

the generator to the rated output of the generator.

Desired output voltage based on the PT Ratio value for the

associated Generator Type. Required for synchronous generators
only.

User Guide

510

Loads and Load Analyses

Generator Output

Specify pf

Select from one of the following options:

Rated kW output.

Specify Output %. Select this option to specify the

percentage of steady-state contribution of the generator for
the active section. The value is the percent of the capacity of
the generating unit that is contributing toward the kW and
kvar loading requirements of the feeder.

Weather based performance.

Diurnal (hourly) curve. Select this option to specify that the

generators output is defined by the load curve of a selected
customer class. For more information on working with
customer classes, see Customer classes on page 810.

Select this check box to specify a power factor percentage specific to

this large customer. If the check box is cleared, the rated power factor
percentage for the associated generator type will be used.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a large customer

The Results tab in the Large Customer editor provides analysis results for the large customer. The Results
tab can be very helpful if you are running multiple analyses and focusing on a particular device. Since the
settings update automatically with each analysis, you can run an analysis and watch the results change in
real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a large customer.

TO VIEW ANALYSIS RESULTS FOR A LARGE CUSTOMER

1

In the SynerGEE model explorer, select the Model tab.

Expand Facilities and then select Large Customers. Double click on the name of the large
customer that you want to work with.

In the Large Customer editor, select the Results tab.

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

511

Customer load curves and large customers (scheduling)

In the Large Customer editor, you can assign independent customer classes to the load and generation
components, known as scheduling. For more information on editing a large customer, see Editing a large
customer on page 504.
When applied to the load component, the load curves in the customer class control the load much like a
customer zone would control a sections load. When applied to the generation component, the functional
effect is similar, with a reverse effect on perceived model load. That is, SynerGEE uses the percentages in
the class to determine how much of the generators capacity is currently engaged, much like a generation
curve.
You can specify different classes for the load and generation components, and they will be handled
independently. In addition, you can configure them to simulate any manner of cogeneration, from simple on/
off timing of each, to detailed percentages of each at any given time. In any case, when you select a time-ofday for analysis, SynerGEE will find and use the respective percentage for each and perform its calculations
appropriately.
The use of customer classes to control generation capacity is somewhat different than the traditional
application to loads, but the functional makeup of the curves is identical. You build these curves and classes
like you would any other, specifying percentage curves on a 24-hour basis. To use curves with distributed
generators, you may find that you need to develop a special set of curves just for them, based on known load/
generation scheduling of your large customer devices. For more information on load curves and customer
classes, see Customer Load Curves/Time-of-Day Analysis on page 808.

PROJECTS (LOAD)
Projects are a means of itemizing multiple spot loads on a single section, versus the traditional method of a
single by-phase spot load. Projects include the following features:

Selective enabling and disabling of individual loads, on a single section

Separate yearly energizing and retiring of individual loads, for multi-year modeling

A special view of all projects in the model for overview, management, and calculations

Projects can be an important tool for load projection and planning. Their use is optional, and they can be used
in conjunction with traditional spot loads.
SynerGEE provides a detailed load model that can be configured in a variety of different ways, with a variety
of different options. In addition, SynerGEE can apply distributed loads throughout your model automatically,
using metered data such as feeder and/or subtran demands and load allocation analysis.
Refer to the topics listed below for more information.

Effect of projects on the model on page 512

Adding, editing, and managing projects on page 512

SynerGEE Electric 5.0

User Guide

512

Loads and Load Analyses

Effect of projects on the model

At the most basic level, projects are simply collections of itemized spot loads that are summed and applied to
respective sections during analysis. Any project that is enabled and energized for the currently selected year
is added to the respective sections spot load value.
Because of their intrinsic relationship to traditional spot loads, projects share many of the same settings of the
traditional spot loads, including:

On/off status

Customer load curves

I,Z,PQ

For example, if you turn off a sections spot load, you also turn off any projects assigned to the section. Or, if
you change a spot loads I,Z,PQ values, you are also affecting project I,Z,PQ, because they are using the
same setting.

Adding, editing, and managing projects

You can access projects in three different places:

Projects worksheet. The Project worksheet allows you to view and edit all projects in the currently
selected feeders.

Section editor. The Load - Proj tab in the Section editor allows you to view and edit projects for a
specific section.

Model explorer. The model explorer contains a list of projects for viewing and navigation purposes.

Normally, the Projects View is used to add and edit projects, because it provides an overall view of the entire
model. However, you can use the Section editor to perform the same tasks if you want to work on a sectionby-section basis.
For more information on editing projects using the Projects worksheet and the Section editor, see Setting up
projects for a section on page 289.

LOAD-FLOW ANALYSIS
Balanced and by-phase load-flow analyses calculate current flows, voltage drops, losses, and loading of
lines, equipment, switches, and protective devices. You can perform either type of load-flow analysis for a
substation or selected feeders. If a substation is selected, all feeders of the substation are analyzed, as well
as the substation transformers, buses, equipment, and switches.
There are no limits on the number of sections that can be included in a load-flow analysis. The calculated
results for each section or substation bus can be exported to a database, or a detailed report can be
produced.
SynerGEE can perform four types of load-flow analysis, as described in the following sections:

Radial load-flow on page 516

Radial load-flow with loops on page 517

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

Radial load-flow with wandering laterals on page 520

Network analysis on page 522

513

Overview of SynerGEE load-flow technology

The load-flow engine is object-oriented, driven by a robust algorithm used to enforce Kirchhoffs laws
between objects representing power system devices. The objects respond to various messages supplied by
the load-flow algorithm. They contain the complicated and highly nonlinear models for various types of
distribution equipment such as voltage regulators, transformers, and switched capacitors. For more
information on the SynerGEE device model, see The radial load-flow foundation on page 513.
The solution of radial power systems is achieved by using methods of network flows based on walks along
directed-in and directed-out trees. These trees have arcs composed of objects designed to simulate various
distribution system devices. In a radial model, each object is connected in a radial fashion so that it has one
predecessor and possibly multiple descendants. The collection of independent objects reaches a state
representative of the load-flow solution through an interaction of objects based on Kirchhoffs laws. This
interaction is facilitated through the load-flow algorithm by two types of walks or object propagations.
SynerGEE can also perform network load-flow calculations. For more information on network load-flow, see
Network load-flow analysis on page 522.
Refer to the topics listed below for more information.

The radial load-flow foundation on page 513

The radial load-flow engine on page 514

The SynerGEE load-flow advantage on page 515

Summary of SynerGEE load-flow benefits on page 515

The radial load-flow foundation

The purpose of load-flow is to determine the state of a power system model. SynerGEE is a distribution
analysis tool and the model is composed of substations, feeders, lines, and various devices such as
transformers, capacitors, and generators. The model description consists of parameters for these devices as
well as descriptions of loads and values for feeder or substation transformer voltages.
The state of the load-flow model resulting from load-flow analysis is described by voltages, current flow, and
positions of controllers for regulators, switched capacitors, and other devices. Once it has obtained the loadflow solution, SynerGEE also determines the values of power flow, losses, and other parameters throughout
the model.
The foundation of SynerGEE is constructed with a very sophisticated by-phase power distribution simulation
engine. Within this engine are the detailed by-phase models of distribution system devices. These devices
are modeled using an object-oriented scheme of components that are constructed in computer code like the
actual devices are manufactured at the factory. For example, the step voltage regulators within SynerGEE
are modeled with a detailed representation of an autotransformer, a load tap-changer, PT and CT, a voltageregulating relay, and a line-drop compensator. These regulators can be put into banks to form Deltas, OpenDeltas, Wyes, and other connections. Each device model in SynerGEE is constructed so that current flows,
voltage drops, and control operation closely represent the by-phase behavior of these devices in your
distribution system.

SynerGEE Electric 5.0

User Guide

514

Loads and Load Analyses

SynerGEE also contains a collection of powerful algorithms for finding load-flow, fault, and other analysis
solutions. These algorithms are modular and are used to enforce Kirchhoffs current and voltage laws
between the object-oriented device models. The most fundamental of these algorithms is the one dedicated
to radial load-flow analysis. This algorithm accommodates specific methods of handling Kirchhoffs laws and
ensures that loads and device models are properly evaluated. The load-flow engine has been the focal point
of SynerGEE development. It entails the most accurate and robust by-phase load-flow algorithm available.
The radial load-flow forms the backbone of other important analysis algorithms within SynerGEE, such as
looped analysis.

The radial load-flow engine

The inward walk is used to accumulate current from the ends of the radial system to the source. The loadflow algorithm sends messages to device objects signaling them to collect the demand current from all of the
devices connected to their downstream end. An object receiving this message takes this downstream current
and propagates it through its particular by-phase model to form its own demand current. This demand current
is eventually accumulated by the objects source. By sending these messages to objects in a proper inward
order, the total current demand of the feeder can be accumulated. At the conclusion of this propagation, each
device object has current flows for its source and load terminals.
The outward walk enforces Kirchhoffs voltage law. During this walk, the load-flow algorithm signals each
device object to take the output voltage of its source object, use it for a source voltage, and determine a load
or output voltage of its own. Each device is responsible for calculating its own internal voltage drop. At the
conclusion of this walk, voltage drops have been calculated from the source of the feeder through all devices.
A load-flow iteration includes one inward and outward propagation along with a linearization step and a
convergence query. During the linearization step, various loads are evaluated at their terminal voltage to
develop a load current. Regulators are allowed to change taps and switched capacitors are allowed to trip
and close. By separating these operations into a single step, the most complicated and nonlinear behavior of
the distribution system model is isolated from the linear inward and outward propagations. This allows for a
much more robust and stable load-flow engine. For more information on linearization, see the SynerGEE
Technical Reference.
The final step in the load-flow iteration is the convergence query. Devices that have undergone fluctuations in
voltage or power above some threshold (or tolerance) value may signal the load-flow algorithm to continue
with another iteration. Devices with controllers may send a similar signal if they change taps or states. For
more information on convergence, see the SynerGEE Technical Reference.
The load-flow algorithm is designed so that values of current stay fixed during voltage propagations and
voltages stay fixed during current propagations. Thus, during any one inward or outward propagation, either
the current or voltage of a particular device object is one iteration old. As the load-flow progresses, however,
the changes in device current and voltage become smaller and convergence is reached. It is essential to note
that the load-flow engine simply directs inward and outward propagations of general arbitrary objects. By
design, the engine is not capable of making a distinction between a transformer object and a generator
object. All modeling associated with a particular device is completely contained within that devices object
model. This allows for a detailed, robust, and realistic modeling of power distribution devices. For example,
an object representing an Open-Delta bank of voltage regulators can be constructed with a detailed model of
an autotransformer, a load tap-changer, a line-drop compensator, and metering equipment. This object is
constructed with objects within SynerGEE much the same way that the actual regulator is built at the
manufacturer and installed onto the distribution system. Device models can be added or modified without
altering the load-flow engine.

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

515

The SynerGEE load-flow advantage

The radial load-flow engine of SynerGEE has two primary advantages over the traditional Gauss-Seidel and
Newton-Raphson methods:

SynerGEE does not rely on a matrix representation or an abstract mathematical representation of

the power system. This allows the model of a power system to simply be a collection of device
models. Furthermore, there is no limit to the size of the system SynerGEE can model. Analysis can
also be run directly from the data source.

SynerGEE allows a coupled three-, two-, or one-phase representation of power lines and power
equipment. Unbalanced loading, long single-phase laterals, ungrounded systems, non-symmetrical
transformer banks, mutual coupling, earth return, and device controller actions can all be modeled in
a manner consistent with the actual construction and physical behavior of these devices.

These advantages make SynerGEE a powerful tool for the simulation and analysis of power distribution
systems. In the past, there had been two prohibitive aspects of the radial load-flow described above,
including the handling of loops and generators. Fortunately, GL Noble Dentons research has produced new
mathematical theory, algorithms, and software. For example:

SynerGEE contains a robust algorithm for modeling looped distribution systems. This algorithm is
built directly on top of the radial load-flow engine of SynerGEE so that all of the modeling detail
associated with radial analysis is maintained. In the looped analysis, current flows are determined
through switches that form loops. These flows are determined using a driving point admittance
matrix as seen at the terminals of the loop tie switches. The matrix is used to determine the amount
of current needed to inject into one side and extract from the other side of each switch so that the
voltage drop across the switch is zero. At this point, the state of the looped distribution system can
be determined from the state of the radial system imposed with these switch flows.

SynerGEE can accurately model both synchronous and induction generators. The synchronous
generators have excitor limits and a balanced three-phase back EMF. Induction generators are
modeled with a variable resistive element representing slip. Both of these models are based on
carefully designed models and are powerful tools for representing the behavior of these machines in
unbalanced distribution systems. It can be important for you to simulate cases in which synchronous
cogeneration facilities may aggravate the pre-existing imbalance of their distribution system.

For more information on radial load-flow with loops, see Radial load-flow with loops on page 517. For more
information on generators, see Generators on page 347.

Summary of SynerGEE load-flow benefits

Classical matrix methods such as Gauss-Seidel or Newton-Raphson are not utilized within SynerGEE loadflow or looped analysis. This allows SynerGEE to take advantage of object-oriented modeling and provide a
series of benefits, including:

The incorporation of coupled by-phase models so that lines, laterals, unbalanced loads, transformer
windings, and other devices can be properly modeled.

Analysis with no limit to the number of sections, devices, or loop tie switches that can be analyzed.

The attention to detail, ease-of-use, and reliable results represented by the SynerGEE load-flow engine are
characteristic of GL Noble Dentons effort to provide the best modeling and analysis software available.

SynerGEE Electric 5.0

User Guide

516

Loads and Load Analyses

Radial load-flow
The SynerGEE radial load-flow engine is detailed and completely by-phase.

Performing a radial load-flow analysis

Perform the following procedure to run a radial load-flow analysis on your model. For SynerGEE to consider
loops and/or wandering laterals, you must have your model and analysis options set up as such. For more
information on loop consideration, see Radial load-flow with loops on page 517. For more information on
wandering lateral consideration, see Radial load-flow with wandering laterals on page 520.

TO PERFORM A RADIAL LOAD-FLOW ANALYSIS

1

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Fundamentals group, click the Load-Flow icon.

By-phase versus balanced load-flow analysis

SynerGEE can perform load-flow in either a by-phase or balanced fashion.

By-phase load-flow
SynerGEE includes a very detailed by-phase analysis engine. During by-phase load-flow, the engine
accounts for the following:

One-, two-, and three-phase lines and laterals

Grounded and ungrounded areas

Unbalanced loading

Various V/I load characteristics

Electric and magnetic field coupling

Transformer, regulator, and capacitor connections

Regulator and capacitor controls

Active generators

Every device within SynerGEE is represented with a detailed by-phase model.

Balanced load-flow
Balanced analysis is designed to produce useful information for the occasions when by-phase loading and
phasing information is unknown, or for the occasions when you are not interested in seeing by-phase results.
The analysis uses the same by-phase engine and detailed by-phase models as by-phase analysis.
Therefore, to run a balanced analysis, SynerGEE makes internal modifications to the data going into the
engine and the results coming out. In most situations, balanced analysis produces results representing a
single-line model of the distribution system. Loads are averaged over the phases of the associated line
section. Currents are averaged at section intersections.
To achieve the balanced analysis, SynerGEE uses the following steps.

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

Loads are averaged over the phases present on sections.

The SynerGEE by-phase engine is used to analyze the system.

The resulting flows and voltages are vectorially averaged over valid phases.

517

This approach allows SynerGEE to have a single, sophisticated analysis engine and one set of models. The
models account for coupling and line admittance for a three-, two- or single-phase grounded or ungrounded
lines, as well as the effects of long laterals.

Radial load-flow with loops

The SynerGEE analysis system, built on top of a powerful load-flow engine, is equipped to handle loops in a
radial model. Load-flow with loops differs from network load-flow, which is designed to handle densely
meshed transmission-style systems, such as urban networks. For more information on network load-flow, see
Network load-flow analysis on page 522.
In a radial model, loops may be modeled directly by allowing loop creation (in the SynerGEE tab of the
Preferences editor) or indirectly by using loop tie switches. If you have any loops created by either method,
they will be automatically considered by load-flow analysis. For more information on loop creation, see
Loops and Wandering Laterals on page 253.

About load-flow with loops

Looped analysis is an algorithm driven by the radial load-flow engine of SynerGEE. It operates by first
breaking any loops and solving the system in a radial fashion. The location of the break(s) is determined as
follows:

If a loop tie switch is modeled, the break occurs there.

If no tie switch is modeled, SynerGEE attempts to choose the most suitable location. To help you
determine the appropriateness of this location, versus whether you may want to model a tie switch,
SynerGEE provides a special map coloring scheme. For more information, see Coloring by path
type on page 216.

After the radial solution, the algorithm then closes the tie switches and/or breaks and determines the
appropriate current flow through each switch/former break that results in the exact same voltage on each
side. Once the voltage drops across the switches/breaks are zero, the solution of the set of radial systems is
the same as the solution of the looped system or network. The benefit of this type of analysis is that all of the
detailed by-phase models supported by SynerGEEs radial analysis are supported in the looped analysis. For
example, the self- and mutual-electric and magnetic fields of one-, two-, and three-phase lines are evaluated.
Controllers for individual regulators connected in Open-Delta banks are handled. By-phase loads with various
connections and V/I curves are analyzed. And, the controller for switched capacitor banks connected to a
single phase can be tripped or closed.

Example Load-flow with loops

As an example of looped analysis, consider the following system, with loop tie switches:

SynerGEE Electric 5.0

User Guide

518

Loads and Load Analyses

Example system

The example system demonstrates advantages to SynerGEEs by-phase looped analysis that cannot be
found in any other distribution analysis software. The system has loop tie switches forming loops between
two feeders. Each 12.47kV feeder contains a Wye-Gnd/Delta transformer bank that produces a 24.9 kV
ungrounded secondary voltage. A switch ties the two feeders forming a loop through the 12.47 kV grounded
and 24.9kV ungrounded systems. A second switch ties the feeders at a second location in the 12.47 kV
portion. Finally, a third switch forms a loop between single-phase laterals of the second feeder.
B
A
a

+ Vw3 -

2
Vw
Y -

I w2

IC

IN

+ V
w

b
c

C
Wye-Gnd-Delta transformer

The analysis of these two feeders and tie switches is complex for a number of reasons. First, the system
contains a three-phase trunk and many one-, two-, and three-phase laterals, some of which are ungrounded.
Second, there are many complex devices in these feeders such as an Open-Delta voltage regulator bank,
switched capacitors connected in Delta, and two transformer banks. Finally, the load-flow solution is found
with the tie switches placed simultaneously within three distinct areas.

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

519

The first switch, SW1, connects two grounded line sections. The algorithm must determine current flow
through the switch and also neutral or earth return flows through the sections forming the loop. The second
switch ties two ungrounded sections. Even though there are three blades to the switch connecting three
conductors, there are only two independent phases. (The voltages are measured line-line on ungrounded
systems and any voltage can be found from the other two.) Finally, the last switch connects a fairly long
single-phase lateral.
SynerGEE uses a unique approach to form a non-singular electrical equivalent that can be seen by looking
into the tie switches. This allows the powerful by-phase load-flow and the looped analysis to form a modular
and complete method for solving looped systems.
The following table summarizes the voltages on each side of the switch following a SynerGEE by-phase loadflow analysis without analyzing loops.
Voltages on each side of a switch with SynerGEE by-phase radial load-flow

SW1

SW2

SW3

One side

Other side

118.3

120.7

116.9

118.7

116.4

122.9

A/B

117.3

124.3

B/C

117.6

124.7

C/A

115.4

124.8

122.3

120.9

These numbers indicate a significant voltage difference across each phase of each tie switch.
You can now analyze the system with looped analysis to account for the loops formed by the tie switches.
The following table summarizes the voltages on each side of the switches after this analysis.
Voltages on each side of a switch with SynerGEE by-phase looped analysis

SW1

SW2

SW3

SynerGEE Electric 5.0

One side

Other side

122.0

122.0

122.2

122.2

121.9

121.9

A/B

120.9

120.9

B/C

119.5

119.5

C/A

122.2

122.2

121.5

121.5

User Guide

520

Loads and Load Analyses

The controller for the switched capacitor and the line-drop compensator of the regulator both responded to
their line voltage and current values in the looped analysis. The switched capacitor closed in both cases. The
voltage regulator bucked one tap on one of the two units forming the Open-Delta.

Invalid tie switches and load-flow

A tie switch will be ignored during balanced or by-phase loop analysis if:

The connected sections have no phases in common (for example, switching from a section with
phasing AB to a section with phasing C).

An ungrounded section is tied to a grounded section.

As would be expected, only those phases common to the connected sections will be tied during by-phase
looped analysis.

Radial load-flow with wandering laterals

Often, a three-phase line drops off a phase to serve the single-phase loading of a subdivision. After serving
the subdivision load, the single-phase line connects back to the main line. The following is an example of a
line that feeds a subdivision with the center phase.
B

B
ABC

B
AC

ABC

Wandering lateral

In a radial model, wandering laterals are modeled indirectly using wandering lateral tie switches, or directly by
allowing loop creation (in the SynerGEE tab of the Preferences editor). If you have any wandering laterals
created by either method, they will be automatically considered by load-flow analysis. For more information
on wandering lateral creation, see Loops and Wandering Laterals on page 253.

About wandering laterals and tie switches

Topologically, the system in the previous figure looks like the following to SynerGEE, without switches:

Topology of a wandering lateral

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

521

Under standard radial system modeling this loop is prohibited, so the wandering lateral must be modeled by
allowing loop creation (in the SynerGEE tab of the Preferences editor) or by using a tie switch. During loadflow analysis, wandering laterals are handled similarly to other loops. For more information on the process of
solving a system with loops, see About load-flow with loops on page 517.
If no tie switch is used and the phasing is correct, the topology engine will resolve the loop, form an internal
break, and conduct the analysis properly. The internal break should generally occur on the last section of the
lateral. Therefore, if a tie switch is used, it is generally placed on the last section of the lateral, where it
reconnects with the trunk, as follows:

Wandering lateral
tie switch

Wandering lateral, showing tie switch

Wandering lateral tie switches should always be placed at the outward connecting section of the wandering
lateral. If a tie switch is not placed on a wandering lateral, loop errors may result in SynerGEE. Also, if the tie
switch is improperly placed, phasing errors show up when running load-flow or fault analysis with wandering
laterals.

Sample wandering lateral calculations Load-flow

To demonstrate the analysis of wandering laterals, consider the same feeder with the following kW flow
values, after a load-flow run. This feeder uses a wandering lateral tie switch. Initially, the model started with a
1500kW three-phase load at the end of the feeder, and a 500kW load about halfway on the wandering lateral.
1000.6
1000.3
1000.2
500.1
1000.8
500.2

500.1

500.1
1000.7
500.2

500.0
500.0
500.2

500.0
500.1

500.0
500.1

500.0
500.0
500.0

500.0
500.0
500.0

kW flows with wandering lateral

Notice the 1000kW on the center phase. It flows from the source, along the wandering lateral to serve the
500kW load there. The remaining 500kW flows around and back to the trunk where it serves the three-phase
load. The 500kW on the outside phases flows right from the feeder to the three-phase load.
To further demonstrate the capabilities of SynerGEE and the placement of wandering lateral tie switches, you
could add a second wandering lateral.

SynerGEE Electric 5.0

User Guide

522

Loads and Load Analyses

1000.6
1000.3
1000.2

500.2
1000.9
500.1

1000.7
500.1

500.1

500.1

500.1
500.0
500.1

500.1

500.2
500.1

500.1

500.0
500.0
500.0
500.0

500.0
500.0
500.0

500.1

A second wandering lateral

No load was added to the model. Notice the power flow into the first wandering lateral. The second
wandering lateral takes another single-phase flow. The center of the diagram shows power flow on three
single-phase lines. The flows join back up to serve the three-phase load.
Analysis using wandering laterals uses the fully detailed by-phase load-flow model and engine.

Network analysis
The network analysis application contains three powerful methods for analyzing and fixing power
transmission, faults, and outages. Network load-flow, network fault, and network outage analysis comprise a
series of reports that simulate network events.
Refer to the topics listed below for more information.

Network analysis types on page 522

Setting up a network analysis on page 523

Performing a network analysis on page 524

Network analysis types

SynerGEE supports three types of network analysis: load-flow, fault, and outage. The analysis type that will
be performed is specified in the Network Analysis Options editor, as described in Setting up a network
analysis on page 523.
Refer to the topics listed below for more information.

Network load-flow analysis on page 522

Network fault analysis on page 523

Network outage analysis on page 523

Network load-flow analysis

The network load-flow analysis facilitates the detailed by-phase modeling of distribution systems and their
equipment. SynerGEE focuses on modeling devices rather than on matrix-based modeling limitations. When
the network load-flow analysis is run, it sees distribution power system devices with interconnected terminals
rather than lines, regulators, and capacitors. When the load-flow applies voltages or demand current to a
device like a regulator, that device handles its own internal workings.

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

523

The network load-flow report details lines, power flow, bus flows (except when a single-phase equivalent is
selected), buses, loads, voltage drop, regulators, and transformers. It also contains summary and topology
chapters. Feeder amps and voltage are updated on the distribution model following a network load-flow
analysis.

Generators in network load-flow

Generators are considered as negative constant power loads by network load-flow analysis, regardless of
how they are set up. That is, even if they are modeled as synchronous or induction machines, they are still
viewed as PQ machines by network load-flow. The generators are modeled at the center of the section with
an artificial bus.

Switches and network load-flow

In the distribution model, loads are placed inside of all devices. The network model places loads at the nodes.
When an open switch is put into a network, amp and power flow values may look peculiar if the section also
has load. The peculiarities come from translating network results into the radial distribution context. The
network load-flow should properly represent the model and its results. As such, it is recommended that loads
not be placed on sections with open switches.

Radial/looped flow versus network load-flow

If the SynerGEE radial or looped analysis engine were analyzing the exact same model as the SynerGEE
network engine, the results would match. The models that are analyzed by each engine differ based on the
strengths and weaknesses of the fundamental mathematics behind each approach.
Radial and looped models are analyzed by trace methods. This allows very robust and detailed models for
power system devices like regulators and capacitors. For a discussion of loops in an otherwise radial model,
see Loops and Wandering Laterals on page 253. On the other hand, network analysis handles densely
meshed networks. In this case, loads have to be placed on nodes and device models are simplified.

Network fault analysis

The network fault report focuses on buses, sequences, and lines during a fault. The network fault analysis
can be set up to run on queried nodes, as described in Setting up a network analysis on page 523.

Network outage analysis

The network outage analysis is designed to take each feeder out, one at a time. The report results
summarize transformer loading, feeder amps, low volts, and maximum loading with each feeder out of
service. If the network protector opens, the transformer loading chapter indicates it is open.

Setting up a network analysis

Perform the following procedure to set up a network analysis.

SynerGEE Electric 5.0

User Guide

524

Loads and Load Analyses

TO SET UP A NETWORK ANALYSIS

1

Perform the following steps to open the Network Analysis Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Network group, click the text label Network Load-Flow and then select Settings.

Use the Network Analysis Options editor to set up the network analysis. Refer to the following table
for more information on the options that you can set.
Type of Network
Analysis

Select the type of network analysis to be performed. The following

options are available:

Load-Flow

Fault

Outage Analysis

For a detailed description of each analysis type, see Network

analysis types on page 522.

Single-Phase
Equivalent Network
Analysis

This option is enabled only when the Analysis Type is set to LoadFlow.

Analyze query set

only

When performing a fault network analysis, select this option to limit

the analysis to sections in the query set only. For more information on
the query set, see Using the Query Set on page 173.

Click Apply to accept your changes, and then click X to close the editor.

Performing a network analysis

Perform the following procedure to run a network analysis on your model.

TO PERFORM A NETWORK ANALYSIS

1

If you have not already done so, use the Network Analysis Options editor to select the analysis type
and configure other analysis-related options as desired. For more information, see Setting up a
network analysis on page 523.

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Network group, click the Network Load-Flow icon.

NETWORK LOAD-FLOW ANALYSIS

The network analysis application contains three powerful methods for analyzing and fixing power
transmission, faults, and outages. Network load-flow, network fault, and network outage analysis comprise a
series of reports that simulate network events.
Refer to the topics listed below for more information.

User Guide

SynerGEE Electric 5.0

Loads and Load Analyses

Network analysis types on page 525

Setting up a network analysis on page 526

Performing a network analysis on page 527

525

Network analysis types

SynerGEE supports three types of network analysis: load-flow, fault, and outage. The analysis type that will
be performed is specified in the Network Analysis Options editor, as described in Setting up a network
analysis on page 523.
Refer to the topics listed below for more information.

Network load-flow analysis on page 525

Network fault analysis on page 526

Network outage analysis on page 526

Network load-flow analysis

The network load-flow analysis facilitates the detailed by-phase modeling of distribution systems and their
equipment. SynerGEE focuses on modeling devices rather than on matrix-based modeling limitations. When
the network load-flow analysis is run, it sees distribution power system devices with interconnected terminals
rather than lines, regulators, and capacitors. When the load-flow applies voltages or demand current to a
device like a regulator, that device handles its own internal workings.
The network load-flow report details lines, power flow, bus flows (except when a single-phase equivalent is
selected), buses, loads, voltage drop, regulators, and transformers. It also contains summary and topology
chapters. Feeder amps and voltage are updated on the distribution model following a network load-flow
analysis.

Generators in network load-flow

Generators are considered as negative constant power loads by network load-flow analysis, regardless of
how they are set up. That is, even if they are modeled as synchronous or induction machines, they are still
viewed as PQ machines by network load-flow. The generators are modeled at the center of the section with
an artificial bus.

Switches and network load-flow

In the distribution model, loads are placed inside of all devices. The network model places loads at the nodes.
When an open switch is put into a network, amp and power flow values may look peculiar if the section also
has load. The peculiarities come from translating network results into the radial distribution context. The
network load-flow should properly represent the model and its results. As such, it is recommended that loads
not be placed on sections with open switches.

Radial/looped flow versus network load-flow

If the SynerGEE radial or looped analysis engine were analyzing the exact same model as the SynerGEE
network engine, the results would match. The models that are analyzed by each engine differ based on the
strengths and weaknesses of the fundamental mathematics behind each approach.

SynerGEE Electric 5.0

User Guide

526

Loads and Load Analyses

Radial and looped models are analyzed by trace methods. This allows very robust and detailed models for
power system devices like regulators and capacitors. For a discussion of loops in an otherwise radial model,
see Loops and Wandering Laterals on page 253. On the other hand, network analysis handles densely
meshed networks. In this case, loads have to be placed on nodes and device models are simplified.

Network fault analysis

The network fault report focuses on buses, sequences, and lines during a fault. The network fault analysis
can be set up to run on queried nodes, as described in Setting up a network analysis on page 523.

Network outage analysis

The network outage analysis is designed to take each feeder out, one at a time. The report results
summarize transformer loading, feeder amps, low volts, and maximum loading with each feeder out of
service. If the network protector opens, the transformer loading chapter indicates it is open.

Setting up a network analysis

Perform the following procedure to set up a network analysis.

TO SET UP A NETWORK ANALYSIS

1

Perform the following steps to open the Network Analysis Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Network group, click the text label Network Load-Flow and then select Settings.

Use the Network Analysis Options editor to set up the network analysis. Refer to the following table
for more information on the options that you can set.
Analysis Type

Select the type of network analysis to be performed. The following

options are available:

Load-Flow

Fault

Outage Analysis

For a detailed description of each analysis type, see Network

analysis types on page 522.

User Guide

Single-Phase
Equivalent Network
Analysis

This option is enabled only when the Analysis Type is set to LoadFlow.

Analyze query set

only

When performing a fault network analysis, select this option to limit

the analysis to sections in the query set only. For more information,
see Using the Query Set on page 173.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Loads and Load Analyses

527

Performing a network analysis

Perform the following procedure to run a network analysis on your model.

TO PERFORM A NETWORK ANALYSIS

1

If you have not already done so, use the Network Analysis Options editor to select the analysis type
and configure other analysis-related options as desired. For more information, see Setting up a
network analysis on page 523.

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Network group, click the Network Load-Flow icon.

SCALE MANAGER
The Scale Manager is a SynerGEE tool that you can use to make temporary global changes to loads and
generation. The Scale Manager includes a number of slider bars for load categories such as distributed
loads, spot loads, large customers, and generators. Adjust a slider bar to the right to increase the loads for
the selected category; adjust the slider bar to the left to decrease the loads for the selected category.
The temporary load changes will be in effect as long as the Scale Manager is open. Once you close the Scale
Manager, the loads will revert to their original values. No permanent model changes are made at any time.
The purpose of the Scale Manager is to allow you to quickly and easily see the effect of increased and
decreased loads in your model. For example, models that will not convert typically will converge if the load is
drastically reduced. With a reduced load, you can explore voltage drops and overloads to try and find
bottlenecks. The Scale Manager makes this type of work extremely easy. You simply reduce the sliders and
then run or re-run your analysis as appropriate.
Another use of the Scale Manager is for photovoltaics intermittence. The Irradiance slider can be used to
increase or decrease the irradiance. This will help you find overvoltage problems and also see where
overloads might occur with the sudden loss of substantial PV.
Refer to the following topic for more information on using the Scale Manager.

USING THE SCALE MANAGER

1

Perform the following steps to open the Scale Manager:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Scale Manager.

In the Scale Manager, adjust a slider bar to the right to increase the loads for the selected category.
Adjust the slider bar to the left to decrease the loads for the selected category. The temporary load
changes will be in effect as long as the Scale Manager is open.

If desired, click the Re-run button to repeat the most recent analysis. You can use this button to see
the impact that adjusted loads will have on your model.

Click Hide or press F4 to close the Scale Manager.

SynerGEE Electric 5.0

User Guide

528

User Guide

Loads and Load Analyses

SynerGEE Electric 5.0

CHAPTER

10
Capacity
SynerGEE provides a variety of analysis tools to help optimize your system and make sound engineering
decisions. Refer to the topics listed below for more information.

Optimal Switching Analysis on page 529

Throw-Over Analysis on page 533

Auto-Transfer Switch Analysis on page 533

Automatic Feeder Switching (AFS) Analysis on page 534

Substation Bus Transformer Analysis on page 534

Contingency Analysis on page 535

OPTIMAL SWITCHING ANALYSIS

SynerGEEs optimal switching analysis is a powerful tool that helps you find the best operating state for
feeder switches. The application accounts for exceptions, low voltages, demands, and other objectives. It is
easy to use and produces a clear and understandable summary report with suggested switching operations.
Refer to the topics listed below for more information.

Optimal switching analysis operation on page 529

OSP application speed on page 530

Setting up an optimal switching analysis on page 530

Performing an optimal switching analysis on page 532

Optimal switching analysis operation

SynerGEEs optimal switching analysis finds the local extreme for a single objective. The analysis starts with
a base load-flow run with switches in their pre-analysis state. From all available switching pairs it finds the
switching pair that would result in the best evaluation of the objective. A switching pair is one open switch and
one closed switch combination. The optimal switching analysis performs the switching operation, runs a new
load-flow, and then repeats the process until no switching pairs result in an improvement of the objective. As
such, the operations are cumulative. Optimal switching considers switches only. That is, switchable protective
devices are not considered.

SynerGEE Electric 5.0

User Guide

530

Capacity
The SynerGEE approach, called local optimization, reaches a solution through successively realizable
states. SynerGEE avoids a second approach, known as global optimization, in which the objective may be
found by initially opening all switches and then reconnecting the system. Global optimization tends to lead to
theoretical results that are not very practical, for the following reasons:

Getting from the base state to a global optimum state may require cumbersome switching plans and
contingency studies.

A global state may be unachievable without causing an outage.

Reaching a global state can be expensive in terms of line crew time.

A clear benefit of the local method used by optimal switching is the ease of actual implementation of the
results. You can apply results in the model or in the actual system in a step-by-step fashion, without losing
any loads or customers. You may implement as many recommendations as desired. For instance, if a report
lists eight switching operations, you may look at the various items within the report and decide to apply only
the first three operations. Keep in mind that the results are generated in a cumulative manner according to
performance, and should be implemented in order. If you had eight recommended operations, you could
choose to implement operations 1, 2, and 3. But implementing 1, 3, and 7, for instance, would produce
unpredictable results, irrelevant to the analysis you performed.
Optimal switching does not make changes to the model; it simply reports recommendations. All switching
operations involve all phases of the relative sections. The analysis includes all selected feeders. The program
ignores switches tied to feeders that are not selected in the current view.
A feeder owns all sections to which it is electrically tied. Therefore, a sections feeder may change many
times during an analysis.

OSP application speed

Constraints and objectives evaluated by optimal switching are very sensitive. Switching cases are brought to
full convergence if possible, which can take some time. Therefore, selection of iteration limits and
convergence tolerance are important to application performance. To keep analysis time to a minimum, the
following are some suggested settings.
Suggested optimal switching settings
Iteration Limit

12 to 20 (higher values will slow the application)

Convergence Tolerance

0.5 to 0.1 (lower values will slow the application)

Setting up an optimal switching analysis

Perform the following procedure to set up an optimal switching analysis.

TO SET UP AN OPTIMAL SWITCHING ANALYSIS

1

User Guide

Perform the following steps to open the Switching Options editor:

a

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Switching group, click the text label Optimal and then select Settings.

SynerGEE Electric 5.0

Capacity

531
2

Use the Switching Options editor to select an objective for the analysis and specify analysis
constraints. The following table describes the different options that you can set.
Objective

Select an objective that you want to achieve in the optimal

switching analysis. These objectives are independent and
evaluated for all feeders selected within the map view used to
invoke the application.

Minimize losses. Switches are toggled to reduce the

total kW loss for all selected feeders.

Improve lowest voltage. Switches are toggled to

obtain the best low voltage for all sections in all feeders
being analyzed. The section having the lowest voltage
may change from the original run and the summary as
successive switching operations are evaluated and
performed.

Minimize number of exceptions. Loading and voltage

exception counts are minimized through switching
operations. The total count from all feeders being
analyzed is considered.

Minimize feeder demand. The lowest total kVA

demand for all feeders being analyzed is found. Since
the total for all feeders is considered, the demand for
particular feeders could conceivably increase and be
offset by a reduction in the demand on other feeders.

Minimize feeder kVA imbalance. Percent kVA

imbalance calculations are made for each feeder.
Switching operations are performed to reduce the
average of all feeder imbalance values.

Minimize substation transformer loading. Switching

operations are made to reduce the total loading on all
substation transformers. If no substation transformers
are in the selected feeders, loading on all primary
transformers is considered.

Equate loading. Switches are toggled to move load so

that the total load is distributed more evenly among the
feeders.

Take note that the analysis results table lists values for all of
these options, regardless of which objective was selected for
optimization.

SynerGEE Electric 5.0

User Guide

532

Capacity

Constraints

Specify the following constraints that may limit switching

operations:

Voltage. Specify a voltage constraint to disallow any

switching operation that would result in a section
voltage falling under the voltage limit.

Loading. Specify a loading constraint to disallow any

switching operation that would result in a device loading
exceeding the loading limit.

Operation Limit. Specify a maximum number of

switching operations that are allowed during the
analysis.

Optimal switching runs a preliminary load-flow on the model

before attempting any switching actions. If current model
conditions already violate the constraints, you will have the
option of resetting those constraints to current model conditions.
This constraint adjustment is temporary for the current analysis
and does not affect your stored analysis options.
3

Click Apply to accept your changes, and then click X to close the editor.

Performing an optimal switching analysis

Perform the following procedure to run an optimal switching analysis.

TO PERFORM AN OPTIMAL SWITCHING ANALYSIS

1

If you have not already done so, use the Switching Options editor to select the contingency analysis
method and set other options related to the analysis. For more information, see Setting up an
optimal switching analysis on page 530.

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Switching group, click the Optimal icon.

The optimal switching analysis produces a report with the components of a load-flow analysis,
including a standard heading and message summary. It also produces a detailed load-flow report
and switch summary. In this part of the report, you can review the improvements made by the
switching operations, as well as the performance of other items like total loading, exceptions, low
voltage, and transformer loading.

Optimal switching report switch plan section

User Guide

SynerGEE Electric 5.0

Capacity

533

THROW-OVER ANALYSIS
The throw-over analysis analyzes the effects of feeder outages and the resulting pickup in capacity of
adjacent feeders. The analysis only evaluates feeders with an auto-transfer switch that connects the feeder
to an adjacent feeder.
During the analysis, each applicable feeder is taken out of service one at a time. The throw-over switches will
transfer load to the adjacent feeders, and the resulting transfers and loading levels are summarized in the
throw-over analysis report.
The State Master window will also appear after the throw-over analysis is complete. The State Master allows
you to temporarily apply the results of each feeder outage to the model, where the results are displayed in the
SynerGEE map display and elsewhere in SynerGEE. You must restore the model to its original condition
before you can close the State Master. For more information on using the State Master, see State Master on
page 768.

TO PERFORM A THROW-OVER ANALYSIS

1

In the SynerGEE ribbon bar, select the Capacity tab.

In the Switching group, click Throw-Over.

AUTO-TRANSFER SWITCH ANALYSIS

The auto-transfer switch analysis allows you to see the impact that the toggling of auto-transfer switches will
have on your system. Essentially, it analyzes a set of feeders tied to critical loads through auto-transfer
switches. The resulting report has two sections. The first section, as shown below, presents the feeder
loading, low voltage, and maximum loading of all feeders affected by auto-transfer switches under normal
conditions, then with all auto-transfer loads connected, and finally with all loads disconnected.

Feeder information, auto-transfer switch analysis report

The second section in the report lists each auto-transfer switch pair. The load, low voltage, and maximum
loading on the feeders associated with each switch are given for the normal switch positions and the toggled
switch positions.

SynerGEE Electric 5.0

User Guide

534

Capacity

Auto-transfer switch information

These two report sections provide a feeder level and switch level review of the impact of auto-transfer
switches on feeder loading.
The auto-transfer analysis runs on the feeders in memory that are currently selected. For more information
on feeder selection, see Selecting Feeders on page 157.

TO PERFORM AN AUTO-TRANSFER ANALYSIS

1

In the SynerGEE ribbon bar, click the CAPACITY tab.

In the Switching group, click Auto-Transfer.

AUTOMATIC FEEDER SWITCHING (AFS) ANALYSIS

The automatic feeder switching (AFS) analysis investigates the ability of surrounding feeders to automatically
pickup load that was isolated due to a feeder outage. This analysis only operates switchable devices that are
automatic, which includes the following:

Switches that have been configured as automatic switches

Reclosers that have been configured as mid-point reclosers

Reclosers that have been configured as tie reclosers

During the analysis, SynerGEE will find all of the automatic switches and reclosers for each feeder and
transfer their load to adjoining feeders. The goal of the analysis is to determine if there is adequate capacity
on the surrounding feeders to pick up all automatic transfers.
For more detailed information on the AFS analysis, see the SynerGEE Electric Engineering Handbook.

TO PERFORM AN AUTOMATIC FEEDER SWITCHING (AFS) ANALYSIS

1

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Switching group, click AFS.

SUBSTATION BUS TRANSFORMER ANALYSIS

The substation bus transformer analysis shows the percentage of a substation transformers demand that
can be picked up by an adjoining substation transformer. There are no configuration settings for this analysis.

User Guide

SynerGEE Electric 5.0

Capacity

535

TO PERFORM SUBSTATION BUS TRANSFORMER ANALYSIS

1

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Switching group, click Substation Bus Transformer.

CONTINGENCY ANALYSIS
Contingency analysis simulates the loss or fault of a section(s) or a bus and then searches for a switching
recovery plan. Recovery plans are presented with comprehensive reports, which include step-by-step
switching recommendations and often present graphic snapshots of the original model, outaged model, and
recovered model.
Contingency analysis offers several different methods of operation. These are as follows:

Fast Pickup method. The fast pickup method uses a switch path reduced model for picking up
outage. If desired, the resulting output can be sent to the Switch Plan Manager. For more
information, see Fast pickup method on page 536.

Optimized Pickup method. The Optimized Pickup method is a detailed, objective-based process
of determining an optimal recovery plan for outage situations. It has a variety of different options that
allow you to create contingency plans for different types of outages that suit your particular system
and protocol. Compared with the Load Transfer method, it is more of a planning tool, whereas the
Load Transfer method focuses more on current performance and safety. For more information, see
Optimized pickup method on page 536.

Load Transfer method. The primary goal of the Load Transfer method is to switch large portions of
load from the outage area to adjacent feeders, while also isolating the outage area. During the
process, it operates mainly by toggling switch pairs, with a strong focus on system performance.
Therefore, it is most useful for determining whether adjacent circuits will be able to handle
contingency situations, and determining where problems may exist. For more information, see
Load Transfer method on page 537.

The results of contingency analysis can vary significantly depending on the method and options you select.
Therefore, you should be sure that you have it configured correctly for your situation, and that you understand
the process behind the results before incorporating them into a real-world workflow.
Refer to the topics listed below for more information.

Contingency analysis methods on page 535

Setting up a contingency analysis on page 537

Performing a contingency analysis on page 546

Isolating sections on page 546

Examples of contingency outage types on page 546

Contingency analysis methods

The contingency analysis provides for several different approaches, including the Fast Pickup method, the
Optimized Pickup method, and the Load Transfer method. Although these methods may provide different

SynerGEE Electric 5.0

User Guide

536

Capacity
solutions to the same problem, you should keep in mind that they are solving for different purposes and the
results should be used accordingly. Any given distribution system may have numerous solutions to a
particular problem, and SynerGEE is simply attempting to find the best one according to the settings and data
provided. Regardless of methodology, though, you should always use sound engineering judgment while
evaluating SynerGEE results, with consideration of the unique characteristics of the actual system under
study.
You can select the approach type in the Contingency Analysis Options editor, as described in Selecting the
contingency analysis method on page 537.
Refer to the topics listed below for more information.

Fast pickup method on page 536

Optimized pickup method on page 536

Load Transfer method on page 537

Fast pickup method

The fast pickup method uses a switch path reduced model for picking up outage. If desired, the resulting
output can be sent to the Switch Plan Manager.

Optimized pickup method

The Optimize Pickup method of contingency analysis is designed primarily as a planning tool for developing
contingency switching plans. It performs a detailed, granular analysis to restore as much of an outage as
possible, according to the specified objective. The Optimized Pickup method does consider constraints and
performance during the analysis, but it is mostly focused on producing a realistic and achievable switching
plan in the event of an outage.
The following basic process is used during an Optimized Pickup method analysis:
1

Analyze the base model without a contingency.

Create an outage with a contingency or multiple contingencies, according to the analysis options.
The newly outaged sections are referred to as the outage set.

Isolate the contingency, if it specified in the analysis options. This simulates a fault type outage, in
which the original conditions that produced the outage are considered to still exist.

Open all closed switches in the outage set. This action allows smaller increments of load to be
picked up when switch closing is begun. Without this action, many switch closings to pick up unfed
sections would result in overloading, and possibly models with infeasible load-flow solutions.

Close switches to pick up the outage, according to the specified objective. The objective has a
significant impact on the recommended switching sequence.

The application only considers contingencies within the selected feeders, but uses adjacent non-selected
feeders in the analysis for a switching recovery plan. Any switch in an adjacent feeder may be used to pick up
unfed sections.
One of the notable aspects of the Optimized Pickup method is that it opens all switches in the outage area
first and then begins to form the most optimal switching plan for maximum pickup. This approach allows the

User Guide

SynerGEE Electric 5.0

Capacity

537

analysis to find recovery solutions in an incremental fashion that helps prevent overload disqualifications
early in the process.

Load Transfer method

The Load Transfer method of contingency analysis is designed to provide a larger view of system
performance and safety in consideration of outage restoration. The Load Transfer method is focused on
transferring larger areas of load from an outage area to another feeder. In doing so, it operates much more
quickly and provides a better view of overall reserve capacity than the Optimized Pickup method. For
example, you can do a batch analysis of all selected feeders, one at a time, and see where problems may
arise system-wide as feeder sources are outaged. It allows you to see how capable adjacent feeders will be
to handle the additional load imposed by an outage restoration process.
During a Load Transfer contingency analysis, SynerGEE looks for switch pairs to toggle in pursuit of load
pickup, without any preliminary opening of switches like the Optimized Pickup method. In the end, the Load
Transfer method produces a switching scenario for pickup as well, but it may be less detailed and effective as
a plan from the Optimized Pickup method. Therefore, the Load Transfer method may be a better means of
determining the preparedness of your system to handle contingencies, rather than producing precise
contingency switching plans.

Setting up a contingency analysis

Perform the following procedure to set up a contingency analysis.

TO SET UP A CONTINGENCY ANALYSIS

1

Perform the following steps to open the Contingency Analysis Options editor:
a

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Analysis group, click the text label Contingency and then select Settings.

On the left side of the Contingency Analysis Options editor, select from the different tab names to
access the available contingency analysis options. The following sections describe the different
tasks that you can perform:
-

Selecting the contingency analysis method on page 537

Setting up a Fast Pickup contingency analysis on page 538

Setting up a Load Transfer contingency analysis on page 540

Setting up an Optimized Pickup contingency analysis on page 542

Click Apply to accept your changes, and then click X to close the editor.

Selecting the contingency analysis method

Perform the following procedure to edit options related to the contingency analysis approach.

SynerGEE Electric 5.0

User Guide

538

Capacity

TO SELECT THE CONTINGENCY ANALYSIS METHOD

1

Perform the following steps to open the Contingency Analysis Options editor:
a

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Analysis group, click the text label Contingency and then select Settings.

In the Contingency Analysis Options editor, select the Approach tab. Use the options in the
Approach tab to edit the following settings:
Analysis Approach

Use the Analysis Approach area to select the analysis approach that
you want to use. Available choices are as follows:

Fast Pickup Method

Transfer method

Optimized Pickup method

For more information on these options, see Contingency analysis

methods on page 535.
Exception limits

Click the Exception limits button to open the Exceptions tab in the
Model and Analysis Options editor, where you can define exception
loading limits.

Contingency

Use the Contingency area to select the type of analysis that you
want to run. Available choices are as follows:

Batch run. A batch run launches an individual contingency

analysis for all displayed feeders (Feeder), substations
(Sub), or all sections that are marked as either
Contingency sections, Critical sections, or both.

Single run. A single run launches an individual analysis on

feeders (Feeder) or substations if downstream sections are
set for contingency (Sub), or for an outage on a section
that is set for analysis (Section itself).

If you select the subsection (Sub) check box for either the Batch run
or Single run option, the Disable Field Switching check box is
enabled. Select this check box to disable the operation of all switches
during the analysis. This option is equivalent to selecting the Dont
allow operation from analysis check box on all switches.
Recommended Plans

Use this option to specify the maximum number of transfer pairs that
will be studied per switching plan during the analysis.

Click Apply to accept your changes, and then click X to close the editor.

Setting up a Fast Pickup contingency analysis

Perform the following procedure to set up a contingency analysis to use the Fast Pickup method.

User Guide

SynerGEE Electric 5.0

Capacity

539

TO SET UP A FAST PICKUP CONTINGENCY ANALYSIS

1

Perform the following steps to open the Contingency Analysis Options editor:
a

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Analysis group, click the text label Contingency and then select Settings.

In the Contingency Analysis Options editor, select the Approach tab, and under Analysis Approach,
make sure that Fast Pickup method is selected. For more information on this and other options on
the Approach tab, see Selecting the contingency analysis method on page 537.

Select the Fast tab. Use the options in the Fast tab to edit the following settings:
Generate switch plans

Select this check box if you want to generate switch plans as a part of
the Fast Pickup contingency analysis.

Bring up Switch Plan

Manager

Select this check box if you want to open the Switch Plan Manager at
the completion of the Fast Pickup contingency analysis. For more
information on the Switch Plan Manager, see Using the Switch Plan
Manager on page 413.

Show poor plans

Select this check box have to send any poor plans from the
Contingency Analysis to the Switch Plan manager. Doing so will make
it easier to implement the switch plan, run a load-flow analysis, and
review the details.
Poor plans are defined later in this table, with the Plans that are
close option.

Limit Results

Select this check box to limit the results of the Fast Pickup
contingency analysis to a specified number of plans. The analysis will
stop when the first limit is reached, but report all plans that were
calculated up until that point. For example, if you specify limits of 10
good plans, 10 close plans, and 100 poor plans, the results could be
5 good plans and 10 close plans, or 10 good plans and 5 close plans,
simply depending on which plan limit SynerGEE reaches first.

Plans that are close

Enter a value here to specify which plans will be determined close

and which will be determined to be poor, based on a percentage of
the emergency exception loading limit, as specified in the Exceptions
tab of the Model and Analysis Options editor.

SynerGEE Electric 5.0

Good plans are those that do not exceed 100% of the

emergency exception loading limit.

Close plans are those that fall between 100% of the

emergency exception loading limit and the percentage value
specified here in the % of emergency rating text box.

Poor plans are those where the emergency exception

loading limit is greater than the percentage value specified
here in the % of emergency rating text box.

User Guide

540

Capacity

Allow reclosers to be
used for switching

Select this check box to allow operation of reclosers on the switching

paths to help restore outaged customers.

Only use automatic

switches

Select this option to consider auto switches only when performing a

Fast Pickup contingency analysis.

Use non-selected
feeders and subs to
pickup

Select this option to use non-selected feeders and subtransformers to

pickup contingency outages. Note that while this option is selected,
only selected feeders or subs will be processed as outage events but
non-selected feeders and subs can be used for pickup.
Note also that this feature is designed to be used in an automated
fashion with reports. If you wish to use the switch plan manager to
work through contingency results, it is strongly recommended that
you do not select this check box.

Click Apply to accept your changes, and then click X to close the editor.

Setting up a Load Transfer contingency analysis

Perform the following procedure to set up a contingency analysis to use the Load Transfer method.

TO SET UP A LOAD TRANSFER CONTINGENCY ANALYSIS

1

Perform the following steps to open the Contingency Analysis Options editor:
a

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Analysis group, click the text label Contingency and then select Settings.

In the Contingency Analysis Options editor, select the Approach tab, and under Analysis Approach,
make sure that Transfer method is selected. For more information on this and other options on the
Approach tab, see Selecting the contingency analysis method on page 537.

Select the Transfer tab. Use the options in the Transfer tab to edit the following settings:
Constraints

User Guide

Use the Constraints section to specify system constraints that may

limit switching operations. The following options are available:

Emer low volts. Use this option to set the analysis to use a
low voltage setting instead of the value set in the exceptions
limits.

Use relay trip points. Select this option to allow the

analysis to consider using relay trip points as a possible
limiting factor during switching.

Use invalid cases if necessary. Select this check box to

display invalid plans in the Valid plans chapter of the
Contingency Output report.

SynerGEE Electric 5.0

Capacity

541

Switching

Output Options

Constraints for
Considering a
Transfer

SynerGEE Electric 5.0

Use the Switching section to set the following options:

Use fuses. Select this check box to allow operation of fuses

on the switching paths to help restore outaged customers.

Use breakers and reclosers. Select this check box to allow

operation of breakers and reclosers on the switching paths
to help restore outaged customers.

Use the Output Options section to set the options that are related to
the reports that are produced at the end of the analysis. The following
options are available:

Limit reports to X failed plans. Use this option to set a limit

on the number of failed reports. The default value is 25.

Generate maps. Select this check box to have the

Contingency Analysis generate maps along with the reports.

Show auto-transfer operations. Select this check box to

show auto-transfer switching operations in the report plans.
Auto-transfers happen automatically at the onset of the
contingency, so you may choose not to show these
operations.

Switch identification. Use this option to specify how

switches are identified in the report by section ID or by
name.

Use the Constraints for Considering a Transfer section to set the ratio
of load through a closed switch over the reserve amps for an open
switch.

Increasing the Min ratio value results in more load being

transferred through the switching pairs.

Decreasing the Max ratio value results in more switching

pairs.

User Guide

542

Capacity

Analysis Time Tuning

Recommended Plans

Use the Analysis Time Tuning area to set the following options:

Time limit. Use this option to set the amount of time that
should be spent in finding a solution for a single event. The
evaluation of an event will be terminated when this time limit
is reached.

Max event overload evals and Max event underload

evals. Use these two options to set the maximum number of
transfers allowed for an event. Typically these values should
be in the 200s range. The default values are 150 and 175.

Max step overload evals and Max step underload evals.

Use these two options to set the maximum number of open
switch transfers that are allowed for a particular closed
switch. Typically these settings should be in the 20s range.
The default values are 25 and 30.

Use Recommended Plans section to set the minimum number of valid

switching plans that will be generated by the Load Transfer
contingency analysis and reported in the analysis report.

Click Apply to accept your changes, and then click X to close the editor.

Setting up an Optimized Pickup contingency analysis

Perform the following procedure to set up a contingency analysis to use the Optimized Pickup method.

TO SET UP AN OPTIMIZED PICKUP CONTINGENCY ANALYSIS

1

Perform the following steps to open the Contingency Analysis Options editor:
a

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Analysis group, click the text label Contingency and then select Settings.

In the Contingency Analysis Options editor, select the Approach tab, and under Analysis Approach,
make sure that Optimized Pickup method is selected. For more information on this and other
options on the Approach tab, see Selecting the contingency analysis method on page 537.

User Guide

SynerGEE Electric 5.0

Capacity

543
3

Select the Optimize tab. Use the options in the Optimize tab to edit the following settings:
Contingency

Select the type of contingency situation that you want to analyze. The
following options are available:

All together. All sections marked as contingency sections

are taken out at once, and a switching recovery plan is
sought.

One at a time. Sections marked as contingency sections

are taken out one at a time. With each outage, contingency
analysis looks for a separate switching plan. All
contingencies are summarized in a single report.

Analysis section only. Only the section that is set for

analysis is outaged. Sections marked as contingency
sections are treated normally.

Remember that marking a section as a contingency section is

different than setting a section for analysis. You can mark a section
as a contingency section using the Section editor, and once applied,
that setting is stored in the model data. Any sections marked in this
fashion apply to the first two types of analysis listed above All
together and One at a time.
For more information on marking a section as a contingency section,
see Editing additional general settings for a section on page 283.
For more information on setting a section for analysis, see Setting a
section for analysis on page 434.
Outage Type

Select the type of outage you want to result when the contingency
section(s) is taken out. Available choices are as follows:

Node (buss) Type. The bus or source node of the

contingency section is considered out. Any other sections
fed by that node are also considered out.

Branch Type. The contingency section is considered out,

but the source node remains fed.

In addition, you can have the contingency simulated as a fault, in

which case SynerGEE first isolates the contingency area by opening
all necessary switches. In this case, the switching recovery plan will
not include the closure of any switches that would feed power to the
contingency area. If SynerGEE is unable to isolate the fault, the
analysis stops and produces an error message.
For more information, see Examples of contingency outage types
on page 546.

SynerGEE Electric 5.0

User Guide

544

Capacity

Constraints

Specify system constraints that would prohibit any switching

operation which would cause any of the following situations:

Voltage. A voltage that is below the specified minimum

value

Loading. A section, transformer, or regulator loading that is

above the specified maximum value

Prot. Dev. A fuse or protective device loading that is above

the specified maximum value

A number of switching options are available at each iteration. A

switch is selected if:

It is an automatic switch and preference is given to

automatic switches.

The switch was closed in the pre-outage model and

minimize switch operations was selected.

It produces the maximum progress towards the selected

objective.

Contingency runs a preliminary load-flow on the model before

attempting any switching actions. If current model conditions already
violate the constraints, you will have the option of resetting those
constraints to current model conditions. This constraint adjustment is
temporary for the current analysis and does not affect your stored
analysis options.
Pickup Order

User Guide

Select the pickup objective to be considered in the switching recovery

plan. The following options are available:

Minimal exceptions. Switches are selected so that closing

them results in a feasible model with the least total number
of exceptions.

Most sections. Switches are selected so that closing them

results in a feasible model with the most sections being fed.

Most load. Switches are selected so that closing them

results in a feasible model with the most kVA load being fed.

Most customers. Switches are selected so that closing

them results in a feasible model with the most customers
being fed. This option requires customer information in the
section records.

Losses. Keep overall losses as low as possible during

pickup.

Low voltage. Switches are selected so that the lowest

voltage of a previously outaged section is as high as
possible.

SynerGEE Electric 5.0

Capacity

545

Min switch changes

Select this check box to have SynerGEE try to find the solutions that
have the fewest switch state changes from the base case.

Isolate Outage

Sets SynerGEE to open switches around the outage as necessary to

isolate it, and hold them open through the analysis. This allows you to
develop a contingency switching plan for a fault-related outage, in
which the fault condition is still present and requires isolation.

Switch Prot. Devices

Sets SynerGEE to consider the switching of protective devices while

developing a recovery plan.
Contingency analysis can operate fuses, reclosers, sectionalizers,
and breakers as switchable devices. These devices can be
individually excluded from consideration during contingency analysis,
like switches. This exclusion is done through a check box on the
respective device editor. Or, you can globally exclude all protective
devices from analysis by selecting this option.
Whether used for switching or not, protective devices are evaluated
for emergency loading constraints during switching operations.
Device loading exceeding the load limit in the analysis will disallow a
switching operation.
For more information on switchable protective devices, see
Switchable protective devices on page 600.

Prefer Auto Switches

Sets SynerGEE to close automatic switches at the earliest

opportunity, provided that constraints are not violated. The automatic
switches are closed before regular switches. The selected objective
for contingency analysis is not considered, and other switching
operations may have resulted in a larger pickup. If multiple automatic
switches can be operated, the specified objective is used to select
among them.
Likewise, auto-transfer switches are toggled to pick up respective
load at the earliest opportunity during contingency analysis. Loads in
the contingency area served by auto-transfer switches are switched
to an unaffected feeder immediately, if possible. Auto-transfer
switches are evaluated after each contingency selection to determine
if their unfed load can be switched to another feeder.
For more information on automatic and auto-transfer switches, see
Special switch types and functions on page 400.

Switch Limit

Sets a maximum number of switching operations to achieve the

desired objective. This setting is for reporting purposes only. If the
analysis reaches the limit, it continues to search for qualified
switching operations as usual; however, any operations that exceed
the limit are flagged in the analysis report.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

546

Capacity

Performing a contingency analysis

Contingency analysis finds switching solutions in a cumulative manner. Beginning with the model as is, it
finds one switching operation to improve the objective, and then continues with more switching operations
until the objective can no longer be improved. This process is generally known as local optimization because
the objective is improved with each step. The alternative, called global optimization, can produce different
results and require a degradation in the objective for one or more switching operations. It can also result in a
solution that is not practical for a line crew and not achievable without imposing even more outages than
were seen by the original contingency.
The contingency analysis runs on the feeders in memory that are currently selected, and may include
adjacent feeders in the switching recovery plan. For more information on feeder selection, see Selecting
Feeders on page 157.
In most cases when the analysis is complete, the Switch Plan Manager will appear. You can use the Switch
Plan Manager to select the switch plan that is most appropriate for your model and then save that plan as a
part of the model. For more information on using the Switch Plan Manager, see Using the Switch Plan
Manager on page 413.

TO PERFORM A CONTINGENCY ANALYSIS

1

If you have not already done so, use the Contingency Analysis Options editor to select the
contingency analysis method and set other options related to the analysis. For more information,
see Setting up a contingency analysis on page 537.

In the SynerGEE ribbon bar, select the CAPACITY tab.

In the Analysis group, click the Contingency icon.

Isolating sections
Within contingency, you can isolate the section with the nearest upstream switchable device and transfer load
downstream from the selected section to neighboring areas. This gives you the ability to evaluate switching
options in SynerGEE.

TO ISOLATE A SECTION
Right click on a section and select Isolate. Use Undo to remove the isolation.

Examples of contingency outage types

Consider this simple model, in which section 4 only is marked for contingency:

User Guide

SynerGEE Electric 5.0

Capacity

547

15

A (NO)

2
3
5

14

4
6

B (NC)

C (NC)
13
8

11
10
9

E (NO)

D (NO)

12

Example model

The following would be the analysis results for the different outage types.

Branch contingency Dont isolate. Section 4 is taken out, but the source node is still fed. Sections
4, 6, 8, 10, and 11 are in the outage. Switch E or switch D could be used to pick up the outage
sections. Sections 4, 6, and 8 will be picked up with switch C if possible.

Branch contingency Isolate as a fault. Section 4 is considered faulted, and the area is isolated by
opening switches B and C, and locking open switch A. The only section that can be recovered is
section 9, by closing switches E and D.

Node contingency Dont isolate. The source node of section 4 is taken out, and sections 3, 4, 2,
and all downstream sections are outaged. Switches A, B, and C can be used to pick up the outage.

Bus contingency Isolate as a fault. A fault is assumed at the source node of section 4, and the
area is isolated by opening switches B and C, and locking open switch A. The only section that can
be recovered is section 9, by closing switches E and D.

SynerGEE Electric 5.0

User Guide

548

User Guide

Capacity

SynerGEE Electric 5.0

CHAPTER

11
Planning
LOAD ALLOCATION ANALYSIS
Load allocation is used to distribute load throughout a model, based on demands specified in meter devices
throughout your model, often at your feeder or subtransformer sources. Optionally, spot loads and loads at
large customers can be updated as well. To accomplish this, SynerGEE adjusts all distributed loads so that
the total load into sections (downstream from a meter) after a balanced or by-phase analysis matches the
specified demands. The value of these distributed loads is determined by running a load-flow analysis and
then looking at the differences between the specified demand values and the actual power into the sections,
with the resulting mismatch divided among sections and phases as appropriate.
The following items should be noted:

By default, load allocation applies to section distributed loads only. Unless specifically enabled, spot
loads and large customer loads are not affected, since they are known loads at specific points and
typically do not need allocation.

Sections without kVA values (or kWh, if you select allocation based on kWh) do not receive portions
of the allocated loads.

Losses are included in the allocation since load-flow analysis is used during each iteration of the
allocation.

Capacitors and generators increase the amount of load that is allocated, since they supply real and
reactive values of power to the feeder.

Following convergence and allocation completion, you have the option of making the loads
permanent. If you choose not to, a report is still generated, but no changes are made to the model. If
you choose to make loads permanent, all kW and kvar information in the selected feeders will be
replaced.

Refer to the topics listed below for more information.

When to run load allocation on page 550

About load allocation demands and meters on page 550

Suggested approaches to load allocation on page 551

Demands format for load allocation on page 551

Regulator and capacitor options during load allocation on page 551

Load allocation calculations with customer load curves on page 552

SynerGEE Electric 5.0

User Guide

550

Planning

Other load allocation considerations on page 552

Setting up a load allocation analysis on page 552

Performing a load allocation analysis on page 555

When to run load allocation

As with most aspects of load modeling, the proper frequency of allocation varies with individual organizations
and users. Generally, allocation should be kept to a logical minimum, to promote stability and consistency in
your models. Some users only allocate once or twice a year, perhaps when some major update is made to
the model. Other users, whose models may receive daily updates to metered demands, might allocate daily.
As a general rule, remember that allocation makes changes to your models and should be performed only
when you have a justifiable need.

About load allocation demands and meters

In a SynerGEE model, all demands are specified using meter devices. For load allocation purposes, you may
find it most suitable to model meters directly downstream from your feeder and subtran sources, because it is
common to have metered source demand data for these locations. In this document, demands are generally
treated with an implied assumption that they are source demands. However, you may put meters anywhere in
your model.
For any given section, when load allocation runs, it considers the nearest upstream active meter as the data
source for calculating distributed load, regardless of the meters proximity to the source. In essence, any
given meter owns the sections downstream from it, until the topological end or another active meter is
encountered. Any section that has no active meter upstream receives no distributed load during allocation. If
a meters kW or amp values are set to zero, then the load allocation analysis will issue a warning. If kW and
amp values in all meters are set to zero, an error will be issued and the analysis will not run.
In the Load Allocation Options editor, you can choose whether to allocate by feeder demands or by
substation transformers. This Scope for Allocation option refers to any meters located directly downstream
from the respective sources, which are essentially considered to be source demands. If you select Allocate
by Feeders, this has the same effect as turning off any subtran demand meters, in which case any meters on
subtran sections are ignored. On the other hand, if you select Allocate by Substation Transformers and you
wish for feeder demands to be ignored, you must select the Overridden by upstream meters option in the
Demands tab of the Meter editor for the feeder demands.
For any given meter, you can also select the Lock downstream loads check box in the Demands tab of the
Meter editor. When this check box is selected, SynerGEE will prevent the updating of any downstream loads
during a load allocation analysis.
If you model both a meter and a primary transformer directly downstream from a subtran source, the demand
data should reflect the metered demands on the secondary of the transformer. From a topology standpoint, a
transformer is always considered closer to a node than a meter. If you model a subtran meter without the
transformer instance, demands should still represent the secondary, unless the transformer is actually
modeled further downstream.
For more information on modeling meters, see Meters on page 356.

User Guide

SynerGEE Electric 5.0

Planning

551

Suggested approaches to load allocation

There are many approaches to allocating load. It is recommended that you try various settings and run
different allocations first without making the loads permanent. This way, you can look at the resulting reports
and find an approach to allocation that produces the most reasonable numbers based on your system and
experience.
The following are some suggested approaches.
Scenario

Recommendation

You have total values for metered demands but

your section by-phase information is unreliable.

Use balanced allocation.

You have a total values for metered demands and

your section phasing is accurate.

Use by-phase allocation with total demand.

You have by-phase metered demands and

accurate section phasing.

Use by-phase allocation with by-phase demands.

You have a total value for metered demands,

accurate section phasing, and a fairly balanced
loading.

Use by-phase allocation with by-phase demands.

In your meters, you should specify your total
demands averaged across the applicable phases.

Demands format for load allocation

In meter devices, you can specify demands in the following formats:

Amps/pf

kVA/pf

For more information on meters, see Meters on page 356.

Regulator and capacitor options during load allocation

The handling of switched capacitors and regulators can be set up before starting the allocation process. The
following options are available for each type of device.

Regulators:
-

Maximum tap

Minimum tap

Neutral tap

Controlled by SynerGEE load-flow

Hold current tap

Capacitors:
-

SynerGEE Electric 5.0

Trip modules

User Guide

552

Planning
-

Close modules

Controlled by SynerGEE load-flow

Hold current switch state

Only regulators in automatic mode and switched portions of capacitor installations in automatic mode are
affected by these selections. SynerGEE never adjusts manual mode regulators or capacitors.
Regulator and capacitor start options are specified in the Model tab of the Model and Analysis Options editor.
For more information, see Setting model and analysis options on page 436.

Load allocation calculations with customer load curves

Time-sensitive load allocation can produce significantly different results than traditional peak load allocation.
These results, in turn, are only useful within an environment of applied load curves. For more information on
load curves, time-of-day, and load allocation, see Load curves and load allocation on page 819.

Other load allocation considerations

The following list describes some additional issues to consider while allocating loads.

Substation transformers. When allocating with subtrans, the specified demands are recognized as
occurring on the primary of the transformer. If you do not have these values, you should place a
metering point on the section directly following the transformer, using the known secondary
demands.

Load I,Z,PQ. Section I,Z,PQ values are used during load allocation and can have a noticeable
impact on the results. For more information on I,Z,PQ, see Load %I, %Z, %PQ on page 496.

Load growth. Load allocation does not consider any kind of load growth, including growth curves.

Loops. Load allocation only handles radial models. If tie switches are modeled, they are treated as
open switches during allocation. For more information on loops and loop tie switches, see Loops
and Wandering Laterals on page 253.

Generators. Synchronous and induction generators are reverted to their corresponding constant
power (PQ) model during allocation. They produce their specified output power (scheduled percent
times rated power) at rated power factor.

Setting up a load allocation analysis

Perform the following procedure to set up a load allocation analysis.

TO SET LOAD ALLOCATION OPTIONS

1

User Guide

Perform the following steps to open the Load Allocation Options editor:
a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Loading group, click the text label Load Allocation and then select Settings.

SynerGEE Electric 5.0

Planning

553
2

Use the Load Allocation Options editor to set the following options:
Assignment

Load Allocation
Method

SynerGEE Electric 5.0

Select one of the following load assignment options:

Ask Before Assigning Loads. Select this option to have

SynerGEE prompt you before assigning loads to the model
for each section. Note the loads do not become permanent
until you manually save the model data. If you select No at
the prompt, SynerGEE will report the calculation results and
not assign any loads.

Report Only (No Assignment). Select this option to simply

report the calculation results and not assign any loads.

Select one of the following load allocation methods:

Connected Customers. Select this method to allocate load

based on the ratio of a sections by-phase connected
customers to the by-phase total for upstream metered
demands. For this method, you must have customer values
entered.

Connected kVA. Select this method to allocate load based

on the ratio of a sections by-phase connected kVA to the
by-phase total for upstream metered demands. For this
method, you must have connected kVA values entered in
the section records. During the analysis, SynerGEE
calculates the kW and kvar loads for each section.

Existing kVA. Select this method to allocate load based on

the ratio of a sections by-phase existing kVA to the byphase total for upstream metered demands. For this
method, you must have existing kVA values entered in the
section records.

Existing kW. Select this method to allocate load based on

the ratio of a sections by-phase existing kW to the by-phase
total for upstream metered demands. For this method, you
must have existing kW values entered in the section
records.

KWH. Select this method to allocate load based on the ratio

of a sections by-phase KWH values to the by-phase total.
For this method, you must have KWH values entered in the
section records.

RUS method. Select this method to allocate loads using the

RUS method of allocation (RUS Bulletin 45-1 and 45-2).
This method uses the same iterative process except that the
kW load is calculated by using Factor A and Factor B. Both
KWH and customer values must exist in the section records.

User Guide

554

Planning

Use Capacity Factor

Values

Select this check box to have SynerGEE use capacity factors during
load allocation. For more information, see Capacity Factors on
page 502.

Update spot loads

Select this option to allocate kW and kvar load values for spot loads
during a load allocation analysis. The spot load needs to have values
for kVA, kWh, or customers, or existing kW and kvar values. During
load allocation, load is distributed to the spot loads based on the
proportion of these allocation factors to the factors for distributed
loads and large customer loads, if enabled.

Update large
customer loads

Select this option to allocate kW and kvar load values for large
customers during a load allocation analysis. The large customer load
needs to have values for kVA, kWh, or customers, or existing kW and
kvar values. During load allocation, load is distributed to large
customers based on the proportion of these allocation factors to the
factors for distributed loads and spot loads, if enabled.

Scale Demands

Use the Scale demands area to adjust meter demands toward

minimum or maximum values, as specified on the Demands tab of the
meter editor. This demand scaling feature can be used to run different
load allocation analyses within the range of demands that you would
expect to see at the meters.
For more information on setting the scaling options for a meter, see
Setting up demands for a meter on page 359.

Load Power Factor

Select the Warn if limits violated check box to have the load
allocation analysis generate a warning if the power factor of a
distributed load is outside the specified range. After the warning is
displayed, you will have the option of making the newly allocated
loads permanent, or canceling the results. A report will be generated
regardless of which option you choose.

Scope for Allocation

Select whether to allocate loads based on feeder demands or subtran

demands. Feeder and subtran demands are specified using meter
devices directly downstream from the respective sources. For more
information on how source meters are handled according this setting,
see About load allocation demands and meters on page 550.
If you allocate based on subtran demands, you can choose to Reset
Downstream Meters. If this check box is selected, SynerGEE
automatically updates any downstream meters that are specified to
be overridden with new demand information derived through the
analysis.
If you allocate based on subtran demands and no substation
transformers are selected or exist in the model, SynerGEE will
allocate by feeder demands instead. An analysis warning will be
provided to notify you when this occurs.

User Guide

SynerGEE Electric 5.0

Planning

555

Type of Allocation

Select one of the following allocation types:

By-phase allocation using by-phase demands. Using a

by-phase load-flow, SynerGEE allocates loads by phase and
uses the by-phase demands to proportion values.

By-phase allocation using total demands. Using a byphase load-flow, by-phase loads are determined from the
ratio of by-phase information to by-phase upstream
demands. Upstream demands are shifted to be proportional
to the total by-phase allocation parameters such as KWH or
kVA.

Balanced allocation. Using a balanced load-flow,

SynerGEE allocates evenly across all phases of a line. It
also totals specified upstream demands, per meter device.

These options are designed to facilitate the various levels of detail in

feeder models, phasing, and metered demands.

Close switch
capacitors at startup

Select this option to close (turn on) any switched capacitors before
the load allocation analysis begins.

Disable meters along

loop paths

Select this check box to disable meters operating within loops. Meters
within loops might cause unexpected allocation results. These meters
will govern some, but possibly not all, of the load allocation within the
group.

Zero Distributed
Loads

Click to set the distributed load kW and kvar to zero for the current
year. This may be a useful way to focus on loads from other load
types.

Model Options

Click the Model Options button to open the Model and Analysis
Options editor.

Click Apply to accept your changes, and then click X to close the editor.

Performing a load allocation analysis

During allocation, SynerGEE performs multiple iterations of the following steps:
1

Remove all distributed loads from sections.

Run balanced or by-phase load-flow.

i
S i = S Specified S Into
Feeder

Calculate

i
Add S to distributed loads.

If

S i > Tolerance

SynerGEE Electric 5.0

, repeat to step 2.

User Guide

556

Planning
If balanced allocation is selected, balanced analysis is used. Otherwise, by-phase analysis is used. The
i
distribution of S among sections is dependent on allocation factors for each section.

TO PERFORM A LOAD ALLOCATION ANALYSIS

1

If you have not already done so, use the Load Allocation Options editor to select the configure
options related to the analysis. For more information, see Setting up a load allocation analysis on
page 552.

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Loading group, click the Load Allocation icon.

FORECASTING ANALYSIS
Forecasting is a SynerGEE analysis tool that can help you determine if your system includes the capacity
required to deliver anticipated future customer loads. Distribution forecasting also has an impact on
transmission planning, since transmission infrastructure must be built to support future distribution demands.
Contracts need to be put into place for future bulk load transfers, and regulating bodies need to be informed
about your plans to support your customers in upcoming years.
Forecasting is important to help evaluate future revenue, to ensure the solvency of your company and
financial performance to your stake or stock holders. For example, an investor-owned utility may look for
ways to attract load, and if the forecast looks bad, then the utility may need to act more aggressively in
looking for new load. A non-profit utility can use forecasting to effectively plan its system layout in order to
keep electric rates stable.
In addition, planning engineers must ensure that the distribution infrastructure can support future load. For
them, the loading along critical paths during the upcoming years is important. Forecasting individual load
growth within an engineering model is important to doing this. Engineering analysis is needed to evaluate the
ability of the distribution system to deal with future loads.
To set up your model for forecasting analysis, you must do the following:
1

Create areas of interest for your model. Areas of interest are two-dimensional geographic entities
that you can draw on the SynerGEE map display to specify anticipated future distribution load and
spot load for your system. For more information, see Areas of Interest on page 217.

Configure the forecasting analysis options. The Forecast Options editor allows you to configure a
number of settings for the forecasting analysis, including the type of forecasting agents that you
want to run. For more information on setting these options, see Setting up a forecasting analysis
on page 557 and Selecting a forecasting agent on page 560.

Once these tasks have been performed, you are ready to perform a forecasting analysis on your model. For
more information, see Performing a forecasting analysis on page 561.
Additional information on SynerGEE forecasting is provided in the Forecasting chapter of the SynerGEE
Technical Reference.

User Guide

SynerGEE Electric 5.0

Planning

557

Setting up a forecasting analysis

Before a forecasting analysis can be run, you must configure options that control the analysis. These include
selecting a forecasting method, forecast period, and forecast agents, as well as configuring multi-year
modeling options. Refer to the following procedure for more information.

TO SET FORECASTING OPTIONS

1

Perform the following steps to open the Forecast Options editor:

a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Loading group, click the text label Forecasting and then select Settings.

In the Forecast Options editor, select the Settings tab. The following table describes the different
tasks that you can perform.
To ...
Select a forecast period

Select forecast agents

SynerGEE Electric 5.0

Do This ...
a

Next to Start/Base Year, select the beginning year for

the forecasting analysis.

Next to Final Year, select the ending year for the

forecasting analysis.

Under Agents, select from any of the following options. A

description of each option is provided in Selecting a forecasting
agent on page 560.

Growth areas

Section curves

Feeder growth

Meter growth

Customer zone

Substation growth

Regional total

Regional distrib

Regional spot

User Guide

558

Planning

To ...

Do This ...

Select multi-year options

Select the appropriate check boxes to enable the following

options:

Select a forecast method

Specify load initialization

options

Hit growth targets. Select this option if you want to

make sure the growth targets are hit, taking into
account loads that may have already been set up for
future years.

No reduction in existing loads. Select this option if

you do not want the loads that were already set to be
adjusted by growth. This feature is particularly useful if
you know future load for certain years or already have
estimated load set for particular years.

Under Forecast method, select one of the following options:

One year to next. Select this option to grow forward

year by year in a linear method. For example, if the
base year has 2% growth and the next year has 3%
growth, the 3% growth is added to the base amount but
not to the base amount plus the 2% growth amount.

From base year. Select this option to grow the load

yearly, with loads adding each year. For example, if the
base year has 2% growth and the next year adds 3%
growth, the 3% growth is added to the base amount
plus the 2%.

Forecast last year and interpolate. Select this option

to forecast the final year growth and estimate the
intermediate years.

Use the Load Initialization section to set load initialization for

each of the following load categories:

Distributed Loads

Spot Loads

Large Customers

Projects

Areas of Interest

Initializing loads by copying values forward eliminates any load

change data beyond the base year. This may be desired for
some categories of loads and not desired by others.

User Guide

SynerGEE Electric 5.0

Planning

559

To ...

Do This ...

Specify meter handling

Select one of the following options to specify how meters are

handled during the forecasting analysis.

Ignore meters. Select this option to ignore meters

when determining growth.

Create meter agents to allocate load. Select this

option to allocate meter growth during the analysis.

Reset meter demand after forecast. Select this option

to reset the meter demand when the forecast is done.

Select the Options tab. The following table describes the different tasks that you can perform.
To ...

Do This ...

Specify when loads are

assumed

Under Loads are, select one of the following options. All loads
are represented at the same point in the year.

Specify how a forecasting

analysis will prioritize new
load versus the particular
growth agent

Specify how load growth will

be distributed across the
area of interest

Set the type of connected

loads that you want to
update during the analysis

SynerGEE Electric 5.0

Beginning of year

Mid-year

End-of-year

Under Resolve new load agents, select one of the following

options:

Before growth agents

After growth agents

With growth agents

Under Spread loads, select one of the following options:

Proportional to existing load

Evenly

Proportional to section length

Under Update distributed connected loads, select any of the

following options:

Connected kVA

Connected kWh

Connected customers

User Guide

560

Planning
4

Select the Script tab. Use the options on the Script tab to create Forecasting scripts that can be run
during the analysis. The following table describes the different tasks that you can perform.
To ...

Do This ...

Enable forecast scripting

Select the Use forecasting script check box.

Create a forecast script

Edit a forecast script

Delete a forecast script

In the text box located above the New button, type the
name of the script that you want to create.

Click New.

Use the Notepad window to type the script. When you

are finished, close Notepad and return to SynerGEE.

In the list of scripts, select the name of the script that

you want to edit.

Click Edit.

Use the Notepad window to edit the script. When you

are finished, close Notepad and return to SynerGEE.

In the list of scripts, select the name of the script that

you want to delete.

Click Delete.

Click Yes to confirm the deletion.

Click Apply to accept your changes, and then click X to close the editor.

Selecting a forecasting agent

An agent is used to represent the load growth or decline expectations for a spatially or logically selected set
of sections. Forecasts are achieved by managing growth. Loads are grouped by location, feed, or
characteristics. These groups are managed by an entity called an agent.
An agent includes a set of specific growth objectives. During the forecasting process, the agent adjusts loads
on the loads within its group until the objectives are met. Loads may be within the groups of several agents. A
load adjusted by one agent may impact the loading in another group. Agents operate in an iterative process
to meet their constraints.
Agents are created for the various areas where the engineer expects to see load growing over time. For
example, if a system is predicted to have 5% overall load growth and 8% growth on spot loads in one of the
feeders, then two agents would be created. The first agent would manage the overall system growth. The
second agent would focus on the spot load growth for the given feeder. During the forecast, the engineer
would see the desired system growth as well as the expected spot load growth on the feeder.
Forecasting agents are selected in the Settings tab of the Forecasting Options editor, as described in Setting
up a forecasting analysis on page 557. The following types of forecasting agents are supported by
SynerGEE:

Growth areas. The Growth areas agent manages sections lying within a polygon region on the map.
The agent focuses on growth for everything in the area, based on the growth settings in the Area of

User Guide

SynerGEE Electric 5.0

Planning

561
Interest editor. The area of interest type (in the Area of Interest tab of the Area of Interest editor)
must be set to Growth Area.

Section curves. The Section curves agent manages section load growth curve. The agent uses the
growth curve that is specified in the Zone tab of the Section editor.

Feeder growth. The Feeder growth agent manages feeder load growth. The agent uses the growth
curve that is specified in the Feeder tab of the Feeder editor.

Meter growth. The Meter growth agent manages meter load growth. The agent uses the growth
curve that is managed in the Demands tab of the Meter editor.

Customer zone. The Customer zone agent manages customer zone growth. A section can be
assigned to a customer zone, which is typically assigned spatially or logically downstream from
certain points. The customer zone contains weighted references to up to three customer class daily
load curves. The zone itself can also have growth information. The agent uses the growth curve set
in the customer zone and customer class editors.

Substation growth. The Substation growth agent manages substation load growth. The agent uses
the growth curve set in the substation editor.

Regional total. The Regional total agent manages load according to a selected growth curve for the
entire region (all five load types). The growth curve is selected in the Settings tab of the Forecast
Options editor.

Regional distrib. The Regional distribution agent manages load according to a selected growth
curve for distributed load across the region. The growth curve is selected in the Settings tab of the
Forecast Options editor, and the distributed loads are set in the Dist. Growth tab of the Area of
Interest editor.

Regional spot. The Regional spot agent manages the load according to a selected growth curve for
spot loads across the region. The growth curve is selected in the Settings tab of the Forecast
Options editor, and the spot loads are set in the Spot Growth tab of the Area of Interest editor.

Performing a forecasting analysis

Perform the following procedure to run a Forecasting analysis on your model.

TO PERFORM A FORECASTING ANALYSIS

1

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Loading group, click the Forecasting icon.

When the Forecasting analysis is complete, the Forecast Complete dialog box appears. Click Yes to
make the new loads and demands permanent in the model, or click No to simply generate a report
of the results, without committing the analysis results to the model.

SynerGEE Electric 5.0

User Guide

562

Planning

CAPACITOR PLACEMENT ANALYSIS

SynerGEEs Capacitor Placement application is a comprehensive tool that helps you find locations for new
capacitor installations. The application can operate under a variety of placement objectives and provide
results on a feeder-by-feeder basis in a clear and concise manner.
Capacitor Placement operates in a cumulative manner, starting from a base case. The application first finds
the most advantageous location for a capacitor, based on user-specified constraints. This location is offered
as the first recommendation. You can then temporarily place a recommended capacitor in your model and
have the analysis look for the next best location to further improve performance. The process can continue in
this manner until one of the following occurs:

The application cannot improve system performance with another capacitor.

The application has placed the maximum number of capacitors, based on your capacitor placement
analysis settings.

Capacitor Placement always tries to place the largest-size capacitor first, based on the sizes you selected for
the analysis. The application then moves sequentially through the sizes until it reaches the smallest one, or
until the maximum number of capacitors have been placed.
Capacitor Placement only places capacitors that have fixed kvar values. If the application places a new
capacitor on a section that already has a capacitor, then the kvar values of the new capacitor are simply
added to the fixed kvar values of the existing capacitor. Adding kvar in this manner is necessary because
SynerGEE only allows one capacitor per line section.
Once finished, the list of recommendations is presented in the SynerGEE Placement Tool editor, in order of
increasing performance, as they were found by SynerGEE. At this point, Capacitor Placement has made no
changes to your model. SynerGEE is simply presenting its recommendations, and you may choose to
implement them as desired.
The cumulative process results in a form of optimization known as local optimization. It does not find a
theoretical global optimum by considering all capacitor sizes and all locations simultaneously. Instead, it
operates by moving from the base case to the next best state, and then to the next best state, and so on. This
approach provides results that are more realistic and useful than a global optimization method.
The analysis places capacitors on a feeder-by-feeder basis. If multiple feeders are selected, it completely
analyzes one feeder before moving to the next.
Refer to the topics listed below for more information.

Setting up a Capacitor Placement analysis on page 562

Performing a Capacitor Placement analysis on page 563

Setting up a Capacitor Placement analysis

Perform the following procedure to set up a Capacitor Placement analysis.

User Guide

SynerGEE Electric 5.0

Planning

563

TO SET UP A CAPACITOR PLACEMENT ANALYSIS

1

Perform the following steps to open the Capacitor Placement Settings editor:
a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click Capacitor Placement.

In the SynerGEE Placement Tool editor, click Settings.

Use the Capacitor Placement Settings editor to edit the following options:
Sizes

Select the capacitor sizes that you want the Capacitor Placement
analysis to consider. The analysis begins with the largest enabled
size and works in a cumulative fashion towards the smallest,
improving the base case further with each placement.

Placement sections

Select the phase line type that you want the Capacitor Placement
analysis to consider. Available choices are Only single-phase lines,
Only three-phase lines, and Single or three-phase lines.
You can also select the Allow placement on cables check box to
consider cables during the Capacitor Placement analysis.

Limits for placement

Specify length and distance constraints to limit which sections will

qualify for placement. These options may be useful for stub or
dummy sections.

Maximum Device
Power Factor

Specify the maximum power factor you want SynerGEE to accept at

the capacitor being placed. For example, -80% indicates that you are
willing to accept a leading power factor of 0.8 or 80%.

Maximum Feeder/
SubTran Power Factor

Specify the maximum power factor you want SynerGEE to accept at

the feeder or subtran after a capacitor is placed. For example, -80%
indicates that you are willing to accept a leading power factor of 0.8 or
80%.

Add to existing banks

only

Select this check box to restrict the Capacitor Placement analysis to

only consider sections that already have capacitors modeled.
Selecting this option will temporarily turn off all existing capacitors
before the analysis, and restores the original settings when the
analysis is complete. When a capacitor is already modeled, the kvar
of the placed capacitor is simply added to the kvar of the existing
capacitor.

Click OK to accept your changes and close the editor.

Performing a Capacitor Placement analysis

The following procedure presents how a typical SynerGEE user might use the Capacitor Placement
application. Your actions may vary from the steps that are presented here, but the SynerGEE Placement Tool
editor is flexible enough that it can work in different ways to suit your particular needs.

SynerGEE Electric 5.0

User Guide

564

Planning
Take note that the Capacitor Placement application by itself never makes permanent changes to a model. It
only makes recommendations, and it is up to you whether to make these recommendations a permanent
change in your model. In your actual system, it will often be infeasible or impractical to implement all the
suggestions that SynerGEE will make. As such, the recommendations are provided so that you can make an
educated judgment about how many of the changes should be made.
The Capacitor Placement analysis runs on the feeders in memory that are currently selected. For more
information on feeder selection, see Selecting Feeders on page 157.

TO PERFORM A CAPACITOR PLACEMENT ANALYSIS

1

Perform the following steps to open the SynerGEE Placement Tool editor:
a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click Capacitor Placement.

If you have not already done so, click Settings to edit the Capacitor Placement analysis settings.
For more information on these settings, see Setting up a Capacitor Placement analysis on
page 562.

In the options list at the top of the SynerGEE Placement Tool editor, select the feeder that you want
to analyze. The feeder that is associated with the section that is currently set for analysis is listed by
default. Any capacitors that already exist in the selected feeder will be shown in the In Place list.
If desired, you can also click the Only place downstream from check box to only recommend
capacitor locations that are downstream from the section that is currently set for analysis. If you
select this check box, the feeder selection options list will be disabled and SynerGEE will
automatically select the feeder that is associated with the section that is set for analysis.
For information on setting a section for analysis, see Setting a section for analysis on page 434.

Click Update Recommended List. SynerGEE will provide a list of suggested sections where a
capacitor may be useful. From the Recommended list, you can do any of the following:
-

Click a column heading to sort the list based on the data in that column.

Click Zoom to zoom to the location of a selected section.

Click the Circles button to toggle the display of circles that identify recommended capacitor
locations in the SynerGEE map display. Recommended capacitor locations are circled in
red, while the capacitor location that is currently selected in the Recommendations list is
circled in green.
You can also use the Percentage text box to specify the percentage of recommended
capacitor locations that you want to show using circles. The Percentage is based on the
sort order in the Recommendations list. For example, if you specify 25% as the
percentage, only the top 25% of recommended capacitor locations will be shown in the
map display using circles, based on the sort order of the Recommendations list. The
capacitor locations that are identified using circles in the map display will update
automatically each time you re-sort the list.

Click Report to generate a report window that includes the list of suggested capacitors.

In the Recommended list, select the name of a section whose capacitor you want to temporarily add
to the model. Click Place.

User Guide

SynerGEE Electric 5.0

Planning

565
6

Next to the In Place list, click Refresh to recalculate load flow results based on the temporary
inclusion of the new capacitors. From the In Place list, you can also do any of the following:
-

Click a column heading to sort the list based on the data in that column.

Click Zoom to zoom to the location of a selected section.

Click On/Off to turn the capacitor for the selected section on and off.

Click Edit to open the capacitor editor for a selected section.

Select Permanent to make the temporary capacitor on a selected section a permanent

part of the model.

Click Remove to remove a selected section from the In Place list.

Click Report to generate a report window that includes the list of placed capacitors.

Next to the Recommendations list, click Update Recommended List. SynerGEE will provide a new
list of suggested sections where a capacitor may be useful, taking into account the temporary and
permanent capacitors that are included in the In Place list.

Repeat the steps in this procedure to add additional recommended capacitors to the model, either
temporarily or permanently, as required.
Take note that SynerGEE retains the temporary capacitors even when the Placement analysis is not
running. However, they will not be included in the model when a non-Placement application is run,
such as load flow. You can make a temporary capacitor permanent to evaluate it with a SynerGEE
application, and then easily remove it again with the Placement analysis.

PHASE BALANCING AND LOAD BALANCING

IMPROVEMENT
Imbalance in loading leads to imbalance in current flow, which results in higher losses, overloading, reduced
capacity, and voltage problems. To this end, SynerGEE provides a balance improvement tool to help identify
loads or laterals that can be rephased to achieve the greatest benefit for a predefined objective. The following
balance improvement applications are available:

Phase Balancing. Phase Balancing looks for single- and two-phase laterals which can be rephased
to improve feeder balance.

Load Balancing. Load Balancing looks for spot and/or distributed loads that can be reconnected to
improve feeder balance.

With each successive step during a balance improvement, SynerGEE focuses on the change that results in
the greatest benefit. Like optimal switching and contingency analysis, balance improvement relies on an
optimization routine that results in a local optimum. The application only suggests changes that improve the
performance of the feeder with respect to the selected objective.
Refer to the topics listed below for information.

Phase Balancing Improvement Analysis on page 566

Load balancing improvement on page 569

SynerGEE Electric 5.0

User Guide

566

Planning

Phase Balancing Improvement Analysis

SynerGEE suggests single- and two-phase laterals that can be rephased. The point to be rephased is always
the point at which the lateral connects to its trunk. In your analysis options, you can specify whether you
would like SynerGEE to consider single-phase laterals, two-phase laterals, or both. For more information on
setting this option, see Setting up a Phase Balancing Improvement analysis on page 566.
Lateral Option
Single-phase laterals

Two-phase laterals

Laterals to Consider

1-phase laterals fed from 2-phase trunk

1-phase laterals fed from 3-phase trunk

2-phase laterals fed from 3-phase trunk

When balance improvement is run, a report is generated with the suggested phase changes. The following is
an example of a phase balancing report.

Summary table from a balance improvement/phase balance run

This analysis was run to improve the lowest voltage. The first change improved the lowest voltage
significantly, from 104.2 volts to 107.6 volts. The second change made a small, additional improvement, from
107.6 volts to 107.8 volts. As you can see, you might consider implementing the first change, but the second
is probably not worth the time or cost.
Looking at the report, you should notice that the first change indicates a phase change C->A. To implement
this change, section NC3 and all sections fed by it would need to be rephased. In the real system, the
change may be as simple as moving some jumpers. On your model, however, this change must include
switching all loads and equipment from phase C to phase A, on all sections fed by NC3. In the modeling
environment, the phase changing effort must be applied to all sections, since each section holds independent
phase data.
The SynerGEE Multiple Editor is useful for rephasing large parts of your model quickly. For more information
on the Multiple Editor, see Using the Multiple Editor on page 177.
Refer to the topics listed below for information.

Setting up a Phase Balancing Improvement analysis on page 566

Performing a Phase Balancing Improvement analysis on page 567

Setting up a Phase Balancing Improvement analysis

Perform the following procedure to set up a Phase Balancing Improvement analysis.

User Guide

SynerGEE Electric 5.0

Planning

567

TO SET UP A PHASE BALANCING IMPROVEMENT ANALYSIS

1

Perform the following steps to open the Phase Balancing Settings editor:
a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click Phase Balancing.

In the SynerGEE Placement Tool editor, click Settings.

Use the Phase Balancing Settings editor to edit the following options:
Minimum Amps

Specify the minimum number of amps for a section to be considered

for phase balancing improvement.

Laterals

Select the type (phasing) of laterals on which to attempt balancing.

Available choices are Single Phase Only, Two Phase Only, or
Both.

Keep phases separate

Select this check box to have the analysis keep single-phase laterals
separate when considering balancing options. This option only
applies to sections that feed multiple single-phase laterals of distinct
phases.

Click OK to accept your changes and close the editor.

Performing a Phase Balancing Improvement analysis

The following procedure presents how a typical SynerGEE user might use the Phase Balance application.
Your actions may vary from the steps that are presented here, but the SynerGEE Placement Tool editor is
flexible enough that it can work in different ways to suit your particular needs.
Take note that the Phase Balance application never makes permanent changes to a model. It only makes
recommendations, and it is up to you whether to make these recommendations a permanent change in your
model. In your actual system, it will often be infeasible or impractical to implement all the suggestions that
SynerGEE will make. As such, the recommendations are provided so that you can make an educated
judgment about how many of the changes should be made.
The Phase Balancing Improvement analysis runs on the feeders in memory that are currently selected. For
more information on feeder selection, see Selecting Feeders on page 157.

TO PERFORM A PHASE BALANCING IMPROVEMENT ANALYSIS

1

Perform the following steps to open the SynerGEE Placement Tool editor:
a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click Phase Balancing.

If you have not already done so, click Settings to edit the Phase Balance analysis settings. For
more information on these options, see Setting up a Phase Balancing Improvement analysis on
page 566.

SynerGEE Electric 5.0

User Guide

568

Planning
3

In the options list at the top of the SynerGEE Placement Tool editor, select the feeder that you want
to analyze. The feeder that is associated with the section that is currently set for analysis is listed by
default.
If desired, you can also click the Only balance downstream from check box to only perform the
phase balancing improvement for locations that are downstream from the section that is currently
set for analysis. If you select this check box, the feeder selection options list will be disabled and
SynerGEE will automatically select the feeder that is associated with the section that is set for
analysis.
For information on setting a section for analysis, see Setting a section for analysis on page 434.

Click Update Recommended List. SynerGEE will provide a list of suggested sections where a
phasing improvement may be useful. The recommended phasing change is provided in the first
column of the list.
From the Recommended list, you can do any of the following:
-

Click a column heading to sort the list based on the data in that column.

Click Zoom to zoom to the location of a selected section.

Click Report to generate a report window that includes the list of recommended sections.

Click the Circle button to toggle the display of circles that identify recommended sections
in the SynerGEE map display. Recommended sections are circled in red, while the section
that is currently selected in the Recommendations list is circled in green.
You can also use the Percentage text box to specify the percentage of recommended
sections that you want to show using circles. The Percentage is based on the sort order in
the Recommendations list. For example, if you specify 25% as the percentage, only the top
25% of recommended sections will be shown using circles, based on the sort order of the
Recommendations list. The sections that are identified using circles in the map display will
update automatically each time you re-sort the list.

In the Recommended list, select the name of a section whose phasing you temporarily want to
change. Click Place.

Next to the In Place list, click Refresh to recalculate load flow results based on the temporary
phasing changes that have already been placed. From the In Place list, you can also do any of the
following:
-

Click a column heading to sort the list based on the data in that column.

Click Zoom to zoom to the location of a selected section.

Select Permanent to make the temporary phasing change on a selected section a

permanent change in the model.

Click Remove to remove a selected section from the In Place list.

Click Report to generate a report window that includes the list of sections included in the In
Place list.

Next to the Recommendations list, click Update Recommended List. SynerGEE will provide a new
list of suggested sections where a phasing improvement may be useful, taking into account the
temporary and permanent changes that are already included in the In Place list.

User Guide

SynerGEE Electric 5.0

Planning

569
8

Repeat the steps in this procedure to add additional phasing changes to the model, either
temporarily or permanently, as required.

Load balancing improvement

The following options are available for a load balance run:

Consider distributed and/or spot loads

Consider one-phase, three-phase, or all spot loads

When the application is run, it produces a report similar to the following.

Summary table from a balance improvement/load balance run

The objective in this case was to improve the lowest voltage on the feeder. If all the changes were
implemented, the system low voltage would improve by 2.6 volts. However, the first two changes would
accomplish 1.8 volts alone, so you might choose to implement only those two. Also, you may notice that while
voltage continues to rise, so does the number of exceptions, but only after the third suggestion.
On the report, you can see that the first change is listed as B->C, C->B. This indicates that the load on B
should be shifted to C and the load that was on C should be shifted to B.
Loads are never combined by balance improvement, only shifted.
Refer to the topics listed below for information.

Setting up a Load Balancing Improvement analysis on page 569

Performing a Load Balancing Improvement analysis on page 570

Setting up a Load Balancing Improvement analysis

Perform the following procedure to set up a Load Balancing Improvement analysis.

TO SET UP A LOAD BALANCING IMPROVEMENT ANALYSIS

1

Perform the following steps to open the Load Balancing Settings editor:
a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click Load Balancing.

SynerGEE Electric 5.0

User Guide

570

Planning
c
2

In the SynerGEE Placement Tool editor, click Settings.

Use the Load Balancing Settings editor to edit the following options:
Minimum kVA

Specify the minimum kVA for a section to be considered for load

balancing improvement.

Load kVA Imbalance >

X%

Specify the minimum %kVA imbalance threshold for a section to be

considered for load balancing improvement. Enter a value from 10 to
100%.

Load Types

Select the type of loads that you want to balance. Available choices
are Spot Loads Only, Distributed Loads Only, or Spot and
Distributed Loads.

Load Phasing

Select the load phase for which you want to perform the balancing
improvement. Available choices are Single Phase Only, Three
Phase Only, or All Loads.

Click OK to accept your changes and close the editor.

Performing a Load Balancing Improvement analysis

The following procedure presents how a typical SynerGEE user might use the Load Balance application.
Your actions may vary from the steps that are presented here, but the SynerGEE Placement Tool editor is
flexible enough that it can work in different ways to suit your particular needs.
Take note that the Load Balance application never makes permanent changes to a model. It only makes
recommendations, and it is up to you whether to make these recommendations a permanent change in your
model. In your actual system, it will often be infeasible or impractical to implement all the suggestions that
SynerGEE will make. As such, the recommendations are provided so that you can make an educated
judgment about how many of the changes should be made.
The Load Balancing Improvement analysis runs on the feeders in memory that are currently selected. For
more information on feeder selection, see Selecting Feeders on page 157.

TO PERFORM A LOAD BALANCING IMPROVEMENT ANALYSIS

1

Perform the following steps to open the SynerGEE Placement Tool editor:
a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click Load Balancing.

If you have not already done so, click Settings to edit the Load Balance analysis settings. For more
information on these options, see Setting up a Load Balancing Improvement analysis on page 569.

In the options list at the top of the SynerGEE Placement Tool editor, select the feeder that you want
to analyze. The feeder that is associated with the section that is currently set for analysis is listed by
default.
If desired, you can also click the Only balance downstream from check box to only perform the
load balancing improvement for locations that are downstream from the section that is currently set
for analysis. If you select this check box, the feeder selection options list will be disabled and

User Guide

SynerGEE Electric 5.0

Planning

571
SynerGEE will automatically select the feeder that is associated with the section that is set for
analysis.
For information on setting a section for analysis, see Setting a section for analysis on page 434.
4

Click Update Recommended List. SynerGEE will provide a list of suggested sections where a load
improvement may be useful. From the Recommended list, you can do any of the following:
-

Click a column heading to sort the list based on the data in that column.

Click Zoom to zoom to the location of a selected section.

Click Report to generate a report window that includes the list of recommended sections.

Click Edit to open the SynerGEE editor for a selected section.

Click the Circle button to toggle the display of circles that identify recommended sections
in the SynerGEE map display. Recommended sections are circled in red, while the section
that is currently selected in the Recommendations list is circled in green.
You can also use the Percentage text box to specify the percentage of recommended
sections that you want to show using circles. The Percentage is based on the sort order in
the Recommendations list. For example, if you specify 25% as the percentage, only the top
25% of recommended sections will be shown using circles, based on the sort order of the
Recommendations list. The sections that are identified using circles in the map display will
update automatically each time you re-sort the list.

In the Recommended list, select the name of a section whose loading you temporarily want to
change. Click Place.

Next to the In Place list, click Refresh to recalculate load flow results based on the temporary
changes in section loading. From the In Place list, you can also do any of the following:
-

Click a column heading to sort the list based on the data in that column.

Click Zoom to zoom to the location of a selected section.

Click Edit to open the SynerGEE editor for a selected section.

Select Permanent to make the temporary loading change on a selected section a

permanent change in the model.

Click Remove to remove a selected section from the In Place list.

Click Report to generate a report window that includes the list of sections included in the In
Place list.

Next to the Recommendations list, click Update Recommended List. SynerGEE will provide a new
list of suggested sections where a load improvement may be useful, taking into account the
temporary and permanent changes that are already included in the In Place list.

Repeat the steps in this procedure to add additional load changes to the model, either temporarily or
permanently, as required.

SynerGEE Electric 5.0

User Guide

572

Planning

DESIGN EVALUATION
SynerGEEs design evaluation analysis provide specialized optimization functions that focus on a particular
type of equipment or device. Some of these applications include financial considerations during the
optimization process, as well as system performance parameters.
Refer to the topics listed below for information on the design evaluation options that are provided with
SynerGEE.

Selecting an optimal conductor on page 572

Determining an optimal regulator position on page 574

Selecting an optimal conductor

SynerGEEs conductor selection application can help planners determine the best conductor type(s) for a
group of sections, based on performance and cost. Conductor selection looks at queried sections and
attempts to reconductor them with the most optimal conductor with consideration of voltage, loading, and
cost. After the analysis, you can compare the construction and performance of the proposed model to the
original base model, and optionally have SynerGEE reconductor the base model automatically.
To use conductor selection effectively, you must have material and installation cost data available for the
conductor types you want to examine. This cost data is specified in the Costs tab of the Model and Analysis
Options editor. For more information, see Setting analysis cost options on page 446.
Refer to the topics listed below for more information on SynerGEEs conductor selection application.

Conductor evaluation processing on page 572

Tips for using conductor selection on page 573

Setting up a conductor selection evaluation on page 573

Performing a conductor selection evaluation on page 574

Conductor evaluation processing

When conductor selection runs, it breaks up the current query set of the base model into groups, based on:

Configuration change (including phasing)

Conductor change

Line split, including wandering laterals

For each group, SynerGEE steps through the conductors in the active cost file one at a time, simulating
reconductoring and running load-flow/fault studies. Of the conductors it evaluates, it chooses a single optimal
conductor for the whole group and then moves to the next group. In areas of lighter loading, SynerGEE
attempts to find a smaller conductor as applicable that satisfies your constraints. A conductor is only
evaluated if it matches the overhead/underground status of the original conductor.
The most upstream groups are considered first, and no group is analyzed until all applicable feeding groups
have been completed. In this manner, results are cumulative and must be regarded as a cohesive answer,
rather than recommendations for individual groups and sections.

User Guide

SynerGEE Electric 5.0

Planning

573

Tips for using conductor selection

Keep the following tips in mind when you are setting up a conductor selection evaluation:

The method by which you form the query set for evaluation can significantly affect how efficiently the
analysis works. For example, if you want to evaluate the reconductoring of a specific conductor type
throughout the selected feeders, you can use the query wizard to very quickly form a query set of
applicable sections only.

The Gallery is a useful tool for viewing detailed comparisons of before-and-after models. For
example, you can put the base model into the gallery prior to analysis, and then access if afterward
the conductor selection evaluation for further study. For more information, see Gallery on
page 129.

The proper setup of the active cost file is critically important for the application to behave as
expected. For more information on cost files, see Cost files on page 447.

Setting up a conductor selection evaluation

Perform the following steps to set up a conductor selection evaluation.

TO SET UP A CONDUCTOR SELECTION EVALUATION

1

Place the sections that you want to analyze into the query set. For more information, see Using the
Query Set on page 173.

Perform the following steps to verify cost data, including the specified costs file, using the Model and
Analysis Options editor.

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

In the Model and Analysis Options editor, select the Costs tab and then verify the cost
data, including the specified costs file. For more information on cost data, see Setting
analysis cost options on page 446.

Click Apply to accept your changes, and then click X to close the editor.

Perform the following steps to open the Design Evaluation editor:

a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the text label Design Evaluation and then select Settings.

In the Design Evaluation editor, select Conductor selection for queried sections and then edit the
following settings as appropriate:
-

Max Volt Drop

Max Line Loading

Fault Amps

Cumulative ZS

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

574

Planning

Performing a conductor selection evaluation

Perform the following procedure to perform a conductor selection evaluation. After the evaluation is
complete, the Conductor Evaluation report will provide a comparative view of the different conductoring
scenarios, section-by-section. While studying the results, keep in mind that the recommendations must be
taken as a whole. Any selective application of individual section results will render the sum of the evaluation
irrelevant.
The reports include comparative results between the before and after models. You can also review
summary information on each conductor that was used and how much. Optionally, the analysis allows you to
implement the results automatically, which is the preferred approach if you do plan to implement them.

TO PERFORM A CONDUCTOR SELECTION EVALUATION

1

If you have not already done so, use the Design Evaluation editor to configure options related to the
analysis. For more information, see Setting up a conductor selection evaluation on page 573.

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the Design Evaluation icon.

Determining an optimal regulator position

Regulator position is an application that helps you determine the proper location for an existing regulator in
your system. To do this, SynerGEE simulates the movement of the regulator up and downstream, section by
section, and produces a comparative set of results. After the application run, you can look at results for
different regulator locations on a section-by-section basis and determine the optimal location.
Refer to the topics listed below for more information.

Regulator position processing on page 574

Setting up a regulator position evaluation on page 575

Performing a regulator position evaluation on page 575

Viewing the results of a regulator position evaluation on page 575

Regulator position processing

Initially, the regulator position application moves the regulator under analysis to the logical end of its feed
branch. Then, it steps it back to the feeder source, section by section. For each section on the way back, the
application records important load-flow-based results and presents them in a comparative manner following
the analysis run.
In some cases, model topology may limit how far a regulator can be moved. For example, during the initial
movement to the end of the feed branch, the application can only move the regulator as far as it can find a
clear, logical electrical path. If it encounters a junction of three or more sections, the downstream path
becomes ambiguous and the movement will stop there. Also, a change in phasing during the upstream walk
may also limit how close the application can bring the regulator to the feeder source.
Regulator position never moves a regulator permanently. After an application run, the model will appear
exactly as it did beforehand. The application only produces analytical results, which you can then use to
manually move the regulator if desired.

User Guide

SynerGEE Electric 5.0

Planning

575

Setting up a regulator position evaluation

Perform the following procedure to set up a regulator position evaluation.

TO SET UP A REGULATOR POSITION EVALUATION

1

Make sure that you have selected the feeder that contains the regulator to be evaluated. For more
information, see Selecting Feeders on page 157.

If the current feeder selection set has more than one active regulator, locate the section that holds
the desired regulator. Right-click on the section and select Set for Analysis.

Perform the following steps to open the Design Evaluation editor:

a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the text label Design Evaluation and then select Settings.

In the Design Evaluation editor, select Regulator positioning along current path.

Click Apply to accept your changes, and then click X to close the editor.

Performing a regulator position evaluation

Perform the following procedure to run a regulator position evaluation.

TO PERFORM A REGULATOR POSITION EVALUATION

1

If you have not already done so, use the Design Evaluation editor to configure options related to the
analysis. For more information, see Setting up a regulator position evaluation on page 575.

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the Design Evaluation icon.

Viewing the results of a regulator position evaluation

The charts produced by the regulator position evaluation are a useful part of the analysis results. Because
the charts are distance-based, they distinctly show the trends in voltage, loading, taps, and other parameters
as the regulator is moved from the source to the branch end. The following graphic shows an example of a
regulator position chart.

SynerGEE Electric 5.0

User Guide

576

Planning

Regulator position chart, showing amps handled by the regulator as it gets farther from the source

MULTI-MODEL ANALYSIS
An analysis can be run on an entire database at once, one substation at a time. Multiple DSAs can be
selected for analysis, as well. The analysis types that are available for multi-model comparisons are loadflow, load allocation, and reliability. In addition, multi-model analysis can also analyze the models for multiple
years.
Refer to the topics listed below for more information.

Setting up a multi-model analysis on page 576

Performing a multi-model analysis on page 579

Setting up a multi-model analysis

TO SET UP A MULTI-MODEL ANALYSIS
1

User Guide

Perform the following steps to open the Multi-Model Analysis editor:

a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the text label Multi-Model and then select Settings.

On the left side of the Multi-Model Analysis editor, select from the different tab names to access the
available multi-model analysis settings. The following procedures describe the different tasks that
you can perform:
-

Identifying data sources for a multi-model analysis on page 577

Selecting analysis types and years for a multi-model analysis on page 577

Selecting pre-processing actions for a multi-model analysis on page 578

Selecting post-processing actions for a multi-model analysis on page 578

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Planning

577

Identifying data sources for a multi-model analysis

TO IDENTIFY DATA SOURCES FOR A MULTI-MODEL ANALYSIS
1

Perform the following steps to open the Multi-Model Analysis editor:

a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the text label Multi-Model and then select Settings.

In the Multi-Model Analysis editor, select the Data Sources tab. The Data sources to be analyzed
section lists the DSAs that have been added to the analysis, and the Available data sources
section lists additional DSAs that can also be added to the analysis.
-

To add a DSA to the multi-model analysis: In the Available data sources section, select
the name of the DSA that you want to add then click the up-arrow button. The DSA name
moves to the Data sources to be analyzed section.

To remove a DSA from the multi-model analysis: In the Data sources to be analyzed
section, select the name of the DSA that you want to remove, and then click the downarrow button. The DSA name moves to the Available data sources section.

Click Apply to accept your changes, and then click X to close the editor.

Selecting analysis types and years for a multi-model analysis

TO SELECT ANALYSIS TYPES AND YEARS FOR A MULTI-MODEL ANALYSIS
1

Perform the following steps to open the Multi-Model Analysis editor:

a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the text label Multi-Model and then select Settings.

In the Multi-Model Analysis editor, select the Analysis tab. The following table describes the
different options that you can set.
Applications to Run

SynerGEE Electric 5.0

Select the check box for each analysis type that you want to run
during the multi-model analysis. The following applications are
available:

Check Coordination

Check Data

Contingency

Fault

Load Allocation

Load-Flow

Reliability

Throw-Over

User Guide

578

Planning

Years to Analyze

Select the check box for each model year that you want to analyze in
the multi-model analysis.

Click Apply to accept your changes, and then click X to close the editor.

Selecting pre-processing actions for a multi-model analysis

Use the Pre-process tab in the Multi-Model Analysis editor to specify tasks that SynerGEE will run after the
model(s) is loaded but before the multi-model analysis is performed. You can:

Run a node reduction

Run a model cleanup script

Refer to the following procedure for more information.

TO SELECT PRE-PROCESSING ACTIONS FOR A MULTI-MODEL ANALYSIS

1

Perform the following steps to open the Multi-Model Analysis editor:

a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the text label Multi-Model and then select Settings.

In the Multi-Model Analysis editor, select the Pre-process tab. The following table describes the
different options that you can set.
Node Reduction

Select this check box to run node reduction after the model(s) is
loaded, but before the multi-model analysis is performed.
For more information on node reduction, see Reducing the number
of nodes on page 267.

Model Cleanup

Select this check box to run a model cleanup script after the model(s)
is loaded, but before the multi-model analysis is performed. Use the
list box to select (highlight) the specific model cleanup script that you
want to run.
For more information on model cleanup scripts, see Model Cleanup
Scripts on page 718.

Click Apply to accept your changes, and then click X to close the editor.

Selecting post-processing actions for a multi-model analysis

Use the Post-process tab in the Multi-Model Analysis editor to save feeders and substations to a target
database, specified via a DSA, after the multi-model analysis is complete. The target database can be either
the same database that you loaded or a different database.
Refer to the following procedure for more information.

User Guide

SynerGEE Electric 5.0

Planning

579

TO SELECT POST-PROCESSING ACTIONS FOR A MULTI-MODEL ANALYSIS

1

Perform the following steps to open the Multi-Model Analysis editor:

a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the text label Multi-Model and then select Settings.

In the Multi-Model Analysis editor, select the Post-process tab. The following table describes the
different options that you can set.
Save Model

Select this check box to save the model to a database.

Save to this data

source

Select (highlight) the target DSA where you want to save the model.

Click Apply to accept your changes, and then click X to close the editor.

Performing a multi-model analysis

Perform the following procedure to run a multi-model analysis.

TO PERFORM A MULTI-MODEL ANALYSIS

1

If you have not already done so, use the Multi-Model Analysis editor to select the data sources for
the multi-model analysis, specify which SynerGEE analysis types you want to run and the years you
want to analyze, and select pre- and post-processing options. For more information, see Setting up
a multi-model analysis on page 576.

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Design group, click the Multi-Model icon.

MULTI-YEAR ANALYSIS
A SynerGEE model can contain up to eleven different yearly versions, including the base year, and analyze
and compare these different years independently. This capability allows you to model and analyze projected
changes in the future, while maintaining your current base model and avoiding the need for additional models
or versions.
Multi-year modeling and analysis is optional. If you do not specifically activate multi-year features, by default
your work will be solely within your base model, and multi-year features will be non-applicable and largely
invisible.
Refer to the topics listed below for more information on multi-year modeling in SynerGEE.

Getting started with multi-year modeling on page 580

General information about multi-year modeling on page 580

Changing years for multi-year modeling on page 581

Modeling for multiple years on page 582

SynerGEE Electric 5.0

User Guide

580

Planning

Multi-year analyses on page 586

Multi-year data characteristics on page 587

Getting started with multi-year modeling

Getting started with multi-year modeling centers mostly around getting your multi-year data into the model.
You may use a variety of means to do this, including the following:

Allowing SynerGEE to populate future years automatically. By default, when you load a model
from a previous version of SynerGEE, the current data set becomes Year 0 (base year). In other
words, all years are identical.

Using tools such as subsets to transfer data. When you save a subset, it saves data from the
currently specified year. When you load a subset, it loads data into the currently specified year.
Therefore, you could save a subset, change the year, and then reload the subset to complete the
transfer.

Manually edit data using the SynerGEE editors. More than likely, much of your multi-year
modeling will be done by specifying energize/retire years and other yearly data in the SynerGEE
editors.

After your model is set up, using multi-year features is largely identical to using any SynerGEE feature,
except that you must always remain aware of the current year setting. For more information on multi-year
data, see Data applicable to multi-year features on page 580. For more information on the interface year
setting, see Changing years for multi-year modeling on page 581.
Tip:

To fully enable all multi-year features, make sure you have selected the Enable multi-year
modeling option in the Units tab of the Preferences editor. For more information, see Setting units
of measurement on page 165.

General information about multi-year modeling

Before using multi-year features, you should be aware of certain limitations and responsibilities on you, the
user. These features are discussed in the topics listed below.

Data applicable to multi-year features on page 580

Differences between the multi-year modeling and versions on page 581

Interaction with customer load curves and load growth on page 581

Data applicable to multi-year features

Yearly versions of a model are based on a specific subset of data, which includes the following:

Energize and retire years. For all sections and devices, you can select an energize year a retire
year. When you run an analysis on a year when a section or device has not yet been energized or
has already been retired, SynerGEE regards those sections and devices as completely absent from
the model.

User Guide

SynerGEE Electric 5.0

Planning

581

Loads and demands. At the individual section level, you can specify different loading for each year
in the model. This is coupled with the ability to run load allocation on a yearly basis, using
customizable demands for each year. Multi-year load data includes capacity factors.
Multi-year demands are specified using meter devices, which also allow multi-year values for
continuous and emergency amp ratings.

Switchable device configuration. The Open and Closed status of switches and protective devices
can be configured independently each year. Elbows and pad-mounted switch gear are not included.

Large customer load and generation parameters. The by-phase load data and kVA/pf generation
data for large customers can be specified on a yearly basis.

In the database, multi-year data is sometimes part of existing instance tables and sometimes requires its own
table. For example, the energize/retire year for a section can be found in its InstSection table record, but its
multi-year load data is stored in a separate table. In some cases, multi-year data may overlap traditional
data, and in this situation, the multi-year data always takes precedence.

Differences between the multi-year modeling and versions

Multi-year modeling has loose conceptual similarities the general versioning feature of SynerGEE, but from a
data perspective, the two are unrelated. The general versioning feature is much broader, allowing you to
make virtually any change to the model and save changes as independent and generally unrelated versions.
Multi-year versions, on the other hand, are represented by very specific subsets of data whose architecture
you cannot change. For example, each yearly version contains a full set of load data, regardless of any
differences or similarities with other years.
For more information on versions, see Versions on page 86.

Interaction with customer load curves and load growth

Customer load curves may be used in conjunction with multi-year modeling. If you are performing timespecific analyses, SynerGEE uses customer load curves as expected, applying them to the load data that is
applicable to the current year. For example, if you have the interface set to Year 2 and you run an analysis on
June 15, SynerGEE applies June 15 load curves to Year 2 load data.
Note that you can only specify one set of annual load curves. You cannot create multi-year versions of the
curves themselves. For more information on customer load curves, see Customer Load Curves/Time-of-Day
Analysis on page 808.
Load growth integrates in a similar fashion. If you have a growth rate set, it is applied to the load data of the
year that the interface is set to. For more information on load growth, see Load Growth on page 801.

Changing years for multi-year modeling

You can switch the interface between different years using the year selector on right end of the SynerGEE
status bar. When you have the interface set to a particular year, all analyses and any year-specific modeling
is done for the selected year only. For example, if you run a load-flow analysis while the interface is set to
Year 1, the analysis runs using Year 1 data and ignores any other years. For this reason, you should always
be aware of the year to which the interface is set.

SynerGEE Electric 5.0

User Guide

582

Planning
The map and editors update dynamically as you switch years, making it easy to see the differences between
them. For more information on modeling in this environment, see Modeling for multiple years on page 582.

Modeling for multiple years

Modeling in a multi-year environment is similar to any modeling activity, except that you must consider the
year component as well. Depending on the feature and/or setting, there are two ways of adding a yearly data
component to your model:

Specifying a year in the editors. Energize and retire years for sections and devices can be specified
directly in the section and device editors. You do not need to reset the interface to the actual year
that you are currently viewing.

Specifying data in the specific year. Other settings, such as loading and switching configuration,
must be done directly in the year that you want the settings to take effect. For example, if you want a
certain load to take effect in Year 1, you must switch the view to Year 1 and then specify the load.
For more information, see Specifying year-specific data for multi-year modeling on page 583.

Refer to the topics listed below for more information.

Multi-year modeling challenges on page 582

Enabling multi-year modeling on page 582

Specifying energize and retire years for multi-year modeling on page 583

Specifying year-specific data for multi-year modeling on page 583

Multi-year modeling using the SynerGEE editors on page 583

Year names and time spans between years on page 584

Copying data using the Multi-Year Editor on page 584

Model Rollover wizard on page 585

Multi-year modeling challenges

If you use multi-year features, you essentially have up to 11 different versions of a model stored in a single
data source. Because it is not possible to display 11 versions of the model at once, the challenges of keeping
data accurate and organized may be increased significantly. When conducting modeling and analysis
activities, you must constantly remain aware of the current year setting and stay generally knowledgeable of
the differences between the yearly versions. For example, if you are working in a year before a certain set of
facilities become energized, they will be absent from both the model explorer and the map display. This type
of situation can easily cause confusion and/or data corruption if you are not careful to conduct modeling
activities with all yearly versions in mind. Naturally, it may be impossible to remember the details of your
different versions, so it may be good practice to always browse through your versions briefly before
conducting modeling activities.

Enabling multi-year modeling

To fully enable multi-year modeling and activate the year setting, select Enable multi-year modeling in the
Units tab of the Preferences editor. This option has limited control over the year setting in the interface, but

User Guide

SynerGEE Electric 5.0

Planning

583

does not necessarily include/exclude all multi-year features. For more information, see Setting units of
measurement on page 165.

Specifying energize and retire years for multi-year modeling

Energize and retire years are specified in the section and device editors, and are not necessarily dependent
on the current year in view. That is, you can specify energize/retire years regardless of the year you have
selected, provided that the facility is visible. When you model a new device, its energize year is automatically
set to the currently selected year.
When working in any given year, any facility that is specified to be retired (or de-energized) is hidden from
view, and ignored by all analyses. If you edit a facility to retire during the year that you are currently viewing,
it will disappear after you have applied those edits. For example, if your interface is displaying Year 2 and you
edit a fuse to retire in Year 2, it will disappear when you click Apply. To access the fuse editor again, you
would have to switch the view to a year during which the fuse is still energized, or use undo.

Specifying year-specific data for multi-year modeling

For each year, a SynerGEE model can contain unique data for:

Distributed and spot loads

Meter device values/demands

Switch and protective device status (open/closed)

Conductors and phasing

Construction types and height

Rephrasing, reconductoring, and burying of distribution lines.

To specify this data for any particular year, you must first switch the interface to the year you want to edit and
then make the appropriate edits. For example, if you want to specify distributed load on a particular section
for Year 3, switch the model interface to year 3 and then make the changes directly in the Section editor. For
more information on switching between years, see Changing years for multi-year modeling on page 581.
Section configuration, pole-top construction, spacings, and other line construction-based parameters cannot
be set up as multi-year. This is to preserve simplicity and reduce the volume of data.

Multi-year modeling using the SynerGEE editors

Certain items in some SynerGEE editors can be directly edited for multi-year data. When you hover your
mouse over one of these items, an arrow will appear in the editing field. Click on the arrow to open a pop-up
list containing the values for the item over all years. You can edit and change values directly in the pop-up
list. Multi-year pop-ups can be found in the following facility editors:

Fuse: Open/closed status

Large Customer: load values

Meter: Metered values and ratings

Recloser: Open/closed status

SynerGEE Electric 5.0

User Guide

584

Planning

Sections: Load values, phasing, conductor types, configurations, and exposure factors

Switch: Open/closed status

Year names and time spans between years

The multi-year interface includes a total of 11 years: the base year plus 10 future years. By default, the base
year is the current year, with all subsequent years listed in order. However, these labels are not relevant to
SynerGEE and you can name them anything you want, within a six-character limit. When you rename a year,
the new name appears in analysis reports and in the year list in the SynerGEE status bar. In a multi-modeling
environment, SynerGEE will write the descriptions for years into the control record of a new database. If you
load or save a database and the year descriptions do not match the current session, then a warning will be
issued so that you may terminate the save or load. For more information on renaming years, see Setting
units of measurement on page 165.
By providing a total of 11 different years, you essentially have the capability of creating 11 different versions
of your model, all stored within the same model data source. For all purposes other than growth curve
calculations, the actual time span between the years is irrelevant. That is, all analysis and modeling activities
treat the yearly versions independently, with no consideration of time span. For example, a multi-year loadflow analysis will analyze all years and place the results together for comparison, with the actual time span
being irrelevant. Each year gets its own results.
Therefore, unless you use growth curves, your years do not actually need to be temporal years, separated
by 365 days. For example, you could use a certain year as a summertime model, and the next year as the
following wintertime model. In this case, the temporal years are different, but the two models are separated
into separate years for SynerGEE classification purposes.
The exception to this rule is growth curve usage. In a growth curve, you specify yearly growth rates, whose
associated calculations are directly related to the temporal yearly span of 365 days. That is, if you analyze
your Year 5 version of a model with growth curves, SynerGEE will consider five years worth of growth
applied based on growth curve values. Therefore, if you use growth curves, you must either adhere to actual
yearly spans between model versions or extrapolate growth curve values that reflect non-annual rates. For
more information on growth curves, see Growth curves on page 804.

TO RENAME YEARS FOR A MULTI-YEAR ENVIRONMENT

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select the Units tab.

Under Year Descriptions, enter a new name for each year, as required.

Click OK to accept your changes and close the editor.

Copying data using the Multi-Year Editor

The multi-year editor is a tool that allows quick migration of specific data and facilities to be copied over to
several different years at once. The wizard acts as an automation engine that searches SynerGEE for the
pertinent data you specify and then carries it into future years. This tool is key when configuring your model
for multi-year analysis.
Refer to the following procedure for more information.

User Guide

SynerGEE Electric 5.0

Planning

585

TO COPY DATA USING THE MULTI-YEAR EDITOR

1

Perform the following steps to open the Multi-Year Editor:

a

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Model group, click Multiyear Editor.

On the first page of the Multi-Year Editor, select Copy from one year to other years, and then click
Next.

On the next page of the Multi-Year Editor, do the following:

a

Under Copy From, select the year that you want to copy data from.

Under Copy To, select the check boxes for each year that you want to copy data to.

Under Categories, select the data categories that you want to copy to the specified years.

Click Next to copy the data.

The final page of the Multi-Year Editor shows the results of the multi-year copy. Click Finish to close
the editor.

Model Rollover wizard

The Model Rollover wizard is a tool that automates a script to populate future years with specific modeling
features. The script that is generated by the wizard applies the changes to the model and optionally
generates a Model Rollover report. The wizard allows you to automatically transfer model updates to future
years for multi-year modeling.
Before running the Model Rollover wizard, it is recommended that you back up your database. For more
information, see Backing Up SynerGEE Data on page 131.

TO RUN THE MODEL ROLLOVER WIZARD

1

Perform the following steps to open the Model Rollover wizard:

a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Tools group, click Model Rollover Wizard.

On the first page of the Model Rollover wizard, do the following:

a

Next to Rollover Script Name, type a name for your script.

Next to Model Data Source, select a data source for your model.

Click Next to continue.

3

On the second page of the wizard, the model years for your model are shown. If desired, you can
type in any of the text boxes to change the model year, or click the Up and Down arrow buttons to
shift the model year labels in the desired direction.
Click Next to continue.

On the third page of the wizard, select the model options you wish to roll over for example, you
can roll over the energize year, retire year, feeder demands, distributed loads, and spot loads. You
can do any of the following to select which options you want to roll over:

SynerGEE Electric 5.0

User Guide

586

Planning

Select and clear individual check boxes to include or exclude the related option from the
Rollover script.

Select a range of options by using the Ctrl or Shift keys on the keyboard or by clicking the
Select All button. Then, click the Select Options button to select the highlighted check
boxes, or click the Clear Options button to clear the check boxes.

Select options as described above and click the Toggle Report button to change the report
status for each highlighted option. The report status, if enabled, will generate a line item in
the Model Rollover report relating to the enabled option.

Click Finish to accept your changes, and then click Yes to confirm that you want to create the
Rollover script.

Multi-year analyses
SynerGEE supports the following types of multi-year analyses:

Load-flow

Fault

Load allocation

Reliability

Contingency

Check data

Generate maps

Cleanup script

When run as a part of a multi-year analysis, these analyses perform many of the same functions as their
single-year counterparts, except that you can specify which years they should analyze. Because of the sheer
volume of data produced during even a single-year analysis, the multi-year versions produce briefer
summarized displays of the multi-year results. As such, multi-year analysis reports can be extremely helpful
in comparing overall construction and performance over the modeled years. Both the check data and cleanup
scripts are targeted at loop identification and correction in future years.
For detailed analysis results on any particular modeled year, you should switch the interface to that year and
run the single-year analysis counterpart. For more information on switching years, see Changing years for
multi-year modeling on page 581.
Multi-year analyses run on all model data in memory, not just selected feeders. This is because multi-year
data, especially when it involves energized/retired sections, can present a complex topological situation in
which feeder ownership cannot be reliably determined at the outset.

Setting up a multi-year analysis

Perform the following procedure to set up a multi-year analysis. The analysis setup includes selecting which
SynerGEE applications you want to run and which years you want to analyze. You can also select cleanup
scripts to run at the completion of the analysis.

User Guide

SynerGEE Electric 5.0

Planning

587

TO SET UP A MULTI-YEAR ANALYSIS

1

Perform the following steps to open the Multi-Year Analysis editor:

a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Time group, click the text label Multi-Year and then select Settings.

Use the Multi-Year Analysis editor to set the following options:

Applications to Run

Select the check box for each analysis type that you want to run
during the multi-model analysis.

Years to Analyze

Select the check box for each year that you want to analyze
during the multi-year analysis.

Cleanup Scripts

Select the check box for each cleanup script that you want to run
at the end of the multi-year analysis. For more information on
model cleanup scripts, see Model Cleanup Scripts on
page 718.

Click Apply to accept your changes, and then click X to close the editor.

Performing a multi-year analysis

A multi-year analysis is run on all model data in memory, not just selected feeders. This is because multi-year
data, especially when it involves energized and retired sections, can present a complex topological situation
in which feeder ownership cannot be reliably determined at the outset.
Refer to the following procedure for more information.

TO PERFORM A MULTI-YEAR ANALYSIS

1

If you have not already done so, use the Multi-Year Analysis editor to set up options related to the
multi-year analysis, including selecting the applications you want to run, the years you want to
analyze, and any cleanup scripts that you want to run. For more information, see Setting up a multiyear analysis on page 586.

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Time group, click the Multi-Year icon.

Multi-year data characteristics

In a database format, multi-year data is represented in two ways:

Separate tables. Some multi-year load data is stored in separate tables for each year. This
approach simplifies the schema for loads, and makes it easier to swap out tables with external
database management tools.

Additional fields on existing tables. Some multi-year data is represented as additional fields on
traditional SynerGEE tables. For example, the InstSwitches table in Access has six columns

SynerGEE Electric 5.0

User Guide

588

Planning
dedicated to the open/close status for each of the six future years, and a column each for the
energize and retire years.
If you are loading a model data source from a previous version of SynerGEE that did not support multi-year
modeling, you should note the following:

SynerGEE uses the current data to build the base year in the new, multi-year environment.
Afterwards, if you choose not to use multi-year features, or change the year of the interface, your
model should behave exactly as it always did.

When a model is imported that is missing data for future years, SynerGEE supplements future data
as follows:
-

Energize/retire years. Any missing energize years become the base year. In other words,
the facility is always energized.

Future year switch positions, meter demands, and loads. For missing switch position,
meter demand, or load data, SynerGEE supplements the data from the base year. For
example, if a switch is open in the base year, and it has no future year data, it is assumed
to be open for all future years.

The same basic rules hold true if you create a new model and do not specify multi-year data. When you save
and reopen the model, the data will be supplemented as described above.
Remember that unique ID and topology rules are always in effect, despite the energized/retired state of
facilities. For example, you cannot have two sections with the same ID, even if they are never energized at
the same time.

FULL-YEAR (8760) ANALYSIS

The 8760 analysis runs a SynerGEE model over every hour of the year for the current year that is selected in
the model. As a result of the analysis, 8760 data points are generated, hence the name of the analysis type.
There are not configuration options required to set up an 8760 analysis. The analysis report includes the
following chapters, with each chapter being generated in chart form:

Total demand

Regulator tap positions

Transformer tap positions

The analysis report charts currently plot 1/4th of the data points. However, all 8760 data points are generated
by SynerGEE and can be exported to a text file or Excel for further evaluation. Export options are available
from the context (right-click) menu for each chart.

TO RUN A FULL-YEAR (8760) ANALYSIS

1

From the SynerGEE ribbon bar, select the PLANNING tab.

In the Time group, click 8760.

User Guide

SynerGEE Electric 5.0

Planning

589

PERFORMANCE COMPARISON
Model performance comparison presents operational and cost comparisons of various modeling alternatives
by comparing the model in memory to variations of that model stored in the gallery. When run, performance
comparison generates a report listing the following comparisons:

Low voltage and total kw demand at minimum load

High voltage and total kw demand peak load

Losses at peak

Capital cost difference between base model and gallery model

Operating cost difference between base model and gallery model

Performance comparison assumes that model loads are allocated at peak demand. To facilitate these
comparisons, it runs two different load-flow analyses:

A normal load-flow on the model, producing results at peak loading.

A load-flow after applying a light run factor to model loads, simulating a time of minimum system
demands. The light run factor is essentially a multiplier value that you can assign in the Performance
Comparison options editor, as described in Setting up a performance comparison analysis on
page 589.
During the light run, all loads are multiplied by the same factor to determine minimum loading
conditions. This approach is a very simple means of simulating light-load modeling, but it should
give useful numbers within the context of other assumptions.

Refer to the topics listed below for more information on performance comparison. For more information on
working with the gallery, see Gallery on page 129.

Setting up a performance comparison analysis on page 589

Add phase/change phase factors on page 592

Overall model costs on page 592

Secondary losses on page 593

Running a performance comparison analysis on page 594

Setting up a performance comparison analysis

Perform the following procedure to set up a performance comparison analysis.

TO SET UP A PERFORMANCE COMPARISON ANALYSIS

1

Perform the following steps to open the Performance Comparison editor:

a

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Performance group, click the text label Performance Comparison and then select
Settings.

SynerGEE Electric 5.0

User Guide

590

Planning
2

On the left side of the Performance Comparison editor, select from the different tab names to access
the available performance comparison settings. Refer to the topics listed below for more
information.
-

Selecting models for a performance comparison analysis on page 590

Setting costs for a performance comparison analysis on page 590

Setting analysis options for a performance comparison analysis on page 591

Click Apply to accept your changes, and then click X to close the editor.

Selecting models for a performance comparison analysis

Use the Models tab in the Performance Comparison editor to select which models in the gallery will be
compared to the model in memory. Performance comparison can compare a maximum of five different
gallery models.
Refer to the following procedure for more information on selecting models for a performance comparison
analysis. For more information on the gallery, see Gallery on page 129.

TO SELECT MODELS FOR A PERFORMANCE COMPARISON ANALYSIS

1

Perform the following steps to open the Performance Comparison editor:

a

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Performance group, click the text label Performance Comparison and then select
Settings.

In the Performance Comparison editor, select the Models tab.

The lower half of the Performance Comparison editor, under Models in Gallery, lists models in the
gallery that are available for analysis. The upper half of the editor, under Compare Model in
Memory to, lists models that will be included in the performance comparison analysis.

To add a model to the analysis: Select the model that you want to add in the Models in
Gallery area and then click the Up arrow button.

To remove a model from the analysis: Select the model that you want to remove in the
Compare Model in Memory to area and click the Down arrow button.

Click Apply to accept your changes, and then click X to close the editor.

Setting costs for a performance comparison analysis

Use the Costs tab of the Performance Comparison editor to set all of the costs associated with the
installation, maintenance, and removal of system equipment. The cost values that you set here are saved
from one SynerGEE session to the next. Once they are properly set, you should be able to run continuous
analyses without having to adjust them again, unless of course you purposefully need to change them.
Refer to the following procedure for more information on setting costs for a performance comparison
analysis. For more information on how these costs are used within the analysis, see the SynerGEE Technical
Reference.

User Guide

SynerGEE Electric 5.0

Planning

591

TO SET COSTS FOR A PERFORMANCE COMPARISON ANALYSIS

1

Perform the following steps to open the Performance Comparison editor:

a

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Performance group, click the text label Performance Comparison and then select
Settings.

In the Performance Comparison editor, select the Costs tab.

The Costs table lists different cost categories for different types of equipment. To edit s value, simply
double-click the current cell and then type the new value.

Click Apply to accept your changes, and then click X to close the editor.

Setting analysis options for a performance comparison

analysis
TO SET ANALYSIS OPTIONS FOR A PERFORMANCE COMPARISON ANALYSIS
1

Perform the following steps to open the Performance Comparison editor:

a

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Performance group, click the text label Performance Comparison and then select
Settings.

In the Performance Comparison editor, select the Analysis tab. The following table describes the
different options that you can set.
Light Run Factor

Multiplier used for the peak load to simulate a minimum load condition
for the light load-flow run. For more information on this factor, see
Performance Comparison on page 589.

Average Load Factor

Multiplier used to determine the average load, for cost calculations.

For more information on this factor, see the SynerGEE Technical
Reference.

Utility kWh Cost

Cost to the utility per kWh delivered. This value is ultimately used to
determine the cost of losses.

Peak Charge

Peak charge to the utility per kW purchased, generally during a time

of peak demand.

Add Phase Factor

Multiplier used to derive the cost of adding a phase. For more

information on this factor, see Add phase/change phase factors on
page 592.

Change Phase Factor

Multiplier used to derive the cost of changing a phase. For more

information on this factor, see Add phase/change phase factors on
page 592.

SynerGEE Electric 5.0

User Guide

592

Planning

Secondary Loss
Factor

Multiplier used to determine the percentage of total loss represented

by secondary loss. For more information on this factor, see
Secondary losses on page 593.

Click Apply to accept your changes, and then click X to close the editor.

Add phase/change phase factors

Adding phases and rephasing can have a significant impact on system performance and the cost of
delivering electricity. However, to simplify the cost settings required for performance comparison analysis, the
application does not provide for the direct specification of costs related to adding phases and rephasing lines.
Rather, it allows you to specify global multipliers that are used against existing line cost parameters.
In your performance comparison analysis options, conductor types are arranged into twelve broad groups,
based on loading and overhead/underground configuration. For each of these groups, you can set overall
cost information which is limited to:

Original equipment cost

Installation cost

Annual maintenance cost

Salvage value

Move cost

Instead of a complex array of phase change cost values for each conductor group, SynerGEE uses two
general multipliers the add phase factor and the change phase factor for all conductor types. When a
new phase is added or a line is rephased, these factors are multiplied against the original line costs to derive
the phase change costs. For example, if a phase is added to a single-phase line and the add phase factor is
1.5, this operation will cost 1.5 times as much as adding the original single-phase line, as specified in your
cost data.
These factors are set in your analysis options. For more information, see Setting up a performance
comparison analysis on page 589.

Overall model costs

Model costs are generated from capital costs and yearly costs.

User Guide

SynerGEE Electric 5.0

Planning

593

Calculating capital costs

Capital costs should reflect the one-time costs associated with the changes made to the base model to create
the comparison model. It is based on four components:

Capital costs for new equipment

+ Labor cost to install new equipment
+ Cost to move equipment

Eq 111

- Salvage recovery for retired equipment

= Total capital costs

Calculating yearly costs

Yearly costs are those recurring costs during the operation of a model:

Peak charge per kW on total model

+ Cost for primary kW losses
+ Cost for secondary kW losses
+ Yearly maintenance on new equipment
- Yearly maintenance on retired equipment
= Total yearly costs

Eq 112

Secondary losses
SynerGEE is a typically used for primary system analysis. However, secondary losses may be 50% or more
of distribution losses. These secondary losses may need to be considered if planning decisions are to be
made based on loss improvement. See the SynerGEE Technical Reference for secondary loss calculations.
During secondary loss calculations, SynerGEE makes the following assumptions:

The relationship between secondary losses and total secondary load is linear and independent of
voltage.

kW and kvar losses can be decoupled

The single k1 factor can be applied to all distributed loads

Loads are distributed evenly among taps on a distributed load

Clearly, these assumptions and this derivation indicate that the expression for secondary losses is not valid
on a per-load basis. In other words, secondary losses at a particular load in a system should not be evaluated
with these calculations. Rather, the intention of the secondary losses expression is to provide a system-wide
representation of the trend for secondary losses.
The k1 factor (or secondary loss factor) can be set in your analysis options. A typical value might be 3%,
which indicates that a typical primary distributed load would have a secondary kW loss component of 3% at
nominal load voltage. If half of distribution losses can be attributed to secondary losses then you might expect
total feeder losses to be around 6%. For more information on setting this factor, see Setting up a

SynerGEE Electric 5.0

User Guide

594

Planning
performance comparison analysis on page 589.
Performance comparison is the only SynerGEE analysis that evaluates secondary losses. Note that
secondary losses are ignored for spot load since the split of losses between the customer and the utility may
be complex. Also note that the cost for secondary losses is determined by multiplying secondary kW losses
by the utility cost per kW lost.
See the SynerGEE Technical Reference for the overall cost of loss calculations, as well as for equipment
data and calculations.

Running a performance comparison analysis

Before running a performance comparison analysis, you should take note of the following:

Equipment data. When you run performance comparison analysis, SynerGEE uses the equipment
data that is currently in memory. It does not load or analyze any equipment data that may be
contained in the gallery model files. This setup allows you to make controlled comparisons between
different configurations of equipment data as well as model data. For example, you could make
changes to regulator type ratings and run different comparisons, to see the effect.

Multi-year modeling. Performance comparison considers the year to which the SynerGEE interface
is set, much like any analysis. It uses this year to determine the year of the model in memory and
any models in the gallery to which it is compared. For example, if you have the interface set to Year
2 and you run performance comparison, it will operate on Year 2 data in both the memory and
gallery models, as applicable.
If you do not use multi-year modeling, you do not need to be concerned about the year setting when
running performance comparison. For more information on multi-year modeling, see Multi-Year
Analysis on page 579.

Perform the following procedure to run a performance comparison analysis.

TO RUN A PERFORMANCE COMPARISON ANALYSIS

1

If you have not already done so, use the Performance Comparison editor to configure options
related to the analysis. For more information, see Setting up a performance comparison analysis
on page 589.

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Performance group, click the Performance Comparison icon.

VOLTAGE OPTIMIZATION ANALYSIS

The voltage optimization analysis (formerly known as the CVR analysis, or conservation reduction analysis)
analyzes the effect of reducing voltage settings on main-line regulators and substation transformers. Voltage
settings are reduced and the effects on downstream minimum voltage, loading, regulators, and exceptions
are reported. This analysis can help you determine the minimum safe source voltage, which may help you
conserve energy.
Refer to the topics listed below for more information.

User Guide

SynerGEE Electric 5.0

Planning

595

Setting up a Voltage Optimization analysis on page 595

Performing a Voltage Optimization analysis on page 595

Voltage Optimization analysis reporting on page 595

Voltage Optimization analysis example on page 596

Setting up a Voltage Optimization analysis

Perform the following procedure to set up a Voltage Optimization analysis.

TO SET UP APPLICATION SETTINGS FOR A VOLTAGE OPTIMIZATION ANALYSIS

1

Perform the following steps to open the Voltage Optimization Analysis Options editor:
a

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Performance group, click the text label Voltage Optimization and then select
Settings.

Use the Voltage Optimization Analysis Options editor to set up the voltage range for the Voltage
Optimization analysis and also to set the interval that will be used for stepping through the analysis.
Refer to the following table for more information on the options that you can set in this editor.
Minimum Downstream
Volts

The Minimum Downstream Volts fields run against three-phase

transformers and voltage regulators. You can specify the minimum
volts for one phase and three phases.

LTC Starting Volt

Setting

The LTC starting voltage setting represents a user-input high that will
be progressively lowered to a setting that will keep the downstream
voltages above a certain value.

Click Apply to accept your changes, and then click X to close the editor.

Performing a Voltage Optimization analysis

Perform the following procedure to run a Voltage Optimization analysis.

TO PERFORM A VOLTAGE OPTIMIZATION ANALYSIS

1

If you have not already done so, use the Voltage Optimization Analysis Options editor to configure
analysis-related options as desired. For more information, see Setting up a Voltage Optimization
analysis on page 595.

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Performance group, click the Voltage Optimization icon.

Voltage Optimization analysis reporting

For each feeder analyzed, reported information may include the following:

SynerGEE Electric 5.0

User Guide

596

Planning

Feeder volts. The range specified when the application was launched. Values are listed in volts.

Drop. The largest drop in the feeder is listed in the report. The voltage drop is calculated by
comparing the feeder voltage to a section voltage, as follows.
1
1
VDrop = VFdr
VSect

Eq 113

Low volts. The lowest voltage in the feeder. The drop value and the low volts value should add up to
match the feeder voltage value.

High volts. The highest section voltage in the feeder.

kVA. Feeder kVA demand at a specified feeder voltage.

kW. Feeder real power demand at a specified feeder voltage.

Amps. Feeder load current.

pf. Power factor of feeder demand at a specified feeder voltage.

Pct loss. Feeder loss as a percentage of feeder kW demand.

VLT exceptions. Instances where one or more voltage exceptions exist at the specified feeder
voltage.

OLD exceptions. Instances where one or more overloaded lines or devices exist.

CTL exceptions. Instances where at least one regulator is sitting at its minimum or maximum tap.

Voltage Optimization analysis example

An example of the benefits of Voltage Optimization analysis follows. It shows a study to justify the installation
of one or two regulators on a feeder.
As with all SynerGEE analyses, you can copy and plot values from the report. The following image contains
the results from the Voltage Optimization analysis runs that were copied and plotted using a spreadsheet
package. This plot shows the range of low voltages as a function of feeder voltage.

Plot of feeder low voltage

User Guide

SynerGEE Electric 5.0

Planning

597

You can see the improvement in low voltage due to regulation. You can also see the effect of voltage settings
on the regulator and the drop from the regulator to the end of the feeder at higher feeder voltages.
The following plot addresses high-voltage problems.

Plot of feeder high voltage

Again, the effect of the regulator voltage settings is apparent. This study may be useful to justify the
installation of one regulator, while demonstrating that the benefits of a second regulator would not be worth
the cost.

ECONOMIC ANALYSIS
The economic analysis uses information from the values determined in cost zones (optional), customer
classes, and customer zones indicated in Section editors, as well as the secondary loss factor in the
economic analysis options. These components work in conjunction to generate the results of the analysis.
When the economic analysis is complete, the analysis results will display. The analysis results contain factors
calculated for each feeder and substation. Each one will contain monthly determinations of peak demand,
utilization, energy loss, load factor, and efficiency. It also contains hourly determinations for losses, utilization,
and load factors. These results can be interpreted and studied to guide the decision-making process for
equipment replacement or maintenance.

TO PERFORM AN ECONOMIC ANALYSIS

1

In the SynerGEE ribbon bar, select the PERFORMANCE tab.

In the Performance group, click the Economic icon.

SynerGEE Electric 5.0

User Guide

598

User Guide

Planning

SynerGEE Electric 5.0

CHAPTER

12
Protection
SynerGEE Protection provides a comprehensive environment for managing protection studies in a
distribution environment. Refer to the topics listed below for more information.

Protective Devices on page 599

Time Versus Current Coordination (TCC) Graph on page 604

Protection Lab on page 615

Protection Curve Editor on page 619

Check Coordination Analysis on page 622

Transformers and Transformer Curves on page 643

Arc Flashover on page 643

Fault Analysis on page 648

Fault Sequence Analysis on page 653

Fault Location Analysis on page 654

Protection Scheme Report on page 658

PROTECTIVE DEVICES
SynerGEE protective device models are detailed and integrate at a fundamental level, like all devices.
Whether you are performing detailed coordination studies or other load-flow based analyses, they provide a
reliable simulation of real-world devices.

Data management and protective devices

Protective devices in a model are represented entirely by instance data; that is, they have no reference to
associated records within the equipment data source. When you add a protective device, you drag a
general version of that device from the Warehouse tab of the model explorer and drop it on the model. Once
on the model, the device is configured and all data is stored in the model data. For more information on
modeling equipment, see Modeling Devices on page 317. For more information on the relationship between
model data and equipment data, see References to equipment data on page 63.
Protective device records do, however, make a reference to curve data in the protection curve library. For
more information on the library, see Protection data on page 67.

SynerGEE Electric 5.0

User Guide

600

Protection

Switchable protective devices

All protective devices are switchable, like switches. This feature allows them to be considered for switching
operations during contingency and reliability analyses. For more information on contingency analysis, see
Contingency Analysis on page 535. For more information on SynerGEE Reliability, see Reliability on
page 661.
The switchable nature of protective devices is only considered during analysis if the applicable analysis
options are set up as such. For more information on setting contingency analysis options, see Setting up a
contingency analysis on page 537. For more information on setting reliability analysis options, see Setting
up a Reliability Analysis on page 662.
Optimal switching analysis does not switch protective devices. For more information on optimal switching
analysis, see Optimal Switching Analysis on page 529.

Protective device details

SynerGEE supports detailed models for the following:

Fuses on page 342

Sectionalizers on page 393

Reclosers on page 377

Breakers on page 321

Transformer curves
For more information on transformer curves and curve shifting through transformers, see Transformers and
Transformer Curves on page 643.

Classic protective devices

In previous versions of SynerGEE, as well as its predecessor Distribution Primary Analysis/Graphics (DPA/
G), a more basic type of protective device was used. These devices, now known as classic protective
devices, may still be found in GIS systems and older SynerGEE models. Though SynerGEE still supports
classic protective devices, you should attempt to use the newer, more detailed models of fuses, reclosers,
breakers, and sectionalizers for new modeling. In addition, you should make an effort to convert any existing
classic protective devices to the new types. The classic protective devices are general in nature and lack the
detailed settings associated with specific protective devices, which are necessary for coordination analysis
and the TCC view. Also, they are not fully supported by all SynerGEE applications, particularly in the area of
exception reporting.
The model cleanup application provides commands specifically for protective device conversion. For more
information on model cleanup, see Model Cleanup Scripts on page 718.
Refer to the topics listed below for more information on working with classic protective devices.

Managing classic protective device types in the equipment warehouse on page 601

Managing classic protective devices in the model on page 602

User Guide

SynerGEE Electric 5.0

Protection

601

Managing classic protective device types in the equipment warehouse

Like certain other equipment types, an instance of a classic protective device references a type record in the
equipment data source. For more information on the relationship between model data and equipment data,
see References to equipment data on page 63.
Refer to the topics listed below for more information.

Creative a classic protective device type on page 601

Editing a classic protective device type on page 601

Deleting a classic protective device type on page 602

Creative a classic protective device type

Perform the following procedure to create a new protective device type in your equipment warehouse.

TO CREATE A CLASSIC PROTECTIVE DEVICE TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Protective Device.

In the Enter Device ID dialog box, type a name for the new device type, and then click OK.

Use the Protective Device Type editor to edit the settings for the protective device type. For more
information on the options you can set, see Editing a classic protective device type on page 601.

Editing a classic protective device type

To edit a protective device type, double-click the protective device type name in the Warehouse tab of the
SynerGEE model explorer. Refer to the following procedure for more information.

TO EDIT A CLASSIC PROTECTIVE DEVICE TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Protective Device Types and then double-click the name of the protective device type that
you want to edit.

Use the Protective Device Type editor to edit the following settings.

Device Kind

Type of device.

Voltage Rating

Device voltage rating.

Phasing

Device phasing.

Current Rating

Amperage ratings for the device.

Minimum Pickup

Current rating required to trip the device, and a multiplier if desired.

Energize and Retire

Energize and retire years for multi-year analysis. For more

information, see Multi-Year Analysis on page 579.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

602

Protection

Deleting a classic protective device type

Perform the following procedure to delete a protective device type from your equipment warehouse.

TO DELETE A CLASSIC PROTECTIVE DEVICE TYPE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Protective Device Types and then select the name of the protective device type that you
want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Managing classic protective devices in the model

Refer to the topics listed below for information on adding, editing, and deleting classic protective devices in
your model.

Adding a classic protective device on page 602

Editing a classic protective device on page 602

Deleting a classic protective device on page 604

Adding a classic protective device

Classic protective devices are added to a model in the same manner as any other equipment, by dragging a
protective device type from the Warehouse tab of the model explorer and dropping it onto an existing section
in the SynerGEE map display. Refer to the following procedure for more information. Additional information
on working with warehouse equipment types is provided in Modeling Devices on page 317.

TO ADD A CLASSIC PROTECTIVE DEVICE TO THE MODEL

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Protective Device Types and then select the protective device type that you want to add to
your model. Drag it onto the map display and drop it onto the desired section.

Editing a classic protective device

Use the Protective Device editor to edit an existing classic protective device in your model. Refer to the
following procedure for more information.

TO EDIT A CLASSIC PROTECTIVE DEVICE

1

In the SynerGEE map display or model explorer, double-click the protective device that you want to
edit.

On the left side of the Protective Device editor, select from the different tab names to access the
available settings for the protective device. The following topics describe the different tasks that you
can perform:

User Guide

Editing general data for a classic protective device on page 603

Viewing analysis results for a classic protective device on page 603

SynerGEE Electric 5.0

Protection

603
3

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a classic protective device

TO EDIT GENERAL DATA FOR A CLASSIC PROTECTIVE DEVICE

1

In the SynerGEE map display or model explorer, double-click on the classic protective device that
you want to edit.

In the Protective Device editor, select the Prot. Dev. tab. The following table describes the different
options that you can set.

Name

Protective device name or ID.

Phasing

Device phasing.

Protective Device

Device type. The list contains all protective device types found in your
equipment data source, managed using the Warehouse tab of the
model explorer. For more information on the relationship between
model data and equipment data, see References to equipment data
on page 63.

Setting

Number that changes the devices minimum pickup multiplier; then

the new multiplier is applied to minimum pickup, continuous current,
and interrupting current for the equipment specified. A value of 0.000
or 1.000 represents a standard piece of equipment and causes no
change.

Location Description

Optional descriptive information on the device, for informational

purposes only.

Click Apply to accept your changes, and then click X to close the editor.

Viewing analysis results for a classic protective device

The Results tab in the Protective Device editor provides analysis results for the protective device. The
Results tab can be very helpful if you are running multiple analyses and focusing on a particular device. Since
the settings update automatically with each analysis, you can run an analysis and watch the results change in
real time.
Note that you can configure which results are shown in the editor by using the Editor Results tab in the
Output Options editor. You can show and hide individual result types, such as Amps Into and Volts Out, and
you can also show and hide entire result categories, such as Fault results, Capacity results, and Reliability
results. In addition, you can select which power units are used to display the results. The Output Options
editor is described in more detail in Selecting which attributes are available in the Results tab on page 445.
Refer to the following procedure for more information on viewing analysis results for a protective device.

TO VIEW ANALYSIS RESULTS FOR A CLASSIC PROTECTIVE DEVICE

1

In the SynerGEE map display or model explorer, double-click on the protective device that you want
to work with.

In the Protective Device editor, select the Results tab.

SynerGEE Electric 5.0

User Guide

604

Protection
3

At the top of the Results tab, click the R button to display a list of the available results categories.
Select the check box for each results category that you want to view, and clear the check box for
each results category that you want to hide. Note that when you edit the category selections here,
you will also edit the category selections for all Results tabs, as well as the list of category selections
in the Editor Results tab of the Output Options editor.

Deleting a classic protective device

Perform the following procedure to delete a protective device from your model.

TO DELETE A CLASSIC PROTECTIVE DEVICE FROM THE MODEL

1

In the SynerGEE map display or model explorer, locate the protective device that you want to
delete.

Right-click on the protective device and select Delete.

Click Yes to confirm the deletion.

TIME VERSUS CURRENT COORDINATION (TCC) GRAPH

The SynerGEE Time versus Current Coordination (TCC) graph is a powerful tool for plotting protective device
curves and evaluating protection coordination. With its versatility and ease of use, SynerGEEs TCC
represents a significant advancement in the field of computerized TCC graphing.
The SynerGEE TCC environment operates around your SynerGEE model. All devices plotted on the graph
come directly from the model, not an external repository. Therefore, you can use the same model for both
planning and protection studies. Working with models in the TCC is similar to traditional planning work in the
map view, in that the TCC view concerns only the devices of the model currently loaded into memory.
The TCC provides a host of useful features. For example, you can:

Plot as many curves as you want

Create as many different graphs as you want

Copy, print, and save graphs

Perform precise measurements on the graph

Opening the TCC view

TO OPEN THE TCC VIEW
1

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click TCC.

Tip:

User Guide

You can also create a new TCC by right-clicking on a protective device in the map view
and selecting Add to TCC. If a TCC is already open, however, that device is added to that
graph instead of creating a new one.

SynerGEE Electric 5.0

Protection

605

Using the TCC explorer

Each TCC view contains a TCC explorer, which is conceptually similar to the model explorer in the SynerGEE
map view. The TCC explorer serves as a convenient point for creating and maintaining your graphs, as well
as managing the protective devices that appear on them.
The TCC explorer includes the following tabs:

Device List. The Device List tab contains a list of all protective devices within the selected feeders.
Note that feeder selection is global between the map and TCC views. You cannot have a different
selection set in a TCC view than the map.

Pair List. The Pair List tab lists pairs of protected and protecting devices, based on the topology of
the selected feeders.

Protection Tree. The Protection Tree tab lists protection devices for the selected feeders in a
topological tree relationship.

Sets List. The Sets List tab lists any TCC sets that are loaded into memory. For more information on
TCC sets, see Saving and loading TCC views as TCC sets on page 612.

From any tab in the TCC explorer, you can do any of the following:

Double-click on the device name to open the SynerGEE editor for that device.

Right-click on a device name to open a context menu with a number of useful shortcuts, such as
adding and removing devices from the TCC display.

You can also drag any device or device pair onto the graph to plot the curve(s). For more
information on plotting curves, see Plotting curves on the TCC on page 605.

Plotting curves on the TCC

To plot a curve on the TCC, simply drag the device or device pair from the TCC explorer and drop it on the
graph area. While plotting curves, take note of the following:

You must have the protection database loaded in memory for curves to appear. For more
information on loading the protection database, see Protection data on page 67.

In the Device List and Pair List tabs, devices with plotted curves appear with an asterisk (*). In the
Protection Tree tab, they appear with a three-colored-circle icon.

Curves are colored according to settings in the individual device editors. To change a curve color,
open the device editor for the associated device. You can open device editors directly from the TCC
view by double-clicking on the respective curve.

The TCC explorer only displays devices in the selected feeders/subtrans. For information on
selecting feeders, see Selecting Feeders on page 157.

You can also plot a curve by right-clicking on the device in the map view or a report and selecting Add to
TCC.

SynerGEE Electric 5.0

User Guide

606

Protection

Panning and zooming in the TCC

Perform the following procedure to pan and zoom in a TCC graph.

TO PAN IN THE TCC GRAPH

Click on the TCC graph and drag it to the desired location.

TO ZOOM IN THE TCC GRAPH

From the CONTROLS tab of the SynerGEE ribbon bar, in the Zoom group, click In, Out, and Previous, as
appropriate. You can also use the mouse wheel to zoom in and out of the TCC graph.

TO RETURN THE VIEW TO THE ORIGINAL ZOOM

From the CONTROLS tab of the SynerGEE ribbon bar, in the Zoom group, click K & E.

Changing TCC view display properties

The TCC view has its own set of display properties. You can change many aspects of the display to suit your
preferences.

TO EDIT THE TCC DISPLAY PROPERTIES

1

If you have not already done so, perform the following steps to open the TCC window.
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click TCC.

From the CONTROLS tab of the SynerGEE ribbon bar, in the TCC group, click Properties. You can
also double-click in any empty space in the TCC window.

Use the TCC Properties editor to edit the display settings for the TCC. The following topics describe
the different tasks that you can perform.

Editing curves in the TCC display on page 606

Editing reference shifting in the TCC display on page 609

Editing the graph in the TCC display on page 609

Editing the grid in the TCC display on page 610

Editing print settings for the TCC display on page 610

Click OK to accept your changes and close the editor.

Editing curves in the TCC display

Use the Curves tab in the TCC Properties editor to provide settings for curve shifting through transformers.
These settings are only applicable if there are devices on the graph that are on opposite sides of a
transformer.

User Guide

SynerGEE Electric 5.0

Protection

607

TO EDIT CURVES IN THE TCC DISPLAY

1

If you have not already done so, perform the following steps to open the TCC window.
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click TCC.

From the CONTROLS tab of the SynerGEE ribbon bar, in the TCC group, click Properties.

In the TCC Properties editor, select the Curves tab. The following table describes the different
options that you can set.
Curves to Display

Select an option corresponding to which curves you want to display.

Available choices are Phase & Ground, Phase Only, and Ground
Only.
This option can also be set from the CONTROLS tab of the
SynerGEE ribbon bar.

Transformer Damage
Curves

SynerGEE Electric 5.0

Select from one of the following options:

Dont Display. Select this option if you do not want to

display transformer damage curves.

Frequent Fault Curves. Select this option to show

transformer damage curves for Type II, III, and IV
transformers. Type II transformers start at 70% of the
maximum fault current and extend to the 100% fault value.
Type III and IV transformers start at 50% and extend to
100% of the maximum fault current. The curve has the same
slope as the infrequent fault withstand curve but is offset by
a factor K (t = K/ (If / Ibase)^2). This factor K is determined
for maximum fault current at two seconds on the secondary
windings.

Frequent and Infrequent Fault Curves. Select this option

to display a fault curve that runs from the end of the through
fault curve at 50 seconds to 2 seconds for Type II, III, and IV
transformers. It runs to 0.5 seconds for Type I transformers.

Inrush Curves. Select this option to show charging current

versus time for the transformer during power up.

User Guide

608

Protection

Cutoff Amps

Select from one of the following options:

No Cutoff Values. Select this option if you do not want to

apply curve cutoff values.

User-Specified Fault Values. Select this option to use

cutoff values that are specified directly in the individual
device editors.

Calculated Fault Values. Select this option to calculate

cutoff values as the result of a fault analysis or check
coordination analysis. Phase curves are usually cut off by
three-phase faults, and ground curves are usually cut off
from line-ground faults. This may vary, especially on singleand two-phase lines.

Cutoff at Amps. Select this option to apply a global cutoff

value to all curves on the TCC graph, regardless of device or
properties.

Note that when applying cutoff values, SynerGEE uses average load
current (vector average) through a protective device. Current on a
particular phase may exceed this value. If desired, you may select the
Show Cutoff or Show Load Current check boxes to display tick
marks or lines to make these values easier to visualize. Note that the
color of a tick mark or line matches its parent curve.
This option can also be set from the CONTROLS tab of the
SynerGEE ribbon bar.
Transformer Colors
and Conductor Colors

Select colors to represent transformer and conductor damage curves

in the TCC display.

Breakers & Electronic

Reclosers

Select an option to control curve visibility for breakers. Available

choices are Response Curve, Control Curve, or Response &
Control Curves.
This option can also be set from the CONTROLS tab of the
SynerGEE ribbon bar.

User Guide

Recloser Curves

Select an option to control curve visibility for reclosers. Available

choices are Fast & Slow Curves, K-Factor Shifted Fast & Slow
Curves, and Fast, Slow, & Cumulative Curves.

Save As Defaults

Select this check box if you want to save the current settings as the
default choices for future TCC views. If this check box is not selected,
any changes you make to the display properties will only apply to the
current TCC view.

Click OK to accept your changes and close the editor.

SynerGEE Electric 5.0

Protection

609

Editing reference shifting in the TCC display

Use the Reference tab in the TCC Properties editor to provide settings for curve shifting through
transformers. This option can also be set from the CONTROLS tab of the SynerGEE ribbon bar. These
settings are only applicable if there are devices on the graph that are on opposite sides of a transformer.
The voltage change across a transformer causes the need to shift curves appropriately if the transformer lies
between two devices. Otherwise, the curves may not align properly with respect to the voltage change, and
coordination may be mismatched. In the Reference tab, SynerGEE allows you to shift curves depending on
the type of fault you are studying, as well as select the device to use as the reference curve. When curves are
shifted, it is done based on the voltage at the reference device. The reference device, therefore, does not
shift.
You can also check Save As Defaults to save the current settings as the default values for new TCC views. If
this option is not checked, any changes you make to the display properties will only apply to the current TCC
view.
For detailed information on curve shifting through transformers, see the SynerGEE Technical Reference.

Editing the graph in the TCC display

TO EDIT THE GRAPH IN THE TCC DISPLAY
1

If you have not already done so, perform the following steps to open the TCC window.
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click TCC.

From the CONTROLS tab of the SynerGEE ribbon bar, in the TCC group, click Properties.

In the TCC Properties editor, select the Graph tab. The following table describes the different
options that you can set.
Display Notes Labels

Select this check box to display notes labels in the TCC display. You
can also click the Font button to specify the font type, style, and size.
This option can also be set from the CONTROLS tab of the
SynerGEE ribbon bar.

Device Curve Legend

Select the appropriate check boxes to display device descriptions and

feed sequence diagrams in the TCC legend. You can also click the
Font button to specify the font type, style, and size.

Axis Labels

Click the Font button to specify the font type, style, and size for x- and
y-axis labels.

Save As Defaults

Select this check box if you want to save the current settings as the
default choices for future TCC views. If this check box is not selected,
any changes you make to the display properties will only apply to the
current TCC view.

Click OK to accept your changes and close the editor.

SynerGEE Electric 5.0

User Guide

610

Protection

Editing the grid in the TCC display

Use the Grid tab of the TCC Properties editor to customize aspects of the grid itself. If any part of the grid or
annotation seems to be missing, check to be sure that the grid or font color is not the same as the
background color.
Some of these options can also be set from the CONTROLS tab of the SynerGEE ribbon bar.
You can also check Save As Defaults to save the current settings as the default values for new TCC views. If
this option is not checked, any changes you make to the display properties will only apply to the current TCC
view.

Editing print settings for the TCC display

Use the Printing tab of the TCC Properties editor to enter local title lines which are only associated with the
particular TCC you are working with, rather than title lines that are set up in the Page Setup dialog box. These
local title lines are saved and printed with the TCC.

Breakers, relays, and the TCC

For more information, see Relays, stages, and curves on page 327.

Adding notes, time lines, amp lines, and arc flashover

to the TCC
You can add notes labels to your TCC, along with time and amp lines, using the TCC Notes Label editor. The
editor contains three tabs: notes, line, and arc flash. Notes labels are provided as a convenience to help you
label and organize your graphs as well as attach specified arc flashover values to a curve. Time and amp
lines allow you to draw a horizontal (amp), a vertical (time), or a diagonal line on the graph at any specified
amperage or time, simply as a reference. Arc flashover values can be calculated and drawn on the TCC
using the TCC Notes Label editor. For more information on arc flash, see Arc Flashover on page 643.
Notes, time lines, amp lines, and diagonal are created in the same editor and are not associated with any
curve on the graph. If you create a note and a line at the same time, they will be associated with each other
and deleting one will delete the other.

TO ADD A NOTE TO THE TCC

1

If you have not already done so, perform the following steps to open the TCC window.
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click TCC.

From the CONTROLS tab of the SynerGEE ribbon bar, in the TCC group, click Add Note.

In the TCC Notes Label editor, select the Notes tab. Select the check box for each line of the note
that you want to enable, and type the desired text in the appropriate text boxes.

Click OK to accept your changes and close the editor.

User Guide

SynerGEE Electric 5.0

Protection

611

TO ADD A TIME LINE, AMP, OR DIAGONAL LINE TO THE TCC

1

If you have not already done so, perform the following steps to open the TCC window.
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click TCC.

From the CONTROLS tab of the SynerGEE ribbon bar, in the TCC group, click Add Note.

In the TCC Notes Label editor, select the Line tab. Select the check box for each line type that you
want to enable, and configure the available options as appropriately.

Click OK to accept your changes and close the editor.

TO ADD ARC FLASHOVER VALUES TO THE TCC

1

If you have not already done so, perform the following steps to open the TCC window.
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click TCC.

From the CONTROLS tab of the SynerGEE ribbon bar, in the TCC group, click Add Note.

In the TCC Notes Label editor, select the Arc Flash tab.

Select the Use Arc Flash Line check box.

Type appropriate values in the Energy, Distance, Bus Gap, Distance Factor, and KVLL text
boxes.

If desired, select the Grounded, Enclosed, or Use Lee Method check boxes to enable the
associated feature.

Use the Style and Color options to select a line style and color for the arc flashover line.

Click OK to accept your changes and close the editor.

TO MOVE A NOTE IN THE TCC

Select the note in the TCC display and drag it to its new location.

TO MOVE AN AMP OR TIME LINE IN THE TCC

Double-click the line to open the TCC Notes Label editor, and then select the Line tab and edit the associated
value.

TO DELETE A NOTE, TIME LINE, OR AMP LINE FROM THE TCC

Right-click on the note or line and select Delete Notes Label.

Using TCC graph measuring tools

SynerGEE provides a quick and precise method for measuring time and amp distances on the graph. This
feature is particularly useful if you are doing a focused coordination between two or more devices.

SynerGEE Electric 5.0

User Guide

612

Protection

TO USE TCC GRAPH MEASURING TOOLS

1

Press and hold the Shift key on your keyboard.

Left-click on the graph at a starting point and draw a vertical or horizontal line. The line snaps to
the closest curve.

Observe the measurements in the status bar at the bottom of the window.

Plotting conductor damage curves on the TCC

SynerGEE supports conductor damage curves on the TCC graph. For information on conductor damage
curve calculations, see Conductor Damage Curves on page 316.

TO PLOT A CONDUCTOR DAMAGE CURVE

From the map view or a report, right-click on the section with the desired conductor and select Add To TCC.

Saving and loading TCC views as TCC sets

You can save a TCC view as a TCC set, which becomes part of your model data and is included with any
model data save. You can also save the TCC as a bitmap (.bmp). At a data level, a TCC set contains the IDs
of devices on the graph, and the plot sequence. TCCs do not contain any display settings information like
external TCC files (SPV format), so you may need to use external files instead if you are attempting to
preserve characteristics such as grid and background colors. For more information, see Saving and loading
TCC views as external files on page 613.
However, if display settings are not a concern, TCC sets may be more convenient than external files because
they are stored as model data, and therefore travel with your model automatically. They also help ensure that
the devices in the plot set are currently loaded in memory whenever you activate the set, because it is likely
that both reside in the same model data source.

TO CREATE AND SAVE A TCC SET

1

After plotting the desired devices, right-click on the TCC graph and select Create TCC Set.

Save your model data as normal.

For more information on saving model data, see To save (export) model data on page 61.

TO OPEN (REDISPLAY) A TCC SET

From the Sets List tab of the TCC explorer, drag the desired set onto the TCC graph.

TO RENAME A TCC SET

In the Sets List tab of the TCC explorer, right-click on the desired set and select Rename TCC Set.

TO DELETE A TCC SET

1

In the SynerGEE model explorer, select the Model tab.

Expand Locations/Groups and select TCC Sets.

User Guide

SynerGEE Electric 5.0

Protection

613
3

Select the TCC set that you want to delete, and then right-click and select Delete.

TO UPDATE AN EXISTING TCC SET WITH THE CURRENT VIEW

In the Sets List tab of the TCC explorer, right-click on the desired set and select Update TCC Set.

Saving and loading TCC views as external files

You can save any TCC view to disk and reload it later inside SynerGEE. The file extension of a TCC file is
SPV, representing a proprietary SynerGEE format. Unlike TCC sets, SPV files are not an intrinsic part of
model data and are therefore not specific to any particular model. Also, SPV files include display settings
information, which TCC sets do not. For more information on TCC sets, see Saving and loading TCC views
as TCC sets on page 612.
When saving and loading TCC views in the SPV file format, it is important to note that SynerGEE does not
save a TCC as flat image. Rather, it saves a file that contains identifying information on which devices were
present on the graph. When you load a TCC file, SynerGEE reads the device IDs and regenerates the TCC
using data currently in memory. For example, assume you have Fuse X and Fuse Y on the graph and
save it to disk. When the file is loaded back, SynerGEE searches the model in memory for these two devices
and plots their curves based on their current configurations.
Therefore, if you alter the configuration of devices on a saved TCC before reloading it, the graph may look
different, because SynerGEE plots the curves based on current model conditions. When loading, if
SynerGEE encounters a device in a file that does not exist in memory, it produces a warning and does not
plot that devices curve.
If you want to save a TCC view as a permanent image, save the view as a JPEG or BMP image file. JPEG or
BMP files are easily imported into other applications, such as Microsoft Word. For more information on saving
a TCC view as a JPEG or BMP image, see Saving a TCC view as a JPEG or BMP image on page 613.

TO SAVE A TCC VIEW

From the CONTROLS tab of the SynerGEE ribbon bar, in the File group, click Save As.

TO LOAD A TCC VIEW

From the CONTROLS tab of the SynerGEE ribbon bar, in the File group, click Open.

Saving a TCC view as a JPEG or BMP image

You can save a TCC view as a JPEG or BMP image for use with other applications, such as Microsoft Word
or Excel. Once saved, the image is static and cannot be reloaded into SynerGEE and further manipulated.
This differs from saving the TCC as a special SynerGEE file that can be reloaded later and changed. For
more information on saving a TCC as this type of file, see Saving and loading TCC views as external files
on page 613.
As an option, you can use the file and location link feature to link a JPEG or BMP image to a device on the
model. This would allow you to associate the image with a particular device and display it quickly from the
map view. For more information on file and location links, see Location Links on page 223.

SynerGEE Electric 5.0

User Guide

614

Protection

TO SAVE A TCC VIEW AS A JPEG OR BMP IMAGE

1

From the CONTROLS tab of the SynerGEE ribbon bar, in the File group, click Save As.

In the TCC to Save editor, next to Save as type, select either JPEG Files (*.jpg) or Bitmap files
(*.bmp).

Next to File Name, type the name for the file you want to save.

Click Save.

Copying a TCC view

The copy command allows you to copy an image of the current TCC to the Windows Clipboard. Once on the
Clipboard, you can paste it into any application that supports image pasting, such as Microsoft Word, Excel,
or Paint. By capturing an image of a TCC in this fashion, you can maintain a permanent record of curve
coordination for a certain model under a particular configuration.

TO COPY A TCC VIEW

1

From the CONTROLS tab of the SynerGEE ribbon bar, in the TCC group, click Copy.

Paste the view in the application where you want to use it, such as Microsoft Word, Excel, or Paint.

Using other TCC functions and features

The TCC provides a number of miscellaneous features to facilitate your coordination studies.

TO USE TCC EDITING AND ZOOMING SHORTCUTS

In the TCC view, you can right-click on a device ID in the explorer, a device curve on the graph, or a device
number in the legend to produce a context menu with a variety of useful shortcuts, including the following:

Edit. Produces the editor for the device

Remove. Removes the curve from the graph

Zoom. Provides TCC graph zooming tools

Map Zoom. Zooms an open map view to the devices parent section

Map Pan. Pans an open map view to the devices parent section

Map Feeder Zoom. Zooms an open map view to the devices parent feeder

Device Settings. Produces a settings report for all devices on the graph. The report is essentially a
collection of rap sheets. For more information on rap sheets, see Rap Sheets on page 179.

Rap Sheet. Produces a rap sheet for the individual device

Link. Allows you to open a file or location link associated with the device, if one exists. For more
information on file and location links, see Location Links on page 223.

Add Note. Produces the TCC Notes Label editor with which you can apply a note and/or amp/time
lines. For more information on notes and amp/time lines, see Adding notes, time lines, amp lines,

User Guide

SynerGEE Electric 5.0

Protection

615
and arc flashover to the TCC on page 610.

TO REMOVE A DEVICE CURVE FROM THE GRAPH

Right-click on the curve and select Remove.
Tip:

You can also right-click on the device ID in the model explorer or on the device number in the TCC
explorer.

TO ADD A TITLE TO TCC PRINTOUTS

1

On the left end of the SynerGEE ribbon bar, click the Pole icon. Hover the mouse over Print and
then select Page Setup.

In the Page Setup dialog box, expand Views and then select TCC.

In the TCC tab, type title text as desire.

TO DELETE AN ENTIRE GRAPH

1

Make sure the graph that you want to delete is displayed.

From the CONTROLS tab of the SynerGEE ribbon bar, in the TCC group, click Remove Tab.

TO VIEW A FULL-SCREEN SIZE VERSION OF A GRAPH

1

Right-click in the TCC view and select Full Screen.

In Full Screen mode, click the X button to return to the SynerGEE window.

TO REFRESH THE TCC VIEW

From the CONTROLS tab of the SynerGEE ribbon bar, in the TCC group, click Refresh.

PROTECTION LAB
SynerGEEs Protection Lab (formerly called the Protective Device Viewer) provides a graphically oriented
view of the curves and coordination sets of devices. These devices are not in the model. You can specify the
parameters of each device (such as relay pickup, time-dial, and so on), and the resulting curves are drawn on
the screen along with the corresponding operating times.
The Protection Lab provides a user friendly interface, since there is no electrical network model to build.
Relays, fuses, and reclosers can be easily added to a study and cases (combinations of devices comprising
a particular coordination) may be saved and recalled at any time. Since the Protection Lab is independent
from the TCC, fault analysis and check coordination analysis does not apply.
Refer to the topics listed below for more information.

Creating a Protection Lab display on page 616

Editing a Protection Lab display on page 616

Copying a Protection Lab display on page 618

Renaming a Protection Lab display on page 618

SynerGEE Electric 5.0

User Guide

616

Protection

Deleting a Protection Lab display on page 619

Creating a Protection Lab display

Perform the following procedure to create a new Protection Lab display. Protection Lab displays are saved
independently and are not associated with any particular model. Therefore, when you create a Protection Lab
display, you are creating it on your hard drive and not as a part of the model that currently is loaded. The
default location for Protection Lab files is your ProtectionLab file directory. You can edit this location from the
Paths tab of the Preferences editor, as described in Defining file paths on page 167.

TO CREATE A PROTECTION LAB DISPLAY

1

Perform the following steps to access the Protection Lab tool:

a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Tools group, click Protection Lab.

On the left side of the Protection Lab window, select the Devices tab. Use the check boxes in the
Devices list to add or remove devices from the Protection Lab display.

In the Protection Lab display, double-click in the shaded area that represents the device that you
added. The device editor will appear. Use the device editor to edit the settings for the device as
appropriate. Click Apply to apply the settings to the Protection Lab display, and then click X to close
the editor.

In the Protection Lab display, double-click in an empty space to access the Protection Lab
Properties editor. Use this editor to edit settings related to curve, graph, grid, and printing options.
Click Apply to apply the settings to the Protection Lab display, and then click X to close the editor.
Note that the settings in the Protection Lab Properties editor are virtually identical to the settings in
the TCC Properties editor. However, not all of the settings apply to Protection Lab displays, including
all of the settings on the Reference tab. These settings will still be enabled but they will not have any
effect on the Protection Lab display that you are viewing.
For more information on these settings, see Changing TCC view display properties on page 606.

On the left side of the Protection Lab window, select the I/O tab. The I/O tab lists any Protection Lab
displays that you have already created and saved.

Click New. SynerGEE saves your Protection Lab display.

Editing a Protection Lab display

There are numerous ways that you can edit a Protection Lab display. You can add and remove devices from
the display, and you can edit the settings for any of the devices in the display. You can also edit the display
itself, including settings related to the Protection Lab curves, graph, and grid. Refer to the following procedure
for more information.

User Guide

SynerGEE Electric 5.0

Protection

617

TO EDIT A PROTECTION LAB DISPLAY

1

If you have not already done so, perform the following steps to access the Protection Lab window:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Tools group, click Protection Lab.

In the Protection Lab window, click the I/O tab. The I/O tab lists the Protection Lab displays
that you have already created and saved.

On the left side of the I/O tab, double-click the name of the Protection Lab display that you want to
copy. The selected Protection Lab display will appear on the right side of the Protection Lab window.

Use the instructions in the following table to edit the Protection Lab display.
To ...

Do This ...

Add or remove devices from

the Protection Lab

On the left side of the Protection Lab window, select the Devices
tab. Use the check boxes in the Devices list to add or remove
devices from the Protection Lab, as described in Creating a
Protection Lab display on page 616. When you are finished,
return to the I/O tab where you can further edit the Protection Lab
display. Remember that, as described below, you must save your
changes manually, or create a new Protection Lab display with
the new edits, before you close the Protection Lab window, or
else your changes will be lost.

Edit a device in the

Protection Lab

In the Protection Lab display, double-click in the shaded area that

represents the device that you want to edit. The device editor will
appear. Use the device editor to edit the settings for the device
as appropriate. Click Apply to apply the settings to the Protection
Lab display, and then click X to close the editor.
For more information on editing devices in SynerGEE, see the
respective section in the User Guide for the device that you want
to edit.

Edit the Protection Lab

display

In the Protection Lab display, double-click in an empty space to

access the Protection Lab Properties editor. Use the Protection
Lab Properties editor to edit settings related to curve, graph, grid,
and printing options. Click Apply to apply the settings to the
Protection Lab display, and then click X to close the editor.
Note that the settings in the Protection Lab Properties editor are
virtually identical to the settings in the TCC Properties editor.
However, not all of the settings apply to Protection Lab displays,
including all of the settings on the Reference tab. These settings
will still be enabled but they will not have any effect on the
Protection Lab display that you are viewing.
For more information on these settings, see Changing TCC view
display properties on page 606.

SynerGEE Electric 5.0

User Guide

618

Protection
4

Click Save to save the changes you have made. If you close the Protection Lab window without
saving the changes, the changes will be lost.

Copying a Protection Lab display

Perform the following procedure to create a duplicate copy of a Protection Lab display. This procedure will
also create a duplicate copy of the Protection Lab files, which are saved on your computer. The default
location for Protection Lab files is your ProtectionLab file directory. You can edit this location from the Paths
tab of the Preferences editor, as described in Defining file paths on page 167.

TO COPY A PROTECTION LAB DISPLAY

1

If you have not already done so, perform the following steps to access the Protection Lab window:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Tools group, click Protection Lab.

In the Protection Lab window, click the I/O tab. The I/O tab lists the Protection Lab displays
that you have already created and saved.

On the left side of the I/O tab, double-click the name of the Protection Lab display that you want to
copy. The selected Protection Lab display will appear on the right side of the Protection Lab window.

Click New. A new copy of the Protection Lab display is created with an automatically generated
name. See Editing a Protection Lab display on page 616 and Renaming a Protection Lab display
on page 618 for information on editing and renaming the new Protection Lab display.

Renaming a Protection Lab display

Protection Lab displays are created using an automatically generated naming sequence that includes the
date and time that the Protection Lab display was created. If desired, you can perform the following table to
rename a Protection Lab display. This procedure will rename the Protection Lab display as you see it in the I/
O tab of the Protection Lab window, and also rename the Protection Lab files that are saved on your
computer. The default location for Protection Lab files is your ProtectionLab file directory. You can edit this
location from the Paths tab of the Preferences editor, as described in Defining file paths on page 167.

TO RENAME A PROTECTION LAB DISPLAY

1

If you have not already done so, perform the following steps to access the Protection Lab window:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Tools group, click Protection Lab.

In the Protection Lab window, click the I/O tab. The I/O tab lists the Protection Lab displays
that you have already created and saved.

On the left side of the I/O tab, select the Protection Lab display that you want to rename.

Click Rename.

Type the new name for the Protection Lab display and then press Enter.

User Guide

SynerGEE Electric 5.0

Protection

619

Deleting a Protection Lab display

Perform the following procedure to delete a Protection Lab display. Remember that Protection Lab displays
are saved independently and are not associated with any particular model. Therefore, when you delete a
Protection Lab display, you are deleting it from your hard drive and not from the model that currently is
loaded. The default location for Protection Lab files is the ProtectionLab folder in your SynerGEE Documents
folder. You can edit this location from the Paths tab of the Preferences editor, as described in Defining file
paths on page 167.
Also note that when you delete a Protection Lab display, you are deleting the Protection Lab display that is
selected (highlighted) in the list of Protection Lab displays on the left side of the I/O tab in the Protection Lab
window. This may or may not be the same Protection Lab display that you are viewing at the time. Take care
to ensure that you have selected the correct Protection Lab display to delete.

TO DELETE A PROTECTION LAB DISPLAY

1

If you have not already done so, perform the following steps to access the Protection Lab window:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Tools group, click Protection Lab.

In the Protection Lab window, click the I/O tab. The I/O tab lists the Protection Lab displays
that you have already created and saved.

On the left side of the I/O tab, select the Protection Lab display that you want to delete.

Click Delete.

Click Yes to confirm the deletion.

PROTECTION CURVE EDITOR

The protection curve editor is a device within SynerGEE that allows you to access the protection database.
Aesthetically similar to the TCC graph, the protection curve editor controls manufacturers with existing curve
data. These curves can be edited, deleted, or created through the protection curve editor.
The protection curve editor contains two tabs. The Browse tab allows you to load a warehouse of existing
curves from different manufacturers. The curves can be edited, if necessary, and then saved. The Import/
Export tab can be used to read a *.CSV file and save the curves to SynerGEEs protection database. It can
also read all user-defined curves and export them to a *.CSV file. The import option will prompt you to load
curves from a file and then save to a database. The export option will prompt you to load curves from a
database and then save to a file. In both instances, the curves can be edited using the procedures that follow.

TO OPEN THE PROTECTION CURVE EDITOR

1

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Protection Curves group, click Editor.

SynerGEE Electric 5.0

User Guide

620

Protection

TO EDIT A PROTECTION CURVE

1

If you have not already done so, perform the following steps to open the Protection Curve editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Protection Curves group, click Editor.

In the CONTROLS tab of the SynerGEE ribbon bar, select the Edit Curve Points check box.
or
Right-click in the graph and select Edit. The curve points will appear on each curve.

Click and drag a point to move it and edit the curve.

TO EDIT A PROTECTION CURVE POINT

1

If you have not already done so, perform the following steps to open the Protection Curve editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Protection Curves group, click Editor.

Double-click the protection curve in the graph. The point editor will appear.

Select and double-click on an amp or time point in the editor.

Click Apply to accept your changes, and then click X to close the editor.

TO ADD A PROTECTION CURVE POINT

1

If you have not already done so, perform the following steps to open the Protection Curve editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Protection Curves group, click Editor.

In the CONTROLS tab of the SynerGEE ribbon bar, select the Edit Curve Points check box.
or
Right-click in the graph and select Edit. The curve points will appear on each curve.

In the CONTROLS tab, click the Add button.

or
Right-click in the graph and select Add Points.

Select an empty place on the curve and click to add a point.

TO DELETE A PROTECTION CURVE POINT

1

User Guide

If you have not already done so, perform the following steps to open the Protection Curve editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Protection Curves group, click Editor.

In the CONTROLS tab of the SynerGEE ribbon bar, select the Edit Curve Points check box.

SynerGEE Electric 5.0

Protection

621
or
Right-click in the graph and select Edit. The curve points will appear on each curve.
3

In the CONTROLS tab, click the Delete button.

or
Right-click in the graph and select Delete Points.

Select a point on the curve and click to delete it.

Click Save.

TO REDRAW A CURVE POINT

1

If you have not already done so, perform the following steps to open the Protection Curve editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Protection Curves group, click Editor.

Use the tree view to navigate to the point you wish to redraw.

Right click on the curve in the menu and select Redraw. All curves will be removed from the graph.

Click and drag in the graph to draw a new curve.

TO ADD A NEW CURVE

1

If you have not already done so, perform the following steps to open the Protection Curve editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Protection Curves group, click Editor.

In the Controls tab of the SynerGEE ribbon bar, click Create New Curve. The Create Protection
Curve wizard appears.

On the first page of the Create Protection Curve editor, select the type of device for which you want
to create a curve. Click Next to continue.

On the second page of the wizard, select the Curve Type and Device Type. Click Next to continue.

On the third page of the wizard, select a Manufacturer or type the name of a new one. Click Next to
continue.

On the fourth page of the wizard, select a Model or type the name of a new one. Click Next to
continue.

On the fifth page of the wizard, select a Rating or type the name of a new one. Click Next to
continue.

On the sixth and final page of the wizard, select a Curve Name or type the name of a new one. Click
Finish.

SynerGEE Electric 5.0

User Guide

622

Protection

MiddleLink and the protection curve editor

MiddleLink records can be used to support the protection curve editor. The Import tab can be used to read a
MiddleLink file with 18001, 18002, 18003, and 18020 records. All 18020 records related to an 18001, 18002,
or 18003 record must come immediately after that record or they will not be read in correctly.
The file can be loaded by selecting the path and then clicking Load. For more information on MiddleLink files,
see Importing GIS Data Using MiddleLink on page 100.

CHECK COORDINATION ANALYSIS

SynerGEEs protection coordination analysis application evaluates the characteristics of fuses, reclosers,
breakers, and sectionalizers, and examines the coordination of these devices throughout your system. The
analysis uses a large rule base to evaluate these devices independently and relatively. If you want, you can
selectively enable and disable individual rules for analysis. For more information on enabling and disabling
rules and the rule base, see Setting up a check coordination analysis on page 623.
Check coordination analysis verifies overcurrent coordination among protective devices as well as the
protection of transformers. This analysis is performed by breaking a feeder up into protective device pairs
and verifying the proper coordination of each pair. Each protective device pair is developed from a
combination of the following protective device types:

Expulsion fuse

Current limiting fuse

Hydraulic recloser

Electronic recloser

Electromechanical relay

Electronic relay

The application also considers:

Transformer inrush curves

Transformer damage curves

For more information on protective device models, see Protective Devices on page 599. Please note that
the application does not evaluate classic protective devices since they lack detailed time-current
characteristics. For more information on classic protective devices, see Classic protective devices on
page 600.
This application is designed to provide useful engineering information about coordination problems or
settings problems that may exist among the protective devices in a model. However, a successful, violationfree run of the application is not a guarantee of proper system coordination. Check coordination analysis is
limited to evaluations based on an internal rule-base, and cannot account for nuances which may be unique
to your system. The information provided by the analysis is valuable; however, you should use analysis
results in conjunction with your own engineering experience and knowledge of your particular system.
Refer to the topics listed below for more information.

User Guide

General check coordination operation on page 623

SynerGEE Electric 5.0

Protection

623

Setting up a check coordination analysis on page 623

Protection pairs and check coordinations on page 639

Running check coordination analysis on page 641

Coordination range of fault levels Check coordination on page 641

Cases not checked Check coordination on page 642

Curve shifting through transformers on page 642

Coordination over non-overlapped ranges on page 642

General check coordination operation

The operation of check coordination analysis is simple and direct. The application uses the following steps:
1

Determine all coordination pairs from the set of protective devices to be analyzed. For more
information on how the analysis set is determined, see Protection pairs and check coordinations
on page 639.

Find applicable rules for each type of pair.

Tip:

You can selectively enable and/or disable individual rules within the rule-base, using your
analysis options. For more information on setting check coordination options, see Setting
up a check coordination analysis on page 623.

Check each rule from an internal rule-base.

Mark each check as a pass or fail.

Generate a report.

The coordination rule-base is extensive and GL Noble Denton welcomes your ideas for expansion for
upcoming releases. For more information on the current rule-base, see Selecting coordination rules for a
check coordination analysis on page 627.

Setting up a check coordination analysis

TO SET UP A CHECK COORDINATION ANALYSIS
1

Perform the following steps to open the Check Coordination Settings editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Analysis group, click the text label Check Coordination and then select Settings.

On the left side of the Check Coordination Settings editor, select from the different tab names to
access the available settings. The following topics describe the different tasks that you can perform:
-

Editing analysis settings for a check coordination analysis

Setting time and percentage margins for a check coordination analysis

Selecting coordination rules for a check coordination analysis

SynerGEE Electric 5.0

User Guide

624

Protection
3

Click Apply to accept your changes, and then click X to close the editor.

Editing analysis settings for a check coordination analysis

TO EDIT ANALYSIS SETTINGS FOR A CHECK COORDINATION ANALYSIS
1

User Guide

Perform the following steps to open the Check Coordination Options editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Analysis group, click the text label Check Coordination and then select Settings.

SynerGEE Electric 5.0

Protection

625
2

In the Check Coordination Options editor, select the Settings tab. The following table describes the
different options that you can set.
Minimum Fault Values

When SynerGEE evaluates the coordination of two devices, it uses a

coordination range. This range extends through the possible fault
levels seen at the protecting (downstream) device.
SynerGEE can calculate the maximum fault level of the range using
fault analysis, based on sequence domain fault models. Or, if the
feeder lacks data to run a valid fault calculation, user-defined fault
levels or cutoff amps can be typed into each protective device editor.
Within the analysis settings editor, you can choose whether to have
calculated fault amps or cutoff amps used.
The minimum of the coordination range is the minimum fault current
expected at the protecting device. There are four options for handling
minimum fault current:

SynerGEE Electric 5.0

Use Percentage of Bolted Fault Amps. Fault analysis is

run. Using no fault impedance, phase and ground faults are
evaluated. All devices fed by the protecting device and no
other downstream protective devices are evaluated. The
fault current from each device is propagated and possibly
reflected through transformers to the protecting device. The
smallest calculated fault current is multiplied by this
percentage to obtain the range minimum. For the ground
range minimum, the maximum ground current is used
because of the bolted fault condition. The phase range
minimum uses the smallest phase fault current.

Use Percentage of Load Amps. The load current through

the protecting device is multiplied by this percentage value
to obtain the range minimum. The phase range minimum
uses phase current and the ground range minimum uses the
neutral current.

Use Fixed Amp Value. A user-defined fixed current is used

for both the phase and ground range minimum. The same
minimum is used for all protective device pairs regardless of
the nominal voltage level.

Use Line-Ground Minimum. SynerGEE uses the fault

impedance specified in the fault analysis settings or the
feeder record to calculate minimum line-ground fault
currents. All devices fed by the protecting device and no
other downstream protective devices are evaluated. The
fault current from each device is propagated and possibly
reflected through transformers to the protecting device. The
smallest calculated line-ground fault current is selected for
both the phase and ground range minimum.

User Guide

626

Protection

Use User-Defined
Cutoffs

Sets SynerGEE to use cutoff values specified in the device editors.

Use K-Shifted Curves

Sets SynerGEE to shift curves based on fuse heating and K-factor

shifting.

Ignore Load
Calculations

Sets SynerGEE to ignore coordination rules relating to load current

on phase and ground, including rules 10-01, 10-04, 30-05, 30-06, 6001, 60-02, and others relating to load. For more information on
coordination rules, see Selecting coordination rules for a check
coordination analysis on page 627.

Report Failed Tests

Only

Limits the analysis report to failed tests only.

Ignore fuses below X

amps

Select this check box to ignore any fuses that are less than a
specified Amp rating.

Coordinate electronic
recloser lockout with
relays

Select this check box to coordinate the lockout curve of electronic

reclosers with breaker relays. Clear the check box if you do not want
this to occur.
This option must be selected for check coordination rules 23-03,
23-04, and 23-06 to be applied.

Click Apply to accept your changes, and then click X to close the editor.

Setting time and percentage margins for a check coordination

analysis
In the Margins tab of the Check Coordination Options editor, you can set the time and percentage margins for
each type of protection pair. To change a margin value, double-click the number and type a new value. For
more information on the various types of pair combinations, see Protection pairs and check coordinations
on page 639. Default margins are described after the procedure below.
Margin settings do not change between SynerGEE sessions. Once you have them properly configured, you
should be able to run continuous analyses without having to adjust them again, unless you purposefully need
to make a change.

TO SET TIME AND PERCENTAGE MARGINS FOR A CHECK COORDINATION ANALYSIS

1

Perform the following steps to open the Check Coordination Options editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Analysis group, click the text label Check Coordination and then select Settings.

In the Check Coordination Options editor, select the Margins tab.

Use the table in the Margins tab to set the time and percentage margins for each type of protection
pair. To change a margin value, double-click the number and type a new value.
Tip:

User Guide

Click the column heading for Margin or Value to sort the margin list.

SynerGEE Electric 5.0

Protection

627
4

Click Apply to accept your changes, and then click X to close the editor.

Check coordination margins

Coordination time margins can be specified for the types of devices in a device pair. Usually, the margins are
in a percent format. In some cases, the margin is specified in seconds. Some pairs, like relay-fuse pairs,
have margins specified in seconds and percent. Fuse minimum fault pickup is specified in amps.
Your copy of SynerGEE included default values for each of these margins, as shown below. You can edit
these at any time, within the analysis settings editor. For more information on changing these margins, see
Setting up a check coordination analysis on page 623.
Default Time Margins

Rule Group

Devices

Percent

Seconds

Fuse minimum fault pickup (amps)

220%

---

10-

Fuse maximum load margin

90%

---

10-

Fuse protecting fuse

75%

---

11-

Fuse protecting recloser

95%

---

12-

Fuse protecting relay

--

0.3 Sec

13-

Fuse protecting transformer

75%

---

15-

Recloser protecting fuse

90%

---

21-

Recloser protecting recloser

75%

---

22-

Recloser protecting relay

75%

---

23-

Recloser protecting transformer

75%

---

25-

Relay protecting fuse

50%

0.3 Sec

31-

Relay protecting recloser

75%

---

32-

Relay protecting relay

75%

2.0 Sec

33-

Relay protecting transformer

75%

---

35-

Transformer inrush/fuse

75%

---

51-

Transformer inrush/recloser

75%

---

52-

Transformer inrush/relay

75%

---

53-

Selecting coordination rules for a check coordination analysis

In the Rules tab of the Check Coordination Options editor, you can select which coordination rules you want
SynerGEE to check during analysis, and also set the priority for each enabled rule: high, medium, or low.
Refer to the following procedure for more information. A description of each coordination rule follows the
procedure.

SynerGEE Electric 5.0

User Guide

628

Protection

TO SELECT COORDINATION RULES FOR A CHECK COORDINATION ANALYSIS

1

Perform the following steps to open the Check Coordination Options editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Analysis group, click the text label Check Coordination and then select Settings.

In the Check Coordination Options editor, select the Rules tab.

The Rules list provides the name of each rule and the rules current priority: High, Medium, Low, or
Disabled. To change the priority of a rule, do the following:

Select the rule or rules that you want to edit. Click the Select All button to select all rules in
the list.

Use the options list next to the Set button to select the priority that you want to assign.

Click Set. The selected rules are updated with the new priority setting.

Repeat these steps to edit additional rule priorities, as required.

Click Apply to accept your changes, and then click X to close the editor.

Check coordination rules

The table below describes the rule base that is used by the Check Coordination Analysis. Each rule uses a
prefix based on the type(s) of devices that make up the pair. For more information on protection pairs and rule
prefixes, see Protection pairs and check coordinations on page 639.
Rule

Protecting

Protected

Margin

Discussion

10-01

Fuse

---

---

Fuse should not blow under possible

load current. Fuse rating must be
greater than maximum continuous
load current.

10-02

Fuse

---

C% (220%)

Fuse should detect phase fault

current in its zone. Minimum phase
fault current seen by the fuse should
be greater than C% of fuse amp
rating.

10-03

Fuse

---

C% (220%)

Fuse should detect ground fault

current in its zone. Minimum ground
fault current seen by fuse should be
greater than C% of fuse amp rating.

10-04

Fuse

---

T% (90%)

Fuse link should not be pre-damaged

by load current. The fuse link should
not experience load current within T%
of its minimum melt curve.

10-05

Fuse

---

---

Fuse should have minimum melt and

maximum clear curves.

User Guide

SynerGEE Electric 5.0

Protection

629

Rule

Protecting

Protected

Margin

Discussion

11-01

Fuse

Fuse

T% (75%)

Protecting link will interrupt and clear

fault before protected link is
damaged. Maximum clearing time of
protecting link should not exceed T%
of the minimum melting time of the
protected link. This rule generally
accounts for the effects of
temperature variation, TCC
tolerances, pre-loading, and predamage.

11-02

Fuse

Fuse

T% (75%)

Same as rule 11-01. Checks

coordination for ground fault range.

11-03

Fuse

Fuse

---

I2t curves should be used to

coordinate current-limiting protecting
current-limiting fuse pairs below 0.01
seconds.

12-01

Fuse

Recloser

T% (95%)

Protecting fuse minimum melt curve

should lie above the recloser fast
curve by a margin of T%.

12-02

Fuse

Recloser

T% (95%)

Rule 12-01 applied to ground faults.

12-03

Fuse

Recloser

T% (95%)

Protecting fuse maximum clear curve

should lie below the recloser slow
curve by a margin of T%.

12-04

Fuse

Recloser

T% (95%)

Rule 12-03 applied to ground faults

13-01

Fuse

Relay

S (0.3 Sec)

Protecting fuse should blow on

downstream faults. Fuse maximumclear curve should lie below the relay
curve over the coordination interval
with a margin of S seconds. This rule
will fail if the fuse curve crosses the
relay curve in the protection interval.

13-02

Fuse

Relay

S (0.3 Sec)

Rule 13-01 applied to ground faults.

This rule will fail if the fuse curve
crosses the relay curve in the
protection interval.

13-03

Fuse

Relay

T% (75%)

Protecting fuse should blow on

downstream faults. Fuse maximumclear curve should lie below the relay
curve over the coordination interval
with a margin of T%.

13-04

Fuse

Relay

T% (75%)

Rule 13-03 applied to ground faults.

SynerGEE Electric 5.0

User Guide

630

Protection

Rule

Protecting

Protected

Margin

Discussion

15-01

Fuse

Tran

T% (75%)

Protecting fuse link will not allow

transformer to be damaged.
Transformer damage curve should lie
above protecting fuse maximum clear
curve by a margin of T%.

15-02

Fuse

Tran

T% (75%)

Rule 15-01 applied to ground faults.

20-01

Recloser

---

---

Reclosers should not experience fault

levels beyond their interrupt rating.

20-02

Recloser

---

---

Rule 20-01 applied to ground faults.

20-03

Recloser

---

---

Minimum fault level seen by a

recloser should exceed its minimum
pickup. Minimum fault current must
be greater than the recloser minimum
pickup.

20-04

Recloser

---

---

Rule 20-03 applied to ground faults.

20-05

Recloser

---

---

Fast curve should lie below slow

curve. A faster curve should be
selected for the fast operation than
for the slow operation. This check is
made for phase and ground curves.

20-06

Recloser

---

---

A recloser should have at least one

fast or one time-delay operation
selected.

20-07

Recloser

---

---

Largest amp value on recloser phase

operation curve should exceed
minimum fault current.

20-08

Recloser

---

---

Rule 20-08 applied to ground curves.

20-09

Recloser

---

---

Recloser fast or slow phase operation

curves should pick up below
maximum fault amps.

20-10

Recloser

---

---

Rule 20-08 applied to ground curves.

20-11

Recloser

---

---

Maximum fault current must not

exceed the recloser phase operation
curves.

20-12

Recloser

---

---

Rule 20-11 applied to ground curves.

20-13

Recloser

---

---

Recloser should have phase or

ground curves.

User Guide

SynerGEE Electric 5.0

Protection

631

Rule

Protecting

Protected

Margin

Discussion

21-01

Recloser

Fuse

T% (90%)

Protected fuse should not be

damaged throughout the entire
operating sequence of the recloser.
Fuse minimum-melt curve should lie
above the K-shifted recloser curve by
a margin of T%. If the Use K-shifted
curves isnt checked in the Settings,
then this rule will analyze the
cumulative curves (sum of curve
operations) instead. In the case of
hydraulic reclosers, coordination is
only checked within the capabilities of
the recloser curves. Fault levels past
the recloser curves are not
considered.

21-02

Recloser

Fuse

T% (90%)

Rule 21-01 applied to ground faults.

22-01

Recloser

Recloser

The number of fast operations of the

protecting recloser should be the
same or greater than the protected
recloser.

22-02

Recloser

Recloser

T% (75%)

The protecting recloser should

operate its slow curve without the
protected recloser tripping on its slow
curve. The protecting reclosers slow
curve should lie below the protected
reclosers slow curve by a margin of
T%.

22-03

Recloser

Recloser

T% (75%)

Rule 22-02 applied to ground curves.

22-04

Recloser

Recloser

S (0.3 Sec)

The protecting recloser should

operate its slow curve without the
protected recloser tripping on its slow
curve. The protecting reclosers slow
curve should lie below the protected
reclosers slow curve by a margin of
S seconds.

22-05

Recloser

Recloser

S (0.3 Sec)

Rule 22-04 applied to ground curves.

SynerGEE Electric 5.0

User Guide

632

Protection

Rule

Protecting

Protected

Margin

Discussion

22-06

Recloser

Recloser

T% (75%)

The protecting recloser should

operate to lockout without the
protected recloser tripping on its
lockout curve (that is, it looks at the
cumulative curve). The protecting
reclosers total clear curve should lie
below the protected reclosers total
response time by a margin of T%.

22-07

Recloser

Recloser

T% (75%)

Rule 22-06 applied to ground curves.

22-08

Recloser

Recloser

S (0.3 Sec)

The protecting recloser should

operate to lockout without the
protected recloser tripping on its
lockout curve (that is, it looks at the
cumulative curve). The protecting
reclosers total clear curve should lie
below the protected reclosers total
response time by a margin of S
seconds.

22-09

Recloser

Recloser

S (0.3 Sec)

Rule 22-08 applied to ground curves.

22-10

Recloser

Recloser

T% (75%)

The protecting recloser should

operate its slow phase curve without
the protected recloser tripping on its
fast or slow ground curve. The
protecting reclosers slow phase
curve should lie below the protected
reclosers fast or slow ground curve
by a margin of T%. The 22-10 rule will
not be used if the upstream or
downstream ground is disabled
(respective to the particular rule) on
the recloser.

22-11

Recloser

Recloser

T% (75%)

The protecting recloser should

operate its slow ground curve without
the protected recloser tripping on its
fast or slow ground curve. The
protecting reclosers slow ground
curve should lie below the protected
reclosers fast or slow ground curve
by a margin of T%. The 22-11 rule will
not be used if the upstream or
downstream ground is disabled
(respective to the particular rule) on
the recloser.

User Guide

SynerGEE Electric 5.0

Protection

633

Rule

Protecting

Protected

Margin

Discussion

22-12

Recloser

Recloser

S (0.3 Sec)

The protecting recloser should

operate its slow phase curve without
the protected recloser tripping on its
fast or slow ground curve. The
protecting reclosers slow phase
curve should lie below the protected
reclosers fast or slow ground curve
by a margin of S. The 22-12 rule will
not be used if the upstream or
downstream ground is disabled
(respective to the particular rule) on
the recloser.

22-13

Recloser

Recloser

S (75%)

The protecting recloser should

operate its slow ground curve without
the protected recloser tripping on its
fast or slow ground curve. The
protecting reclosers slow ground
curve should lie below the protected
reclosers fast or slow ground curve
by a margin of S. The 22-13 rule will
not be used if the upstream or
downstream ground is disabled
(respective to the particular rule) on
the recloser.

22-14

Recloser

Recloser

T% (75%)

The protecting recloser should

operate its fast phase curve without
the protected recloser tripping on its
fast ground curve. The protecting
recloser's fast phase curve should lie
below the protected recloser's fast
ground curve by a margin of T%. The
22-14 rule will not be used if the
upstream or downstream ground is
disabled (respective to the particular
rule) on the recloser.

SynerGEE Electric 5.0

User Guide

634

Protection

Rule

Protecting

Protected

Margin

Discussion

22-15

Recloser

Recloser

T% (75%)

The protecting recloser should

operate its fast ground curve without
the protected recloser tripping on its
fast ground curve. The protecting
recloser's fast ground curve should lie
below the protected recloser's fast
ground curve by a margin of T%. The
22-15 rule will not be used if the
upstream or downstream ground is
disabled (respective to the particular
rule) on the recloser.

23-01

Recloser

Relay

T% (75%)

The protecting recloser should

operate to lockout without tripping the
protected relay. The protecting
recloser t.d. curve should lie below
the protected relay curve by a margin
of T%.

23-02

Recloser

Relay

T% (75%)

Rule 23-01 applied to ground curves.

23-03

Recloser

Relay

Protecting recloser should operate to

lockout without tripping the protected
relay.
Note that the Coordinate electronic
recloser lockout with relays option
must be selected in the Settings tab
of the Check Coordination Options
editor in order for this rule to be
applied.

23-04

Recloser

Relay

Similar to 23-03 except with the

ground capabilities of both devices.
Note that the Coordinate electronic
recloser lockout with relays option
must be selected in the Settings tab
of the Check Coordination Options
editor in order for this rule to be
applied.

23-05

User Guide

Recloser

Relay

Protecting recloser should operate its

slow phase curve without tripping the
ground curve of the protected relay.

SynerGEE Electric 5.0

Protection

635

Rule

Protecting

Protected

Margin

Discussion

23-06

Recloser

Relay

Protecting recloser should operate its

cumulative phase curve without
tripping the ground curve of the
protected relay.
Note that the Coordinate electronic
recloser lockout with relays option
must be selected in the Settings tab
of the Check Coordination Options
editor in order for this rule to be
applied.

23-07

Recloser

Relay

S (0.05 Sec)

Recloser fast ground curve should lie

below the fastest relay ground curve
by a margin of S seconds.

23-08

Recloser

Relay

S (0.05 Sec)

Recloser fast phase curve should lie

below the fastest relay ground curve
by a margin of S seconds.

23-09

Recloser

Relay

S (0.05 Sec)

Recloser fast phase curve should lie

below the fastest relay phase curve
by a margin of S seconds.

25-01

Recloser

Tran

T% (75%)

Protecting recloser phase curve will

not allow transformer to be damaged.
Transformer damage curve should lie
above protecting recloser phase
curve by a margin of T%.

25-02

Recloser

Tran

T% (75%)

Rule 25-01 applied to ground faults.

30-01

Relay

Breakers should not experience fault

levels beyond their interrupt rating.
Maximum fault current must not
exceed the breaker interrupt rating.

30-02

Relay

Rule 30-01 applied to ground faults.

30-03

Relay

Minimum fault level seen by phase

relay should exceed its minimum
pickup.
Minimum pickup value is determined
from all phase / ground relays;
reclosing or not. If the breaker lacks a
valid non-reclosing curve, the rule is
marked as an invalid check and will
not be listed.

30-04

Relay

SynerGEE Electric 5.0

Rule 30-03 applied to ground faults.

User Guide

636

Protection

Rule

Protecting

Protected

Margin

Discussion

30-05

Relay

Phase relay should not trip under

load current.
Minimum pickup value is determined
from all phase / ground relays;
reclosing or not. This min pickup is
used against available load current at
the protective device. If the breaker
lacks a valid non-reclosing curve, the
rule is marked as an invalid check
and will not be listed.

30-06

Relay

Ground relay should not trip under

neutral load current.
Minimum pickup value is determined
from all phase / ground relays;
reclosing or not. This min pickup is
used against available load current at
the protective device. If the breaker
lacks a valid non-reclosing curve, the
rule is marked as an invalid check
and will not be listed.

30-07

Relay

Relay time dial or time multiplier

setting must be within the range
dictated by available curves.
SynerGEE should find a matching
curve or should be able to interpolate
between two curves to generate the
relay characteristic curve.

30-08

Relay

Rule 30-07 applied to ground relays.

30-09

Relay

Breaker should have phase or ground

relay curves.

31-01

Relay

Fuse

T% (50%)

Protected fuse should not be

damaged by faults beyond the relay.
To coordinate, the fuse minimummelt curve should lie above the relay
curve by a margin of T% over the
coordination interval.

31-02

Relay

Fuse

T% (50%)

Rule 31-01 applied to ground faults.

User Guide

SynerGEE Electric 5.0

Protection

637

Rule

Protecting

Protected

Margin

Discussion

31-03

Relay

Fuse

S (0.3 Sec)

Protected fuse should not be

damaged by faults beyond the relay.
To coordinate, the fuse minimummelt curve should lie above the relay
curve by a margin of S seconds over
the coordination interval.

31-04

Relay

Fuse

S (0.3 Sec)

Rule 31-03 applied to ground faults.

32-01

Relay

Recloser

T% (75%)

The protecting relay should trip

before the protected recloser
operates to lockout. The relay phase
curve should lie below the recloser
total clear curve by a margin of T%.

32-02

Relay

Recloser

T% (75%)

Rule 32-01 applied to ground faults.

33-01

Relay

Relay

T% (75%)

Protecting relay will trip and clear

fault before protected relay trips.
Protecting relay curve should not
exceed the protected relay curve by a
margin of T%.

33-02

Relay

Relay

T% (75%)

Rule 33-01 applied to ground faults.

33-03

Relay

Relay

S (2.0 Sec)

Protecting relay will trip and clear

fault before protected relay trips.
Protecting and protected relays
should maintain an S second margin.

33-04

Relay

Relay

S (2.0 Sec)

Rule 33-03 applied to ground faults

35-01

Relay

Tran

T% (75%)

Protecting relay phase curve will not

allow transformer to be damaged.
Transformer infrequent fault damage
curve should lie above protecting
relay phase curve by a margin of T%.

35-02

Relay

Tran

T% (75%)

Rule 35-01 applied to ground faults.

40-01

Sctnlzr

A sectionalizer should have an

upstream recloser. Sectionalizer
should have recloser along feed path.

51-01

Tran

Fuse

T% (75%)

Feeding fuse link will not be damaged

by transformer inrush current.
Transformer inrush curve should lie
below the feeding fuse minimum-melt
curve by a margin of T%.

SynerGEE Electric 5.0

User Guide

638

Protection

Rule

Protecting

Protected

Margin

Discussion

51-02

Tran

Fuse

T% (75%)

Feeding fuse link should protect the

transformer. Fuse max clear curve
should lie below the transformer
damage curve by a margin of T%.

52-01

Tran

Recloser

T% (75%)

Feeding recloser will not operate to

lockout by transformer inrush current.
Transformer inrush curve should lie
below the recloser t.d. curve by a
margin of T%.

52-02

Tran

Recloser

T% (75%)

Feeding recloser fast operation will

not occur from transformer inrush
current. Transformer inrush curve
should lie below the recloser fast
curve by a margin of T%.

52-03

Tran

Recloser

T% (75%)

Feeding recloser should protect the

transformer. Recloser phase lockout
curve should lie below the
transformer damage curve by a
margin of T%.

53-01

Tran

Relay

T% (75%)

Feeding relay will not trip from

transformer inrush current.
Transformer inrush curve should lie
below the relay phase curve by a
margin of T%.

53-02

Tran

Relay

T% (75%)

Feeding breaker should protect the

transformer. Phase relay curve
should lie below the transformer
damage curve by a margin of T%.

60-01

Any

Zone fault at a protective device

should be detectable. The load
current through a protective device
should not exceed the minimum fault
current of any device fed by that
protective device. If this rule is not
met, a downstream protective device
may be necessary to reduce the
zone.

User Guide

SynerGEE Electric 5.0

Protection

639

Rule

Protecting

Protected

Margin

Discussion

60-02

Any

Zone fault at a protective device

should be detectable. The neutral
load current through a protective
device should not exceed the
minimum ground fault current of any
device fed by that protective device. If
this rule is not met, a downstream
protective device may be necessary
to reduce the zone.

Protection pairs and check coordinations

SynerGEE uses a concept of protective device pairs when performing coordination checks. An upstream
(protected) device will form coordination pairs with any and all downstream devices. SynerGEE evaluates
each pair and reports on the coordination results.

Sample feeder and pairs Check coordination example

As an example, consider the following feeder.
4
F

2 3
6

Feeder serving a load through a transformer

The following coordination pairs are generated.

Pair

Protecting
device

protecting

protecting

protecting

protecting

protecting

protecting

protecting

protecting

protecting

protecting

SynerGEE Electric 5.0

Protected
device

User Guide

640

Protection

Pair

Protecting
device

Protected
device

protecting

protecting

protecting

All pairs look past sectionalizers when considering the fault zone. Sectionalizers are not interrupting devices
and should not affect the fault zone of an upstream device. The minimum fault current for a protective device
is found from the minimum fault current of all downstream sections (propagated through necessary
transformers) that are not fed by other downstream protective devices, unless those downstream protective
devices are electrically at the given device.

Pair types and rule prefixes Check coordination

Coordination rules use a numbering scheme help manage the wide variety of pair combinations and relate
them to the particular margins and rules used in the application. These numbers, as shown below, are
combined into prefixes based on the pair type. Each rule uses one of these prefixes for organization.
1

Fuse

Recloser

Relay

Sectionalizer

Transformer

General

For example, rules and margins for a fuse protecting a recloser would use the prefix 12- (1-fuse, 2-recloser).
In general, the numbers in the prefixes are in the order of protecting/protected. If a rule pertains to a particular
isolated device, the protected value would be zero. For example, a rule for an isolated fuse would be
prefixed with 10-.
There are general and specific rules that are applied to the different combination of devices making up a
coordination pair. The coordination pairs recognized by SynerGEE are as follows.
Protecting device
Protected device

All

Fuse

Recloser

Relay

Sctzlr

Trans

None

60-

10-

20-

30-

40-

Fuse

11-

21-

31-

51-

Recloser

12-

22-

32-

52-

Relay

13-

23-

33-

53-

User Guide

SynerGEE Electric 5.0

Protection

641

Protecting device
Protected device

All

Fuse

Recloser

Relay

Sctzlr

Trans

Sectionalizer

Transformer

15-

25-

35-

Running check coordination analysis

Perform the following procedure to run a check coordination analysis. Note that check coordination analysis
can be run from a map view or from a TCC view with or without devices selected. The protective devices to
be included in the analysis are determined as follows:

Map view. All protective devices on the map are considered. All observable combinations of
protective devices are evaluated.

TCC view with no devices selected. All protective devices belonging to the selected feeders are
considered. All observable combinations of protective devices are evaluated.

TCC view with devices selected. Only combinations of the selected devices are evaluated.
Coordination between selected devices and other devices on the model is not evaluated.

TO RUN A CHECK COORDINATION ANALYSIS

1

If you have not already done so, use the Check Coordination Settings editor to configure options
related to the analysis. For more information, see Setting up a check coordination analysis on
page 623.

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Analysis group, click the Check Coordination icon.

Coordination range of fault levels Check coordination

When SynerGEE evaluates the coordination of two devices, it uses a coordination range. This range extends
through the possible fault levels seen at the protecting (downstream) device.
SynerGEE can calculate the maximum fault level of the range using fault analysis, based on sequence
domain fault models. Or, if the feeder lacks data to run a valid fault calculation, user-defined fault levels or
cutoff amps can be typed into each protective device editor. Within the analysis settings editor, you can
choose whether to have calculated fault amps or cutoff amps used.
The minimum of the coordination range is the minimum fault current expected at the protecting device. There
are four options for handling minimum fault current. For more information on setting this option, see Setting
up a check coordination analysis on page 623.

Line-ground minimum fault current. SynerGEE uses the fault impedance specified in the fault
analysis settings or the feeder record to calculate minimum line-ground fault currents. All devices
fed by the protecting device and no other downstream protective devices are evaluated. The fault
current from each device is propagated and possibly reflected through transformers to the protecting

SynerGEE Electric 5.0

User Guide

642

Protection
device. The smallest calculated line-ground fault current is selected for both the phase and ground
range minimum.

Percentage of bolted fault. Fault analysis is run. Using no fault impedance, phase and ground
faults are evaluated. All devices fed by the protecting device and no other downstream protective
devices are evaluated. The fault current from each device is propagated and possibly reflected
through transformers to the protecting device. The smallest calculated fault current is multiplied by
this percentage to obtain the range minimum. For the ground range minimum, the maximum ground
current is used because of the bolted fault condition. The phase range minimum uses the smallest
phase fault current.

Percentage of load current. The load current through the protecting device is multiplied by this
percentage value to obtain the range minimum. The phase range minimum uses phase current and
the ground range minimum uses the neutral current.

Use fixed current. A user-defined fixed current is used for both the phase and ground range
minimum. The same minimum is used for all protective device pairs regardless of the nominal
voltage level.

Cases not checked Check coordination

This section lists known cases that are not checked by SynerGEE. Many of these cases require additional
data that is not handled by SynerGEE.
The computer analysis relies solely on the rule-base in the previous section. If you find a need for an
expansion of those rules, please contact GL Noble Denton with your suggestions or concerns.
Keep in mind that protective device coordination is complex and in many cases requires human judgment.
You should always couple analysis results with your own knowledge and experience.

Ground curve tripping from the inrush of a single- phase

transformer
Single-phase transformers have inrush currents that look like a line-ground fault to upstream protective
devices. Reclosers and relays equipped with ground units may trip on a real feeder with sufficient transformer
inrush. SynerGEE does not check the coordination of protective device ground curves with transformer
inrush curves.

Curve shifting through transformers

For detailed information on curve shifting through transformers, see the SynerGEE Technical Reference.

Coordination over non-overlapped ranges

In some cases, the coordination range of a device pair may correspond to an amp range in which the devices
do not overlap. In the following example, an S&C 65A-Slow SMU-20 fuse serves a transformer and a low side
Kearney 65A T-Link fuse. The source, transformer, and line impedances are such that the maximum fault
current seen by the secondary fuse is about 1800A. The following is the TCC shown with L-G fault shifting to
the secondary fuse.

User Guide

SynerGEE Electric 5.0

Protection

643

Fuse curves on secondary side

You can see that there is no overlap in the amp ranges of either curve. SynerGEE treats this as a miscoordination.

TRANSFORMERS AND TRANSFORMER CURVES

SynerGEE accounts for transformer inrush and damage curves during check coordination analysis and can
plot them on the TCC graph. For more information on the TCC, see Time Versus Current Coordination
(TCC) Graph on page 604. For more information on check coordination analysis, see Check Coordination
Analysis on page 622.

ARC FLASHOVER
Arc flashover deals with the energy produced from a fault and its upstream coordination of protecting
equipment. SynerGEEs arc flashover application analyzes the safe working distances, estimated arc fault
amps, incident energy, and recommended PPE for clothing. SynerGEEs will make suggestions for safety
clothing to wear during maintenance, and can also produce printable safety labels with safe working distance
values, to be placed on equipment.
Arc flashover can be run on selected feeders, a query set, or a selected section with a device. Arc flashover
values can also be calculated and drawn on the TCC graph, as described in Adding notes, time lines, amp
lines, and arc flashover to the TCC on page 610.

SynerGEE Electric 5.0

User Guide

644

Protection
Refer to the topics listed below for more information. Additional information on arc flashover is provided in the
Arc Flashover chapter of the SynerGEE Technical Reference.

Arc Flashover Overview on page 644

Disclaimer on page 644

Exceptions on page 645

Model requirements on page 645

Setting up an arc flashover analysis on page 645

Performing an arc flashover analysis on page 648

Arc Flashover Overview

Arc flashover is the passage of current between two electrodes through ionized gases and vapors. The
electrical energy supplied to the arc is converted into other forms of energy and results in intense heat. The
extremely high temperatures of these arcs can cause fatal burns at about 5 feet and major burns at up to a
10-foot distance from the arc. The intensity of an arc depends on voltage, fault current, clearing time of
protective device, enclosure space, and so on. Arc flashover is primarily found in circuits with an operating
voltage of 208V and higher in commercial and industrial facilities.
Electric arc burns make up a major portion of injuries related to electric malfunctions. Arc flashover standards
by IEEE and National Fire Protection Agency (NFPA) are a result of the industry efforts to protect employees
from arc flashover hazards. Most of the incidents could be prevented or their intensity significantly reduced if
the employees wore the proper type of clothing or were forewarned of safety hazards. IEEE and NFPA
standards now require switchboards, panel boards, and motor control centers to be individually field-marked
with arc flashover warning labels that also specify the protective clothing and the arc flashover boundary
distance.
Arc flashover calculations form the basis to develop strategies to minimize burn injuries. These strategies can
include specifying the rating of personal protective equipment (PPE), working de-energized, using arcresistant switchgear, or applying other engineering techniques and work practices.
The calculation for the arc flashover analysis in SynerGEE is based on IEEE standard 1584-2002. Arc fault
calculations are performed for all sections and devices in the selection set. Labels can be generated for the
devices right from SynerGEE.
IEEE and NFPA standards specify that flash-protection boundary, working distance, and incident energy
should be prominently displayed on every piece of electrical equipment where an arc flashover hazard exists.

Disclaimer
The data and the information are believed to be correct in the program and the documentation. However, any
and all liability, for the content and any omissions including any inaccuracies, errors, or misstatements in
data, calculations, or information is expressly disclaimed. GL Noble Denton disclaims any liability for the use
of software, calculations, or other information.

User Guide

SynerGEE Electric 5.0

Protection

645

Exceptions
IEEE standards do not cover single-phase ac systems, but SynerGEEs arc flashover analysis covers fault on
three-phase lines and sections.
For a three-phase line, only three-phase faults are considered for arc flashover calculations since the severity
of three-phase faults is the highest (according to the IEEE standards).

Model requirements
Arc flashover analysis requires similar model data requirements as the load flow and fault analysis. Source
resistance and reactance should be accurately specified in the source, line impedances and lengths should
be correctly modeled, and protective devices (fuses, reclosers, breakers, and sectionalizers) should be
correctly modeled with the necessary settings. Once this is done, as would normally be done for running load
flow and check coordination analysis, you are ready to configure the arc flashover analysis options and then
run the analysis.

Setting up an arc flashover analysis

Options that control the arc flashover analysis are configured in the Arc Flashover Options editor. These
include basic settings for the analysis, the specification of working distances, and custom text that is added to
the optional arch flashover label.
Refer to the topics listed below for more information.

Configuring settings for an arc flashover analysis on page 645

Editing working distances on page 646

Creating an arc flashover label on page 647

Configuring settings for an arc flashover analysis

The Settings tab in the Arc Flashover Options editor is where most of the options for arc flashover are
available. Refer to the following procedure for more information.

TO CONFIGURE SETTINGS FOR AN ARC FLASHOVER ANALYSIS

1

Perform the following steps to open the Arc Flashover Options editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Safety group, click the text label Arc Flashover and then select Settings.

SynerGEE Electric 5.0

User Guide

646

Protection
2

In the Arc Flashover Options editor, select the Settings tab. The following table describes the
different options that you can set.
Arc-flash analysis

Specifies the goal of the arc flashover analysis. Select from one of the
following options:

Find safe working distances for each category of PPE

Calculate energy and PPE from equipment working

distance

Calculate energy and PPE at this [user-specified]

working distance

Fault clearing

Specifies the minimum, maximum, and unprotected fault clear times

(in ms). Also allows you to specify a fault clear time.

Risk categories

Specifies the PPE grade. Use these fields to manually set the PPE
grade for safety clothing. See Selection of PPE rating for clothing on
page 646 for more information.

Other settings

Specifies a percentage for a reduced arc level. Also allows you to

choose the Lee Method for any voltage.

Click Apply to accept your changes, and then click X to close the editor.

Selection of PPE rating for clothing

Arc flashover analysis suggests a rating of personal protective equipment (PPE) that can be used to develop
safe working conditions for the utility workers. Arc flashover uses the calculated incident energy at the
working distance to create the PPE suggestion. PPE for an arc flashover hazard is the last line of defense
against injury and is intended to mitigate the damage from an arc flashover impact on the individual. The
selection of PPE should provide enough protection to prevent a second degree burn, yet avoid clothing that
may cause heat stress, poor visibility and limited body movement.
IEEE standard emphasizes that it is not intended to imply that workers be allowed to perform work on
exposed energized equipment or circuit parts.

Editing working distances

Working distance is defined as the sum of the distance between the worker (standing in front of the
equipment) to the equipment, and from the front of the equipment to the potential arc source inside the
equipment. Arc flashover protection is always based on the incident energy level on the persons face and
body at the working distance, and not the incident energy on the hands or arms. Since the head and body are
the largest-percentage of the total skin surface area, injuries to the head and body are much more life
threatening than burns on hands or arms.
Typical values of working distances are given in the IEEE standard. The working distances can be edited in
the Equipment tab of the Arc Flashover Options editor, so that working distances for different voltages can be
changed from the IEEE standard. Working distance may vary not only with the voltage, but also with the class
of equipment (such as switchgear, motor control centers, or cable) and on a case-to-case basis. It is very

User Guide

SynerGEE Electric 5.0

Protection

647

important that you choose working distance carefully and consider the equipment you are studying in the arc
flashover analysis.
Refer to the following procedure for more information on editing working distances.

TO EDIT WORKING DISTANCES FOR PPE

1

Perform the following steps to open the Arc Flashover Options editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Safety group, click the text label Arc Flashover and then select Settings.

In the Arc Flashover Options editor, select the Equipment tab.

In the Equipment table, select the facility category that you want to edit and then use the settings
below the table to set the following options:
-

Working distance

Bus gap distance (gap between flashover points)

Distance factor

In addition, select the Report check box if you want to report on the equipment category.
4

Click Apply to accept your changes, and then click X to close the editor.

Creating an arc flashover label

The Label tab in the Arc Flashover Options editor can be used to customize a printable label that can be used
to identify equipment that is vulnerable to arc flashover, or to record the repair work that was done. You can
include as much or as little information as you need.
Refer to the following procedure for more information on creating the arc flashover label. The label can be
printed after performing the arc flashover analysis, as described in Performing an arc flashover analysis on
page 648.

TO CREATE AN ARC FLASHOVER LABEL

1

Perform the following steps to open the Arc Flashover Options editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Safety group, click the text label Arc Flashover and then select Settings.

In the Arc Flashover Options editor, select the Label tab.

Make sure that the Generate label(s) for analysis section check box is selected.

Use the Comment to place on label area to type the custom text that you want to appear on the
label.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

648

Protection

Performing an arc flashover analysis

Perform the following procedure to run an arc flashover analysis on your model. When the analysis is
complete, the Arc Flashover Analysis report will display. The report includes details such as suggestions for
PPE, suggested working distances, incident energy, clear time, and arc flashover amps. If you selected to
generate a label in the Label tab of the Arc Flashover Options editor, a label will be generated for you to print.

TO PERFORM AN ARC FLASHOVER ANALYSIS

1

If you have not already done so, use the Arc Flashover Analysis Options editor to configure options
related to the analysis. For more information, see Setting up an arc flashover analysis on
page 645.

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Safety group, click the Arc Flashover icon.

FAULT ANALYSIS
SynerGEE fault analysis determines the balanced or by-phase fault currents flowing to and into a fault. It can
also determine the balanced or by-phase fault voltages. SynerGEE supports three types of fault analysis:
basic fault, fault flow, and fault voltage.
Refer to the topics listed below for more information.

Fault analysis types on page 648

Including generators during fault analysis on page 650

Setting up a fault analysis on page 650

Performing a fault analysis on page 652

Fault analysis with wandering laterals on page 652

Fault analysis types

SynerGEE supports three types of fault analysis: basic fault, fault flow, and fault voltage. The analysis type
that will be performed is selected from the PROTECTION tab of the SynerGEE ribbon bar.
Refer to the topics listed below for more information on each analysis type.

Fault analysis on page 648

Fault flow analysis on page 649

Fault voltage analysis on page 649

Fault analysis
Fault analysis places a fault on each section of the model, one by one, and then computes the fault current in
amps for the load end of each section. The fault values include minimum and maximum line-ground, phasephase, and three-phase faults. The distances from the substation and the positive and zero sequence

User Guide

SynerGEE Electric 5.0

Protection

649

impedance are accumulated along the feeder. The analysis checks the minimum fault current from the
selected protective device down-line to the next section with a protective device. Fault analysis is available
for substation models and in feeders or substations with looped configurations.
Fault values are calculated using the symmetrical components method of solution. If a system has loops or
active generators, the impedance seen by the fault is calculated in the phase domain and then transformed to
the sequence domain model. For more information on this classical method, see the SynerGEE Technical
Reference.

Pre-fault load current and fault analysis

Fault analysis determines the fault current into the fault. SynerGEE lists the results for all sections in a feeder
by faulting the lines one at a time. Including the pre-fault load current into these results does not affect the
current into the fault. It only affects the current into the faulted section and the fault current on other sections.

Fault flow analysis

Fault flow analysis places a fault at one location in the distribution system model and calculates the flows
throughout. By-phase models of regulators, transformers, loads, and other devices are utilized. The analysis
results in a report listing the by-phase or maximum current flows on each section for line-ground, line-line,
and three-phase faults at the given fault location. A bolted maximum line-ground fault and a minimum lineground fault through a fault impedance are used. If the faulted section has a neutral, a line-line-ground fault
type is used. Otherwise, a line-line type is used.
Fault flow analysis requires that you first set a particular section for analysis, which becomes the fault
location. For more information on setting a section for analysis, see Setting a section for analysis on
page 434.

Pre-fault load current and fault flow analysis

Pre-fault load current can be included in the results for fault flow analysis. In this case, a load-flow is run
before the fault analysis and the flows are stored. After the fault flow analysis is completed, the pre-fault flows
are combined with the fault flows as follows:
| I Total | = | I From Fault | + | I Prefault |

Eq 121

The values of | I Total | for affected lines are listed in the fault flow analysis report.

Fault voltage analysis

Fault voltage analysis calculates voltages throughout a system due to a fault at a single location. This
application combines the SynerGEE fault current calculations, fault flow analysis, and the load-flow
calculations to simulate worst-case voltage conditions near the time of the fault. The calculations are
performed in the following order:
1

Fault flow analysis is used to determine fault current into the fault, any generators, and through tie
switches for each type of fault.

A load-flow analysis is used to calculate load currents and the source voltage behind the feeder or
substation source impedance.

SynerGEE Electric 5.0

User Guide

650

Protection
3

For each fault type, the fault currents and the load currents are accumulated.

For each fault type, voltage drops are calculated throughout the feeder.

The fault voltage analysis report lists balanced or by-phase voltages and current flows for each section and
for each fault type. The report also lists the percent dip, fault impedance, and percent loading of conductors
and other devices. The kVA flow is also given.
Fault voltage analysis requires that you first set a particular section for analysis, which becomes the fault
location. For more information on setting a section for analysis, see Setting a section for analysis on
page 434.

Including generators during fault analysis

During a fault, active synchronous and induction generators behave like a voltage source behind a
subtransient reactance tied to their grounding impedance. Since they are effectively a source, generators
contribute to the system of equations used to handle loops. The rank of the Tie/Fault impedance matrix is
adjusted according to the characteristics of each generator included in the analysis. Flows out of the
generator during a fault are handled with the Tie/Fault and Red matrices discussed above. For more
information on generators, see Generators on page 347.

Setting up a fault analysis

All three fault analysis types fault, fault flow, and fault voltage are configured from the same editor. Refer
to the following procedure for more information.

TO SET UP A FAULT ANALYSIS

1

Perform the following steps open the Fault Analysis Options editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Fault Operations group, click the text label for any of the three fault analysis types
Fault, Flow, or Voltage and then select Settings.

In the Fault Analysis Options editor, use the Shared Settings section to configure options that apply
to all three analysis types. Refer to the following table for more information.
Use Calculated PreFault Voltage

Select this check box to have SynerGEE perform an initial load-flow

analysis to determine the section voltage at the moment before the
fault. For more information on pre-fault voltage, see the SynerGEE
Technical Reference.

Use maximum
(instead of average)
LLG values

Select this check box to use the maximum LLG values to calculate
fault values.

Use inverter models

with PV generators

User Guide

SynerGEE Electric 5.0

Protection

651

Set min L-G equal to

1/(denominator) max
L-G

Select this check box to set the minimum L-G fault values to 1/ an
optional denominator between 1 and 9.9. The default value, as shown
in the text box, is 1/3.0.
If you select this option, the Fault resistance for min L-G fault option
will be disabled.

Fault Resistance For

Min L-G Fault

Specify the minimum resistance seen by a line to ground fault. If this

value is 0.0, SynerGEE uses the minimum resistance assigned in
individual feeder records instead. For more information on assigning
this value in the feeder record, see Editing a feeder or subtran node
on page 247.
This option will be disabled if you have selected the Set min L-G
equal to 1/ check box.

Source Impedance
3

Use the Section by Section Fault Analysis Settings area to configure options that apply to the fault
analysis type only. Refer to the following table for more information.
Fast Wandering
Laterals & Skip Loop
Areas

Select this option to have SynerGEE perform a fault analysis that

quickly analyzes wandering lateral areas, by essentially ignoring the
variance in source impedance due to paths of the wandering part of
the lateral. SynerGEE will also skip and not analyze areas in loops or
areas fed by loops.

Update Feeder With

Calculated Source Z

Select this check box to have SynerGEE automatically update feeder

records with calculated source impedance values, as propagated
from the respective substation transformers. This option is only
applicable if you have substations modeled and selected.

Analyze Sources and

Queried Sections only

Select this option to limit the analysis to feeders, subtrans, and

sections in the query set only. For more information, see Using the
Query Set on page 173.

Asynchronous Fault
Cycle

Specify the number of cycles past the fault instance to establish the
point in time for the analysis.

Current Options

Select the type of current to be considered for the fault analysis.

Available choices are as follows:

SynerGEE Electric 5.0

Symmetrical AC component

Asymmetrical DC component

Both the sum of both

User Guide

652

Protection
4

Use the Fault Flow/Fault Voltage Analysis Settings section to configure options that apply to both
the fault flow and fault voltage analysis types. Refer to the following table for more information.
Add in pre-fault load
current

Select this check box to have SynerGEE consider pre-fault load

current based on a preliminary load flow analysis. For more
information, see Pre-fault load current and fault flow analysis on
page 649.

Click Apply to accept your changes, and then click X to close the editor.

Performing a fault analysis

The fault analysis runs on the feeders in memory that are currently selected. For more information on feeder
selection, see Selecting Feeders on page 157.
Perform the following procedure to run a fault analysis on your model.

TO PERFORM A FAULT ANALYSIS

1

If you have not already done so, use the Fault Analysis Options editor to select the analysis type
and configure other analysis-related options as desired. For more information, see Setting up a
fault analysis on page 650.

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Fault Applications group, click the icon that corresponds to the fault analysis type that you
want to run.
-

Click the Fault icon to run a fault analysis.

Click the Flow icon to run a fault flow analysis.

Click the Voltage icon to run a fault voltage analysis.

Fault analysis with wandering laterals

In a radial distribution model, wandering laterals can be created directly by allowing loop creation (in the
SynerGEE tab of the Preferences editor) or indirectly by using wandering lateral tie switches. During the
analysis, any tie switches are treated as if they were closed. For more information on wandering lateral tie
switches, see Loops and Wandering Laterals on page 253.
Consider the following model, with two wandering laterals, using tie switches:

User Guide

SynerGEE Electric 5.0

Protection

653

1000.6
1000.3
1000.2
500.2
1000.9
500.1

1000.7
500.1

500.1

500.1

500.1
500.0
500.1

500.0

500.1

500.2
500.1

500.1

500.0
500.0
500.0

500.0
500.0
500.0

500.1

Feeder with two wandering laterals

The feeder serves a 500kW load on the upper wandering lateral and a three-phase 1500kW load at the end
of the feeder. The map shows the kW flows from the feeder and along the laterals and back to the main line
to serve the three-phase load.
Fault, fault flow, and fault voltage can be run on this feeder. If fault analysis is run, fault impedances are found
using looped fault analysis. Fault currents and flows are found from the fault impedances. Fault flow and fault
voltage analysis use their load-flow based engine that is fully compatible with wandering laterals.

FAULT SEQUENCE ANALYSIS

The fault sequence analysis is designed to help you better understand the switching sequences of protective
devices and automated switches. This protection application allows you to specify fault values at specific
locations and estimate the operation of relays, reclosers, fuses, and auto-transfer switches in response to the
fault. SynerGEEs simulation of these devices is an accurate estimate of real-world behavior. All protective
devices are treated as three-phase devices when they operate.
Refer to the topics listed below for more information.

Setting up a fault sequence analysis on page 653

Performing a fault sequence analysis on page 654

Setting up a fault sequence analysis

For the fault sequence analysis, you are able to specify fault values at a specific location, the fault current,
fast and slow reclosing times and an auto-transfer switch delay. You can also add fault current to the existing
load current or indicate that the fault values entered already include load current.
Refer to the following procedure for more information.

TO SET UP A FAULT SEQUENCE ANALYSIS

1

Perform the following steps to open the Fault Sequence Analysis editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Fault Operations group, click the text label Fault Sequence and then select
Settings.

Use the Fault Sequence Analysis editor to configure the analysis settings.

SynerGEE Electric 5.0

User Guide

654

Protection
3

Click Apply to accept your changes, and then click X to close the editor.

Performing a fault sequence analysis

Perform the following procedure to run a fault sequence analysis.

TO PERFORM A FAULT SEQUENCE ANALYSIS

1

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Fault Operations group, click the Fault Sequence icon.

When the analysis is complete, the fault sequence analysis report displays. The report contains
three main chapters:
-

Switching. The Switching chapter of the fault sequence analysis report contains
information about the type of device that responded to a fault, and the section on which it
lies. This chapter also contains buttons for you to click to go to any switching state seen in
the analysis.

Section Amp Summary. The Section Amp Summary chapter of the Fault Responses
Analysis report contains information about each sections current levels on each phase
both before and after a fault. This data can be exported to Excel by selecting File > Open in
Excel.

Events. The Events chapter in the fault sequence analysis report can be viewed two
different ways: all at once, or separated out by section. The All chapter is sorted by the
amount of time that passes after a fault occurs, and the events which occurred at those
times, involving specific devices on a section. It also lists the next event after the initial fault
reaction by the device.
The chapters that are separated out by section contain the same information as the All
chapter. The difference is that only one section, and the device on that section that reacted
to the fault, is listed in each chapter.

FAULT LOCATION ANALYSIS

SynerGEEs fault location analysis finds probable fault locations when the magnitude of fault current is known
for a specific location. If you have gathered fault values from electronic relay readings, fault meter values, or
other sources, then SynerGEE can help track down the location of the fault, sometimes within a section if the
best match is between the inward and outward nodes. SynerGEE will estimate the location and output it as a
percentage distance away from the inward node.
SynerGEEs fault location analysis considers the following types of faults:

Bolted phase to ground

Phase to ground through fault resistance

Phase to phase

Phase to phase to bolted ground

User Guide

SynerGEE Electric 5.0

Protection

655

Three-phase

Refer to the topics listed below for more information.

Fault events on page 655

Setting up a fault location analysis on page 656

Performing a fault location analysis on page 658

Fault events
Fault events allow you to import fault data recorded in a SCADA database into SynerGEE, for use with a fault
location analysis. In most cases, you will want to import this data using a messaging script. You can then set
up the fault location analysis to analyze one fault event or all fault events, as described in Setting up a fault
location analysis on page 656. However, SynerGEE also allows you to manually create, edit, and delete fault
events, if desired.
Refer to the topics listed below for more information.

Adding a fault event on page 655

Editing a fault event on page 655

Deleting a fault event on page 656

Adding a fault event

Perform the following procedure to manually add a fault event to a section in your model.

TO ADD A FAULT EVENT

1

In the SynerGEE map display, right-click on the section where you want to add the fault event.

Select Add Fault Event.

Use the Fault Event record to edit details for the fault event. For more information, see Editing a
fault event on page 655.

Click Apply to accept your changes, and then click X to close the editor.

Editing a fault event

Perform the following procedure to edit a fault event in your model.

TO EDIT A FAULT EVENT

1

In the Model tab of the SynerGEE model explorer, expand Locations/Groups and select Fault
Events.

In the lower-half of the model explorer, double-click the name of the fault event that you want to edit.

SynerGEE Electric 5.0

User Guide

656

Protection
3

Use the Fault Event editor to edit details for the fault event. The following table describes the
different fields that you can edit.
Fault measured at

Name of the section where the fault has been recorded. This is a
read-only field that cannot be edited.

Description

Description of the fault event. By default, this field is assigned the

name of the section where the fault event occurred. It is strongly
recommended that you change the description to a unique value.
Fault locations are identified by description in the Fault Location
Analysis settings editor. If you have multiple fault events on the
same section that all have the same description, then obviously it
will be very difficult to select the proper event to analyze.

Fault level information

If the fault level is known for specific phases, select the Fault
values are known by-phase check box. Then, select the check
boxes for the appropriate phase(s) and enter the fault level
value(s).

Protection equipment

If a protective device operated downstream after a fault occurred,

select the A downstream protected device operated check
box and then select the device type. This will help SynerGEE
narrow the fault location.
You must select the Metered fault amps option, as described
above, to enable the protection equipment settings.

Click Apply to accept your changes, and then click X to close the editor.

Deleting a fault event

Perform the following procedure to delete a fault event from your model.

TO DELETE A FAULT EVENT

1

In the Model tab of the SynerGEE model explorer, expand Locations/Groups and select Fault
Events.

In the lower-half of the model explorer, select the name of the fault event that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Setting up a fault location analysis

Perform the following procedure to set up a fault location analysis.

User Guide

SynerGEE Electric 5.0

Protection

657

TO SET UP A FAULT LOCATION ANALYSIS

1

Perform the following steps to open the Fault Location Analysis editor:
a

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Fault Operations group, click the text label Fault Location and then select Settings.

Use the Fault Location Analysis editor to configure the fault location analysis settings. Refer to the
following table for more information on the options that you can set.
Fault amps into
section

Select from one of the following options:

Metered fault amps. Select this option to specify fault-level

information with known fault values on a known phase.
Selecting this option will enable the Fault level information
and Protection event options in the editor.

Use a Fault Event record. Select this option to select a

specific fault event to analyze. Use the Fault Event field to
select the event to analyze.

Analyze all Fault Event records. Select this option to

analyze all fault events.

For more information on fault events, see Fault events on page 655.
Fault level information

If the fault level is known for specific phases, select the Fault values
are known by-phase check box. Then, select the check boxes for
the appropriate phase(s) and enter the fault level value(s).
These options are enabled when you select the Metered fault amps
option, as described above. If you are analyzing a fault event, these
options are set on the fault event itself.

Protection equipment

If a protective device operated downstream after a fault occurred,

select the A downstream protected device operated check box
and then select the device type. This will help SynerGEE narrow the
fault location.
These options are enabled when you select the Metered fault amps
option, as described above. If you are analyzing a fault event, these
options are set on the fault event itself.

Options

Faults to consider

SynerGEE Electric 5.0

Add in pre-fault load current. Select this check box to

consider pre-fault load current based on a preliminary load
flow analysis.

Use calculated pre-fault voltage. Select this check box to

perform an initial load-flow analysis to determine the section
voltage at the moment before the fault.

Select from the appropriate check boxes to narrow the fault location
by phase. This option can be helpful if you know the phase type
where the fault occurred.

User Guide

658

Protection

Fault R Ohms

Use the appropriate check boxes to specify fault resistance values for
line-gnd faults.

Report up to

Groups are divided equally and create ranges based on the

percentage match of the recommended fault locations. Group 1 will
yield results that most closely match the information configured in the
setup, while Group 4 will yield results from all four groups, even
though the percentage of accuracy decreases slightly with each
group. It is recommended that you include all four groups in your
analysis for a larger comparison base.

Click Apply to accept your changes, and then click X to close the editor.

Performing a fault location analysis

Perform the following procedure to run a fault location analysis. When the analysis is complete, the fault
location report will display. This report shows the fault current through the metered section. Some faults can
be line-to-line, and others are line-to-line-to-ground. The Pct Match column in the report shows the
calculated likelihood of the fault flow through the section listed. The Pct Match value can be plotted on the
map display to highlight the most likely location of the fault. If a fault can be located within a section (and it
sometimes may not), you will see a Location chapter on the report.

TO PERFORM A FAULT LOCATION ANALYSIS

1

If you have not already done so, use the Fault Location Analysis editor to configure analysis-related
options as desired. For more information, see Setting up a fault location analysis on page 656.

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Fault Operations group, click the Fault Location icon.

PROTECTION SCHEME REPORT

The Protection Scheme Report provides information about the protection scheme for the currently selected
subtrans and feeders. The report includes the following sections:

Run Summary. The Run Summary section provides a brief overview of the time and conditions that
are being analyzed in the report.

Structure. The Structure section shows the sections that include protective devices for the selected
subtrans and feeders in the model. The section name is provided along with the protective device
type, its amp rating, and its customer count. The report also identifies which zone includes each
protective device.

Exposure. The Exposure section shows the exposure of a protective device directly downstream.,
including miles, configuration, and conductor.

Breaker Zone 1. The Breaker Zone 1 section provides details on any devices that are within the first
zone of a breaker.

Refer to the following procedure for information on viewing the Protection Scheme report.

User Guide

SynerGEE Electric 5.0

Protection

659

TO VIEW THE PROTECTION SCHEME REPORT

1

In the SynerGEE ribbon bar, select the PROTECTION tab.

In the Tools group, click the Scheme Report icon.

If prompted, click Yes to perform a load-flow analysis and a fault analysis before viewing the report.
Or, click No to view the report without running new analyses. In this case the report will show the
most recently available results.

SynerGEE Electric 5.0

User Guide

660

User Guide

Protection

SynerGEE Electric 5.0

CHAPTER

13
Reliability
SynerGEE Reliability is a comprehensive package to aid in the simulation and analysis of distribution system
reliability. Delivered on the SynerGEE platform, it is a powerful tool for investigating root cause and
configuration effects on system-level and customer-level reliability.
Refer to the topics listed below for more information.

RELIABILITY
About Reliability and SynerGEE
SynerGEE Reliability brings you the following features and characteristics:

Zone-based failure rates, repair times, and repair costs with provisions for single- or three-phase
lines

Use of failure rates based on historical outages

In depth root cause analysis

Comprehensive and detailed switching models

By-phase analysis

By-cause analysis

Sectionalizing, reclosing, pickup

Capacity evaluation

Unlimited and customizable causes

Failure rates by category and subcategory

Mitigation over multiple subcategories

Comprehensive contingency-based interruption, switching, and pickup plans

By-phase analysis and results reporting

Handling of automatic switches and auto-transfer switches

Refer to the topics listed below for more information.

SynerGEE Electric 5.0

User Guide

662

Reliability

Importance of reliability
Reliability metrics indicate how well a utility serves its customers. More specifically, these metrics indicate the
value that customers realize through their current service. Since quality of service is basic to the long-term
health of any utility, reliability metrics are a fundamental concern of engineers, managers, and executives
alike. These metrics often affect financial decisions related to long-range and business planning. In addition,
as movements toward deregulation and open competition continue, issues of distribution system reliability
become even more important.

The SynerGEE approach to reliability

SynerGEE Reliability provides an intuitive and simple user interface to analyze system reliability. Though
reliability simulation tends to be vast and complex, SynerGEE presents results in a manner that is easily
understood and manipulated. In many utilities, reliability calculations are performed by select individuals with
specialized knowledge and complicated software, and often the crucial information is not understood by
those who need it. Now, through powerful reporting and display capabilities, SynerGEE helps shield you from
the complexity of system-wide metrics and gives information that many parties can use, particularly those in a
decision-making capacity. SynerGEE results do not require advanced knowledge in the technical aspects of
modeling and simulation.
Reliability scenario evaluations should not be independent studies. As such, SynerGEE provides reliability
simulation based on the same data model as other engineering simulations and applications. SynerGEE
considers security, capacity, efficiency, and power quality using the powerful SynerGEE platform which
already provides load-flow, contingency, protection coordination, and other analyses. In this manner, all
SynerGEE analyses, including reliability, are fully compatible and performed on the same model.

Reliability study challenges

By nature, reliability simulation is a complex statistical analysis of a very large and highly non-linear system.
The randomness of failures does not allow precise predictions, no matter how good the data or calculations.
At best, reliability simulation can generate overall expectations of a systems performance. It must be
understood that these expectations may or may not be realized. For example, even if a simulation indicates
that a substation reconfiguration could drop SAIFI from 2.5 to 2.2, it may be unlikely that the improvement will
be realized immediately, even if the reconfiguration were implemented. Changes in conditions and hazards,
cyclic behaviors, and simple bad luck can potentially prevent the change in SAIFI. However, with SynerGEE
and a well-built model, the predicted trends should generally be seen over the upcoming years.
It is vitally important to use reliability simulation with care. Knowledge of the basis of the reliability model and
analysis should be available. Assumptions should be recognized. A process for building distribution system
models, validating them, and analyzing them with simulation software should be formalized.
Keep in mind that results are significantly affected by the quality of the model, and that even a good model is
still a simplification of a complicated power distribution system. Therefore, reliability simulation should be
considered as one aspect of a utilitys overall process for maintaining and improving reliability.

Setting up a Reliability Analysis

Before performing a reliability analysis, you must configure the analysis settings using the Reliability Analysis
Options editor. Refer to the following procedure for more information.

User Guide

SynerGEE Electric 5.0

Reliability

663

TO SET RELIABILITY ANALYSIS OPTIONS

1

Perform the following steps to open the Reliability Analysis Options editor:
a

In the SynerGEE ribbon bar, select the RELIABILITY tab.

In the Analysis group, click the text label Reliability and then select Settings.

On the left side of the Reliability Analysis Options editor, select from the different tab names to
access the available reliability analysis options. The following sections describe the different tasks
that you can perform:
-

Setting up basic reliability analysis options

Setting up additional reliability analysis options

Setting up scalars for a reliability analysis

Click Apply to accept your changes, and then click X to close the editor.

Setting up basic reliability analysis options

TO SET UP BASIC RELIABILITY ANALYSIS OPTIONS
1

Perform the following steps to open the Reliability Analysis Options editor:
a

In the SynerGEE ribbon bar, select the RELIABILITY tab.

In the Analysis group, click the text label Reliability and then select Settings.

In the Reliability Analysis Options editor, select the Setup tab. Use the options in the Setup tab to
edit the following settings:
Analysis

Allows you to choose analysis specifications and type of reporting

results. You can choose to run the standard reliability analysis, report
failure rates and repair times, or calibrate exposure zones. Exposure
zone calibration and creation can then be specified in the Settings tab
of the Reliability Analysis Options editor. For more information, see
Exposure factors and reliability studies on page 673.

Pickup Model

Controls how customers are picked up with adjacent feeders or

adjacent feeds during an outage, with regards to constraints. You can
choose to always allow pickup with or without protective devices,
never allow pickup, or allow pickup within a specified percentage of
emergency loading. You also have the option to use open switches at
unfed tie points. This will allow open switches on the ends of lines to
pick up unfed customers.

SynerGEE Electric 5.0

User Guide

664

Reliability

Calculations

Feeder Behavior

User Guide

Specify the following options:

Use Mitigation. Select this check box to globally enable any

mitigation applied to the model.

Calculate confidence interval values. Select this check

box to enable confidence interval calculations. Take note
that the analysis will take longer when this option is selected.

Specify the following options:

Allow feeder reclosing. Causes momentary faults fed

directly by the feeder to result in momentary interruptions for
all customers on the feeder. If the option is not selected,
unprotected momentary faults result in an outage for all
feeder customers. Some customers will be picked up with
adjacent feeders if possible.

Allow by-phase feeder operation. Allows feeders to

reclose in a by-phase manner on momentary faults.

Auto-Transfer
Switches

Sets SynerGEE to use either the crew operation times assigned to

individual auto-transfer switches, or a global operation time specified
here. In essence, the second option simulates true auto-transfer
switches, since auto-transfer switches should by nature have no crew
operation time. Likewise, selecting the first option essentially allows
you to disable auto-transfer switches in your model, depending on the
crew operation times you have established for them. For more
information on auto-transfer switches, see Special switch types and
functions on page 400.

Automatic Switches

Sets SynerGEE to use either the crew operation times assigned to

individual automatic switches, or a global operation time specified
here. In essence, the second option creates true automatic switches,
since automatic switches should by nature have no crew operation
time. The global value, therefore, might represent a SCADA control
capability of automatic switches. Likewise, selecting the first option
essentially allows you to disable automatic switches in your model,
depending on the crew operation times you have established for
them. For more information on automatic switches, see Special
switch types and functions on page 400.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Reliability

665

Setting up additional reliability analysis options

TO SET UP ADDITIONAL RELIABILITY ANALYSIS OPTIONS
1

Perform the following steps to open the Reliability Analysis Options editor:
a

In the SynerGEE ribbon bar, select the RELIABILITY tab.

In the Analysis group, click the text label Reliability and then select Settings.

In the Reliability Analysis Options editor, select the Settings tab. Use the options in the Settings tab
to edit the following settings:
SAIDI

Units for reported SAIDI values: hours or minutes.

Maximum Time for

Outage events

Sets the amount of time allowed for outage. If the outage event is
longer than the Disregarded event value, the event is not considered
during Reliability analysis.
If the event duration is less than the Momentary event value but
greater than the Disregarded event value, then the event will only
impact MAIFI results during Reliability analysis.

Uncleared Temporary
Failures

Sets the time of permanent outage time for each cause in

percentages. Outage times for temporary faults that are not cleared
with upstream reclosing equipment are also supported.

Generate subcategory
results

Shows more comprehensive data for certain reliability results.

Suppress Feeder
Breaker Events

Causes SynerGEE to disallow the operation of feeder breakers and

reclosers. In SynerGEE, a device must be modeled directly after the
feeder source to be considered a feeder device.

Failures that are

single phase

Indicates the percent of faults to be treated as single-phase faults.

Since most faults are single-phase, this setting allows the analysis to
be more precisely configured to the actual conditions of your system.
Keep in mind that reclosers and feeders with by-phase operation
capabilities can isolate single-phase faults with fewer customers
experiencing an outage.

SynerGEE Electric 5.0

User Guide

666

Reliability

Fuse/Recloser
Coordination

Select from one of the following options to determine whether fuse

saving and fuse closing actions will be controlled globally or on a
case-by-case basis, as determined by settings at each individual
fuse.

Global fuse saving. When this option is selected, an event

downstream from a fuse will result in the operation of the
nearest upstream recloser. If a recloser or reclosing breaker
or feeder does not exist upstream, then the fuse will blow.

Global fuse blowing. When this option is selected, a fuse

will always blow for an event directly downstream despite
any upstream reclosing capabilities.

Use each fuses setting. When this option is selected, the

saving or blowing of fuses will be determined on a case-bycase basis, based on whether the Fuse saving scheme
check box is selected on the Fuse tab of the Fuse editor at
each individual fuse. If the check box is selected on a Fuse
editor, the fuse saving action will occur for that fuse. If the
check box is cleared on a Fuse editor, the fuse blowing
action will occur for that fuse.
For more information on the fuse editors Fuse saving
scheme check box, see Editing general data for a fuse on
page 343.

Calibration and Zone

Creation

Creates exposure zones based on one of the following criteria: feeder

type, conductor type, source distance, or configuration. SynerGEE
will then use this input to adjust exposure factors to achieve the
SAIFI, SAIDI, and MAIFI values specified in the meters.
Exposure factors are used to adjust each sections individual failure
rates. These are multi-year enabled to allow modeling of declining or
improving prospects for reliability related events.

Click Apply to accept your changes, and then click X to close the editor.

Setting up scalars for a reliability analysis

TO SET UP SCALARS FOR A RELIABILITY ANALYSIS
1

Perform the following steps to open the Reliability Analysis Options editor:
a

In the SynerGEE ribbon bar, select the RELIABILITY tab.

In the Analysis group, click the text label Reliability and then select Settings.

In the Reliability Analysis Options editor, select the Scalars tab. Perform the following steps to
enable scalars and suppressions for the reliability analysis:
-

User Guide

To apply scalars to the analysis, select the Use Scalars check box. The Multiplier and
Adder fields represent the effects of the weather or time of year. These values can be

SynerGEE Electric 5.0

Reliability

667
applied to the permanent and temporary failure rates, as well as to the repair time of any
section with an exposure zone that contains the same category and subcategory of event.
-

To set percentages of suppression for the effects of various root causes, select the Use
Suppression check box. The suppression works much like the percentages specified in
mitigation zones, except that the effects are global. Suppression only applies to root
causes found in applied exposure zones. The suppression of a root cause not applied to
the model will have no effect.
For more information on exposure zones, see Setting up additional reliability analysis
options on page 665.

Click Apply to accept your changes, and then click X to close the editor.

Performing a Reliability Analysis

Perform the following procedure to run a reliability analysis. Keep in mind that full reliability analysis requires
a license. You can operate reliability analysis without one; however, your results will be restricted to the
global level and the advanced by-phase and by-device capabilities will not be available.
The reliability analysis runs on the feeders in memory that are currently selected. For more information on
feeder selection, see Selecting Feeders on page 157.

TO PERFORM A RELIABILITY ANALYSIS

1

If you have not already done so, use the Reliability Analysis Options editor to configure options
related to the analysis. For more information, see Setting up a Reliability Analysis on page 662.

In the SynerGEE ribbon bar, select the RELIABILITY tab.

In the Analysis group, click the Reliability icon.

Aspects of SynerGEE Reliability

Reliability simulation is a statistical analysis yielding expectations of customer-, feeder-, and system-level
reliability metrics. It is used to predict reliability problems by geographic region, electrical zone, and root
cause. SynerGEE provides analytical insight into the complex realm of system performance under various
conditions of failure, loading, and configuration.
With a properly calibrated model, SynerGEE Reliability can provide realistic predictions of expected reliability.
Though random events may cause unexpected fluctuation, long-term trends should tend to match these
predictions.

Supported reliability indices

Indices that result from a SynerGEE analysis are described below, along with the typical equation-based
representation for each index.

SynerGEE Electric 5.0

User Guide

668

Reliability

SAIFI System average interruption frequency index

SAIFI is the rate indicating the number of customer interruptions per customers served. The units for SAIFI
are interruptions/feeder customer/year.

SAIFI =

Total Number of Customer Interruptions per Year

Total Number of Customers Served

Eq 131

Equation 132

CAIFI Customer average interruption frequency index

CAIFI is the rate used for the number of customer interruptions per number of customers affected. The units
for CAIFI are interruptions/customer affected/year.

CAIFI =

Total Number of Customer Interruptions per Year

Total Number of Customers Affected

Eq 133

SAIDI System average interruption duration index

SAIDI is the rate used for the average number of customer interruptions. The units for SAIDI are hours/feeder
customer/year.

SAIDI =

Total Customer Interruption Duration Hours per Year

Total Number of Customers

Eq 134

CAIDI Customer average interruption duration index

CAIDI is the rate used for the customer interruption duration per customer experiencing interruptions. The
units for CAIDI are hours/customer interruption.

CAIDI =

Total Customer Interruption Duration Hours per Year

Total Number of Affected Customers

Eq 135

ASAI Average service availability index

ASAI is the rate used for the average availability of service based on demand:

ASAI =

User Guide

Hours of Available Service

Hours of Customer Demand

Eq 136

SynerGEE Electric 5.0

Reliability

669

MAIFI Momentary average interruption frequency index

MAIFI is the rate used for the average number of times an interruption occurs.

MAIFI =

Total number of customers momentary interruptions

Total number of customers served

Eq 137

Publishable reliability results

SynerGEE presents simulation results in a simple and comprehensive format. Since an enormous amount of
data is typically available from a simulation, it is best presented in charts and maps. The chart below, for
example, depicts the correlation between a reliability index and a billing code typically used for load modeling
in load-flow analysis.

SAIFI versus customer class

This type of chart provides valuable insight, demonstrating the importance of customer- or zone-based index
and standard deviation values.

Version comparison and reliability analysis

SynerGEE provides the ability to create and compare multiple versions within the same model. Versions can
be particularly useful with reliability studies, as you can evaluate any number of versions and select one
based on supporting evidence, cost/benefit ratio, utility planning guidelines, variance of results, and basic
engineering judgment.
In previous releases of SynerGEE, versions were called scenarios. For more information on versions, see
Versions on page 86.

Switching plan models and reliability

SynerGEE reliability generates and evaluates reasonable switching plans that are consistent with actual
utility operation. It carefully considers which devices operate during a failure, how they operate, and whether
fault-related failures can be isolated. In addition, it examines issues such as alternate feed sources for outage

SynerGEE Electric 5.0

User Guide

670

Reliability
customers and the operation of automatic switches. Clearly, it is impossible to mimic real world operations
within a simulation for every type of failure. However, SynerGEEs fault location application can be helpful in
determining a close approximation of a fault location. For more information see Fault Location Analysis on
page 654.

Capacity considerations during reliability analysis

Since capacity constraints can affect a switching operation, detailed by-phase load-flow analyses are integral
to SynerGEE reliability simulations. The load-flow analysis performed by SynerGEE reliability represents the
same proven calculations used for planning studies elsewhere within SynerGEE.

Metric variance during reliability analysis

Since reliability simulation is a statistical analysis, and metrics such as SAIDI and SAIFI are based on random
variables, SynerGEE results can include values of variance. For example:

Portion of a reliability report, showing index and variance values

Variance is very sensitive to feeder configuration and device placement. For example, a feeder
reconfiguration may change a SAIFI value from 2.5 to 2.3. However, if the SAIFI was originally 2.5 +/- 1.0 and
the reconfiguration resulted in a value of 2.3 +/- 1.5, the original configuration may be considered superior
from a strict metric perspective. The necessity of the variance calculation becomes even more evident when
considering cost functions associated with performance-based rates.
Values of variance can also be referred to as confidence intervals. For more information on setting
SynerGEE to calculate confidence intervals, see Setting up a Reliability Analysis on page 662.

Root causes and reliability studies

In SynerGEE, reliability results are calculated and can be presented on the basis of root causes. Therefore,
an understanding of root cause is essential for evaluating reliability issues. As an example, the following pie
chart shows apportionment of SAIDI values for a sample system, by root cause.

User Guide

SynerGEE Electric 5.0

Reliability

671

SAIDI breakdown by root cause

Correlation between root cause exposure, feeder configuration, and protective device placement is high.
Diagrams such as this help evaluate the effectiveness of a particular mitigation effort. Root cause categories
may be extensive and there may be considerable variation between utilities.
For more information on establishing root causes within the SynerGEE environment, see Defining root
causes for a reliability simulation on page 677.

Spatial mitigation and reliability studies

Since mitigation efforts are often dispatched in regions or zones, SynerGEE Reliability supports the spatial
application of mitigation. You can create mitigation zones and apply them to geographic regions of your
model. Zones should be constructed with data that represents the average effects of mitigation for a
geographic area.

Map colored by mitigation zones

For more information on creating, applying, and managing mitigation zones, see Mitigation zones on
page 683.

Using meters for reliability studies

Meters can be opened or closed like a switch and used to isolate sections for reliability studies. This isolation
is useful for eliminating parts of the model that are not needed for the study.

SynerGEE Electric 5.0

User Guide

672

Reliability
Place a meter at the outward end of a section you wish to isolate. Run a load-flow analysis and then click the
Replace with results button in the Demands tab of the Meter editor. Change the meters status to open and
enable the meter to use demands as load out of the meter. This will isolate upstream sections from the meter,
as shown in the following figures.

Full feeder

Isolated meter

Reliability targets can also be set with the Meter editor. This will help you adjust exposure factors so that
SAIDI, SAIFI, and MAIFI targets can be achieved. For more information, see Exposure factors and reliability

User Guide

SynerGEE Electric 5.0

Reliability

673

studies on page 673.

Exposure factors and reliability studies

You can calibrate exposure factors using a combination of devices in SynerGEE. Orchestrating a range of
events will generate statistically accurate exposure zones in your reliability analysis results.
Use the reliability analysis options editor in conjunction with meters to adjust exposure factors. Select the
Calibrate exposure factors option in the Setup tab of the Reliability Analysis Options editor, and then select
a Calibration & Zone Creation option in the Settings tab of the editor. For more information, see Setting up
additional reliability analysis options on page 665. From here, you want to use the Reliability tab in the Meter
editor to set SAIFI, SAIDI, and MAIFI indices. For more information, see Supported reliability indices on
page 667 and Using meters for reliability studies on page 671. After you run the reliability analysis, you will
notice the difference in SAIDI, SAIFI, and MAIFI results in the Results tab of the Meter editor. SynerGEE will
use the exposure factors to try to reach the target indices you have set.
Each section also contains a set of exposure factors. These can be used to scale permanent and temporary
failure rates and repair times of a sections exposure zones. This allows event frequency to be controlled at a
section level. Use the reliability features in the Zone tab of the Section editor to configure these settings. For
more information, see Assigning zones to sections on page 301.

Supporting applications for reliability studies

Reliability cannot be an isolated simulation. Voltage support, contingency, power quality, capacity, and
efficiency are just a few of the serious considerations that accompany it. With SynerGEE, you have the
support of many other analysis features, including:

Load-flow

Economic analysis

Fault flow and fault voltage

Contingency

Optimal switching

Phase balancing

Harmonic analysis

Capacitor analysis

Coordination checking

Time range load analysis

The collaboration of these applications enables you to fully evaluate system performance while making
reliability decisions. You do not have to base decisions on any single type of engineering analysis. Also, since
these applications are used in other planning, protection, and operational roles, you can take advantage of
the consistency and compatibility of all SynerGEE modeling and analysis features.

SynerGEE Electric 5.0

User Guide

674

Reliability

Reliability Data Management

Evaluating reliability involves complex procedures, large data sets, and comprehensive paradigms. Overall,
reliability evaluation can be done in three ways.

Topology
(GIS or
SynerGEE)
SynerGEE model

Sample years
historical

Historical
(OMS) data

Direct
analysis

Analytical
analysis

Simulated
direct
analysis

Three types of distribution reliability analysis

SynerGEE handles two of the approaches, analytical analysis and simulated direct analysis. The third
type, direct analysis, involves near-raw outage data and specific utility customs. You should have some
means of conducting direct analysis, since it is an important part of evaluating system reliability performance
as well as expected performance. Often, spreadsheets or database procedures can adequately evaluate
reliability performance.

Outage data calibration Reliability analysis

Unlike typical model data, calibration of reliability data requires a more insightful approach. Your model was
probably constructed with a focus on more consistent features, such as lines and equipment, which allow a
precise calibration of parameters such as voltage and flow. Calibration of models using historical outage data
is more difficult, since failures are random events. Even under the same conditions, outages in a distribution
system in any given year are different. As such, failure rate calibration must be done with consideration of the
known system history so that predicted trends reflect the performance of the actual system.

Historical outage data calibration

In many cases, existing historical outage data may be incomplete or not fully compatible with your GIS or
SynerGEE model. For example, call records typically do not fully capture the interruption extent of an event.
Customers may be away from home or asleep when an interruption occurs. Customers may not be inclined to
phone when their service is interrupted. Phasing information may be inaccurate or other data issues may be
present.
Therefore, historical data calibration involves validating recorded outage information against a reliable
network model. As an example, assume that you have recorded outage information for a recloser lockout
event. The outage record indicates that 120 customers were out of service. However, your GIS model shows

User Guide

SynerGEE Electric 5.0

Reliability

675

that the recloser serves 155 customers. Therefore, you should update your outage record to reflect 155
affected customers for reliability analysis. This type of validation should be applied to any applicable
correlations between outage and network information.

Historical data calibration

Analytical model calibration Outage data

This type of calibration involves running reliability studies within the analytical engine and comparing the
results with known indices calculated from quality outage data.

Analytical data calibration

Failure rates, repair times, and other information should be adjusted in the model until analysis results are
consistent with historical values.

Variation analysis and reliability

You should give consideration to the variation or variance in indices predicted by reliability simulation. An
extremely low variance might indicate that data is unrealistic or that configuration options are limited in the
feeders being analyzed. An extremely large variance might indicate poor failure data or unresolved
correlations in failure data.

SynerGEE Electric 5.0

User Guide

676

Reliability

Variation data calibration

It may be a challenge to identify and resolve problems with large variance values.

Failures and reliability studies

Distribution reliability simulation is based on the probability of device failure. With a device in continuous
operation, the ultimate goal is to capture the probability that the device will fail. In SynerGEE, this process
begins with the following common assumptions:

A device either fails or it operates. A regulator, for example, cannot operate at reduced capacity.

The probability that a device will fail remains consistent over time. For example, the probability that
a regulator will fail is the same regardless of the time-of-day.

The reliability evaluation period is constant for each and every device.

The probability of failure for each device is independent. If a regulator fails, the probability of the
downstream line failing is unaffected. The probability of the regulator failing again is unaffected.

See the SynerGEE Technical Reference for reliability calculations and example studies.

Interruptions and reliability studies

Customers can experience momentary or sustained interruptions. SynerGEE considers any failure that can
be cleared by reclosing equipment to be a momentary interruption. Your organization may use different
standards, since the criteria for distinguishing the two can vary between utilities.
Consider the example of a tree branch striking a line, creating an arc. The branch disintegrates or is pulled
away, but the arc remains until its current is interrupted by an interrupting device.
Tree branch
F

Interruption
device

Line failure from a tree branch

User Guide

SynerGEE Electric 5.0

Reliability

677

If the interrupting device has reclosing capability, the interruption caused by the tree branch failure will be
momentary. However, if the interrupting device is a fuse or a breaker without a reclosing relay, the interruption
will be permanent.
Some failures cannot be cleared by reclosing equipment. If a tree branch falls on a line and it does not
disintegrate or fall away, reclosing equipment will operate to lockout. Therefore, SynerGEE considers the
following failure rates:

Sustained fault failure rate. Expected yearly rate for failures that remain after reclosing equipment
actions.

Momentary fault failure rate. Expected yearly rate for failures that can be cleared by reclosing
equipment.

If no reclosing equipment exists to protect against a momentary event, a sustained interruption results.
Consider the following situation, which will result in a sustained interruption.
Non-reclosing
feeder
F

Momentary event

Fuse

Sustained interruption resulting from a momentary event

However, in the following case, only a momentary interruption results because of the upstream reclosing
device.
Non-reclosing
feeder
F

Momentary event
Recloser

Fuse

Momentary interruption resulting from a momentary event

If a permanent event occurred on the system above, SynerGEE assumes that the recloser and fuse are
coordinated so that the fuse blows.
Non-reclosing
feeder
F

Permanent event
Recloser

Fuse

Sustained interruption resulting from a permanent event

Even with the assumption, overall performance of the model should be reasonable. Consideration of timecoordination settings of devices and the breadth of available fault levels from a failure would be very complex,
and would not likely be of value to the simulation.

Defining root causes for a reliability simulation

Failure analysis is based on root causes in SynerGEE. These root causes can be customized to match the
conditions in your system.

SynerGEE Electric 5.0

User Guide

678

Reliability
SynerGEEs root cause data is stored in a text file, ReliCauseMeta.txt, that is saved by default in your
Settings file directory. This file is read when SynerGEE starts up and held in memory for the entire session.
Therefore, if you change the file, you must restart SynerGEE to see any changes.
For information on locating and editing your Settings file directory, see Defining file paths on page 167.
The root causes that are saved in the ReliCauseMeta.txt are used to populate the exposure and mitigation
zone editors. For more information on exposure zones, see Exposure zones on page 679. For more
information on mitigation zones, see Mitigation zones on page 683.

ReliCauseMeta.txt file format

Each entry in the ReliCauseMeta.txt file has the following format:
{Category}, {Subcategory}, {Description}

To illustrate the architecture of the root cause file, consider the following example:
10,
10,
10,
10,
10,
15,
15,
15,
20,
20,
20,
32,
32,
32,
32,
32,
42,
42,
42,
42,
42,
...

-1, Animals
5, Squirrels
7, Raccoons
8, Snakes
22, Chimps
-1, Trees
5, Deciduous
9, Evergreen
-1, Accident
5, Driver
15, Vandalism
-1, Birds
10, Nesting
18, Pigeon
14, Condor
22, Gull
-1, Weather
16, Rain
18, Ice / Snow
22, Hail
24, Hurricane

The numbers used for categories and subcategories may be arbitrarily chosen. The only significant
subcategory value is -1, which indicates that the entry contains the category name. Otherwise, you can
create subcategories as needed, using a consistent category number, and choosing a subcategory number.
The category number can be any integer, so long as all subcategories are associated with that same number.
You can place any entry anywhere in the file, since it has no ordering requirements. However, you may wish
to keep all entries for a particular category together, for convenience.
The category and subcategory numbers that you assign are referenced by SynerGEE during analysis.
Although the text descriptions appear in SynerGEE editors, the numbers are vital to internal functions.
Therefore, you should use caution if changing or removing items. If inconsistencies arise between different
files used by different users, data problems could result.

User Guide

SynerGEE Electric 5.0

Reliability

679

Editing ReliCauseMeta.txt
To illustrate the editing of ReliCauseMeta.txt, assume that your feeders are in a politically unstable area, with
frequent intentional damage caused by unruly citizens and foreign insurgents. Anywhere in the
ReliCauseMeta.txt file, you could add the following lines, assuming that category 100 is not already used:
100,
100,
100,
100,
100,
100,

-1, Civil Unrest

1, Simple vandalism
2, Explosion - Wires/network
3, Explosion - Substation
4, Pole destruction
5, Misc terrorism

After you restart SynerGEE, the exposure zone editor would appear as follows:

To ensure consistency, you should consider creating one ReliCauseMeta.txt file for your organization and
distributing it to all users. If you make changes afterward, you should:
1

Verify that all users receive and apply the updated file.

Review the impact of changes on existing models.

Generally, adding new items causes less impact than removing or changing items.

Exposure zones
Exposure zones allow you to apply section failure data to your model. Stored as equipment data, an
exposure zone represents a predefined collection of failure data that can be applied to multiple sections in
your model. All sections that are associated with a particular exposure zone share the common values for
that zone, which means you do not have to configure an individual data set for each applicable section.

SynerGEE Electric 5.0

User Guide

680

Reliability
The values that you can define for an exposure zone include the following:

Sustained failure rate per set length of line

Repair time for a sustained failure

Repair cost for a sustained failure

Temporary failure rate per set length of line

Refer to the topics listed below for more information.

Exposure zone setup methods

Once your exposure zones are defined, each section can be assigned to any zone. There are two primary
methods of defining exposure zones:

Geographically, by physical characteristics

Topologically, by interrupting device configurations

The method you choose will depend largely on how you apply your historic outage data to the model.

Exposure zones by geography

Zones can be set up geographically to account for similarities in construction, location, history, and terrain.

Exposure zones by geography

With this method, you can apply multiple causes to whole regions of your system, and varying degrees of
each. It allows the correlation of lines with similar construction, in like areas, and with common isolation
devices. For example, you may have a region in which squirrels, snakes, and deciduous trees are a problem.
In SynerGEE, you can create an exposure zone that represents these causes, and apply it to sections in your
model as appropriate.

User Guide

SynerGEE Electric 5.0

Reliability

681

Exposure zones by interrupting device topology

Exposure zones can also be set up to correspond to interrupting devices, which allows a more direct
application of historical outage data. You would probably construct zones in this manner if your outage data is
assigned by interrupting device.
Birds
Trees

Zone
4334552

Recloser

4334552"

Squirrels

Fuse 1565423

Zone
1565423

Birds

Squirrels

Exposure zones by interrupting device

Creating an exposure zone

Perform the following procedure to create a new exposure zone in your model.

TO CREATE AN EXPOSURE ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Exposure Zone.

In the Enter Device ID dialog box, type a name for the new exposure zone and then click OK.

Use the Exposure Zone editor to edit the settings for the exposure zone. For more information on
the options you can set, see Editing an exposure zone on page 681.

Editing an exposure zone

To edit an exposure zone, double-click the exposure zone name in the Warehouse tab of the SynerGEE
model explorer. From the Zone tab in the Section editor, you can also click the edit button that is located next
to the name of the selected exposure zone.
Refer to the following procedure for more information.

TO EDIT AN EXPOSURE ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Zones - Exposure and then double-click the name of the exposure zone that you want to
edit.

SynerGEE Electric 5.0

User Guide

682

Reliability
3

Use the options in the Exposure Zone editor to perform the following tasks:
To ...

Do This ...

Select a color to represent

the zone in the SynerGEE
map display

Click on the Color option and select a new color, as appropriate.

This color will be used in the SynerGEE map display when the
color by option has been set to Exposure Zones. For more
information on color-by settings, see Configuring the map
display style on page 201.

Specify an optional
description for the exposure
zone

Type the exposure zone description in the Description text box.

The description has no impact on data storage or model
topology. It does not need to be unique.

Apply a root cause to the

exposure zone

In the list of root causes on the left side of the editor,

select the root cause that you want to add to the
exposure zone.

Select the Enabled check box.

Use the text boxes under Sustained Faults and

Temporary Faults to specify failure rates, repair times,
and repair costs for the root cause.

Repeat these steps to enable other root causes for the

exposure zone.

Click Apply to accept your changes, and then click X to close the editor.

Assigning an exposure zone to a section

You can assign an exposure zone to a section using the Section editor. Exposure factors can also be
configured in the Section editor, as well as the Meter editor and Reliability Analysis Options editor. Exposure
factors are used to scale the permanent and temporary failure rates and repair times of a sections exposure
zone. From this, you can correlate a wide range of events to generate statistically relevant exposure zones.
Exposure factors are enabled for multi-year analysis so that you can model declining or improving prospects
for reliability related events. For more information see Exposure factors and reliability studies on page 673.
For more information on multi-year analysis, see Multi-Year Analysis on page 579.

TO ASSIGN AN EXPOSURE ZONE TO A SECTION

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Zone tab.

Next to Exposure Zones, select the name of the exposure zone that you want to assign to the
section.

Click Apply to accept your changes, and then click X to close the editor.

Deleting an exposure zone

Perform the following procedure to delete an exposure zone from your model.

User Guide

SynerGEE Electric 5.0

Reliability

683

TO DELETE AN EXPOSURE ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Zones - Exposure and then select the name of the exposure zone that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Mitigation zones
From a data perspective, mitigation zones are similar to exposure zones. The data is organized by root
cause, and every section can be assigned to a mitigation zone. A mitigation zone is simply a collection of all
the root causes in your system with a percentage of mitigation effectiveness assigned to each. When you
assign a mitigation zone to a section, root causes are considered mitigated according to those percentages,
respectively. Mitigation zones also contain fixed and annual cost data that is used by the analysis for costs
calculations, including those based on initial costs versus cost savings due to effective mitigation.
Keep in mind that root cause failure data is controlled by exposure zones, and mitigation against a particular
root cause is meaningless if that cause was not active to begin with. For example, you may assign a
mitigation zone to a section that specifies a 50% mitigation effectiveness against the root cause of Trees,
perhaps through some sort of tree-trimming. However, if the exposure zone assigned to the same section
does not list failure data for trees, the mitigation data is unused.
For any given mitigation zone, it is likely that mitigation will be zero for most root causes since your mitigation
efforts are probably focused by region. However, keep in mind that some mitigation efforts can affect multiple
causes. For example, squirrels, birds, trees, and other causes may all be partially mitigated through tree
trimming.
In order for reliability analysis to consider mitigation in your model, you must have your analysis options set
up as such. For more information on globally enabling mitigation in your analysis options, see Setting up a
Reliability Analysis on page 662.
Refer to the topics listed below for more information.

Creating a mitigation zone

Perform the following procedure to create a new mitigation zone in your model.

TO CREATE A MITIGATION ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Mitigation Zone.

In the Enter Device ID dialog box, type a name for the new mitigation zone and then click OK.

Use the Mitigation Zone editor to edit the settings for the mitigation zone. For more information on
the options you can set, see Editing a mitigation zone on page 684.

SynerGEE Electric 5.0

User Guide

684

Reliability

Editing a mitigation zone

To edit a mitigation zone, double-click the mitigation zone name in the Warehouse tab of the SynerGEE
model explorer. From the Zone tab in the Section editor, you can also click the edit button that is located next
to the name of the selected mitigation zone.
Refer to the following procedure for more information.

TO EDIT A MITIGATION ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Zones - Mitigation and then double-click the name of the mitigation zone that you want to
edit.

Use the options in the Mitigation Zone editor to perform the following tasks.
To ...

Do This ...

Select a color to represent

the zone in the SynerGEE
map display

Click on the Color option and select a new color, as appropriate.

This color will be used in the SynerGEE map display when the
color by option has been set to Mitigation Zones. For more
information on color-by settings, see Configuring the map
display style on page 201.

Specify an optional
description for the mitigation
zone

Type the mitigation zone description in the Description text box.

The description has no impact on data storage or model
topology. It does not need to be unique.

Specify cost data

Under Fixed Cost and Yearly Cost, specify the fixed and annual
mitigation costs, respectively. These values are used by the
analysis for costs calculations, including calculations based on
initial costs versus cost savings due to effective mitigation.

Apply a root cause to the

mitigation zone

In the list of root causes on the left side of the editor,

select the root cause that you want to add to the
exposure zone.

Select the Enabled check box. (Enabled root causes

will appear in a bold font in the list of causes.)

Use the Mitigation slider bar or the Effect text box to

specify a percentage of effectiveness for the root cause.

Repeat these steps to enable other root causes for the

mitigation zone.

Click Apply to accept your changes, and then click X to close the editor.

Assigning a mitigation zone to a section

Perform the following procedure to assign a mitigation zone to a section in your model.

User Guide

SynerGEE Electric 5.0

Reliability

685

TO APPLY A MITIGATION ZONE TO A SECTION

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Zone tab.

Under Reliability Zones, select the desired mitigation zone and click Apply.
Tip:

If you have multiple sections to assign, you may find it much more convenient to use the
Multiple Editor. For more information on the Multiple Editor, see Using the Multiple Editor
on page 177.

Deleting a mitigation zone

Perform the following procedure to delete a mitigation zone from your model.

TO DELETE A MITIGATION ZONE

1

In the SynerGEE model explorer, select the Model tab.

Expand Zones - Mitigation and then select the name of the mitigation zone that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Devices and failure rates Reliability studies

Most devices, such as regulators and transformers, have failure rates. The failure of these devices can cause
a sustained or momentary event. Switchable devices also have failure rates, but they play an even larger role
in reliability simulation because they govern reconfiguration. During analysis, SynerGEE classifies devices in
the following four ways:

Fail device. Device that can fail with a momentary or sustained type of event. Upstream protection
devices are used to interrupt the fault.

Interrupting device. Device that can interrupt fault current. The interruption can be sustained if the
fault is sustained or the device cannot reclose. The interruption can be momentary if the device has
reclosing capabilities.

Isolating device. Device that can isolate the faulted area to allow resetting of an upstream
interrupting device. An isolating device is used to quickly pick up customers between itself and the
upstream interrupting device, while the fail device is being repaired.

Pickup device. Device used to quickly restore service to customers isolated from a failure by
isolating devices.

Motors, capacitors, and generators do not have failure rates. However, these devices may still contribute to
the reliability characteristics of a set of feeders if capacity constraints are an issue.
Devices failure data has similarities to the data contained within exposure zones. However, since it
represents the actual failure data for a particular device, it is not broken up into the single-phase/three-phase
groups. It is also not characterized by category. Switchable devices like switches and protective devices also
have a crew operation time value. This value corresponds to the typical time it takes for a crew to reach and
operate the device.

SynerGEE Electric 5.0

User Guide

686

Reliability
In reliability reports, indexes resulting from device failures are listed under an Equipment category.

Reliability Analysis Details

Reliability indices are calculated based on customer exposure to outage, isolation, and repair time. A simple
outage process model is used to make use of failure rates and repair times. The process is applied to failures
at every device. The aggregation of results from the process results in SynerGEEs reliability indices.
During analysis, faults are simulated at every device. The resulting effects of these faults are combined
based on the failure rates of relevant devices. For each fault, steps are taken to:
1

Interrupt the fault with the closest feeding protective device.

Isolate the faulted/damaged device with the closest feeding switch or protective device.

Pick up customers that were outaged in step 1 and separated from the fault in step 2.

Repair the fault.

Close the switch or protective device used in step 2.

The sections listed below present conceptual and mathematical representations of this process.

Reliability processing examples

Consider the following feeder. The components are designated by letters A through G. There is a feeder,
fuse, switch, and four lines.

H
A
F

D
Fuse

Switch

Simple feeder

Consider a fault at line F. In this case, the analysis process would assume the following sequence.
1

Fault occurs at F.

Fuse at C blows.

Customers on D, F, G, and H experience an outage.

After a specified sectionalizing interval, switch E is opened to isolate the fault.

Fuse C is reset to restore service to customers on D and H.

After a repair time based on the line type for F, switch E is closed to restore service to customers on
F and G.

Now, consider a fault at D. The process would then assume this sequence.
1

Fault occurs at D.

Fuse at C blows.

User Guide

SynerGEE Electric 5.0

Reliability

687
3

Customers on D, F, G, and H experience an outage.

There is no isolating switch, so C remains open throughout the repair time of D.

D is repaired and service is restored to customers on D, F, G, and H.

Reliability calculation results

Reliability analysis calculates different levels of SAIFI, SAIDI, and MAIFI values within the analysis set. Since
the indices are calculated by-phase, by-phase reclosers or feeders with by-phase reclosing capabilities will
have an impact. Also, the variation of customers attached to each phase contributes to by-phase index
results.
Results are collected at the following levels.

System. Index values for all feeders together are generated.

Feeders and Subtrans. Indices for each feeder are generated. The feeders are analyzed
independently with respect to indices. Switching may be performed between feeders to pick up
customers during the analysis.

Protection Zone. Unique zones can be defined by an interrupting/isolation device pair. Every
customer directly fed by these two devices will share the same outage characteristics. Indices are
generated for these zones.

Customer Zone. If customer classes are assigned to sections, indices are collected for the customer
zones.

Mitigation Zone. Index values are reported for the areas receiving mitigation.

Section. Indices are calculated for each section.

Reliability results presentation

You can view results in reports or by special map coloring. The map can be colored based on a wide variety
of results, mostly corresponding to data in the reports. There are some values available for coloring that are
not found in the reports.

Cause In Zone. Reliability indices calculated using protection zone and only those failures occurring
within the protection zone.

Percent Cause In Zone. Percent of index caused by failures within a sections zone.

Charts are also available to summarize and distinguish reliability characteristics.

Trial and study during reliability studies

The SynerGEE Reliability environment is well-equipped for a pattern of multiple trials and searching for
improvement. You have a variety of aspects available to help perform a well-rounded study of your system.

New model saving

On-screen results and comprehensive reporting

Scenarios

SynerGEE Electric 5.0

User Guide

688

Reliability

Undo/Redo

Contingency analysis

Fault analysis

SynerGEE protection

Reliability analysis assumptions

Outage and failure modeling can be vast and complicated. SynerGEE makes certain assumptions to simplify
the problem into a manageable process. These assumptions include the following.

Reliability analysis isolates all outage devices as if they were faulted. In actuality, some device
failures may just result in loss of service to downstream customers and not require the operation of
upstream protective devices. SynerGEE always isolates an outage with an upstream protective
device.

SynerGEE assumes that a feeder device is capable of interrupting service even if a breaker is not
modeled directly after the feeder. An event on a device having no protective devices along its feeder
path results in an outage of the entire feeder.

No parallel components are considered. A regulator bypass, for example, is not modeled within SynerGEE.

Isolating/switching/pickup example Reliability analysis

The handling of failure contingencies is a critical aspect of reliability analysis. Outage and realistic pickup
schemes are evaluated for every possible failure in the SynerGEE model. Consider an outage on section 1 in
the following system.

Failure zones by interrupting device

Recloser 2 will operate to interrupt the outage resulting in an outage for all customers fed by the recloser.
Switch 3 will then be opened to isolate the outage. The recloser will be reset. Fuse 4 will be opened and
switch 5 will be closed to pick up those customers. Fuse 6 and switch 7 will be handled in a similar manner.

User Guide

SynerGEE Electric 5.0

Reliability

689

HARMONIC
Electronic loads are sensitive and susceptible to a number of natural and unnatural disturbances that affect
the quality of a load. Circuit breakers trip for unknown reasons, neutral conductors in balanced circuits
overheat from excessive loads, and transformers with an average load mysteriously overheat. These are
symptoms of power quality disturbances, the cause of which could be any number of problems, including
sags, transients, swells, harmonics, and momentary interruptions.
Power quality disturbances can be broken down into three types:

RMS variations, including faults, improper wiring, equipment failure, sudden removal of a large load,
and weather.

Transients, including sub-cycle disturbances, lightning strikes, capacitor switching, removal of

inductive load, and switching operations.

Waveform distortion or harmonics, most often caused by modern electronics.

SynerGEEs Harmonic Analysis application is designed to isolate and simulate harmonic power quality
issues. For more information, see Harmonic Analysis on page 689.

Harmonic Analysis
A harmonic is a component of a periodic wave having a frequency that is an integral multiple of the
fundamental power line frequency of 60Hz. In other words, the 1st harmonic exists with 60Hz, the 2nd with
120Hz, the 3rd with 180Hz, and so on. Total harmonic distortion is the combination of all the harmonic
frequency currents to the fundamental. The characteristic harmonics are based on the number of rectifiers
(pulse numbers) used in a circuit. SynerGEE can handle subharmonics, or interharmonics. If a harmonic
based on a whole number does not converge, then SynerGEE will automatically check at h-0.25 or h+0.25
intervals. For example, if a harmonic does not converge at 2.0, it will check 1.75 and 2.25. If it still does not
converge, SynerGEE will expand the check to 1.5 and 2.5.
Harmonics pose a problem because of the loss to customer and utility systems as well as the extra costs that
can be incurred because of damaged equipment, replacements, and repairs. Current harmonics can distort
the voltage waveform and cause voltage harmonics. Voltage distortion affects sensitive electronic loads,
motors, and capacitors. In motors, negative sequence harmonics produce rotating magnetic fields. These
fields rotate in the opposite direction of the fundamental magnetic field and could cause overheating and
mechanical oscillations. Capacitors do not generate harmonics, but the reactance (impedance) of a capacitor
decreases as the frequency increases. This causes the capacitor to act as a trap for higher harmonic currents
and magnify them. High harmonics can overheat the capacitors.
Refer to the topics listed below for more information.

Setting up a harmonic analysis

Before you perform a harmonic analysis, you must create harmonic curves and then assign those curves to
large customers in your model. You must also designate which sections will be used during the harmonic
analysis, and also set up analysis settings for the harmonic analysis.
Refer to the topics listed below for more information.

SynerGEE Electric 5.0

User Guide

690

Reliability

Creating and editing harmonic curves

Harmonic curves, like other devices, are created in the equipment warehouse and can then be applied to any
large customer in your model. When creating a harmonic curve, you will probably want to have contributions
at the 3rd, 9th or 15th harmonic to see a distorted neutral current. If your model is heavily unbalanced, you
will most likely see neutral distortion at other harmonic values.
When setting up a harmonic curve, you can use the chart view in the Harmonics Curve Type editor to set
odd-numbered harmonics, from 3 to 25, up to 15 percent. In addition, the grid view in the Harmonic Curve
Type editor can be used to configure even-numbered harmonics and angles from 0 to 100 percent. However,
you may not have a need to do this unless you are pulling raw data out of a BMI/Dranetz meter or harmonic
load study.
Refer to the topics listed below for more information.

Creating a harmonic curve

Perform the following procedure to create a harmonic curve type in your equipment warehouse.
1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Harmonic Curve.

In the Enter Device ID dialog box, type a name for the new harmonic curve and then click OK.

Use the Harmonic Curve Type editor to edit the settings for the harmonic curve. For more
information on the options you can set, see Editing a harmonic curve on page 690.

Editing a harmonic curve

To edit a harmonic curve, simply double-click the harmonic curve type name in the Warehouse tab of the
SynerGEE model explorer. From the Load tab of the Large Customer editor, you can also click the edit button
that is located next to the name of the selected Harmonic Profile.
Refer to the following procedure for more information.

TO EDIT A HARMONIC CURVE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Harmonic Curves and then double-click the name of the harmonic curve that you want to
edit.

Use the options in the Harmonics Curve Type editor to perform the following tasks:

User Guide

To ...

Do This ...

Edit general information

for the curve

Edit the following options:

Description. Type an optional description for the harmonic

curve.

Color. Select a color to represent the harmonic curve.

SynerGEE Electric 5.0

Reliability

691

To ...

Do This ...

Edit curve data using

the chart view

Click the Toggle button so that the harmonics chart view displays.
Using the mouse, drag the bar for each harmonic to set the desired
percentage. The chart view can be used to set odd-numbered
harmonics, from 3 to 25, between 0 and 15 percent. To set evennumbered harmonics or to set harmonic percentages from 15 to 100
percent, you must use the table view.

Harmonic Curve Type editor (chart view)

SynerGEE Electric 5.0

User Guide

692

Reliability

To ...

Do This ...

Edit curve data using

the table view

Click the Toggle button so that the harmonics table view displays.
The table view can be used to set harmonics for both odd- and evennumbered values between 3 and 25, from 0 to 100 percent. Oddnumbered harmonic values can also be set in the chart view between
0 and 15 percent.

Harmonic Curve Type editor (table view)

Click Apply to accept your changes, and then click X to close the editor.

Deleting a harmonic curve

Perform the following procedure to delete a harmonic curve type from your equipment warehouse.

TO DELETE A HARMONIC CURVE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Harmonic Curves and then select the name of the harmonic curve that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Assigning a harmonic curve to a large customer

Perform the following procedure to assign a harmonic curve to a large customer in your model.

User Guide

SynerGEE Electric 5.0

Reliability

693

TO APPLY A HARMONIC CURVE TO A LARGE CUSTOMER

1

In the SynerGEE model explorer, select the Model tab.

Expand Facilities and then select Large Customers. Double-click the name of the large customer
that you want to edit.

In the Large Customer editor, select the Load tab.

Next to Harmonic Profile, select the name of the harmonic curve that you want to apply to the large
customer.

Click Apply to accept your changes, and then click X to close the editor.

Designating sections for harmonic monitoring

Perform the following procedure to designate sections for harmonic monitoring.

TO DESIGNATE A SECTION FOR HARMONIC MONITORING

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Section tab.

Under Attributes, select the Monitor Harmonic check box. Selecting this option will enable the
section for harmonic monitoring.

Click Apply to accept your changes, and then click X to close the editor.

Configuring options for a harmonic analysis

Use the Harmonic Analysis Options editor to select the harmonic analysis type and to specify whether
generators will be included in the analysis. Refer to the following procedure for more information.

TO SET UP A HARMONIC ANALYSIS

1

Perform the following steps to open the Harmonic Analysis Options editor:
a

In the SynerGEE ribbon bar, select the RELIABILITY tab.

In the Power Quality group, click the text label Harmonic and then select Settings.

SynerGEE Electric 5.0

User Guide

694

Reliability
2

Use the Harmonic Analysis Options editor to set up the harmonic analysis. Refer to the following
table for more information on the options that you can set.
Harmonic Analysis
Type

Harmonic scan

Select the type of harmonic analysis that you want to perform. The
following options are available:

Impedance frequency scan. The impedance frequency

scan looks at a particular section (the section that has been
Set for Analysis) and presents the driving point impedance
as a function of frequency or harmonic order.

Harmonic impedance along path. SynerGEE will calculate

the harmonic impedance for sections from the selection
point all the way back to the source.

Harmonic load-flow. The harmonic load-flow report uses

information from the harmonic profile of a large customer
and any sections that have been enabled for harmonic
monitoring (as described in Designating sections for
harmonic monitoring on page 693). The resulting reports
show harmonic curves and total harmonic distortion (THD)
throughout the system.

Select the Include Generators check box if you want to include

section generators in the harmonic analysis.

Click Apply to accept your changes, and then click X to close the editor.

Performing a harmonic analysis

Perform the following procedure to run a harmonic analysis on your model.

TO PERFORM A HARMONIC ANALYSIS

1

In the SynerGEE ribbon bar, select the RELIABILITY tab.

In the Power Quality group, click the Harmonic icon.

When the analysis is complete, the Harmonic Analysis report will display. Depending on the type of
analysis that you ran, see Viewing the Harmonic load-flow report on page 694 or Viewing the
impedance frequency scan report on page 695 for more information.

Viewing the Harmonic load-flow report

The Harmonic load-flow report includes the following chapters:

Run Summary. The Run Summary chapter provides a brief overview of the analysis, including the
devices involved in the scan, the analysis year, spot and distributed load, and warnings and fixes.

THD Distribution. The THD (Total Harmonic Distortion) Distribution chapter shows a pie chart that
represents the miles of line in each percentage category. The example below shows that

User Guide

SynerGEE Electric 5.0

Reliability

695
approximately 75% of the line in the model contains less than 0.1% THD. About 20% of the line in
the model contains 2-3% THD.

Section-based report chapters. The other chapters of the report are based on the sections that were
configured for harmonic monitoring. Each section will appear as a chapter in the report and may
include any of the following sub-reports:
-

Amp and Volt Values. The Amp and Volt Values bar chart represents the by-phase current
and voltage contribution as a percentage of the fundamental for each harmonic order. This
takes into account the models harmonic curves and load-flow calculations.

Volt Chart. The Volt Chart bar chart represents the by-phase voltage contribution as a
percentage of the fundamental for each harmonic order based on the models harmonic
curves and load-flow calculations.

Amp Chart. The Amp Chart bar chart represents the by-phase current percent contribution
as a percentage of the fundamental for each harmonic order based on the models
harmonic curves and load-flow calculations.

Neutral Chart. The Neutral Chart bar chart represents the neutral current contribution of the
fundamental for each harmonic order based on the models harmonic curves and load-flow
calculations.

Volt Cycle. The Volt Cycle graph represents the non-sinusoidal by-phase current waveform
distortion due to harmonic current.

Amp Cycle. The Amp Cycle graph represents the non-sinusoidal by-phase current
waveform distortion due to harmonic content.

Neutral Curve. The Neutral Curve graph represents the non-sinusoidal neutral current
waveform distortion due to harmonic content.

Viewing the impedance frequency scan report

The impedance frequency scan is designed to aid in distribution planning by helping you spot potential
problems with resonant frequencies. It performs a full network analysis of the feeder, including loads,
capacitors, generators, transformers, and line models, which contribute to the harmonic driving point
impedance of a section. These devices may be upstream or downstream from the section being analyzed,
and they may be on or off the feeder path. Harmonic analysis does not model filters, harmonic bus voltages,
or harmonic load currents. The impedance frequency scan report includes the following chapters:

SynerGEE Electric 5.0

User Guide

696

Reliability

Positive Sequence Z. This plot represents the positive sequence impedance in ohms as seen at the
load end of the selected section.

Positive Sequence R, X. This plot represents the positive sequence resistance and reactance in
ohms as seen at the load end of the selected section.

Phase Z. This plot represents the per-phase impedance (phase domain) in ohms as seen at the
load end of the selected section.

Phase R. This plot represents the per-phase resistance (phase domain) in ohms as seen at the load
end of the selected section.

Phase X. This plot represents the per-phase reactance (phase domain) in ohms as seen at the load
end of the selected section.

Sequence Domain Z. This plot represents the positive and zero sequence impedance in ohms as
seen at the load end of the selected section.

Sequence Domain R, X. This plot represents the positive and zero sequence resistance and
reactance in ohms as seen at the load end of the selected section.

Impedance values. As an alternative to the plot chapters, this grid-style report contains harmonic
impedance values at increments of 1/4 the fundamental frequency.

UNFUSED TAP ANALYSIS

SynerGEEs Unfused Tap Analysis identifies areas in the model where taps lack fusing. Faults on these
sections will result in the operation of main-line protection. An event on a small tap serving just a few
customer could impact hundreds of customers fed off the main.
The report that is generated by this analysis includes a Summary chapter that shows the number of unfused
taps for each feeder, as well as exposure miles (exposed length from the start of the tap to downstream
devices) and exposure customer miles (number of customers fed from the nearest upstream device) per
feeder. Additional report chapters show more detailed information on each feeder for unfused taps as well as
fused taps, and also the exposed miles by conductor type.

TO PERFORM AN UNFUSED TAP ANALYSIS

1

In the SynerGEE ribbon bar, select the RELIABILITY tab.

In the Analysis group, click the Unfused Tap icon.

DEVICE RISK RANKING ANALYSIS

Device Risk Ranking is useful to compare the risk factors of a variety of devices. This gives the ability to
evaluate how a device might affect customer reliability. The risk ranking takes into account the number of
customers the device serves, the failure rate of the device itself, and the number of repair hours for the
device.
First, a consequence value is determined by multiplying the number of customers by the repair hours. This
consequence value is then multiplied by the failure rate of the device. This result is called the risk factor.

User Guide

SynerGEE Electric 5.0

Reliability

697

To use this tool, the model must have customer count values populated. It should also have failure rates and
repair times entered for transformers, feeders, breakers, and so on.
The report chapters generated by this application can be opened in Excel. At that point, various scatter
charts, pivot tables, and diagrams can be utilized.

RELIABILITY EVENT MANAGEMENT WIZARD

The Reliability Event Management wizard is a powerful tool for handling large sets of outage event data that
comes from your OMS or other system. The wizard consists of three sections for reliability management:
Typical Actions, Maintenance, and Advanced. The selections you make will be automatically saved as you
use the wizard.

TO RUN THE RELIABILITY EVENTS MANAGEMENT WIZARD

1

Use one of the following methods to open the Reliability Event Management wizard:
-

In the SynerGEE ribbon bar, select the FORGE tab. Then, in the Model Forge group, click
Outage Events.
or

In the SynerGEE ribbon bar, select the RELIABILITY tab. Then, in the Tools group, click
Outage Events.

On the first page of the Reliability Event Management wizard, select from one of the following
actions. It is important to note that in order to use the Reliability Event Management wizard, a text
file containing outage data must already exist in MiddleLink format.
Category
Typical actions to load
outage events

Maintenance

SynerGEE Electric 5.0

Description

Import events in data file(s) into a reliability data set.

Select this option to load outage events in MiddleLink format
from one or more text files and place them into an Oracle,
SQL Server, or Access data set.

Create model exposure zones and process events.

Select this option to create zones, correlate outages, and
calculate failure rates with events in a data set and a model
in SynerGEE.

Once outage events are loaded and zones are created, you can
perform maintenance operations on your data sets. The following
options are available:

Report on event data set.

Create/destroy reliability data sets.

Merge data sets.

User Guide

698

Reliability

Category
Advanced

User Guide

Description

Load exposure zones from data set to SynerGEE. Select

this option to load exposure zones from the data set into
SynerGEE, remove existing exposure zones, or use phasing
to calculate failure rates. This applies to the currently loaded
model only.

Click Next and follow the prompts throughout the wizard.

SynerGEE Electric 5.0

CHAPTER

14
Scripts
Scripts are customized macros that store a sequence of SynerGEE commands in an externally saved file.
SynerGEEs scripting language uses simple, predefined statements that you can customize with your own
parameters to perform very precise events in SynerGEE. The Startup recipe, for example, can be configured
to automatically perform specific functions each time that SynerGEE starts, such as loading models,
selecting feeders, and performing certain analyses.
You can write SynerGEE scripts directly in a text file using Notepad or any other text editing application, or
you can write scripts directly in SynerGEE using the SynerGEE Script editor. Script schemas are available
from the Support tab in the SynerGEE ribbon bar and are also provided as appendices to this User Guide.
Once written, you can run the scripts manually while you are using SynerGEE, or you can set up some scripts
to run on an automated basis.
Scripts can also be written using the Python programming language. Python is an open-source language that
is known for its simple, concise programming language. One advantage of writing Python scripts for use with
SynerGEE is that you have access to the complete Solver object library. This allows you full access to
practically all of the data in your model. By comparison, with the traditional SynerGEE scripts, you are
dependent upon specific commands to be provided with SynerGEE to perform specific tasks. If a command is
not available for the task you want to perform, then you simply cannot perform that task through a script.
Another advantage of writing Python scripts is you can use common programming concepts, including if, for,
and while statements, that are not available in SynerGEEs traditional scripting syntax.
Most script files, including Python scripts, are stored in your Scripts file directory. Recipe script files are stored
in your Macros file directory. You can change the location of either folder in the Preferences editor, as
described in Defining file paths on page 167. For example, you can store script files on a network folder so
they can be used by multiple SynerGEE users.
Scripts can be used any time a specific set of customized commands is needed, especially if they are used
frequently. In addition, you can use scripts to automate the process of importing data, such as from a
MiddleLink data source. For example, you could write a recipe script to import MiddleLink model data, and
then create a command line file to automatically launch SynerGEE and the MiddleLink recipe, perhaps on a
nightly basis. This functionality can help you fully automate a regular GIS-to-SynerGEE data conversion
process to ensure that your models always stay current.
Refer to the topics listed below for more information on working with scripts in SynerGEE.

Recipe Scripts on page 700

Model Forge Scripts on page 702

Python Scripts on page 705

Startup Scripts on page 715

SynerGEE Electric 5.0

User Guide

700

Scripts

Model Cleanup Scripts on page 718

Automation Scripts on page 720

Messaging Scripts on page 720

Cable Study Scripts on page 721

Writing Scripts on page 722

Running Scripts on page 730

Viewing a Script Schema on page 733

Process Diagrams on page 733

RECIPE SCRIPTS
A recipe script consists of a sequence of commands stored in a recipe text file. Each line is a separate
command that is performed according to its sequence in the file. Like many other script types in SynerGEE,
you can write recipe scripts directly in the text file or from SynerGEE using the Script editor. Recipes can be
run from the MACROS tab of the SynerGEE ribbon bar, or they can be configured to run automatically after
certain SynerGEE events, such as loading a model or changing the analysis year.
Recipe scripts can be written in two different formats. The original format, referred to in this User Guide as
numerical recipes, used a command numbering sequence based on the MiddleLink format. Recipes that
are written in the numerical format are still supported by SynerGEE, but in general new commands are no
longer being created for this syntax. The newer recipe format is referred to as text-based recipes, where
recipes commands are called using simple text codes. For example, to create a DSA, you would use the
command DSA.Create, and to run a fault location analysis, you would use the command FaultLoc.Run.
Other than the differences in how the recipes are called, the results are the same for both text-based and
number-based scripts. The schemas for both numerical recipes and text-based recipes are available from the
Support tab in the SynerGEE ribbon bar, and are described in much greater detail in the appendices to this
User Guide.
Refer to the topics listed below for more information.

Recipe syntax on page 700

Recipe script example on page 701

Recipe syntax
In numerical recipes, all recipe command lines begin with the command number, such as 3100. The
remaining arguments in a command must follow the syntax designated for that command. Any text in a recipe
file that does not follow proper recipe syntax is ignored and no warning is given. Therefore, if your recipe
does not behave as expected, carefully verify that there are no mistakes in the file. For example, if you forget
the comma after the recipe command itself, and the command uses additional parameters, SynerGEE will
ignore the line.

User Guide

SynerGEE Electric 5.0

Scripts

701
Text-based recipes follow a similar convention, but use text-based commands instead of numerical
commands. For example, to run a load flow analysis in a numerical recipe, you would use the following
command:
3200, Load flow, 1

In numerical recipes, 3200 is the command to run an analysis. The first parameter specifies what analysis to
run, and the second parameter specifies whether to generate the load-flow report (0 = no, 1 = yes). To
perform the same task in text-based recipes, you would use the following command:
LoadFlow.Run, 1

The LoadFlow.Run command specifically runs a load-flow analysis, and the one and only parameter specifies
whether to generate the load-flow report (0 = no, 1 = yes).

Recipe script example

Consider the following example of a numerical recipe:
Color sections in the map display.
3100, My Map Colors
3102, Underground, Yellow, Under
3103, 336 ACSR, Blue, 336 ACSR
3104, Target kVA, Red, ConnKva, 50, 150

This customized recipe applies section coloring as specified to a model. When this recipe file is run, it will do
the following:
1

The 3100 command will place the title My Map Colors in the map legend.
3100, My Map Colors

The 3102 command will apply yellow to all sections with underground conductors. Underground is
added to the map legend.
3102, Underground, Yellow, Under

The 3103 will apply blue to all sections with the 336 ACSR conductor. 336 ACSR is added to the
map legend.
3103, 336 ACSR, Blue, 336 ACSR

The 3104 command will apply red to all sections that have a total connected between 50 and 150.
Target kVA is added to the map legend.
3104, Target kVA, Red, ConnKva, 50, 150

The first line is a comment, designated by the apostrophe ( ' ) that precedes the line. You can add an
apostrophe to any line in the script to comment out that line. For example, if you added an apostrophe before
the 3013 command, that command would not be applied when you run the script. Remove the apostrophe to
re-activate the line.
Take note of the following:

SynerGEE Electric 5.0

User Guide

702

Scripts

Recipe commands are performed in the order in which they appear in the script. Therefore, it is
possible for one command to override another.

You can use recipes to read from and write to data sources, via DSAs. However:

Recipes cannot create databases. To save to a database, it must already exist.

If an Access database is currently open in Access, a recipe may not be able to transact
with it.

The map-related recipe commands allow you to perform custom map coloring. When one of these
commands is executed, SynerGEE automatically changes the Color by option in your map settings
to Recipe. After the recipe run, you can switch Color by options, and later return to your custom
recipe coloring at any time. However, the colors will be the same as they were following the recipe
run, regardless of what transpired in the interim. For example, if you ran a results-based map
coloring recipe, and a subsequent analysis run changed those results, your colors will not update
until you run the recipe again.

Detailed information of all available recipes and their commands is provided in Numerical Recipe
Commands on page 855 and Text-Based Recipe Commands on page 907. You can also view the recipe
script schema directly in SynerGEE, as described in Viewing a Script Schema on page 733. The
subsections below provide additional guidelines that you will need to keep in mind as you write and edit
recipe scripts.

MODEL FORGE SCRIPTS

The Model Forge is an automated tool primarily used to import model data from a database or text file. The
wizard prompts for a source folder, destination folder, and an optional model cleanup script. It then reads the
source files, creates MiddleLink files based on zones from the source data, imports each file into SynerGEE,
runs the (optional) model cleanup script, and then saves the model to the destination folder. The output files
are named Model_**, where ** is the zone ID.
The feature lock function plays an important role in the Model Forge wizard. When the wizard is initialized, it
checks the engines available in the feature lock dialog. If only one engine exists, then that engine will
automatically be selected and the wizard will begin on page four of eight. If all the engines are locked in the
feature lock, then you will be notified with a message. If more than one engine is available, you will be
prompted to choose your engine on page one of the wizard. The Model Forge wizard contains engines to
import PTI, SIGED, or NEPLAN data into SynerGEE. For more information on feature locks, see Setting
feature locks on page 171.
Running the Model Forge wizard with the PTI engine will read a *.DMP file and save it to a *.CSV file in
MiddleLink format. The PTI engine will prompt you to select a source and destination file on page two of the
Model Forge wizard.
The SIGED engine reads an Informix database and converts it to the SynerGEE format, which can then be
saved as an Informix or Access database. The SIGED engine will prompt you to select a source file on page
two of the Model Forge wizard.
Running the wizard with the NEPLAN engine will bring up a page where the source file, target model DSA
and target equipment DSA can be specified. Once the wizard is complete, the process will read the NEPLAN
data, convert it to the SynerGEE format, and then save it to the specified DSAs.
Refer to the topics listed below for more information.

User Guide

SynerGEE Electric 5.0

Scripts

703

Running the Model Forge wizard on page 703

Viewing the Model Forge schema on page 703

Model Forge Script example on page 703

Running the Model Forge wizard

Perform the following procedure to run the Model Forge wizard.

TO RUN THE MODEL FORGE WIZARD

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click the Forge icon.

If more than one engine is available, select one from the list and then follow the prompts.
or
If the feature lock is enabled, then select the data source from page four of the wizard. Click Next to
continue.

On page 5 of the wizard, select the operation. Click Next to continue.

On page 6 of the wizard, select the target data source for the model. Click Next to continue.

On page 7 of the wizard, select the zone from the database to process. Click Next to continue.

On the last page of the wizard, select a model build script. Click Finish.

Viewing the Model Forge schema

The following procedure describes how to view the Model Forge schema from within the SynerGEE
application. A more detailed description of the Model Forge schema is provided in Model Forge Commands
on page 947.

TO VIEW THE MODEL FORGE SCHEMA

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click the text label Forge and then select Schema.

Model Forge Script example

The following script is a short example of a typical Model Forge script. The intent of this script is to read data
from one database and copy it into the current database. The script begins by defining the SQL statement
that will be used in the script, using the ModelForge.DefineSQL command. The script then identifies which
data source the data will be read from. The data source is identified by a pre-configured DSA, which is
accessed by the script using the ModleForge.DataMartDSA command. In this example, Settings Database
is the name of both the data mart and the SynerGEE DSA. The script then queries the database using the
ModelForge.DataMartQuery command and SynerGEE Model Forge commands to copy data from the data

SynerGEE Electric 5.0

User Guide

704

Scripts
source into the current model. FDR_102, for example, is used to import minimum and maximum source
impedance values for the feeders in the model.
'
'
'
'

**
** Setup queries to be used for data loading
**
** ModelForge.DefineSQL, Query Name, SQL

ModelForge.DefineSQL, GetFeederZ, SELECT SynNode, SynPosSeqR, SynPosSeqX,

SynZeroSeqR, SynZeroSeqX FROM SynE_FeederZ;
ModelForge.DefineSQL, GetSubTranZ, SELECT SynNode, SynPosSeqR, SynPosSeqX,
SynZeroSeqR, SynZeroSeqX FROM SynE_SubTranZ;
ModelForge.DefineSQL, GetRegSet1, SELECT SynAMSLink, SynConfiguration,
SynGangOp, SynGangPhase FROM SynE_RegSettings;
ModelForge.DefineSQL, GetRegSet2, SELECT SynAMSLink, SynForwardVoltSet,
SynForwardRDialSet, SynForwardXDialSet, SynForwardBWDialSet FROM
SynE_RegSettings;
ModelForge.DefineSQL, GetRegSet3, SELECT SynAMSLink, SynReverseMode,
SynReverseThreshold FROM SynE_RegSettings;
ModelForge.DefineSQL, GetRegSet4, SELECT SynAMSLink, SynReverseVoltSet,
SynReverseRDialSet, SynReverseXDialSet, SynReverseBWDialSet FROM
SynE_RegSettings;
ModelForge.DefineSQL, GetRegSet5, SELECT SynAMSLink, SynFirstHouseActive,
SynFirstHouseHighV, SynFirstHouseLowV FROM SynE_RegSettings;
ModelForge.DefineSQL, GetRegSet6, SELECT SynAMSLink, SynTapLimActive,
SynTapLimHighSet, SynTapLimLowSet FROM SynE_RegSettings;
ModelForge.DefineSQL, GetRegSet7, SELECT SynAMSLink, SynTapDirection,
SynTapOperation FROM SynE_RegSettings;
ModelForge.DefineSQL, GetLTCSet1, SELECT SynAMSLink, SynGangOp, SynGangPh,
SynManualTapControl FROM SynE_LTCSettings;
ModelForge.DefineSQL, GetLTCSet2, SELECT SynAMSLink, SynForwardVoltSet,
SynForwardRDialSet, SynForwardXDialSet, SynForwardBWDialSet FROM
SynE_LTCSettings;
ModelForge.DefineSQL, GetLTCSet3, SELECT SynAMSLink, SynFirstHouseActive,
SynFirstHouseHighV, SynFirstHouseLowV FROM SynE_LTCSettings;
ModelForge.DefineSQL, GetLTCSet4, SELECT SynAMSLink, SynTapLimActive,
SynTapLimHighSet, SynTapLimLowSet FROM SynE_LTCSettings;
ModelForge.DefineSQL, GetLTCSet5, SELECT SynAMSLink, SynTapSetting FROM
SynE_LTCSettings;
'
'
'
'

**
** Specify locations for utility data for Model Forge to attach
** ModelForge.DataMartDSA, Data Mart Name, DSA Name
**

ModelForge.DataMartDSA, Settings Database, Settings Database

' **
' ** Specify queries to retrieve data from data mart tables
' ** ModelForge.DataMartQuery, Active, Mart Name, Schema Code, SQL Query

User Guide

SynerGEE Electric 5.0

Scripts

705
' **
ModelForge.DataMartQuery, 1, Settings Database, FDR_102, GetFeederZ
ModelForge.DataMartQuery, 1, Settings Database, STN_102, GetSubTranZ
ModelForge.DataMartQuery,
ModelForge.DataMartQuery,
ModelForge.DataMartQuery,
ModelForge.DataMartQuery,
ModelForge.DataMartQuery,
ModelForge.DataMartQuery,
ModelForge.DataMartQuery,

1,
1,
1,
1,
1,
1,
1,

Settings
Settings
Settings
Settings
Settings
Settings
Settings

Database,
Database,
Database,
Database,
Database,
Database,
Database,

REG_105,
REG_106,
REG_107,
REG_108,
REG_109,
REG_110,
REG_111,

GetRegSet1
GetRegSet2
GetRegSet3
GetRegSet4
GetRegSet5
GetRegSet6
GetRegSet7

ModelForge.DataMartQuery,
ModelForge.DataMartQuery,
ModelForge.DataMartQuery,
ModelForge.DataMartQuery,
ModelForge.DataMartQuery,

1,
1,
1,
1,
1,

Settings
Settings
Settings
Settings
Settings

Database,
Database,
Database,
Database,
Database,

TRN_106,
TRN_107,
TRN_108,
TRN_109,
TRN_110,

GetLTCSet1
GetLTCSet2
GetLTCSet3
GetLTCSet4
GetLTCSet5

ModelForge.Option, 0, GenerateReport

PYTHON SCRIPTS
Python is a free, open-source programming language that is known for its readable and intuitive
programming code. Python support was added to SynerGEE Electric with the 5.0 release, to provide an
alternative to the more traditional script types in SynerGEE, like recipes and Model Forge scripts. The
software required to edit and run Python scripts is installed on your PC as a part of the SynerGEE installation.
Python scripts provide a number of advantages over traditional SynerGEE scripts, including the following:

Access to the Solver library. Python scripts written for use with SynerGEE provide you with full
access to the Solver object model library. This provides you with the ability to perform far more tasks
than you could ever do with the traditional SynerGEE recipe scripts, from editing data to
performing analyses to controlling the SynerGEE map display.

Process automation. Python scripts can be written to perform any number of very specific tasks,
including the tasks you might perform yourself on a day-to-day basis. For example, you may need to
open SynerGEE, open a SynerGEE model, import data from an external data source, perform one
or more analyses using the new data, and then export results or perform other related tasks. You
can write a Python script to perform all of these tasks, and run that script even when SynerGEE is
not open. In addition, the script can be associated with a Windows scheduled task, so that it will run
automatically and repeatedly, without any user intervention at all. This type of full SynerGEE
automation is simply not possible with traditional SynerGEE scripts.

Open-source language. Python is a fully developed open-source programming language, allowing

you to perform far more complex tasks than you could ever perform with a SynerGEE recipe script.
For example, you can write compound statements using commands such as if, while, and for;
use various comparison operations, including <, >, ==, >=, <=, and !=; and use a variety of
mathematical commands in your scripts. Again, this level of programming is simply not possible with
traditional SynerGEE scripts.

SynerGEE Electric 5.0

User Guide

706

Scripts
Refer to the topics listed below for more information.

Creating a Python script on page 706

Opening a Python script in the default Python editor on page 706

Writing a Python script on page 707

Copying a Python script on page 708

Renaming a Python script on page 709

Deleting a Python script on page 709

Running a Python script on page 709

Python scripts examples on page 710

Creating a Python script

Python scripts can be created at any time from the MACROS tab of the SynerGEE ribbon bar. The script will
be saved in your Scripts folder, which by default is located in your SynerGEE Electric documents directory
in the following location (Windows 7), where username is your Windows user name:
C:\Users\username\Documents\Stoner Software\SynerGEE Electric\
Scripts

Take note that you can use the Paths tab in the Preferences editor to change the location of the Scripts
folder. For more information on customizing file paths, see Defining file paths on page 167.

TO CREATE A PYTHON SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Python group, click the text label Edit and then select New.

In the New Script dialog box, type the name of the new script file that you want to create and then
click OK.

Opening a Python script in the default Python editor

Python scripts can be edited in any Python script editor, including the two that are installed with SynerGEE,
PythonWin and Python IDLE. In SynerGEE, you can select a script to edit from the MACROS tab of the
SynerGEE ribbon bar. The script will open in the application that has been configured as the SynerGEE
Python editor, which is PythonWin by default. You can also the default Python editor to another application, if
desired. Refer to the procedures below for more information.

TO CHANGE THE DEFAULT PYTHON EDITOR

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Python group, click the text label Edit and then select Set Python Editor.

User Guide

SynerGEE Electric 5.0

Scripts

707
3

In the Python Editor Path dialog box, click the Browse button and then navigate to the application
that you want to use to edit Python scripts. The path for the current Python editor will be listed by
default.
The default paths for PythonWin editor and the Python IDLE editor that is also installed with
SynerGEE are as follows:

PythonWin: C:\Python33\Lib\site-packages\pythonwin\pythonwin.exe

Python IDLE: C:\Python33\Lib\idlelib\idle.bat

Click OK.

TO OPEN A PYTHON SCRIPT IN THE DEFAULT PYTHON EDITOR

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Python group, under Script, select the name of the Python script that you want to edit.

Click Edit.

Writing a Python script

It is beyond the scope of this SynerGEE User Guide Online Help file to document the Python programming
language. Python is an open-source programming language that has been available since 1991. It is
supported by a very active user community, and it is easy to find a large number of books and websites that
thoroughly explain the Python programming language. The Python software that is installed with SynerGEE
on your PC includes the Python IDLE and PythonWin script editing applications plus supporting
documentation.
However, for the purpose of writing Python scripts for use with SynerGEE Electric, there are several key
issues that you need to be aware of. These issues are addressed in the subsections that follow.

Python script file directory

First and foremost is that if you want to launch a Python script from within SynerGEE (from the MACROS tab
of the SynerGEE ribbon bar), you must save the Python script file in your Scripts folder. By default this
folder is located in your SynerGEE Electric documents directory, in the following location, where username
is your Windows user name:
C:\Users\username\Documents\Stoner Software\SynerGEE Electric\
Scripts

Take note that you can use the Paths tab in the Preferences editor to change the location of the Scripts
folder. For more information on customizing file paths, see Defining file paths on page 167.

Required Python script code

All Python scripts must start with several lines of code that enable the Solver library. This code is included
with all Python script examples included in this User Guide Online Help file, as well as with all sample scripts
provided with the SynerGEE installation. The required lines of code is also repeated here for your reference.
# Import the Solver enumerated types
import SELib

SynerGEE Electric 5.0

User Guide

708

Scripts
# Import the module which creates the Solver
from win32com.client import Dispatch
# Import the module for COM exception handling
import pythoncom

Creating and initializing the Solver

To use the Solver in a Python script, you must specifically create it and then initialize it. The code required to
perform these tasks is provided below. This code is included with all Python script examples included in this
User Guide Online Help file, as well as with all sample scripts provided with the SynerGEE installation.
# Create the Solver
s = Dispatch("SESolver.StonerElectricSolver")
# Initialize the Solver
s.Init("", "kilowatt")

Note that when configured in this manner, the variable s is used to represent the Solver, and all Solver
commands in your Python script will begin with s. For example, the command to clear the current
SynerGEE model from memory is:
s.Model().Clear()

Likewise, the command to count the number of sections in the currently loaded model and assign that value
to a variable named numSections is:
numSections = s.Model().Sections().Count()

Both of these code examples are taken from the Python script examples provided in Python scripts
examples on page 710.

Deleting the Solver

At the end of your script, you need to delete (end) the instance of the Solver that you created in the beginning
of the script. The code required to perform this task is provided below, where s is a variable that represents
the Solver, as described earlier in this section. This code must be included with all Python script examples
included in this User Guide Online Help file, as well as with all sample scripts provided with the SynerGEE
installation.
# Delete the Solver
del s

Copying a Python script

Perform the following procedure to create a duplicate copy of a Python script.

TO COPY A PYTHON SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Python group, under Script, select the name of the Python script that you want to copy.

In the Python group, click the text label Edit and then select Copy. A duplicate copy of the script file
will be created, following the file copy-and-paste conventions on your operating system. The new

User Guide

SynerGEE Electric 5.0

Scripts

709
copy of the Python script will now be selected as the active script in the MACROS tab of the
SynerGEE ribbon bar.

Renaming a Python script

Perform the following procedure to rename a Python script.

TO RENAME A PYTHON SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Python group, under Script, select the name of the Python script that you want to edit.

In the Python group, click the text label Edit and then select Rename.

In the Rename Script dialog box, type the new name of the script file and then click OK.

Deleting a Python script

Perform the following procedure to delete a Python script.

TO DELETE A PYTHON SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Python group, under Script, select the name of the Python script that you want to delete.

In the Python group, click the text label Edit and then select Delete.

Click Yes to confirm the deletion.

Running a Python script

Python scripts can be run internally from within SynerGEE, or they can be run externally from a Python editor.
From within SynerGEE, you can run the script from the MACROS tab of the SynerGEE ribbon bar. This
method is essentially the same as running any other script type. Externally, you can run scripts from a Python
editing application, such as the PythonWin and Python IDLE applications that are installed with SynerGEE.
Refer to the following procedures for more information.

TO RUN A PYTHON SCRIPT FROM INSIDE SYNERGEE

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Python group, under Script, select the name of the Python script that you want to run.

Click Run.

TO RUN A PYTHON SCRIPT FROM PYTHON IDLE

1

Open the script you want to run in the Python IDLE application.

From the Python IDLE main menu, select Run > Run Module.

SynerGEE Electric 5.0

User Guide

710

Scripts

TO RUN A PYTHON SCRIPT FROM PYTHONWIN

1

Open the script you want to run in the PythonWin application.

From the PythonWin main menu, select File > Run.

Python scripts examples

Refer to the topics listed below for simple SynerGEE scripts written in the Python programming language.

Python script example Reporting model data on page 710

Python script example Startup script on page 711

Python script example Performing a fault analysis on page 712

Python script example Updating neutrals on page 714

Python script example Reporting model data

The script example provided in this section will load the sample database that is provided with SynerGEE and
then report on the number of meters, feeders, and loads included in that model. This script is designed to be
run from the Python IDLE application, and the model data will be reported to the Python console window
using the print command in the script.
Specifically, the commands in this script will do the following:
1

Create and initialize the Solver. These initial steps are required for any Python script that is written
for use with SynerGEE. See Writing a Python script on page 707 for more information.

Clear the current model from memory.

Load feeders from a specified DSA. In this example, the script will use the DSA for the sample
model that is provided with SynerGEE, Access Database (Sample Model).

Read several SynerGEE values and print them to the Python IDLE console window, including the
number of meters, feeders, and loads.

Delete the Solver instance. This step is required for any Python script that is written for use with
SynerGEE. See Writing a Python script on page 707 for more information.

The script example is shown below.

# Import the Solver enumerated types
import SELib
# Import the module which creates the Solver
from win32com.client import Dispatch
# Import the module for COM exception handling
import pythoncom
# Create the Solver
s = Dispatch("SESolver.StonerElectricSolver")
# Initialize the Solver
s.Init("", "kilowatt")
# Set version of Access
s.Settings().eAccessVersion = SELib.SEAccessVersion.seAccess2002

User Guide

SynerGEE Electric 5.0

Scripts

711
# Create new model
s.Model().Clear()
s.Model().Connect()
# Load feeders
# Replace username in the file path below with your Windows user name.
m = s.Settings().DataSources().Add("Access Database (Sample Model)",
SELib.SECDSProvider.seDSPAccessPersonal, SELib.SECDSContents.seDSCModel,
"C:\\Users\\username\\Documents\\Stoner Software\\SynerGEE Electric\\Sample
Data\\SampleModel.mdb","", "", "")
s.Model().LoadFromDataSource(m)
s.Model().Connect()
print('Welcome to the Sample Model!')
print('Total Meter Count is', s.Model().Meters().Count())
print('Total Feeder Count is', s.Model().Feeders().Count())
print('Total Dist Loads is', s.Model().Loads().Count())
# Delete the Solver
del s

Figure 14-1 shows the result of the Reporting Model Data script.

Figure 14-1 Reporting Model Data script result

Python script example Startup script

The script example provided in this section shows the default SynerGEE startup recipe saved in the Python
script format. Python scripts are one of the formats you can use for the startup script, as described in
Specifying which script type to run at startup on page 715.
Specifically, the commands in this script will do the following:
1

Create and initialize the Solver. These initial steps are required for any Python script that is written
for use with SynerGEE. See Writing a Python script on page 707 for more information.

Clear the current model from memory.

Load feeders from a specified DSA. In this example, the script will use the DSA for the sample
model that is provided with SynerGEE, Access Database (Sample Model).

Load a specified equipment warehouse. In this example, the script will use the DSA for the sample
warehouse that is provided with SynerGEE, Access Database (Sample Warehouse).

SynerGEE Electric 5.0

User Guide

712

Scripts
5

Load a specified protection database. In this example, the script will load the protection database
that is provided with SynerGEE, named SynProtectionDb.mdb.

Delete the Solver instance. This step is required for any Python script that is written for use with
SynerGEE. See Writing a Python script on page 707 for more information.

The script example is shown below.

# Import the Solver enumerated types
import SELib
# Import the module which creates the Solver
from win32com.client import Dispatch
# Import the module for COM exception handling
import pythoncom
# Create the Solver
s = Dispatch("SESolver.StonerElectricSolver")
# Initialize the Solver
s.Init("", "kilowatt")
# Create new model
s.Model().Clear()
s.Model().Connect()
# Create new warehouse
s.Warehouse().Clear()
# Load feeders
# Replace username in the file path below with your Windows user name.
m = s.Settings().DataSources().Add("Access Database (Sample Model)",
SELib.SECDSProvider.seDSPAccessPersonal, SELib.SECDSContents.seDSCModel,
"C:\\Users\\username\\Documents\\Stoner Software\\SynerGEE Electric\\Sample
Data\\SampleModel.mdb","", "", "")
s.Model().LoadFromDataSource(m)
s.Model().Connect()
# Load equipment
# Replace username in the file path below with your Windows user name.
w = s.Settings().DataSources().Add("Access Database (Sample Warehouse)",
SELib.SECDSProvider.seDSPAccessPersonal, SELib.SECDSContents.seDSCEquipment,
"C:\\Users\\username\\Documents\\Stoner Software\\SynerGEE Electric\\Sample
Data\\SampleEquipment.mdb","", "", "")
s.Warehouse().LoadFromDataSource(w)
# Load the protection database
# Replace username in the file path below with your Windows user name.
s.Warehouse().ProtDevCurves().LoadFromDatabase("C:\\Users\\username\\Documen
ts\\Stoner Software\\SynerGEE Electric\\SynProtectionDb.mdb")
# Delete the Solver
del s

Python script example Performing a fault analysis

The script example provided in this section will load the sample database that is provided with SynerGEE and
then perform a fault analysis. This script is designed to be run from the Python IDLE application. Several
messages will be reported to the Python console window using the print command in the script.
Specifically, the commands in this script will do the following:

User Guide

SynerGEE Electric 5.0

Scripts

713
1

Create and initialize the Solver. These initial steps are required for any Python script that is written
for use with SynerGEE. See Writing a Python script on page 707 for more information.

Check out the Planning license.

Clear the current model from memory.

Load feeders from a specified DSA. In this example, the script will use the DSA for the sample
model that is provided with SynerGEE, Access Database (Sample Model).

Load a specified equipment warehouse. In this example, the script will use the DSA for the sample
warehouse that is provided with SynerGEE, Access Database (Sample Warehouse).

Perform a Fault analysis.

Delete the Solver instance. This step is required for any Python script that is written for use with
SynerGEE. See Writing a Python script on page 707 for more information.

The script example is shown below.

# Import the Solver enumerated types
import SELib
# Import the module which creates the Solver
from win32com.client import Dispatch
# Import the module for COM exception handling
import pythoncom
# Create the Solver
s = Dispatch("SESolver.StonerElectricSolver")
# Initialize the Solver
s.Init("", "kilowatt")
# Check out licenses
s.License().CheckModuleOut(SELib.SEMod.sePlanningMod)
# Create new model
s.Model().Clear()
s.Model().Connect()
# Create new warehouse
s.Warehouse().Clear()
# Load feeders
# Replace username in the file path below with your Windows user name.
m = s.Settings().DataSources().Add("Access Database (Sample Model)",
SELib.SECDSProvider.seDSPAccessPersonal, SELib.SECDSContents.seDSCModel,
"C:\\Users\\username\\Documents\\Stoner Software\\SynerGEE Electric\\Sample
Data\\SampleModel.mdb","", "", "")
s.Model().LoadFromDataSource(m)
s.Model().Connect()
# Load equipment
# Replace username in the file path below with your Windows user name.
w = s.Settings().DataSources().Add("Access Database (Sample Warehouse)",
SELib.SECDSProvider.seDSPAccessPersonal, SELib.SECDSContents.seDSCEquipment,
"C:\\Users\\username\\Documents\\Stoner Software\\SynerGEE Electric\\Sample
Data\\SampleEquipment.mdb","", "", "")
s.Warehouse().LoadFromDataSource(w)
print('Run Fault Analysis.')
s.Engine().Run(SELib.SEAppTypes.seFault)

SynerGEE Electric 5.0

User Guide

714

Scripts
print('Fault Analysis Complete.')
# Delete the Solver
del s

Python script example Updating neutrals

The script example provided in this section will load the sample database that is provided with SynerGEE and
then perform a fault analysis. This script is designed to be run from the Python IDLE application. Several
messages will be reported to the Python console window using the print command in the script.
Specifically, the commands in this script will do the following:
1

Create and initialize the Solver. These initial steps are required for any Python script that is written
for use with SynerGEE. See Writing a Python script on page 707 for more information.

Check out the Planning license.

Clear the current model from memory.

Load feeders from a specified DSA. In this example, the script will use the DSA for the sample
model that is provided with SynerGEE, Access Database (Sample Model).

Load a specified equipment warehouse. In this example, the script will use the DSA for the sample
warehouse that is provided with SynerGEE, Access Database (Sample Warehouse).

Search the model for any sections where the phase conductor is set to "336 ACSR" and, if found,
set the neutral conductor on those sections to "2/0 CU". Likewise, if the neutral conductor is set to
Concentric, the neutral conductor will be reset to Same as phase.

Delete the Solver instance. This step is required for any Python script that is written for use with
SynerGEE. See Writing a Python script on page 707 for more information.

The script example is shown below.

# Import the Solver enumerated types
import SELib
# Import the module which creates the Solver
from win32com.client import Dispatch
# Import the module for COM exception handling
import pythoncom
# Create the Solver
s = Dispatch("SESolver.StonerElectricSolver")
# Initialize the Solver
s.Init("", "kilowatt")
# Create new model
s.Model().Clear()
s.Model().Connect()
# Create new warehouse
s.Warehouse().Clear()
# Load feeders
# Replace username in the file path below with your Windows user name.
m = s.Settings().DataSources().Add("Access Database (Sample Model)",
SELib.SECDSProvider.seDSPAccessPersonal, SELib.SECDSContents.seDSCModel,

User Guide

SynerGEE Electric 5.0

Scripts

715
"C:\\Users\\username\\Documents\\Stoner Software\\SynerGEE Electric\\Sample
Data\\SampleModel.mdb","", "", "")
s.Model().LoadFromDataSource(m)
s.Model().Connect()
# Load equipment
# Replace username in the file path below with your Windows user name.
w = s.Settings().DataSources().Add("Access Database (Sample Warehouse)",
SELib.SECDSProvider.seDSPAccessPersonal, SELib.SECDSContents.seDSCEquipment,
"C:\\Users\\username\\Documents\\Stoner Software\\SynerGEE Electric\\Sample
Data\\SampleEquipment.mdb","", "", "")
s.Warehouse().LoadFromDataSource(w)
numSections = s.Model().Sections().Count()
i = 0
while i < numSections:
if "336 ACSR" in
s.Model().Sections().Item(i).sPhaseConductor(SELib.SEPhase.seA):
s.Model().Sections().Item(i).sNeutralConductor = "2/0 CU"
elif "Concentric" in s.Model().Sections().Item(i).sNeutralConductor:
s.Model().Sections().Item(i).sNeutralConductor =
s.Model().Sections().Item(i).sPhaseConductor(SELib.SEPhase.seA)
i += 1
# Delete the Solver
del s

STARTUP SCRIPTS
A startup script is run automatically when you start SynerGEE. The startup script can be in the SynerGEE
recipe format or in the Python script format. You select which script format is run from the MACROS tab of
the SynerGEE ribbon bar.
Refer to the topics listed below for more information.

Specifying which script type to run at startup on page 715

About the Startup recipe script on page 716

Using the Startup Script Wizard on page 716

Setting the current model as a startup recipe script on page 717

Specifying which script type to run at startup

You can configure SynerGEE to run either a recipe script or a Python script when you start the application.
Refer to the following procedure for more information.
Note:

By changing this option, you will also change the script type is used with SynerGEEs case models.
See Cases on page 91 for more information.

SynerGEE Electric 5.0

User Guide

716

Scripts

TO SPECIFY WHICH SCRIPT TYPE TO RUN AT STARTUP

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, click the SynerGEE tab.

Select Use Python for Startup Script and Case Files to run a Python script whenever you start
SynerGEE.
or
Clear the check box to run a recipe script when you start SynerGEE.

About the Startup recipe script

If you have configured SynerGEE to run a recipe script upon startup, the file that is run is named Startup.srf.
This recipe can be configured to point to a second recipe that will automate a series of designated tasks at
startup, thus allowing you to maintain multiple startup recipes that you can change back and forth as desired.
For example, you might create one startup recipe to automatically load a particular model, and a second
startup recipe to load the protection database, and a third startup recipe to load both. You can use any
available commands in the recipe that is run at startup.
When SynerGEE starts, it searches for and runs the Startup.srf recipe. The Startup.srf recipe will either
contain the required commands to execute your desired startup tasks, or will run a second recipe that
executes the startup tasks. If the Startup.srf recipe does not exist, SynerGEE will create a new one, with
commands to load the sample database and protection database. A SynerGEE-created startup recipe also
contains commands to generate DSAs to those databases. If you delete one of these DSAs and it reappears
later, it is possible that your startup recipe recreated it.
Because the startup recipe is automatically generated, deleting it will not stop its functionality. If you delete it,
it will simply be regenerated. Therefore, if you do not want anything special to happen upon startup, you
should comment out all content and leave the empty script in place, instead of deleting the Startup.srf file
itself. You can access this recipe file for editing using standard recipe tools. For more information, see
Recipe Scripts on page 700.

Using the Startup Script Wizard

The Startup Script Wizard is an easy way to create and edit startup scripts in the recipe script format. The
wizard walks you through the process of selecting a data source for the model, warehouse, and feeders. In
addition, you can choose a display style, choose to use a protection database, select control growth options,
and run load flow or fault during startup. The Startup Script Wizard lets you review and edit (if desired) the
script code before the new startup script is created.
Refer to the following procedure for more information.

CREATING A STARTUP RECIPE SCRIPT WITH THE STARTUP SCRIPT WIZARD

1

User Guide

Perform the following steps to open the Startup Script Wizard:

a

In the SynerGEE ribbon bar, select the MACROS tab.

In the Tools group, click the Startup Script icon.

SynerGEE Electric 5.0

Scripts

717
2

On the first page of the Startup Script wizard, select whether you want to create a new startup script
or select an existing script to run at startup.
-

Create New Startup Script. If you choose to create a new startup script, type the name of
the script that you are creating and then click Next. Continue with step 3 of this procedure.

Run Existing Script At Startup. If you choose to select an existing script to run at startup,
use the options list to select the name of the existing script you want to run at startup and
then click Next. Proceed to step 7 of this procedure.

On the second page of the wizard, select the model and the warehouse that you want to open on
startup. Click the Browse button to locate the file names if they are not present in the options list.
Click Next to continue.

On the next page of the wizard, select an existing display style that will be applied to the map view
after the model is opened, and then click Next.

On the next page of the wizard, click Yes or No to select whether you want to load the Protection
Library at startup, and then click Next.

On the next page of the wizard, do the following:

a

Select the Load-Flow or Fault check boxes if you want to run the load-flow and fault
applications on startup.

Select the Analysis Year.

Select the Growth Option check box if you want to configure growth settings. Select the
growth option type that you want to apply on startup, and set values for any additional
options if required.

Click Next.
7

The final page of the wizard displays the new startup script, based on either the options or you
selected in the Startup Script Wizard or the existing script that you selected to use as the startup
script. Review the script and, if required, type any edits or additions to the script directly in the script
window.

Click Finish to close the Startup Script Wizard and save the changes as the new startup script.

Setting the current model as a startup recipe script

SynerGEEs Startup On This Model feature is a simple method to save the currently loaded model as a
startup script. SynerGEE looks at all components in the current view, including the current warehouse and
loaded protection database (if applicable), and saves those settings as the new startup script.

TO SET UP THE CURRENT MODEL AS A STARTUP RECIPE SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Tools group, click the text label Startup Script and then select Startup On This Model.

Click Yes to overwrite the current startup script.

SynerGEE Electric 5.0

User Guide

718

Scripts

MODEL CLEANUP SCRIPTS

Model cleanup scripts can be used to find and fix common model data problems. Following a model cleanup
run, you can either implement the actual cleanup results or simply produce a report on the findings. Model
cleanup is very flexible and can search and replace data on an individual field level, as well as perform global
repairs such as the removal of duplicate nodes.
Model cleanup runs on the model data in memory, on selected feeders only. Source files on disk are not
affected unless you manually resave the data afterwards.
Model cleanup scripts follow the MiddleLink format. Detailed information on the supported commands is
provided in Model Cleanup Commands on page 1117. In addition, you can view the model cleanup schema
from within SynerGEE, as described in Viewing a Script Schema on page 733. For general information on
the MiddleLink format, see MiddleLink data format on page 72.

Sample model cleanup script

The following script demonstrates possible uses of the model cleanup application. Your scripts may vary
according to your specific needs.
Assume that you have imported data from a GIS that is missing spacing data for a majority of conductors.
The following script sets all sections to use equivalent spacing and then validates the actual spacing
parameters:
'Set all sections to use equivalent spacing.
4050, InstSection, UseEquivSpacing, 1
'Validate the phase-phase spacing. Must be between 48 and 58,
'otherwise it is replaced with 48.
4052, InstSection, PhaseToPhaseSpacing_MUL, 48, 48
4053, InstSection, PhaseToPhaseSpacing_MUL, 48, 58
'Likewise, validate that phase-neutral spacing is between 48 and 58.
4052, InstSection, PhaseToNeutralSpacing_MUL, 48, 48
4053, InstSection, PhaseToNeutralSpacing_MUL, 48, 58
'Validate that average height above ground is between -10 and 35.
'If it is not, assume that it is invalid, and reset it to 30.
4052, InstSection, AveHeightAboveGround_MUL, 30, -10
4053, InstSection, AveHeightAboveGround_MUL, 30, 35
'One more check for the average height. If the current value
'is zero, assume that the value was missing during import, and
'therefore invalid. In this case, set it to 30.
4054, InstSection, AveHeightAboveGround_MUL, 30

User Guide

SynerGEE Electric 5.0

Scripts

719

Model cleanup and supplementing spacing data

In some cases, a GIS may not contain the conductor spacing data required for SynerGEE calculations, and
therefore must be supplemented following a GIS data import. This function can be handled by a model
cleanup script.
Model cleanup scripts use a single record, 4006, to supplement spacing data. With this command, the model
cleanup script will search the model for sections with a certain number of phase conductors and with a
phase-to-phase spacing value less than a specified amount. Any section that matches the criteria receives
supplemented data.
For example, the following command causes model cleanup to search for sections with three total phase
conductors, and a current phase-to-phase spacing of less than 4 feet. For any section found that meets those
criteria, the phase-to-phase and phase-to-neutral spacing values are reset to 5 feet (60 inches):
4006, 1, 3, 4, 5, 5

Model cleanup and classic protective device conversion

Earlier versions of SynerGEE supported a simple protective device model, now known as a classic
protective device. These devices a largely obsolete and should be replaced with newer, detailed device
models, and model cleanup provides features to accomplish this conversion. For more information on classic
protective devices, see Classic protective devices on page 600.
Some organizations still have GIS databases which contain classic devices. Therefore, these devices may be
introduced into SynerGEE each time external data is imported via the MiddleLink 3.4 format. In addition,
some SynerGEE models may still use them due to legacy issues. In any case, conversion to the newer types
is strongly recommended to keep your models current, and to allow detailed protection studies as applicable.
Earlier versions of stand-alone MiddleLink and the SynerGEE validator performed this conversion process.
With the retirement of these tools, model cleanup has been expanded to replace this functionality. Model
cleanup also now includes comprehensive, bottom-up conversion features, with which you can perform
conversions directly on SynerGEE models, rather than relying on a MiddleLink import process as an
intermediate step.

Basic protective device conversion Model cleanup

With model cleanup tools, you can perform complete conversions of classic devices, all within SynerGEE.
The commands used to accomplish these conversions are:

4020 Convert classic fuses

4021 Convert classic reclosers

4022 Convert classic breakers

4023 Convert classic sectionalizers

As an example, the following command converts all 100 A Fuse classic fuses to newer Kearney models:
4020, 1, 100 A Fuse, Kearney, T, 100, 14.4

For more information and detailed descriptions of these records, see Model Cleanup Commands on
page 1117.

SynerGEE Electric 5.0

User Guide

720

Scripts

Finishing conversion after a MiddleLink 3.4 import Model cleanup

Model cleanup provides a special set of records for completing protective device conversion, following a
MiddleLink 3.4 model data import. These records include 4024, 4025, and 4026.
When you import classic protective devices via MiddleLink 3.4 data, SynerGEE automatically performs basic
conversions to newer, detailed, models on import. For example, a classic device that is specified as a fuse
becomes a newer fuse model automatically. However, the original classic device model provides only limited
information for the conversion, and important data such as manufacturer and model is normally missing and
needs to be supplemented, usually with the model cleanup records mentioned above.
To facilitate model cleanup functionality, when a classic device is imported, the original Classic Type Name
field (PDV file, field 5) populates the Manufacturer field in the new device record. For example, if you have a
classic device called a 100 A Fuse, it is converted to regular SynerGEE fuse, with the manufacturer 100 A
Fuse (InstFuses table, Manufacturer field, in Access). Generally, little other data is available for SynerGEE to
define the fuse.
Following the previous example, a fuse needs at least a valid manufacturer, model, and ratings for detailed
protection work. Assume that you know that a classic 100 A Fuse should become a newer Kearney T fuse.
To complete the conversion, you could put the following line in a cleanup script:
4024, 1, 100 A Fuse, Kearney, T, 100, 14.4

When run, this record searches the model for any newer fuse that has a Manufacturer specified as 100 A
Fuse. If found, model cleanup supplements the remaining information. For more information on the
parameters of this record and others, see Model Cleanup Commands on page 1117.
Keep in mind that the model data import and the model cleanup run are completely separate processes. The
4024 - 4026 cleanup records are designed specifically for a MiddleLink 3.4 imported model, but you would
run each as a separate, independent process.

AUTOMATION SCRIPTS
Automation scripts can be used to complete actions in SynerGEE, one after another, by running tasks without
actual hands-on in SynerGEE. This script is much more detailed for executing specific actions such as a left
click, select a ribbon bar option, and wait. This means that the script can be customized to execute almost
any action, like running an entire wizard and then selecting new map settings. It can be done in any order.
The automation script is different from the format of other SynerGEE scripts in that the automation script is
not numeric. All automation scripts are based on text commands only.

MESSAGING SCRIPTS
Messaging scripts are used to connect to a PI Historian database through a PI OleDb driver configured on
the current machine. Once connected to the database, SynerGEE retrieves values for the tags specified in
the script. The values are then associated with parameters for various facilities within the SynerGEE model.
The Messaging script can also be configured to have SynerGEE write calculated values into the historian.
This results in tags with calculated values or virtual SCADA points.

User Guide

SynerGEE Electric 5.0

Scripts

721
Messaging scripts are also used with real-time data stored in a DBMS to update values for meter kW and
kvar, feeder voltage, and substation voltage. This real time data functions much in the same way as the PI
Historian system and pulls its records from the same type of data hub.
For more information, see PI Messaging script on page 125 and DBMS Real-Time Data on page 127.

CABLE STUDY SCRIPTS

As an alternative to modeling duct banks, you can use a cable study script to perform derating calculations. A
study script has no interaction with the map or the model. It is strictly a calculation engine designed to handle
complex configurations that would be difficult to model.
Study scripts should be used whenever you have a duct configuration that is too complex to model with the
standard interface tools. SynerGEEs calculation engine can handle detailed configurations, well beyond
what can be modeled with the duct bank view and associated tools. Because these tools were designed for
simplicity, the script approach was implemented to allow detailed studies, while maintaining a friendly and
intuitive interface.
Note that the use of scripts has no interaction with the interface, other than the steps required to launch the
script and report the results. If you want to implement the results in your model, it will be your responsibility
afterward to do so.
A cable study script is created as a text file using the MiddleLink format. It can be written in any text editor,
such as Notepad, and can also be edited in the Script editor in SynerGEE. A cable study script must have a
STUDY file extension and be saved in your Scripts file directory. For information on locating and editing your
Scripts file directory, see Defining file paths on page 167.
The 12000 series of the MiddleLink schema is reserved for cable study parameters. A cable study script must
begin with a 12001 record. This record identifies the script as a cable study script. You should also have
records to define basic characteristics of the duct bank and surrounding earth. For example, the following
might be the first three lines of a cable study script:
12001
12005, 2.5, 6.0, 4.125, 0.70
12006, 20.0

In this example, record 12002 defines the script as a cable study script. Record 12005 sets the dimensions
and depth of the overall bank, and record 12006 defines parameters for the earth.
After the initial duct bank definition, the remaining lines should define the duct configuration and the circuits
within. You can use records such as 12010 and 12020 to create ducts and circuits, and then use other
records to add more data for the calculations, such as cable size, insulation, and jacket parameters. The
following is an example of some lines from sample cable study script:
' Define two ducts, named "11" and "12"
12010, 11, 0.500, 0.500, 3.0, 0.25, 6.0
12010, 12, 0.500, 1.125, 3.0, 0.25, 6.0
' Define two circuits, for the previously created ducts
12020, 3115-A1, 3115, A, 11, 0.0, 0.0
12020, 3115-B1, 3115, B, 12, 0.0, 0.0

SynerGEE Electric 5.0

User Guide

722

Scripts
' Add some additional information about the cables used for the circuits
12021, *, 2.8264E-8, 4.03E-3, 1.0, 0.8
12022, *, 750.0, 0.998, 90.0

In this example, note the use of apostrophes to add comments. Also, in the last two lines, note the use of
asterisks (*) to apply the parameters to all cables used in the study script.
Naturally, SynerGEE must create the banks first, and then the circuits within. However, your study script does
not necessarily need to be in this order. SynerGEE will automatically order the records by number when it
runs the script. You may, though, find it easier to organize your written scripts in the same order that
SynerGEE will process them.
The full schema for cable study script commands can be viewed from within SynerGEE. Refer to Viewing a
Script Schema on page 733 for more information.

WRITING SCRIPTS
SynerGEE provides a number of ways to create and edit script files. Refer to the topics listed below for more
information.

Creating a new script on page 722

Copying a script on page 723

Opening a script file for editing on page 723

Renaming a script on page 724

Deleting a script on page 724

Using the Script Editor on page 725

Using the Script Wizard on page 729

Creating a new script

Perform the following procedure to create a new SynerGEE script from the SynerGEE ribbon bar. For other
methods of creating new scripts, see Creating a script using the Script editor on page 726, Copying a
script on page 723, Using the Script Wizard on page 729, and Using the Startup Script Wizard on
page 716.

TO CREATE A SYNERGEE SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

or
If you want to create a Model Cleanup script, select the FORGE tab.

User Guide

In the selected tab, locate the group for the script type that you want to create.
-

To create a recipe, use the Recipes group.

To create a model cleanup script, use the Model Cleanup group.

SynerGEE Electric 5.0

Scripts

723
-

To create any other script type, use the Other Scripts group. Next to Type, select the type
of script that you want to create, such as Report Script or Study.

In the appropriate group, click the text label Edit and then select New.

In the New Script editor, type the name of the new script that you want to create, and then click OK.

Use the Script editor to edit the script that you created. For more information, see Opening a script
file for editing on page 723.

Copying a script
Perform the following procedure to create a duplicate copy of an existing SynerGEE script.

TO COPY A SYNERGEE SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

or
If you want to copy a Model Cleanup script, select the FORGE tab.

In the selected tab, locate the group for the script type that you want to copy.
-

To copy a recipe, use the Recipes group.

To copy a model cleanup script, use the Model Cleanup group.

To copy any other script type, use the Other Scripts group. Next to Type, select the type
of script that you want to copy, such as Report Script or Study.

Use the list of script names to select the name of the script that you want to edit.

Click the text label Edit and then select Copy. A duplicate copy of the script, with - Copy added to
the end, is created and selected in the list of script names.

Rename the script if desired, according to the directions in Renaming a script on page 724.

Use the Script editor to edit the script that you created. For more information, see Opening a script
file for editing on page 723.

Opening a script file for editing

From the SynerGEE ribbon bar, you can open a script file for editing in either the SynerGEE Script editor or
the Windows Notepad application. Refer to the following procedure for information.

TO OPEN A SCRIPT FILE FOR EDITING

1

In the SynerGEE ribbon bar, select the MACROS tab.

or
If you want to edit a Model Cleanup script, select the FORGE tab.

In the selected tab, locate the group for the script type that you want to edit.

SynerGEE Electric 5.0

User Guide

724

Scripts
-

To edit a recipe, use the Recipes group.

To edit a model cleanup script, use the Model Cleanup group.

To edit any other script type, use the Other Scripts group. Next to Type, select the type of
script that you want to edit, such as Report Script or Study.

Use the list of script names to select the name of the script that you want to edit.

Click the Edit button to edit the script using SynerGEEs Script editor. For more information, see
Using the Script Editor on page 725.
or
Click the text label Edit and then select Notepad to edit the script using the Notepad editor.

Renaming a script
Perform the following procedure to rename a script from the SynerGEE ribbon bar. Since scripts are saved as
text files on your PC, you can also rename script files manually using standard Windows controls. By default,
most script files are saved in your Scripts file directory, while most recipe scripts are saved in your Macros file
directory. For information on locating or editing either of these file locations, see Defining file paths on
page 167.

TO RENAME A SCRIPT
1

In the SynerGEE ribbon bar, select the MACROS tab.

or
If you want to rename a Model Cleanup script, select the FORGE tab.

In the selected tab, locate the group for the script type that you want to rename.
-

To rename a recipe, use the Recipes group.

To rename a model cleanup script, use the Model Cleanup group.

To rename any other script type, use the Other Scripts group. Next to Type, select the
type of script that you want to rename, such as Report Script or Study.

Use the list of script names to select the name of the script that you want to rename.

Click the text label Edit and then select Rename.

In the Rename Script editor, type the new name for the existing script, and then click OK.

Deleting a script
Perform the following procedure to delete a SynerGEE script. Since scripts are saved as text files on your
PC, you can also delete script files manually using standard Windows controls. By default, most script files
are saved in your Scripts file directory, while most recipe scripts are saved in your Macros file directory. For
information on locating or editing either of these file locations, see Defining file paths on page 167.

User Guide

SynerGEE Electric 5.0

Scripts

725

TO DELETE A SYNERGEE SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

or
If you want to delete a Model Cleanup script, select the FORGE tab.

In the selected tab, locate the group for the script type that you want to delete.
-

To delete a recipe, use the Recipes group.

To delete a model cleanup script, use the Model Cleanup group.

To delete any other script type, use the Other Scripts group. Next to Type, select the type
of script that you want to delete, such as Report Script or Study.

Use the list of script names to select the name of the script that you want to delete.

Click the text label Edit and then select Delete.

Click Yes to confirm the deletion.

Using the Script Editor

The SynerGEE Script editor is a SynerGEE window that provides a convenient way to write SynerGEE
scripts. The left side of the Script editor is a tree view that provides a complete list of SynerGEE script
commands. The right side of the Script editor is the data entry area for the script.
To add a command to a script, simply locate the command that you want to add in the tree view and then
double-click it. The command will be inserted above the active row in the data entry area. As you select
various commands in the data entry area, the column headings will change to reflect the data that you are
required to enter. Simply type the required data directly into the data entry cells, and enable or disable
individual lines by selecting or cleaning the check boxes for each row. When you save the script in the
SynerGEE Script editor, SynerGEE will create or update the associated script file with the proper script
syntax.
For example, assume that you want to add a command to a recipe script to run a load flow analysis. In the
Script editor tree view, you would expand Recipe and then Analysis, and then double-click 3200 - Run
Analysis. The 3200 line will be added to the data entry area, with two column headings enabled: App Name
(app) and Report (b). In the App Name column, you would enter load flow. In the Report column, you would
enter 1 if you want to generate the load flow report after the analysis is complete (or 0 if you do not).
Many of the SynerGEE script schemas, including the recipe schemas, are documented in the appendices to
this User Guide.
Refer to the topics listed below for more information on using the Script editor.

Creating a script using the Script editor on page 726

Opening a script from the Script editor on page 726

Opening a script in Notepad from the Script editor on page 727

Editing a script using the Script editor on page 727

Deleting a script from the Script editor on page 729

SynerGEE Electric 5.0

User Guide

726

Scripts

Creating a script using the Script editor

Perform the following procedure to create a new script using the SynerGEE Script editor. For other methods
of creating new scripts, see Creating a new script on page 722, Using the Startup Script Wizard on
page 716, and Using the Script Wizard on page 729.

TO CREATE A NEW SCRIPT FROM THE SCRIPT EDITOR

1

If you have not already done so, perform the following steps to open the Script editor:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Script Editor.

From the CONTROLS tab in the SynerGEE ribbon bar, click New. A blank script is created in the
Script editor window.

It is a good idea to save your new script even before you start editing it. From the CONTROLS tab in
the SynerGEE ribbon bar, click Save. Use the Script File to Save editor to select the file name, file
extension, and folder location for the new script file.
When saving a script file, take note of the following:

In the Script File to Save dialog box, be sure to select the proper script file type in the
bottom of the dialog box, next to Save as type. This will apply the proper file extension to
the file that is saved by SynerGEE. The file extension is used by SynerGEE to properly
recognize the script type later when you want to run it and further edit it.

Also, be sure to save the script file in the proper folder location. The default folder that
appears when you save a script for the first time is your Scripts file directory, as specified in
Defining file paths on page 167. This is the default location for many script types, but
recipe scripts must be saved in your Macros file directory. If you are creating a recipe
script, you must manually navigate to the Macros folder.

Refer to Editing a script using the Script editor on page 727 for information on adding and editing
script commands.

Opening a script from the Script editor

Perform the following procedure to open a script from the SynerGEE Script editor. For other methods of
opening scripts, see Opening a script file for editing on page 723 and Using the Script Wizard on
page 729.

TO OPEN A SCRIPT FROM THE SCRIPT EDITOR

1

If you have not already done so, perform the following steps to open the Script editor:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Script Editor.

From the CONTROLS tab in the SynerGEE ribbon bar, click Open.

In the Script File to Open editor, locate the folder and file name for the script file that you want to
open and then click Open. When opening a script file, take note of the following:

User Guide

SynerGEE Electric 5.0

Scripts

727

In the Script File to Open dialog box, be sure to select the proper script file type in the
lower-right corner of the dialog box, across from File name. This will allow the Script File
to Open editor to properly recognize script files for the script type that you want to open.

Also, be sure that you navigate to the proper folder location. The default folder that appears
when you open a script is your Scripts file directory, as specified in Defining file paths on
page 167. This is the default location for many script types, but recipe scripts are typically
saved in your Macros file directory. If you are open a recipe script, you must manually
navigate to the Macros folder.

Refer to Editing a script using the Script editor on page 727 for information on adding and editing
script commands.

Opening a script in Notepad from the Script editor

Since all SynerGEE scripts are simple text files, you can edit them in Notepad, as well as any text editing
application. Perform the following procedure to open a script in Notepad directly from the SynerGEE Script
editor. For other methods of opening scripts in Notepad, see Opening a script file for editing on page 723
and Using the Script Wizard on page 729.

TO OPEN A SCRIPT IN NOTEPAD FROM THE SCRIPT EDITOR

1

If you have not already done so, perform the following steps to open the Script editor:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Script Editor.

From the CONTROLS tab in the SynerGEE ribbon bar, click Open.

In the Script File to Open editor, locate the folder and file name for the script file that you want to
open and then click Open. When opening a script file, take note of the following:

In the Script File to Open dialog box, be sure to select the proper script file type in the
bottom of the dialog box, across from File name. This will allow the Script File to Open
editor to properly recognize script files for the script type that you want to open.

Also, be sure that you navigate to the proper folder location. The default folder that appears
when you open a script is your Scripts file directory, as specified in Defining file paths on
page 167. This is the default location for many script types, but recipe scripts are typically
saved in your Macros file directory. If you are open a recipe script, you must manually
navigate to the Macros folder.

From the CONTROLS tab in the SynerGEE ribbon bar, select Open in Notepad.
The specified script is now opened in the Notepad window. Be aware that once it is opened in
Notepad, the script will be closed in the Script editor. (A blank script will be created in its place.) This
will help ensure that you are not editing the same script twice in two different applications. If you
made changes to the script before selecting the Open in Notepad option, SynerGEE will
automatically save those changes to the script file before opening the script file in Notepad.

Editing a script using the Script editor

Perform the following procedure to edit a script using the SynerGEE Script editor.

SynerGEE Electric 5.0

User Guide

728

Scripts

TO EDIT A SCRIPT USING THE SCRIPT EDITOR

1

If you have not already done so, perform the following steps to open the Script editor:
a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the Views group, click Script Editor.

If you have not already done so, follow the instructions in Creating a script using the Script editor
on page 726 or Opening a script from the Script editor on page 726 to create a new script file or
open a script file for editing, respectively.

Refer to the following table for typical actions that you will perform when editing a script.
To ...
Add a command to the
script

Add a comment to the

script

Delete a command from

the script

User Guide

Do This ...
a

Select an empty row in the script editing area. Or, if you want
to insert a new row into an existing script, select the row
immediately below where you want to add the new
command. (If youve selected an existing row that includes
data, SynerGEE will automatically add a new row above the
selected row when you insert a command, as described in
the next step.)

In the tree view on the left-side of the Script editor, locate the
command that you want to add to your script. Double-click
the command to add it to the script.

In the script editing area, select the new row and review the
column headings to determine what additional data you
need to enter. Detailed information on the script command
syntax is provided throughout this User Guide and are also
provided within SynerGEE by viewing the appropriate
Schema file (as described in Viewing a Script Schema on
page 733).

Select the line in the script immediately after where you want
to add the comment.

Right-click and select Insert Comment.

Select the line in the script that you want to delete.

Right-click and select Delete.

SynerGEE Electric 5.0

Scripts

729

To ...

Do This ...

Duplicate commands in
the script

Select the line in the script that you want to copy.

Right-click and select Duplicate Row to create a copy of the

row immediately below the current row.
or
Right-click and select Copy. Select the row immediately
after where you want to paste the copied row, and then rightclick and select Insert Copied Cells. Note that if you select
the Paste command, you will replace the selected row with
the copied cells.

Enable and disable

rows

Select all rows in the

script

Select the line in the script that you want to enable or

disable.

Select or clear the check box associated with the row. If the
check box is cleared, the row will be disabled. (SynerGEE
will disable the row by commenting the line in the completed
script file.)

Right-click and select Select All Rows.

Perform other tasks as required. The tasks you perform will

be applied to all selected rows.

In the CONTROLS tab of the SynerGEE ribbon bar, click Save to save the script. If you try to close
the Script editor without saving your changes, SynerGEE will prompt you to save or discard your
changes, or return to the Script editor to continue working on the script.

Deleting a script from the Script editor

You cannot delete scripts directly from the Script editor. Instead, you can delete a script from the SynerGEE
ribbon bar, as described in Deleting a script on page 724. You can also delete script files manually directly
from your computer. By default, most script files are saved as text files in your Scripts file directory. Recipe
script files are saved in your Macros file directory.
For information on locating and editing your file directories, see Defining file paths on page 167.

Using the Script Wizard

SynerGEE provides a wizard-like interface that you can use to manage a number of different script types,
including the messaging, study, report, and model cleanup scripts. The Script wizard provides a convenient
means to perform the same script management tasks that you can perform from the SynerGEE ribbon bar or
the SynerGEE Script editor. For example, you can create new scripts, run existing scripts, and open a script
for editing in either Notepad or the SynerGEE script editor.
Refer to the following procedure for more information.

SynerGEE Electric 5.0

User Guide

730

Scripts

TO MANAGE SCRIPTS USING THE SCRIPT WIZARD

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Other Scripts group, next to Type, select the type of script that you want to work with in the
Script wizard.

Click Wizard. Use the options in the Script wizard to perform the following tasks:
To ...

Do This ...

Create a new script

Edit a script using Notepad

Edit a script using the

SynerGEE Script editor

In text box at the top of the Script wizard, type the name
of the script that you want to create.

Click New. The new script is added to the list of existing

scripts.

In the list of scripts in the Script wizard, select the name

of the script that you want to edit.

Click Notepad. The script opens in a Notepad window.

Use Notepad to manually edit the file, and then save
and close the file when you are done.

In the list of scripts in the Script wizard, select the name

of the script that you want to edit.

Click Editor. The script opens in SynerGEEs Script

editor.
For more information on using the Script editor, see
Using the Script Editor on page 725.

Run a script

In the list of scripts in the Script wizard, select the name

of the script that you want to run.

Click Run.

Click X to close the Script wizard.

RUNNING SCRIPTS
SynerGEE provides a number of methods to run scripts. The most common method is to use the controls in
the MACROS tab of the SynerGEE ribbon bar. You can also run scripts while using the SynerGEE Script
wizard. Recipe scripts can even be configured to run automatically after certain SynerGEE events, such as
loading a model or changing the model year.
Refer to the topics listed below for more information.

Running a script from the SynerGEE ribbon bar on page 731

Running a script from the Script wizard on page 731

Running recipe scripts automatically on page 731

User Guide

SynerGEE Electric 5.0

Scripts

731

Repeating the most recently run recipe script on page 732

Running a script from the SynerGEE ribbon bar

One of the most common methods of running scripts is to run the script from the controls in the SynerGEE
ribbon bar. Refer to the following procedure for more information.

TO RUN A SCRIPT FROM THE SYNERGEE RIBBON BAR

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the selected tab, locate the group for the script type that you want to run.
-

To run a recipe, use the Recipes group.

To run any other script type, use the Other Scripts group. Next to Type, select the type of
script that you want to run, such as Model Cleanup or Python.

Use the list of script names to select the name of the script that you want to run.

Click Run.

Running a script from the Script wizard

Many SynerGEE script files can be run from the Script wizard. Refer to the following procedure for more
information.

TO RUN A SCRIPT FROM THE SCRIPT WIZARD

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Other Scripts group, next to Type, select the type of script that you want to run.

Click Wizard.

In the list of scripts in the Script wizard, select the name of the script that you want to run.

Click Run.

Running recipe scripts automatically

Recipe scripts can be configured to run automatically at the following times:

Any time you manually load a model.

Any time you change the year in your SynerGEE model.

At a specified time interval when you are using SynerGEE.

Refer to the following procedure for more information.

SynerGEE Electric 5.0

User Guide

732

Scripts

TO CONFIGURE RECIPE SCRIPTS TO RUN AUTOMATICALLY

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Preferences.

In the Preferences editor, select Triggers. The following table describes the different tasks that you
can perform.
To ...
Run a recipe after a specific
type of event

Run a recipe at scheduled

intervals

Do This ...
a

Select the check boxes, as appropriate, next to the

following options:
-

After Model Load (manual only)

After Year Changes

Switch Open (manual only)

Switch Close (manual only)

Next to the appropriate Recipe option, select the name

of the recipe that you want to run.

Select Enable Automatic Recipe Runs.

Next to Recipe, select the name of the recipe that you

want to run.

Next to Run Every, specify the time interval to run the

selected recipe.

Select Prompt Before Running if you want SynerGEE

to prompt you before running the selected recipe. This
will give you the opportunity to cancel the recipe run, if
desired.

Click Run Now if you want to run the selected recipe

right away.

Click OK to accept your changes and close the editor.

Repeating the most recently run recipe script

Once you run a recipe script, you can repeat the script by clicking the Last Recipe button on the MACROS
tab of the SynerGEE ribbon bar. Refer to the following procedure for more information.

TO REPEAT THE MOST RECENTLY RUN RECIPE SCRIPT

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Rerun group, click Last Recipe.

User Guide

SynerGEE Electric 5.0

Scripts

733

VIEWING A SCRIPT SCHEMA

Refer to the following procedures for information on viewing a script schema directly in SynerGEE. Detailed
information for some schemas is provided in the appendices to this User Guide.

TO VIEW A SCRIPT SCHEMA

1

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, click Schemas and then Scripts, and then select the specific script type that you
want to view. The selected schema appears in a new SynerGEE window.
Refer to the following sections for detailed information on several of the SynerGEE script schemas:
-

Numerical Recipe Commands on page 855

Text-Based Recipe Commands on page 907

Model Cleanup Commands on page 1117

TO VIEW THE MODEL FORGE SCHEMA

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click the text label Forge and then select Schema. Detailed information
on the Model Forge schema is provided in Model Forge Commands on page 947.

PROCESS DIAGRAMS
Process diagrams provide a GUI-based approach to creating SynerGEE scripts. Process diagrams are
created in a flow-charting environment where you can add and connect the individual steps in a process,
such as running an analysis or performing model maintenance tasks. Process diagrams are not associated
with any specific model, so they can be easily run at any time with any model in memory.
Refer to the topics listed below for more information.

Opening the Process Diagram window on page 733

Managing process diagrams on page 734

Editing a process diagram on page 735

Saving a process diagram on page 737

Running a process on page 737

Opening the Process Diagram window

Perform the following procedure to open the Process Diagram window.

SynerGEE Electric 5.0

User Guide

734

Scripts

TO OPEN THE PROCESS DIAGRAM WINDOW

1

In the SynerGEE ribbon bar, select the MACROS tab.

In the Tools group, click Process Diagrams.

Managing process diagrams

Use the lists on the right side of the Process Diagram window to manage the process diagrams that you have
created. Each process diagram has two files associated with it, which are saved by default in your Scripts file
directory. The two files for each diagram are named <name>.pdd and <name>.pdl. For information on
locating and editing your Scripts file directory, see Defining file paths on page 167.
Each process diagram must be associated with a group, which you can also manage in the Process Diagram
window. A default group, named Group1, will be created automatically the first time you open the Process
Diagram window. You can rename this group and add additional groups, as required, but you must have at
least one group at all times. If you delete a group, any associated process diagrams will be deleted as well. If
you delete the last diagram in a group, the group will also be deleted.
Refer to the following procedure for more information on creating, renaming, and deleting both groups and
process diagrams.

TO MANAGE PROCESS DIAGRAMS

1

On the right side of the Process Diagram window, in the Groups area, perform the following tasks to
create, edit, and delete groups.
To ...
Create a new group

Rename a group

Delete a group

In the Groups area, click the New button.

Type the name of the new group and then press Enter.

In the Groups area, select the name of the group that

you want to rename.

Type a new name for the group and then press Enter.

In the Groups area, select the name of the group that

you want to delete.

Click the Delete button.

In the groups area, select the name of the group that you want to work with. Then, in the Diagrams
area, perform the following tasks to create, edit, and delete process diagrams.
To ...
Create a new process
diagram

User Guide

Do This ...

Do This ...
a

In the Diagrams area, click the New button.

Type the name of the new process diagram and then

press Enter.

SynerGEE Electric 5.0

Scripts

735

To ...

Do This ...

Rename a process diagram

Delete a process diagram

In the Diagrams area, select the name of the process

diagram that you want to rename.

Type a new name for the process diagram and then

press Enter.

In the Diagrams area, select the name of the process

diagram that you want to delete.

Click the Delete button.

Editing a process diagram

SynerGEEs process diagram tool is an open-ended scripting environment that cannot be summarized in any
one procedure. The following procedure describes a general process that you can follow when creating and
editing a process diagram. Links are provided to related topics that provide more detailed information on
each step in this process.

TO EDIT A PROCESS DIAGRAM

1

Use the TOOLS tab in the SynerGEE ribbon bar to add individual steps to your process diagram.
See Adding steps to a process diagram on page 735 for more information.

Use the commands on the bottom of the Process Diagram window to set up commands and
parameters for selected process steps. See Adding commands to a process step on page 736 for
more information.

Use the Properties editor to edit the appearance of selected process steps. See Editing the
appearance of a process diagram step on page 736 for more information.

Adding steps to a process diagram

To add steps to a process diagram, use the TOOLS tab in the SynerGEE ribbon bar to select the type of step
that you want to add, and then click the location in the Process Diagram window where you want to add the
step. You will need to manually move the process steps and connecting arrows in the Process Diagram
window to complete the connectivity of the process and to arrange the layout in the manner that you want.
Refer to the following procedure for more information.

TO ADD STEPS TO A PROCESS DIAGRAM

1

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Drawing group of the Tools tab, select the process step that you want to add to your diagram.

In the Process Diagram window, click in the location where you want to add the step.

Once placed, you will likely need to move the process step to align it with other steps. You will also
need to move the arrows in the process diagram to link steps together in the desired order. The
connecting arrows will be solid and bold when they are connected to a step; they will be dotted and
thin when they are not connected to a step.

SynerGEE Electric 5.0

User Guide

736

Scripts

Adding commands to a process step

Some process steps include associated commands, which are listed on the bottom of the Process Diagram
window when the process step is selected. Commands, like diagrams, are organized into groups, and these
commands help further define the process that you want to perform. You can activate multiple commands for
a single process step.
For example, if you add an Analysis step to a process diagram, you will need to specify which type of analysis
to perform. You will also need to specify whether or not you want to generate an analysis report. The Analysis
step, therefore, includes a Core group that allows you to select the analysis type you want to perform, such
as a load flow analysis or a fault analysis. Each analysis command includes a report parameter that you can
configure to generate or not generate a report after the analysis.
Refer to the following procedure for more information.

TO SET UP COMMANDS FOR A PROCESS STEP

1

In the Process Diagram window, select the process step that you want to edit.

In the bottom of the Process Diagram window, in the Command Groups area, select the different
command group names to see which commands are available for that step.

In the Commands area, double-click a command that you want to apply to the process step. The
command will be listed in the Script Commands area. Repeat this step to add additional commands
to the script, if desired.

Select each command in the Script Command area. If additional parameters are associated with the
script command, they will be listed in a grid in the lower-right area of the Process Diagram window.
Use the grid to set the appropriate value for each listed command parameter. Repeat this step to set
additional script command parameters, as applicable.

Editing the appearance of a process diagram step

Each process diagram step has a default appearance that defines the border color and font size for the step.
Perform the following procedure to edit these properties for a process step. Note that you can also use this
procedure to edit an arrow that connects one step to another.

TO EDIT THE APPEARANCE OF A PROCESS DIAGRAM STEP

1

In the Process Diagram window, double-click on the process step that you want to edit.

Use the Properties editor to edit the following settings.

User Guide

Symbol

Select a Fill color and Outline color for the process step.

Text Value

Type the text that you want to appear on the process step label.

Box

Select a Fill color and Outline color for the process step label.

Font

Select the Size and Color for the process step label.

Click OK to accept your changes and close the editor.

SynerGEE Electric 5.0

Scripts

737

Clearing all steps in a process diagram

Perform the following procedure to clear all steps in a process diagram. The only step that will remain is the
Start step, which is required and cannot be deleted.

TO CLEAR ALL STEPS IN A PROCESS DIAGRAM

1

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Operations group, click Clear.

Changing the background color of the Process Diagram

window
Perform the following procedure to change the background color of the Process Diagram window.

TO CHANGE THE BACKGROUND COLOR OF THE PROCESS DIAGRAM WINDOW

1

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Settings group, click Background.

Select the color that you want to apply to the background of the Process Diagram window.

Saving a process diagram

Perform the following procedure to save a process diagram.

TO SAVE A PROCESS DIAGRAM

1

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Operations group, click Save.

Running a process
Perform the following procedure to run the process that has been created by a process diagram.

TO RUN A PROCESS
1

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Operations group, click Run.

SynerGEE Electric 5.0

User Guide

738

User Guide

Scripts

SynerGEE Electric 5.0

CHAPTER

15
Tools, Calculators,
and Worksheets
SynerGEE provides a variety of specialized tools for performing calculations, evaluating your model, and
conducting focused analyses. Refer to the topics listed below for more information.

Publishing Export on page 739

Power Tool Applications on page 744

Regression on page 759

PowerCalc on page 761

Toolbox on page 763

Data Hammer on page 767

State Master on page 768

Demo Manager on page 769

Media Viewer on page 770

Library on page 770

SQL Dashboard on page 772

Running the Solver from Within SynerGEE on page 783

PUBLISHING EXPORT
The Publishing export provides a means of exporting your model image to a variety of vector image formats,
including the following:

AutoCAD DXF. DXF is a layered vector format developed by Autodesk, Inc. for use with its
AutoCAD drafting software. The DXF format is also supported for viewing by other applications,
including SynerGEE, due to its compatible design and flexibility. For more information on the DXF
format, visit www.autodesk.com.

SVG. The scalable vector graphics (SVG) format is XML-based image format, designed to be
portable across applications. Along with vector image components, it also supports internal scripting
for dynamic effects, such as the labels that automatically appear when you move the mouse over
items in a SynerGEE-generated SVG. The SVG format is maintained as a W3 Consortium

SynerGEE Electric 5.0

User Guide

740

Tools, Calculators, and Worksheets

recommendation (www.w3.org), and you can download a viewer from Adobe Systems, Inc. at
www.adobe.com/svg. For more information, see SVG output information on page 744.

Model Viewer. This output is a special database designed specifically for use with GL Noble
Dentons Model Viewer application. Model Viewer is an Internet Explorer-based viewing application
for models, intended to allow users to view the maps of models in customizable configurations. It
functions like a simplified version of the SynerGEE map, without the analytical capabilities of
SynerGEE. For more information, please contact GL Noble Denton.

KML. KML files can be imported and viewed in Google Earth. The KML file needs to contain section
IDs and the longitude and latitude coordinates, which the Publisher converts to a script. Google
Earth will read and import the script into its satellite mapping system.

Refer to the topics listed below for more information.

Setting Publishing export options on page 740

Running a Publishing export on page 742

Layer creation during a DXF Publishing export on page 742

SVG output information on page 744

Setting Publishing export options

TO SET PUBLISHING EXPORT OPTIONS
1

Perform the following steps to open the Publishing Options editor:

a

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Publish group, click the text label Publishing and then select Settings.

The options in the Publishing Options editor will change based on the type of file that you want to
export. Refer to the following table for specific information on setting up an export for each file type.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

741

Descriptions of each file type are provided in Publishing Export on page 739.
To Set Up ...
DXF

SVG

Model Viewer

SynerGEE Electric 5.0

Do This ...
a

Under Type, select DXF.

Next to Path, type the full path and name of the file you want
to export, or click the Browse button and navigate to the
desired directory and file.

Under Results, select up to three annotation categories to

include in the exported DXF file. The annotation takes the
form of a label that includes up to three lines, with each line
containing a results parameter that you specify here. Select
None to leave a category blank.

If desired, select the Output Every check box to place the

annotation labels at defined intervals along sections in the
exported DXF file. If this option is selected, then only section
results are exported; device results are not included. If this
option is not selected, then device results are included and
each section gets one results label, as designated in the
Results options described above.

If desired, select the Generate Equipment Symbols check

box to include equipment symbols in the exported DXF file.

Under Text, select whether to convert SynerGEE text labels

to AutoCAD or SVG labels and/or have labels generated for
conductor type names. You can also select size and rotation
attributes for these labels.

Under Type, select SVG.

Next to Path, type the full path and name of the file you want
to export, or click the Browse button and navigate to the
desired directory and file.

Under Type, select Model Viewer.

Next to Path, type the full path and name of the file you want
to export, or click the Browse button and navigate to the
desired directory and file.

Under Model Viewer Settings, enter a title that will be

saved with the Model Viewer file.

User Guide

742

Tools, Calculators, and Worksheets

To Set Up ...
KML

Do This ...
a

Under Type, select KML.

Next to Path, type the full path and name of the file you want
to export, or click the Browse button and navigate to the
desired directory and file.

Under KML Settings, next to Lat/Lon Source, select the

name of a SynerGEE DSA that contains the latitude and
longitude coordinates for your data.

Next to Table, specify the table in your SynerGEE data

source that includes the section IDs to export.

Click Apply to accept your changes, and then click X to close the editor.

Running a Publishing export

Perform the following procedure to run a Publishing export. The generated image file will show all currently
selected feeders, zoomed to the bounds of the image. The current zoom of the SynerGEE map is not
considered.

TO RUN A PUBLISHING EXPORT

1

If you have not already done so, use the Publishing Options editor to configure options properly
configure the file you want to export. For more information, see Setting Publishing export options
on page 740.

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Publish group, click the Publishing icon.

Layer creation during a DXF Publishing export

Note:

This feature is only available with the Publishing license.

When you use the Publishing wizard to export a map to the DXF format, SynerGEE automatically separates
your model into layers during the export. This layering scheme cannot be altered within SynerGEE.

Nodes and vertices

During export, a separate layer is created for:

Nodes

Vertices

Equipment
A separate layer is created for each of the following device types:

User Guide

Switches

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

Capacitors

Regulators

Fuses

Reclosers

Sectionalizers

Breakers

Motors

Generators

Transformers

743

Each device type gets its own layer, regardless of feeder. In other words, all switches from all feeders will go
on one layer, all regulators on another, and so on. Equipment layers are usually named with the DEV prefix,
followed by the equipment type. For example, the switch layer is named DEV_SWITCHES. Results, labels,
and conductors go on separate layers.

Sections
Sections are placed on different layers according to configuration type. During the export, SynerGEE
recognizes the following six configurations, and creates six layers per feeder for each, as applicable:
Configuration

Abbreviation

Three-phase overhead

O3

Two-phase overhead

O2

Single-phase overhead

O1

Three-phase underground

U3

Two-phase underground

U2

Single-phase underground

U1

Afterwards, these layers are named according to the following convention, using the feeder ID and the
abbreviation as a suffix:
FeederID_ConfigAbbreviation

For example, the following suffix is for overhead two-phase sections for a feeder with the ID Fairfield:
Fairfield_O2

Likewise, the following suffix is for underground single-phase sections for a feeder with the ID FDR_011:
FDR_011_U1

Because AutoCAD allows a maximum of 31 characters for a layer name, your feeder ID will be truncated at
28 characters if necessary, to leave room for the three-character suffix. If you have two feeders with identical

SynerGEE Electric 5.0

User Guide

744

Tools, Calculators, and Worksheets

characters through the first 28 characters of the IDs, their configurations will be placed on the same layers.
This is, however, an unlikely occurrence.
Line styles and colors are set to default values by SynerGEE during the export. Afterward, you may change
colors and line styles using AutoCAD.

SVG output information

Through Publishing Export, you can export a map to the SVG image format. SVG is well-suited for an
external representation of the map display because it is:

Non-proprietary. The SVG standard is maintained by the W3 Consortium (www.w3.org) and has no
corporate copyright.

XML-based. Because it is an XML file, it is easily extensible by GL Noble Denton or the end user,
and can be modified or managed through automation technologies such as XSLT. Also, it can be
directly edited in any text editor.

Vector-based. Unlike raster image formats such as BMP, a vector file is normally much smaller in
size, yet the image itself is crisp in detail at any zoom level.

Scripting-enabled. The SVG format supports a certain level of scripting for dynamic effects. For
example, in a SynerGEE-generated SVG, you can hover the mouse over a device or section to see
the ID appear in the lower corner.

POWER TOOL APPLICATIONS

SynerGEE includes a series of miscellaneous calculation, analysis, and reporting applications, known
collectively as the power tools. These useful tools can help you understand certain detailed aspects of your
model and configure it accurately.
Use the Power Tools Options editor to select the specific power tool that you want to run. Some power tools
contain additional settings, which are enabled when you select the power tool name. These options are
described with the individual power tool sections that are listed at the end of this topic. Once you have
selected a power tool application and set up any options, if required, you can run the power tool application
from the ANALYSIS tab in the SynerGEE ribbon bar.
The power tool applications run on the feeders in memory that are currently selected. For more information
on feeder selection, see Selecting Feeders on page 157.

TO SELECT A POWER TOOL APPLICATION TO RUN

1

Perform the following steps to open the Power Tools Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Power Tools and then select Settings.

In the Power Tools Options editor, under Tool, select the power tool application that you want to run.
If required, set additional options as described in the sections that are listed at the end of this topic.

Click Apply to accept your changes, and then click X to close the editor.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

745

TO RUN A POWER TOOL APPLICATION

1

In the SynerGEE ribbon bar, click the ANALYSIS tab.

In the Applications group, click the Power Tools icon.

FOR MORE INFORMATION

Refer to the topics listed below for more information.

Regulator Setting power tool on page 745

I,Z,PQ Calibration power tool on page 748

Capacitor Flicker Report power tool on page 753

Ten-Year Growth Report power tool on page 755

Insert Tie Switches power tool on page 756

Node Overlap Report power tool on page 757

Regulator Setting power tool

Using the regulator voltage setting and the minimum downstream voltage as input, the Regulator Setting
power tool attempts to find R and X settings for the regulator that will keep the lowest voltage downstream
above the specified minimum.
Peak load conditions are used to determine the regulator R and X settings, and these conditions are
reported. In addition, minimum load conditions are evaluated and reported with the regulator set up with the
proposed settings.
The Regulator Settings power tool evaluates one regulator at a time. The regulator must be connected in a
Wye-gnd connection. First house, tap limiter, gang operation, and reverse flow settings are disabled.
Refer to the topics listed below for more information.

Setting up the Regulator Setting power tool on page 745

Performing a Regulator Setting analysis on page 746

Regulator Setting power tool examples on page 747

Setting up the Regulator Setting power tool

Perform the following procedure to set up a Regulator Setting analysis.

TO SET UP THE REGULATOR SETTING POWER TOOL

1

Perform the following steps to open the Power Tools Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Power Tools and then select Settings.

In the Power Tools Options editor, under Tool, select Regulator Setting.

SynerGEE Electric 5.0

User Guide

746

Tools, Calculators, and Worksheets

3

Select either or both of the following options as appropriate:

-

Minimum Downstream Voltage. Specify the minimum downstream voltage that you want
the regulator to allow.

Regulator V Setting. Specify the regulator set point.

Use Customer Load Curves. Select this check box to have SynerGEE consider load
curves as assigned by customer zone. When this option is selected, the peak and
minimum load times are found and used in Regulator Setting analysis. For more
information on customer load curves, see Customer Load Curves/Time-of-Day Analysis
on page 808.

Minimum Load. If you do not select the Use Customer Load Curves check box, feeder
load can be used directly. In this case, specify a factor (such as 20%) that will be used to
multiply the loads to get minimum loading on the feeder.

Click Apply to accept your changes, and then click X to close the editor.

Performing a Regulator Setting analysis

Perform the following procedure to run a Regulator Setting analysis. During the analysis, the Regulator
Setting power tool will perform the following steps.
1

Determine R/X ratio.

At peak load, find R and X values.

Evaluate regulator at peak load and minimum load.

The R/X ratio is determined from a weighted average of downstream section impedances, as follows:

R / X =

I j , R j

I j , X j

j = Downstream

j = Downstream

Eq 151

The factor is weighted by the current flow through the downstream line. Long sections are going to be
weighted higher. Sections with a larger current flow are going to be weighted higher.
The R/X ratio is not listed in the report that is produced by the Regulator Setting analysis. However, the ratio
between the R setting and the X setting is the same as the R/X ratio.
The Regulator Setting power tool runs on the feeders in memory that are currently selected. For more
information on feeder selection, see Selecting Feeders on page 157.

TO PERFORM A REGULATOR SETTING ANALYSIS

1

Make sure you have set up the Power Tool Options editor to perform a Regulator Setting analysis,
as described in Setting up the Regulator Setting power tool on page 745.

In the SynerGEE ribbon bar, click the ANALYSIS tab.

In the Applications group, click the Power Tools icon.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

747

Regulator Setting power tool examples

Example 1
The following is a report from a sample run:

Regulator setting sample report

The voltage setting, R and X settings, and bandwidth are listed at the top of the report. The voltage setting is
a reflection of the user input. The bandwidth is always 2V. Keep in mind that the settings are always in volts
on a 120V base.
The next section of the report lists the results for the regulator and feeder under peak load conditions, as
follows.

The expected taps are given. Vrr is the voltage on the regulating relay within the regulators
controller.

Vrr =

1000 kVout I out

Z RX
PT
CT

Eq 152

The voltage of the regulating relay is used to determine if a tap change is needed. If the voltage is
more than one-half the bandwidth away from the voltage setting, a tap change will occur. The
voltage is included on the reports so the effects of the R and X settings can be seen. For more
information on voltage regulators, see Regulators on page 383.

The minimum and maximum downstream volts are determined by looking at all line sections
downstream from the regulator. Sections fed by the regulator under study and a second regulator
are not considered.

The regulator output volts and amps are listed to help with the evaluation of first house settings and
tap limiter values.

The same results are then listed for minimum feeder loading.

SynerGEE Electric 5.0

User Guide

748

Tools, Calculators, and Worksheets

Example 2
In the previous example, the voltage setting was 120V. If the voltage setting were 122V, you would expect
that the tap positions under peak load would not change because the regulator needs to be at the same tap
to meet the minimum voltage constraint. The following is a report from another sample run, with the 122V
setting:

Sample report, using the 122V voltage setting

The R and X settings are different because the voltage setting is different. Notice that the peak load tap
settings are the same. The minimum and maximum downstream voltages at peak are also the same.
The minimum load values are very different. The regulator taps are higher and the downstream voltages are
higher with the 122V setting. Comparing the two examples, therefore, you might decide that the low regulator
voltage setting is better. As with this situation, multiple runs of the regulator settings tool may often be needed
to get a good picture of the possible settings.

I,Z,PQ Calibration power tool

Loads in SynerGEE are modeled with constant impedance, constant current, and constant power
components. As such, I,Z,PQ Calibration is a calculation tool designed to help you find the appropriate
percentages of these components, depending on the load you are modeling. Realistic percentages of load
components contribute to the accuracy of your models and the reliability of analyses.
The I,Z,PQ Calibration power tool also simplifies the process of modeling complex loads. It can aid in finding
basic values for constant current and constant impedance loads to make the metered demands versus
feeder voltage response more realistic.
Refer to the topics listed below for more information.

Power mathematics and I,Z,PQ on page 749

Using the calibrator on page 749

I,Z,PQ Calibration power tool operation on page 752

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

Setting up the I,Z,PQ Calibration power tool on page 753

Performing an I,Z,PQ Calibration analysis on page 753

749

Power mathematics and I,Z,PQ

As described in Loads and Load Analyses on page 493, the actual kW and kvar load at a load point is
expressed with:
2

kV
kV
S Actual = k PQ S Nom + k I
S Nom + k Z
S Nom
kVNom
kVNom
S Nom = Nominal Voltage

Eq 153

k PQ + k I + k Z = 1
From this equation, you can see that as the feeder voltage drops:

The nominal part of the load modeled as constant PQ does not change. However, since the feeder
voltages are down, line current increases and losses increase somewhat. The net result is that
power into the feeder goes up or remains virtually the same.

The part of the load modeled as constant current goes down proportionally with the voltage. The
load current does not change. The result is that power into the feeder goes down.

The part of the load modeled as constant impedance drops and load current goes down. Power into
the feeder goes down significantly.

Therefore, you can see that a change in voltage has a significant impact on feeder loading. If you have a
feeder with loads modeled as constant power, you can try the following to demonstrate this:
1

Run a load-flow and record the power into the feeder.

Reduce the feeder voltage by a volt and run load-flow again.

Compare the two values of power.

The power into the feeder with the reduced voltage should have gone down (you may need to turn off or lock
regulators). Distribution systems with residential and commercial loading should have a demand reduction
with a drop in feeder voltage.
The I,Z,PQ Calculation power tool changes the load model on the feeder loads. Different values for the
percentage constant current, constant impedance, and constant power are used. All loads use the same load
model.

Using the calibrator

Running the I,Z,PQ Calculation power tool on a feeder results in a graph like the following.

SynerGEE Electric 5.0

User Guide

750

Tools, Calculators, and Worksheets

Graph produced by the I,Z,PQ calibrator

The graph shows lines for four values of constant PQ. Curves for other PQ values can be found by
interpolating the graph. To use the graph, find the desired %kW / %V value on the Y axis. Move across
until a line is intersected. The line intersected represents the percent constant PQ value. Next, move down
from the intersection point to find the percent constant Z value.
For example, if the %kW / %V value is 1.1, you could use PQ = 0%, Z=15%, I=85%. Or, you could also
use PQ=20%, Z=30%, I=50%. Likewise, PQ=40%, Z=55%, I=5% also works. Smaller values of %PQ are
recommended.

Calculating Delta %kW / Delta %V

To use the graphs, an accurate measurement of %kW / %V is important. To find this value, the best
approach is to measure feeder load before and after an LTC tap change. For example:

Before tap change:

-

Volts: 12.886 kV

kW: 5760 kW

After tap change:

-

Volts: 12.782 kV

kW: 5724 kW

If there are downstream voltage regulators, it is important to make the readings quickly after the LTC tap
change. The goal is to see the impact of the voltage change on loads, so the readings need to be made
before downstream voltage regulators can respond.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

751

From the data, %kW can be calculated as:

5760 5724
100%
5760
= 0.625%

Eq 154

12886 12782
100%
12886
= 0.807%

Eq 155

%kW =

%V can also be calculated as:

%V =

...which allows the calculation of %kW / %V as:

%kW

%V

0.625
= 0.77
0.807

Eq 156

Using the calculated Delta %kW / Delta %V

Once you have the %kW / %V, you can use the graph (assuming it was generated from a valid model of
the actual feeder) to determine load model values. As an example, consider the following chart and assume a
%PQ of 40.

Sample graph, showing the usage of Delta %kW/Delta %V

SynerGEE Electric 5.0

User Guide

752

Tools, Calculators, and Worksheets

The resulting values are as follows.

PQ = 40%
Z = 15%

Eq 157

I = 100% 40% 15% = 45%

As another example, you could interpolate a 35% PQ curve:

Sample graph, interpolating a %PQ of 35

... and get the following values:

PQ = 35%
Z = 8%

Eq 158

I = 100% 35% 8% = 57%

I,Z,PQ Calibration power tool operation

The graphs generated by the I,Z,PQ Calibration power tool are produced by adding and subtracting a very
small change to the voltage, running a load-flow, and calculating the impact on the kW. The change is then
added and the load-flow process is repeated. Three values for %kW / %V are found from this data. The
values are averaged and used on the chart.
The tool uses the following steps.
1

Set all load model I,Z,PQ values based on %PQ line and %Z axis value.

Calculate %kW / %V for the feeder.

Plot the values.

The I,Z,PQ Calibration power tool has provisions to ignore spot loads and to ignore customer class-based
I,Z,PQ values. If either of these selections is made, the load model I,Z,PQ values remain as they are set up in

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

753

the spot load or customer class, and are not changed to the values used to generate the chart. Care should
be taken to not replace these load models if the Multiple Editor is used to globally change load model I,Z,PQ
values.

Setting up the I,Z,PQ Calibration power tool

Perform the following procedure to set up an I,Z,PQ Calibration analysis.

TO SET UP THE I,Z,PQ CALIBRATION POWER TOOL

1

Perform the following steps to open the Power Tools Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Power Tools and then select Settings.

In the Power Tools Options editor, under Tool, select I,Z,PQ Calibration.

Select either or both of the following options as appropriate:

Do Not Calibrate Spot Loads. Select this option to calibrate distributed loads only.

Ignore Customer Class I,Z,PQ. Select this option to disregard I,Z,PQ values assigned to
customer classes. For more information on I,Z,PQ and customer classes, see Load %I,
%Z, %PQ on page 496.

Click Apply to accept your changes, and then click X to close the editor.

Performing an I,Z,PQ Calibration analysis

Perform the following procedure to run an I,Z,PQ Calibration analysis. The I,ZX,PQ Calibration power tool
runs on the feeders in memory that are currently selected. For more information on feeder selection, see
Selecting Feeders on page 157.

TO PERFORM AN I,Z,PQ CALIBRATION ANALYSIS

1

Make sure you have set up the Power Tool Options editor to perform an I,Z,PQ Calibration analysis,
as described in Setting up the I,Z,PQ Calibration power tool on page 753.

In the SynerGEE ribbon bar, click the ANALYSIS tab.

In the Applications group, click the Power Tools icon.

Capacitor Flicker Report power tool

The Capacitor Flicker Report details the momentary voltage effects that discharged capacitors will have if
and when they are switched on. For each capacitor in the selected feeders, SynerGEE sets the capacitor as
off, records current voltage levels, and then switches the capacitor on to evaluate the momentary fluctuation
in voltage. These fluctuations are evaluated capacitor-by-capacitor and then presented individually in the
report.

SynerGEE Electric 5.0

User Guide

754

Tools, Calculators, and Worksheets

Capacitor flicker report

The report shows two percentages for each capacitor. The first percentage, Flicker, represents the flicker at
the capacitor. The second percentage, Max Flicker, represents the maximum flicker on any section
throughout selected feeders. The calculation of flicker is a simple percentage based on before/after voltages,
as follows:

% Flicker =

VCapOff VCapOn
VCapOff

100

Eq 159

The analysis calculates the potential flicker for all capacitors in selected feeders. No distinction is made
between switched/fixed or currently on/off capacitors.
Refer to the topics listed below for more information.

Setting up the Capacitor Flicker Report power tool on page 754

Generating a Capacitor Flicker Report on page 754

Setting up the Capacitor Flicker Report power tool

Perform the following procedure to set up the Capacitor Flicker Report.

TO SET UP THE CAPACITOR FLICKER REPORT POWER TOOL

1

Perform the following steps to open the Power Tools Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Power Tools and then select Settings.

In the Power Tools Options editor, under Tool, select Cap. Flicker Report.

Click Apply to accept your changes, and then click X to close the editor.

Generating a Capacitor Flicker Report

Perform the following procedure to generate a Capacitor Flicker Report. The Capacitor Flicker Report power
tool runs on the feeders in memory that are currently selected. For more information on feeder selection, see
Selecting Feeders on page 157.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

755

TO GENERATE A CAPACITOR FLICKER REPORT

1

Make sure you have set up the Power Tool Options editor to generate a Capacitor Flicker Report, as
described in Setting up the Capacitor Flicker Report power tool on page 754.

In the SynerGEE ribbon bar, click the ANALYSIS tab.

In the Applications group, click the Power Tools icon.

Ten-Year Growth Report power tool

The Ten-Year Growth Report power tool analyzes your model and summarizes the year-by-year impact of
ten years of growth. The analysis results in a report listing demands, low voltage, and maximum loading
values for each feeder over a ten-year period.

Ten year growth study report

The Ten-Year Growth Report power tool uses customer zone or section growth rates, as set up in the Growth
Options editor (as described in Enabling load growth rates on page 802).
Refer to the topics listed below for more information.

Setting up the Ten-Year Growth Report power tool on page 755

Generating a Ten-Year Growth Report on page 756

Setting up the Ten-Year Growth Report power tool

Perform the following procedure to set up the Ten-Year Growth Report.

TO SET UP THE TEN-YEAR GROWTH REPORT POWER TOOL

1

Perform the following steps to open the Power Tools Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Power Tools and then select Settings.

In the Power Tools Options editor, under Tool, select Ten-year Growth Report.

SynerGEE Electric 5.0

User Guide

756

Tools, Calculators, and Worksheets

3

Click Apply to accept your changes, and then click X to close the editor.

Generating a Ten-Year Growth Report

Perform the following procedure to generate a Ten-Year Growth Report. The Ten-Year Growth Report power
tool runs on the feeders in memory that are currently selected. For more information on feeder selection, see
Selecting Feeders on page 157.

TO GENERATE A TEN-YEAR GROWTH REPORT

1

Make sure you have set up the Power Tool Options editor to generate a Ten-Year Growth Report,
as described in Setting up the Ten-Year Growth Report power tool on page 755.

In the SynerGEE ribbon bar, click the ANALYSIS tab.

In the Applications group, click the Power Tools icon.

Insert Tie Switches power tool

The Insert Tie Switches power tool provides an automated means of detecting loops and wandering laterals
in the model, and adding tie switches to break connectivity for topological purposes. These tie switches
function identically to any manually modeled tie switch. For more information on tie switches and loops, see
Loop tie switches on page 255.
When the Insert Tie Switches power tool runs, it performs the following actions:
1

Removes all tie switches inserted by a previous run of this power tool. These switches are identified
by their TSIA_ prefixes.

Removes all established internal breaks. For more information on the purpose of internal breaks,
see Analysis considerations for loops and wandering laterals on page 256.

Inserts open tie switches to break all loops. Generally, the switches are placed wherever internal
breaks would normally be established, if you analyzed the model without tie switches.

The Insert Tie Switches power tool can be useful for preparing a looped model for non-loop-supporting
analyses. It is important to note, however, that its usefulness may decrease as looped configurations become
more complex. If you attempt to run the tool on a model with detailed, nested loops and/or densely meshed
configurations, the results may be unpredictable and perhaps undesirable. Always be sure to thoroughly test
the revised model before committing it as your production model.
Refer to the topics listed below for more information.

Setting up the Insert Tie Switches power tool on page 756

Performing an Insert Tie Switches analysis on page 757

Setting up the Insert Tie Switches power tool

Perform the following procedure to set up the Insert Tie Switches power tool.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

757

TO SET UP THE INSERT TIE SWITCHES POWER TOOL

1

Perform the following steps to open the Power Tools Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Power Tools and then select Settings.

In the Power Tools Options editor, under Tool, select Insert Tie Switches.

Click Apply to accept your changes, and then click X to close the editor.

Performing an Insert Tie Switches analysis

Perform the following procedure to run the Insert Tie Switches power tool. The Insert Tie Switches power tool
runs on the feeders in memory that are currently selected. For more information on feeder selection, see
Selecting Feeders on page 157.

TO PERFORM AN INSERT TIE SWITCHES ANALYSIS

1

Make sure you have set up the Power Tool Options editor to perform an Insert Tie Switches
analysis, as described in Setting up the Insert Tie Switches power tool on page 756.

In the SynerGEE ribbon bar, click the ANALYSIS tab.

In the Applications group, click the Power Tools icon.

Node Overlap Report power tool

The Node Overlap Report power tool scans your model and reports on any nodes that are within five feet of
each other. It is designed to help you find node-related connectivity errors in model data. By searching for
nodes within such a close proximity, the tool can help find problems in GIS-extracted data. If two nodes are
very close and one is unfed, there may be a connectivity problem in the data, with roots in the GIS extraction.

Node overlap report, showing nodes within five feet of each other

The following is a map image representing the area circled in the previous report:

SynerGEE Electric 5.0

User Guide

758

Tools, Calculators, and Worksheets

Map of overlapped nodes listed in the report

In this example, the nodes, which represent cable terminations, are probably correctly placed in the model,
and no connectivity corrections need to be made.
However, here is an example of an area exposed by the report that may represent a connectivity problem.

Proximal nodes representing a connectivity problem

Two nodes are very close and an open switch is tied to one. Operating the switch has no effect. A single node
should probably replace the two nodes. This would connect the sections and allow proper modeling of the
switch.
Refer to the topics listed below for more information.

Setting up the Node Overlap Report power tool on page 758

Generating a Node Overlap Report on page 759

Setting up the Node Overlap Report power tool

Perform the following procedure to set up the Node Overlap Report.

TO SET UP THE NODE OVERLAP REPORT POWER TOOL

1

User Guide

Perform the following steps to open the Power Tools Options editor:
a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Power Tools and then select Settings.

In the Power Tools Options editor, under Tool, select Node Overlap Report.

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

3

759

Click Apply to accept your changes, and then click X to close the editor.

Generating a Node Overlap Report

Perform the following procedure to generate a Node Overlap Report. The Node Overlap Report power tool
runs on the feeders in memory that are currently selected. For more information on feeder selection, see
Selecting Feeders on page 157.

TO GENERATE A NODE OVERLAP REPORT

1

Make sure you have set up the Power Tool Options editor to generate a Node Overlap Report, as
described in Setting up the Ten-Year Growth Report power tool on page 755.

In the SynerGEE ribbon bar, click the ANALYSIS tab.

In the Applications group, click the Power Tools icon.

REGRESSION
Regression is a tool for making specific topological and analytical comparisons between two models. You can
compare any two models, and even use recipes to do it automatically.
To use regression, you must first create regression files from the active models that you wish to compare.
Then, the actual comparison is performed on the regression files, producing a report of key differences in
topology and analysis results.
Regression is useful for examining key differences between two different models, especially if a full data
comparison is not warranted. In particular, if you regularly update your models from a GIS or other data
source, regression can help pinpoint differences between updates, including analytical changes.
Refer to the topics listed below for more information.

General steps for using regression on page 759

Creating a regression file on page 760

Deleting a regression file on page 760

Comparing two regression files on page 760

General steps for using regression

To use regression, you should follow the general steps listed below. Take note that these steps illustrate a
general start-to-finish process only.
1

Load the first model for comparison, and run any applicable analyses necessary to populate results.
Tip:

Regression can compare load-flow, fault, and reliability results. A lack of results prior to
comparison will not prevent you from running regression, but you will not be able to
compare those specific items.

Create a regression file for the first model. For more information, see Creating a regression file on
page 760.

SynerGEE Electric 5.0

User Guide

760

Tools, Calculators, and Worksheets

3

Close the model and load the second for comparison.

Again, run any analyses as applicable.

Create a regression file for the second model.

Compare the two regression files. For more information, see Comparing two regression files on
page 760.

Because regression compares two files, and not data in memory, you can create the regression files at any
time, and likewise compare them at any time in the future. For example, you may want to create one or more
regression files and store them as a baseline representation of your model, to which you can repeatedly
compare newer or updated versions of the model.

Creating a regression file

Perform the following procedure to create a regression file.

TO CREATE A REGRESSION FILE

1

In the SynerGEE ribbon bar, click the MODEL tab.

In the Model group, click Regression and then select Save.

In the Regression Create editor, type the name of the regression file that you want to create, and
enter an optional note, if desired.

Click Create to create the regression file and close the editor.

Deleting a regression file

Perform the following procedure to delete a regression file.

TO DELETE A REGRESSION FILE

1

In the SynerGEE ribbon bar, click the MODEL tab.

In the Model group, click Regression and then select Save.

In the Regression Create editor, select the name of the regression file that you want to delete.

Click Delete.

Click X to close the editor.

Comparing two regression files

Perform the following procedure to compare two regression files.

TO COMPARE TWO REGRESSION FILES

1

In the SynerGEE ribbon bar, click the MODEL tab.

In the Model group, click Regression and then select Compare.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

761

In the Regression Compare editor, press and hold the Ctrl key on the keyboard and select the
names of the two regression files that you want to compare.

Click Compare.

POWERCALC
PowerCalc is a general-purpose engineering calculator built into SynerGEE that can perform a variety of
calculations geared toward electrical theory. In particular, PowerCalc provides the following features:

Basic conversion utilities such as rectangular to polar, and trigonometric functions such as sin and
cos

Support for imaginary numbers with all functions

Step-by-step stack-based operation similar to advanced scientific calculators

Ability to load and save calculation scripts

With its ability to load and save scripts, you may find PowerCalc to be a convenient means of conveying
mathematical information between peers or between your organization and GL Noble Denton.
Refer to the topics listed below for more information.

Starting PowerCalc on page 761

Understanding PowerCalc on page 761

Available PowerCalc functions on page 763

Loading and saving calculation scripts on page 763

Starting PowerCalc
Perform the following procedure to start the PowerCalc application.

TO START POWERCALC
1

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Calculators group, click the PowerCalc icon.

Understanding PowerCalc
PowerCalc operates with a stack-based concept, where you specify a series of arguments that act
progressively on the active stack at their respective moments. After you specify arguments in the Entries area
of the PowerCalc window, you can move the insertion point up and down your list of arguments and watch the
stack change in the Stack area with each step. In this way, calculations are never a single, absolute action.
Rather, they are like a script that you can step into at any point to see the precise calculations at that moment.
As a simple example, consider the following calculation script, which you can enter in the Entries area of the
PowerCalc window:

SynerGEE Electric 5.0

User Guide

762

Tools, Calculators, and Worksheets

3
4
+

If you place the cursor on the second line in the Entries area (4), the stack would show the following:
3

That is, the first argument was processed, which specified simply to place 3 on the stack. When you place
the cursor on the third line in the Entries area (+), the stack would show the following:
3
4

If you place the cursor after the third line, the stack would show the following:
7

This is because the third argument, +, specifies that the previous two items on the stack should be added
and the result displayed in their place. In this way, you can see that the + argument operated on the stack,
and is not intrinsically related to the first two arguments, other than the fact that they provided numbers for the
stack on which + operated.

Sample PowerCalc screen

The PowerCalc script is color-coded and automatically formatted according to the data entered.

Constants such as e or pi will appear as lowercase and in green.

Mathematical symbols (+ and =) will appear in red.

Keywords such as logarithms and exponents will appear in blue and in all caps.

To learn about PowerCalc, you may find it helpful to experiment with the sample calculation script, which is
named Sample power calculation.spc. You can find the sample PowerCalc script in your Calcs file directory.
See Loading and saving calculation scripts on page 763 for information on how to load this script. For

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

763

information on viewing or editing the location of the Calcs file directory, see Defining file paths on page 167.

Available PowerCalc functions

A complete list of functions that can be used in PowerCalc is provided in the bottom of the PowerCalc editor.
Select a command group on the left side of the editor and then double-click the command that you want to
insert on the right side of the editor. The command will be inserted at the insertion point.
You can also add comments to your script by preceding the comment with an apostrophe ( ' ). Generally, you
should put comments on their own lines.
A complete list of PowerCalc functions can be viewed by selecting the TOOLS tab in the SynerGEE ribbon
bar, clicking the PowerCalc text label, and then selecting Functions.

Loading and saving calculation scripts

Use the Load and Save buttons in the PowerCalc editor to load and save your calculation scripts. You can
also click the Clear button to remove the current script from the editor.

TOOLBOX
The toolbox provides a group of tools that allow you to focus on specific aspects of your model and their
effect on the model as a whole. For example, one particular tool, the Capacitor manager, provides an overall
view of your capacitors and general model parameters. With this tool, you can make quick changes to the
capacitors and run a load-flow analysis to watch the general effect on the model. Another tool, the Switch
manager, performs a similar function with switches. You can find the toolbox tools in the Toolbox tab of the
model explorer.
The toolbox is designed to allow quick, focused changes to your model with a clear view of the general effect.
It is not designed for detailed studies or complex data edits.
Refer to the topics listed below for more information.

Switch Manager on page 763

Feeder Overview on page 764

Capacitor Manager on page 765

Load Center Manager on page 765

Switch Manager
The Switch Manager allows you to see certain switch pairs in the selected feeders as well as general
information about the feeders, such as connected kVA, power factor, and low volts. Using the Switch
Manager, you can toggle the status of any switch pair and run a quick load-flow analysis to see the results.
Only switches that can transfer load from one selected feeder to another are listed. Therefore, you must have
more than one feeder selected for the tool to have value.

SynerGEE Electric 5.0

User Guide

764

Tools, Calculators, and Worksheets

To access the Switch Manager, select the Toolbox tab on the model explorer and then select Switch Manager
from the Tool options menu. Two tables will display in the Toolbox tab:

Switch Pairs. The Switch Pairs table displays a list of all switch pairs in the selected feeders.

Feeders. The Feeders table displays a list of all selected feeders.

The following options are associated with the Switch Pairs table in the Switch Manager. Note that you can
use the Shift and Ctrl keys to select multiple switch pairs, if desired.

Only Show Transfer Switches. Select this check box to only show transfer switches in the Switch
Pairs table.

Load-Flow. Click this button to run a load-flow analysis. No report is generated. However, results
can be seen in the Feeders list or through map annotations.

Toggle. Click this button to toggle the open/closed status of the switch pair that is selected in the
Switch Pair list.

Highlight. Click this button to add the sections between the selected switches to the query set, and
also highlight those sections in the SynerGEE map display.

Clear Highlight. Click this button to clear the query set. You must clear one highlight before you can
enable another.

Zoom. Click this button to zoom the map display to the section that contains the first switch in the
selected switch pair.

You can also double-click any feeder in the Feeders list to produce the Feeder editor.

Feeder Overview
The Feeder Overview provides a tree list that gives general, balanced information about selected feeders,
including minimum and maximum voltages, maximum loading, and some basic equipment information. The
Feeder Overview is designed to give you an overall view of your feeders and provide quick access to some
basic editing functions.
To access the Feeder Overview, select the Toolbox tab on the model explorer and then select Feeder
Overview from the Tool options menu. The following options are available in the Feeder Overview:

Load-Flow. Click this button to run a load-flow analysis. No report is generated. However, results
can be seen in the Feeder Diagnostics list or through map annotations.

Edit. Click this button to open the editor for the item selected in the Feeder Diagnostics list. If the
item selected is a parameter, such as Min. Volts, SynerGEE opens the editor for the section or
device that is producing that parameter. You can also double-click a feeder to open the Feeder
editor.

Zoom. Click this button to zoom the map display to the selected item. If the item selected is a
parameter, such as Min. Volts, SynerGEE zooms to the section or device that is producing that
parameter.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

765

Capacitor Manager
The Capacitor Manager displays all capacitors in the selected feeders as well as general information about
the feeders, such as connected kVA, power factor, and low volts. Using the Capacitor Manager, you can
toggle the on/off status of any capacitor and run a quick load-flow analysis to see the results.
To access the Capacitor Manager, select the Toolbox tab on the model explorer and then select Capacitor
Manager from the Tool options menu. Two tables will display in the Toolbox tab:

Capacitors. The Capacitors list displays a list of all capacitors in the selected feeders.

Feeders. The Feeders list displays a list of all selected feeders.

The following options are available in the Capacitor Manager:

Load-Flow. Click this button to run a load-flow analysis. No report is generated. However, results
can be seen in the Feeders list or through map annotations.

Toggle. Click this button to toggle the on/off status of the capacitor that is selected in the Capacitors
list.

Edit. Click this button to open the editor for the selected capacitor. You can also double-click a
capacitor to open the editor, or double-click a feeder in the Feeders list to open the Feeder editor.

Zoom. Click this button to zoom the map display to the section that contains the capacitor.

Load Center Manager

The Load Center Manager allows you to pinpoint an area of your map and determine the amount of load
within that area. This is an excellent means to determine the placement of a substation or feeder.
To access the Load Center Manager, select the Toolbox tab on the model explorer and then select Load
Center Manager from the Tool options menu. Three tables will display in the Toolbox tab:

Feeders. The Feeders table includes all feeder(s) that are featured on the map. If a feeder is
affected by a load center, then the kW, customer, and miles values will change both in the Feeder
window and the Load Center window. Feeder values decrease when sections from that feeder are
included in a load center. If a load center is moved or decreased in radius, then the Feeder window
will reflect these changes, most likely by increasing, according to the action.

Load Centers. The Load Center table displays the name of the load center(s) you created as well
as the kW, customer, and mile values. These values increase or decrease depending on the location
and radius of your load center. This window also contains all of the commands you need to create
and manipulate your load centers.

Substations. The Substations table operates much in the same way as the Feeders table. In this
table, substation values are affected by the placement and size of a load center.

The following options are available in the Load Center Manager:

Include these load types. Select the appropriate check boxes to include Spot, Distributed, Large
Customer, and Project loads in the load center. The load types that you include or exclude will affect
the kW and customer values in the Feeder, Load Center, and Substation tables. Note that you may
need to resize the model explorer area to see all of the load type check boxes.

SynerGEE Electric 5.0

User Guide

766

Tools, Calculators, and Worksheets

Save. Click this button to save the details of the load center(s) you have created, including the
name, radius, and shape, as a SynLC file. The Save command will not save the entire scenario with
the feeders and substations that are managed by the load center at the time of the save. These
must be loaded separately.

Load. Click this button to load a saved load center into your model. The name, radius, and shape
will appear as the same size, and in the same location, as they were at the time of the save.

Name. Use the Name text box to specify the name of a load center. More than one load center may
be managed at a time.

Radius. Use the Radius text box to configure the size of a load center, measured in feet.

Add Circle. Click this button to add a new load center to the Load Center table and to the
SynerGEE map display. The load center will be represented by a circle in the map display.

Add square. Click this button to add a new load center to the Load Center table and to the
SynerGEE map display. The load center will be represented by a square in the map display.

Update. Click this button to apply changes that were made to the Name and Radius of an existing
load center.

Re-Center. Use the Re-Center button to change the location of a load center in the SynerGEE map
display. First, select a load center in the Load Center table. Then, click the spot on the map where
you want to relocate the load center, and then click the Re-Center button. The load center will
reposition itself, centered on the location where you clicked the mouse in the map display.

Delete. Click this button to delete a selected load center from the Load Center table and also the
SynerGEE map display.

Clear All. Click this button to delete all load centers from your model.

Re-calculate values. Click this button to reconfigure kW, customers, and miles after changes are
made to a load center. For example, after changing the radius for a load center, click the Update
button and then the Recalculate values button to add or subtract the appropriate amounts from the
kW, customer and miles fields.

If you create more than one load center at a time, they will be shown on the map together. The active load
center (that is, the load center that is selected in the Load Centers list) is always shown in red, and any
inactive (that is, currently unselected) load centers are shown in blue.
It is recommended that you set your monitor to a higher resolution when using this feature. The results will be
more accurate.

Creating and editing a load center

The Load Center Manager is a unique tool that can be used several different ways. The following procedure
describes one possible scenario for creating and editing load centers. For more information on the Load
Center Manager tools, see Load Center Manager on page 765.

TO CREATE AND EDIT A LOAD CENTER

1

In the SynerGEE model explorer, select the Toolbox tab.

From the Tool options menu, select Load Center Manager. The load center tools will appear. If
necessary, adjust the size of the model explorer panel so that you can see all of the tools.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

767

Next to Name, type the name of the load center you want to create.

Next to Radius, type the radius (in feet) of the load center you want to create.

Click a spot in the map display where you want the load center to be centered.

Click Add Square or Add Circle, as desired. The selected shape will appear at the spot you clicked
in the map display, indicating the location of the new load center. The new load center will also
appear in the Load Centers table in the Toolbox tab.

Click Re-calculate values. Values for kW, customer and miles will be added to the load center in
the Load Centers table.

Now that you have created a load center, there are several ways you can edit it. Some of the typical
actions are as follows:
-

Select a load center from the Load Centers table, and then click a new spot on the map
and click Re-center. The circle or square will relocate to the new point.

Select a load center from the Load Centers table, and then use the Radius text box to
change the radius of the selected load center. Click Update to apply the change to the map
display, and then click Re-calculate values to update the load center data.

Click Save to save any changes you have made to the load center.

Select or clear the Spot, Distributed, Large Customer, or Project check boxes to enable
or disable different load types. Then, click the Re-calculate values button to see the
changes in the feeders.

DATA HAMMER
Data Hammer is a tool that can help you overcome low-level data problems, such as missing warehouse
equipment types. This will allow you to get your model in working order so that you can troubleshoot bigger
problems using other SynerGEE tools. You may want to save the model to a temporary location after running
the Data Hammer.
The Data Hammer can perform the following actions:

Add missing conductor types to the warehouse

Add missing switch types to the warehouse

Apply a height value of 10 to any section that has a height value of 0

Apply descriptions to relays (all relays in model that do not already have a Description will have their
Descriptions named after their Section IDs plus an incremental counter suffix to ensure
uniqueness).

If any conductor types or switch types are created by using the first two options listed above, the description
for the newly created types will include Created by Data Hammer, thus making them easy to identify. For all
other settings, default values will be used when creating new equipment types.
Refer to the following procedure for more information.

SynerGEE Electric 5.0

User Guide

768

Tools, Calculators, and Worksheets

TO USE THE DATA HAMMER

1

Perform the following steps to open the Data Hammer editor:

a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Hammer.

In the Data Hammer editor, select the check box for each action that you want to perform. Available
choices are as follows:
-

Create missing conductor types

Create missing switch types

Give height to sections

Apply descriptions to relays

Click Finish.

A message box will appear, showing you the results of the Data Hammer actions. When you are
finished reviewing the results, click OK to close the message box.

STATE MASTER
The State Master will appear during some SynerGEE analyses, such as the throw-over analysis, allowing you
to temporarily view the results of different model states created by the analysis. You view a state by selecting
it from the list of options in the State Master window. The map display will update to reflect the current state,
and it will update again each time you select a state from the list.
You must restore the model to its original condition before you can close the State Master window. However,
restoring the model in this case will only remove the state that you selected in the State Master. If you made
an edit to the model while an analysis state was being viewed, those edits will remain even after you restore
the model through the State Master.

TO USE THE STATE MASTER

1

Perform an analysis that will create the State Master window, such as the throw-over analysis
described in Throw-Over Analysis on page 533. Note that even though you can open the State
Master from the Tools tab of the SynerGEE ribbon bar, the State Master can only be used after
performing an applicable analysis.

In the State Master window, select from the available states to view that state as applied in the
SynerGEE model, including the SynerGEE map display. Select other states to apply those states to
the model. The following list describes additional tasks that you can perform.

User Guide

Clear. Click the Clear button to clear all states from the State Master. Note that clearing the
State Master will also restore the model to its original state, and that you must repeat the
original analysis run to bring back the states that you cleared.

Restore Model. Click Restore Model to restore the model to its original state. The states in
the State Master window will remain, however, and can be re-applied simply by selecting
them from the list.

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

-

769

Restore and Close. Click Restore and Close to restore the model to its original state and
also close the State Master window. This is the only way to close the State Master window.

DEMO MANAGER
The Demo Manager provides the ability to record screen activities for playback. Each demo can be saved
and run from the Demo Manager. The demo file is saved in a MiddleLink file, and MiddleLink records can be
used to add text boxes to the demo.

TO CREATE A DEMO
1

Perform the following steps to open the Demo Manager editor:

a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the General group, click Demo Manager.

In the Demo Manager editor, in the top text box, type a name for the demo that you want to create,
and then click New.

When you are ready to record all mouse movements and selections, slick Start Recording.

The Demo Manager window will disappear and SynerGEE will record all mouse clicks and
keystrokes. Keystrokes and left-click mouse actions are recorded without delays. However, other
actions, like ribbon bar selections, have a default 1/2 second delay associated with them. This helps
to keep the movement controlled and easy to follow. These delays can be edited in the demo
MiddleLink file. In addition, text captions can be added to the demo via MiddleLink 17011 records.
See the MiddleLink schema for more information.

Do the following to pause or stop the recording:

-

To pause the recording, click the Pause key on your keyboard.

To stop the recording, re-open the Demo Manager editor (from the VIEWS tab in the
SynerGEE ribbon bar) and click Stop Recording.

TO RUN A DEMO
1

Perform the following steps to open the Demo Manager editor:

a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the General group, click Demo Manager.

In the Demo Manager editor, select the demo that you want to run from the list of available choices.

Click Run.
The demo will automatically run in SynerGEE.

SynerGEE Electric 5.0

User Guide

770

Tools, Calculators, and Worksheets

TO DELETE A DEMO
1

Perform the following steps to open the Demo Manager editor:

a

In the SynerGEE ribbon bar, select the VIEWS tab.

In the General group, click Demo Manager.

In the Demo Manager editor, select the demo that you want to delete from the list of available
choices.

Click Delete.

Click Yes to confirm the deletion.

MEDIA VIEWER
The SynerGEE Media Viewer allows you to view documents, images, and videos from within SynerGEE. In
order to be viewed in the Media Viewer, these files must be saved in the Doc folder in your SynerGEE
installation directory. The Doc folder is the default folder where all SynerGEEs help files are installed,
including the SynerGEE User Guide, Technical Reference, and Release Notes.
To use the Media Viewer, simply open it from the SUPPORT tab of the SynerGEE ribbon bar and then select
the name of the file you want to view from the list of files on the left side of the application. The Media Viewer
will identify the file type and display it as appropriate in the Media Viewer window.

TO OPEN THE MEDIA VIEWER

1

From the SynerGEE ribbon bar, select the SUPPORT tab.

In the Documents group, click Media Viewer.

LIBRARY
Documents can be added to SynerGEE in the Library, making documents such as equipment specs or other
internal documents accessible directly within the SynerGEE application. These documents can be re-named
and also viewed in either in SynerGEEs link viewer dialog or a regular window.
Refer to the topics listed below for more information.

Adding a document to the library on page 770

Viewing a document in the library on page 771

Updating a document in the library on page 771

Deleting a document from the library on page 772

Adding a document to the library

Perform the following procedure to add a document to the library.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

771

TO ADD A DOCUMENT TO THE LIBRARY

1

Perform the following steps to open the Library editor:

a

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, click Library.

In the Library editor, perform the following steps to identify the document that you want to add to the
library:
a

Next to Name, type the name of the document as you want it to be identified in the
SynerGEE library.

Next to Path, type the path of the document file, or click Browse to search for the file.

Under Open In, select Dialog or Window to specify where the file will be opened.

Click New. The document is added to the library.

Click Apply to accept your changes, and then click X to close the editor.

Viewing a document in the library

Perform the following procedure to view a document in the library.

TO VIEW A DOCUMENT IN THE LIBRARY

1

Perform the following steps to open the Library editor:

a

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, click Library.

In the Library editor, locate the name of the document that you want to view.

Double click on the document name or select the document name and click Open.

Updating a document in the library

Perform the following procedure to update a document in the library.

TO UPDATE A DOCUMENT IN THE LIBRARY

1

Perform the following steps to open the Library editor:

a

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, click Library.

In the Library editor, select the document that you want to edit from the list of available choices.

Use the Name, Path, and Open In options to update the document, as appropriate.

Click Update.

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

User Guide

772

Tools, Calculators, and Worksheets

Deleting a document from the library

Perform the following procedure to delete a document from the library.

TO DELETE A DOCUMENT FROM THE LIBRARY

1

Perform the following steps to open the Library editor:

a

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, click Library.

In the Library editor, select the document that you want to delete from the list of available choices.

Click Delete. Note that there is no confirmation of the documents deletion.

Click Apply to accept your changes, and then click X to close the editor.

SQL DASHBOARD
The SQL Dashboard is a general purpose tool in SynerGEE that an engineer can use to run queries directly
against the tables in any database represented with a DSA. Views, joins, updates, and other queries can be
authored and run from the SQL Dashboard. These queries can be written against any data source (model or
dataset independent). The dashboard allows the engineer to work directly with data by writing and managing
queries that can be run against models, customer tables, and other SynerGEE data stored in the database.
Scripts containing one or more queries can be written in the SQL Dashboard. The scripts are stored in the
Scripts folder with a *.SynSQL file extension. You can create multiple queries in a single file, as long as each
query is separated by a semi-colon. These queries will run against any database specified by the selected
DSA. You can write a query once and run it against any databases by selecting the appropriate DSA.
Depending on the type of database you rely on (Access, SQL Server, or Oracle) and the complexity of the
query, the SQL language may vary slightly. It is recommended that you become familiar with the language
most applicable to your needs.
Refer to the topics listed below for more information.

Opening the SQL Dashboard on page 773

Using the SQL Dashboard on page 773

Selecting a data type and data source for use with the SQL Dashboard on page 774

Writing a SQL query on page 775

Showing tables and fields in the SQL Dashboard on page 776

Running a SQL query and viewing the results on page 777

Using the model-in-memory feature in the SQL Dashboard on page 778

Mining in the SQL Dashboard on page 779

Feature locks and the SQL Dashboard on page 779

Common SQL commands on page 780

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

773

Sample SQL queries on page 782

Opening the SQL Dashboard

Perform the following procedures to open the SQL Dashboard and to open or close multiple tabs within the
SQL Dashboard window. SQL Dashboard tabs are located on the right side of the SQL Dashboard window
and allow you to view multiple queries and query results.

TO OPEN THE SQL DASHBOARD

1

In the SynerGEE ribbon bar, select the FORGE tab.

In the Database group, click SQL Dashboard.

TO ADD A SQL DASHBOARD TAB

From the CONTROLS tab of the SynerGEE ribbon bar, click Add.

TO CLOSE A SQL DASHBOARD TAB

1

On the right side of the SQL Dashboard window, select the tab that you want to close.

From the CONTROLS tab of the SynerGEE ribbon bar, click Remove. If you try to remove the last
tab, the tab will clear but remain open.

Using the SQL Dashboard

The SQL Dashboard, as shown in the following example, includes three main areas. The left side of the SQL
Dashboard includes the controls that you use to select the data type and data source, and also to select
existing SQL queries that have been saved as script files (*.SynSQL files). The upper half of the SQL
Dashboard is where you write and edit the queries and view tables and fields from the selected data source.
The lower half of the SQL Dashboard displays the results of the queries that you run.

SynerGEE Electric 5.0

User Guide

774

Tools, Calculators, and Worksheets

Detailed procedures for working with the different areas of the SQL Dashboard are provided in the following
sections:

Selecting a data type and data source for use with the SQL Dashboard on page 774

Writing a SQL query on page 775

Showing tables and fields in the SQL Dashboard on page 776

Running a SQL query and viewing the results on page 777.

Selecting a data type and data source for use with the
SQL Dashboard
In the SQL Dashboard window, the data type option is where you select the type of SynerGEE data that you
want to query. The following data types are supported:

CMM

Data Mart

Equipment

Events

Historian

Mining

Model

PI

Results

Subsets

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

775

For more information on these supported data types, see SynerGEE Data Types on page 59.
Once a data type is selected, you may select a data source alias (DSA) against which the query will be run.
The SQL Dashboard also supports connections to a PI server.
Refer to the following procedure for more information.

TO SELECT A DATA TYPE AND DATA SOURCE FOR THE SQL DASHBOARD
1

From the SQL Dashboard window, directly under the SynerGEE logo, use the options list to select
one of the supported data types.

Under DSA, use the options list or click the ... button to select a data source against which the query
will be run.
Tips:

If you selected Model or Equipment as the data type, you can also click the Use Model/
Equipment in Memory check box to use the model or equipment data source that is
currently loaded in SynerGEE.
You can also edit the selected DSA by clicking the Edit DSA button.

If you selected an Oracle or SQL Server DSA as the data source, then you may also select a data
set from the Data Set options list.

Writing a SQL query

In the SQL Dashboard, you can write a new query directly in the SQL Dashboard window, or you can select
an existing query to work with from the list of query script files in the lower-left corner of the SQL Dashboard.
A standard query consists of a series of commands and a series of tables and/or database fields. The
specific actions that a query can take are completely up to you and can comprise almost countless
combinations. The two primary types of queries are SELECT, which retrieves data from a database table, and
UPDATE, which modifies data in a database table. Be very careful when running UPDATE queries after
changes are committed, they cannot be undone.
Typical query commands and examples of their usage are provided in Common SQL commands on
page 780 and Sample SQL queries on page 782.
Refer to the procedures listed below for more information.

To write a query on page 775

To save a query on page 776

To delete a query on page 776

TO WRITE A QUERY
1

In the data source area of the SQL Dashboard window, select a database to run the query against.
For more information, see Selecting a data type and data source for use with the SQL Dashboard
on page 774.

To create a new query, type a query name in the Name text box and a query group in the Group text
box. Both the Name and the Group are required if you want to save the query.
or

SynerGEE Electric 5.0

User Guide

776

Tools, Calculators, and Worksheets

To edit an existing query, select a saved query that you want to work with from the list of queries in
the lower-left corner of the SQL Dashboard window.
3

Write the query text in the in the SQL area, near the top of the SQL Dashboard window.
Tip:

To increase or decrease the font size in the query window for better visibility, hold down
Ctrl and scroll the mouse wheel.

TO SAVE A QUERY
1

Write a query following the instructions provided in To write a query on page 775. Make sure that
you have specified a Name and a Group.

Click Save. The query and the group, if applicable, will be added to the list of saved queries in the
lower-left corner of the SQL Dashboard window.

TO DELETE A QUERY
1

In the lower-left corner of the SQL Dashboard window, select the name of the query that you want to
delete.

Click Delete.

Click Yes to confirm the deletion.

Showing tables and fields in the SQL Dashboard

SynerGEE provides a convenient method to explore the tables and fields in your databases directly in the
SQL Dashboard window, without having to switch to another application in order to view the database. You
can also insert table and field names directly into any query, simply by double-clicking on the table or field
name.
Refer to the following procedure for more information.

TO SHOW TABLES AND FIELDS IN THE SQL DASHBOARD

1

In the data source area of the SQL Dashboard window, select the database that you want to work
with. For more information, see Selecting a data type and data source for use with the SQL
Dashboard on page 774.

On the right-side of the SQL Dashboard window, click the Show Tables check box. A list of tables
within the selected database will appear underneath the check box, and the Show Fields check box
will display.

Select the table whose fields you want to view, and then click the Show Fields check box. A list of
data fields within the selected table will appear underneath the check box.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

4

777

If desired, the following table describes additional tasks that you can perform from the Table and
Fields lists.
To ...

Do This ...

Add a table name or a field

name to the current query

Under Show Tables or Show Fields, double-click the table or

field name. The table or field name will be inserted at the
cursor position in the query-writing area.

View a complete table in the

Results area

View the number of records

for a table

View selected fields in the

Results area

Under Show Tables, select the table that you want

to work with.

Right-click and select Open Table. SynerGEE will

automatically run a Select * from <table> query on
the selected table. The fields and corresponding
data for the selected table will display in the
Results area.

Under Show Tables, select the table that you want

to work with.

Right-click and select Get Record Count. The

number of records for the selected table will display
in the Results area.

Under Show Fields, select the field(s) that you want

to work with. Use the Ctrl and Shift keys to select
multiple fields.

Right-click and select Open and Sort By

[FieldName] (Asc) or Open and Sort By
[FieldName] (Desc). SynerGEE will display the
selected fields and corresponding data in the
Results area. The results will be sorted by the field
name where you right-clicked, in either ascending
or descending order.

Running a SQL query and viewing the results

When a query is run, the results are displayed in the lower-half of the SQL Dashboard window. The results
appear just as though they would in the database. You can manipulate the data if you select the Allow Edits
in Recordset option. The results can also be printed, saved as a CSV file, or opened directly in Excel.

TO RUN A QUERY AND VIEW THE RESULTS

1

In the SQL Dashboard window, write or load the query that you want to run. For more information,
see To write a query on page 775.

Click Run to run the query against the selected database. If you wrote more than one query and
only want to run one of those queries, select the SQL code that you want to run (from the area
where you wrote the query) and click Run Selection. SynerGEE will automatically highlight the
query that is run.

SynerGEE Electric 5.0

User Guide

778

Tools, Calculators, and Worksheets

The query results are displayed in the lower-half of the SQL Dashboard window.
3

If desired, the following table describes additional tasks that you can perform in the Results area.
To ...
Save the query results as a
CSV file

Open the query results

directly in Excel
Print the query results

Graph query results

Manipulate the query results

Do This ...
a

From the CONTROLS tab of the SynerGEE ribbon

bar, click Export to CSV.

Use the Save CSV File dialog box to specify the

name and location of the file you are saving, and
then click Save.

From the CONTROLS tab of the SynerGEE ribbon bar, click

Open in Excel. The query results will automatically open in
an Excel window.
a

At the left end of the SynerGEE ribbon bar, click the

Pole icon and then select Print.

Use the Print dialog box to select the settings for

your print job, and then click Print.

From the SQL Dashboard results area, select the

cells that you want to view in a graph.

Right-click and select Graph Selected Cells.

In the CONTROLS tab of the SynerGEE ribbon bar,

make sure that Allow Edits in Recordset option is
selected (highlighted).

In the Results area, select any cell that you want to

edit and type new values, as appropriate. You can
also use the right-click menu to perform Copy,
Paste, and Undo operations.

Using the model-in-memory feature in the SQL

Dashboard
If you select either Model or Equipment as the data type in the SQL Dashboard window, you will be
presented with an option to use the model in memory to run queries against. You can select this option by
selecting the Use Model in Memory check box or the Use Equipment in Memory check box, respectively.
When a query is run, SynerGEE saves an Access database with the current selected feeders or loaded
equipment, and also saves a binary file with all feeders or equipment for backup. If the query runs
successfully on the Access database, then you will be prompted to apply the changes. If the changes are
applied, then the Access database is loaded into SynerGEE.
The query will only be run against the current feeders.

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

779

Mining in the SQL Dashboard

The mining feature allows you to view data from non-SynerGEE tables directly within SynerGEE. The SQL
Dashboard is used to launch a SQL query that retrieves the information from the database that does not
reside within the SynerGEE model or data. This external data can be in Access, SQL Server, or Oracle, and
may include records pertaining to outage information, equipment failure history, device control settings, and
notes about a device.

TO USE THE MINING FEATURE

1

Create a DSA that links to the external database. Be sure to check the Mining box during setup. For
more information on creating a DSA, see To create, delete, and manage DSAs on page 77.

Use the Mining tab in the Preferences editor to map the external data source to both the SynerGEE
device and SQL query that controls what is brought over into SynerGEE.

Create a query in the SQL dashboard. This query must include one of the following mining
constants. This is to indicate the type of device to which your mined data will connect:
Constant

Command

f_sectid

Section Id

f_devdesc

Device name

f_regkva

Regulator rated kVA

f_sectcond

Section phase conductor

f_sectneut

Section neutral conductor

The following sample query uses the f_devdesc constant:

SELECT *
FROM InstCapacitors
WHERE UniqueDeviceId = @f_devdesc@;

Once the query is set up, return to the Mining tab in the Preferences editor. Select the Facility Type
from the list, which will automatically fill in the Name field. Map the rest of the information to the data
and SQL Script.

Click OK to run the query. The dataset will be filled in with the mining constant used in the query.

Right-click on the type of device on the map that was queried. A link to the external database
appears in the context menu. This link will launch the SQL Dashboard, which will retrieve the control
settings that reside on the server containing the database.

Feature locks and the SQL Dashboard

For security purposes, a Feature Lock may be applied to the SQL Dashboard. This is especially important
when working in a shared database. To restrict query runs for select users, open the Preferences editor and
in the Feature Locks tab, select Select Queries Only (SQL Dashboard). For more information on Feature
Locks, see Setting feature locks on page 171.

SynerGEE Electric 5.0

User Guide

780

Tools, Calculators, and Worksheets

Common SQL commands

The following two tables list sample SQL code commands and examples of these SQL commands. The
information in these two tables can help you get started writing queries in SQL Dashboard.

SQL commands
Command

Type

Definition

SELECT

Clause

Selects data from a table

FROM

Clause

Specifies which table

WHERE

Clause

Specify a selection criterion

UPDATE

Clause

Modify the data in a table

SET

Clause

Update a column with a new value

ORDER BY

Clause

Displays columns in ascending or descending order

ALTER

Clause

Modifies an existing object, such as adding a column to a

table.

NOT

Operator

Displays a row for all values not equal to condition

OR

Operator

Displays a row if any of the conditions listed are true

AND

Operator

Displays rows if all conditions listed are true

IN

Operator

Return exact value for at least one of the columns

BETWEEN

Operator

Selects a range of data between two values

UNION

Operator

Select related information from two tables with the same

data type

INTERSECT

Operator

Returns only the rows found by both queries

MINUS

Operator

Returns rows from first query that are not present in second
query

Operator

Add

Operator

Subtract

Operator

Divide

Operator

Multiple

Operator

Equal to

<

Operator

Less than

>

Operator

Greater than

!=

Operator

Not equal to

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

781

Command

Type

Definition

<=

Operator

Less than or equal to

>=

Operator

Greater than or equal to

Operator

Wild card

||

Operator

Concatenates two strings

SQL examples
Example

Syntax

Querying all data from a table.

SELECT*
FROM table_name

Querying column data from a table.

SELECT column_name(s)
FROM table_name

Querying specific column data from a

table.

SELECT column_name(s)
FROM table_name
WHERE condition

Querying table data and re-ordering the

columns.

SELECT column_name(s)
FROM table_name
ORDER BY column_name [ASC|DESC]

Querying table data using the AND or OR

operators

SELECT column_name(s)
FROM table_name
WHERE condition
AND|OR condition

Querying table data using the BETWEEN

operator.

SELECT column_name
FROM table_name
WHERE column_name
BETWEEN value1 AND value2

Querying table data using the IN operator.

SELECT column_names(s)
FROM table_name
WHERE column_name
IN (value1, value2...)

SynerGEE Electric 5.0

User Guide

782

Tools, Calculators, and Worksheets

Example

Syntax

Updating column data in a table.

UPDATE table_name
SET column_name=new_value
WHERE column_name=some_value

Sample SQL queries

Selecting distribution transformers
The following query selects all distribution transformers from a CMM table that have a utilization factor of
greater than 100%. For this problem, the DSA target (Oracle) will be the CMM DistTrans table which stores
the calculated customer transformer utilization factor (part of the CMM process).
SELECT DTranId, SectionId, RatedKVA, UtilFAC
FROM @CMM@DistTrans
WHERE UtilFac > 1.0
ORDER BY UtilFac DESC;

Selecting customers
The following query selects all customers that are fed from the most utilized distribution transformer as
reported in the first example. This time the DSA target will be the CMM Customers table (Oracle).
SELECT CustomerId, LastName, Address, City, CustClassId, DTranId
FROM @CMM@Customer
WHERE DtranId = F;
ORDER BY Last Name ASC:

Updating three-phase sections

The following query updates all three-phase sections that have a phase conductor of 336 ACSR to have a
neutral conductor of 1/0 AAC. However, all single-phase and two-phase 336 ACSR phase conductors are not
to have their neutral conductors modified.
SELECT SectionId, SectionPhases, PhaseConductorId, NeutralConductorId
FROM InstSection
WHERE PhaseConductorId = 336 ACSR

The following SELECT query displays these results, proving that only the three-phase conductors were
modified. The DSA type for this will be Model (Access), which represents a SynerGEE Model Database.
UPDATE InstSection
SET NeutralConductorId = 1/0 AAC
WHERE PhaseConductorId = 336 ACSR AND SectionPhases = ABCN;

Selecting sections that match a queried section

Using the keyword SYN_QUERY_SECTS_ID will results in a reference to the IDs of sections in the query set.
The following query will select all sections in the InstSection table that match SynerGEEs queried sections:

User Guide

SynerGEE Electric 5.0

Tools, Calculators, and Worksheets

783

SELECT *
FROM InstSection
WHERE SectionId IN (@SYN_QUERY_SECTS_ID@);

Associating a data source with a query

The following commands will automatically associate a data source with a query. This can be used in lieu of
the options list to manually select a DSA. This should be written immediately before a regular query.
@SYN_SET@@d_datasource@ = Access Database (Sample Model);

Eliminating unused nodes

Over time, unused nodes may accumulate in a database and will not be deleted by SynerGEE during normal
loading and saving activities. The following SQL Dashboard script can be used to eliminate nodes in a
database.
Uncomment these queries and run to look at SynerGEE tables:
SELECT COUNT(*) FROM @MOD@Node;
SELECT * FROM @MOD@Node WHERE lIsUsed=0;
SELECT * FROM @MOD@Node;

Comment out the queries above and run the queries below as a process:
ALTER TABLE @MOD@Node ADD lIsUsed long;
UPDATE @MOD@Node SET lIsUsed = 0
UPDATE @MOD@Node SET lIsUsed = 1 WHERE NodeId IN (SELECT FromNodeId FROM
@MOD@InstSection);
UPDATE @MOD@Node SET lIsUsed = 1 WHERE NodeId IN (SELECT ToNodeId FROM
@MOD@InstSection);
UPDATE @MOD@Node SET lIsUsed = 1 WHERE NodeId IN (SELECT FeederId FROM
@MOD@InstSection);
DELETE FROM @MOD@Node WHERE lIsUsed = 0
ALTER TABLE @MOD@Node DROP COLUMN lIsUsed;

RUNNING THE SOLVER FROM WITHIN SYNERGEE

SynerGEE provides a special feature that you can use to launch Solver-based applications from within
SynerGEE. To set up a Solver instance within SynerGEE, you need to provide the program ID for the
application you want to run. SynerGEE will create the Solver, pass it to a COM DLL created by a user, and
then clean up after the DLL completes its tasks.
The SynerGEE Electric installation includes two examples for Solver Tools, named SolverCOMCPP and
SolverCOMVB. The example files are located in the Sample Data folder in your SynerGEE documents
directory, which is in the following location by default (Windows 7), where username is the name of your
Windows login:

C:\Users\username\Documents\Stoner Software\SynerGEE Electric\5\Sample Data\

SolverCOMCPP. (The program ID for this Solver example is SolverCPPSample.1.)

C:\Users\username\Documents\Stoner Software\SynerGEE Electric\5\Sample Data\

SolverCOMVB. (The program ID for this Solver example is SolverCOMVB.SolverClass.)

SynerGEE Electric 5.0

User Guide

784

Tools, Calculators, and Worksheets

Take note that you must first build these examples in your own Visual Studio environment before you can use
them with the Sample Model. If you already build applications for Solver Tools, you typically will have your
own Visual Studio environment installed on your PC and likely already have prior coding experience. Once
you build a Solver example, you can distribute the application to other users who do not have Visual Studio.
Those users will be able to run the Solver application, but each user must register the Solver Tool DLL before
it can be run in SynerGEE.
For more information on working with the Solver, see the Electric Solver Getting Started Guide and the
Electric Solver Developers Reference.

TO RUN THE SOLVER FROM WITHIN SYNERGEE

1

Perform the following steps to open the Solver Tools editor:

a

In the SynerGEE ribbon bar, select the MACROS tab.

In the Tools group, click Solver Tools.

Use the Solver Tools editor to perform the following tasks:

To:
Add a Solver instance

Edit a Solver instance

Run a Solver instance

Delete a Solver
instance

User Guide

Do This:
a

Click New.

In the New Solver Tool editor, next to Name, type a unique

name that identifies the Solver instance you are creating.
This name is only used to identify the Solver instance in
SynerGEE; it does not need to have any direct association
with the Solver COM file.)

Next to ProgID, type the Program ID that is associated with

the COM dll that you have created to work with the Solver.

Click OK to close the New Solver Tool editor.

Select the Solver instance that you want to edit.

Click Edit.

Use the New Solver Tool editor to edit the Name and
ProgID, as required. Descriptions for these two fields are
provided in the previous row in this table.

Click OK to close the New Solver Tool editor.

Select the Solver instance that you want to run.

Click Run.

Select the Solver instance that you want to run.

Click Delete.

Click Yes to confirm the deletion.

Click Close to close the Solver Tools editor.

SynerGEE Electric 5.0

CHAPTER

16
SynerGEE Cable
Cables should be loaded so that their operating temperature is within the standard or manufacturer stated
limits. As such, SynerGEE includes a cable ampacity tool that you can use to calculate amperage derating
due to burial and duct bank configuration. The tool can be used as a standalone calculator or it can integrate
directly within SynerGEEs modeling and analysis environment. In other words, you can build duct banks just
to find derated values for your duct bank cables, or you can go as far as applying duct banks to your model
for use in exception flagging during analysis.
With the cable ampacity tool, you can model direct buried cables with or without conduit and cables within
encased duct banks. Cable modeling is circuit-based and a maximum amp value can be specified by circuit.
If a circuit has no specified amp value, SynerGEE calculates the maximum current allowed to avoid thermal
overloading of the cable. Other features of SynerGEE cable analysis include:

Realistic duct bank simulation, with a simple graphic editor to help create them.

Consideration of duct size, soil type, spacing, depth, and mutual heating.

Immediate, on-screen derating values.

Option to apply duct banks to sections, for automatic application of derated values.

Refer to the topics listed below for more information on working with cables in SynerGEE.

General Steps for SynerGEE Cable Analysis on page 785

Modeling Cables on page 786

Creating a Duct Bank on page 790

Editing Duct Banks on page 790

Applying Duct Banks to Sections on page 797

Duct Bank Evaluation on page 798

Detailed Cable Studies Using Scripts on page 800

GENERAL STEPS FOR SYNERGEE CABLE ANALYSIS

To use SynerGEE cable analysis, you should follow these general steps:
1

Define your cable conductors in your equipment data source and enable them for ampacity studies.
If you are an established SynerGEE user, you may already have your conductors defined, but you
may still need to enable them for ampacity studies. For more information on modeling cables, see

SynerGEE Electric 5.0

User Guide

786

SynerGEE Cable
Modeling Cables on page 786.
2

Create duct banks, using the duct bank editing features and your cable types.

Apply duct banks to the applicable sections in the model.

Run the section derating update power tool to apply derated values to those sections.

Run SynerGEE analyses as normal, noting that exceptions are now flagged based on the derated
values.

These steps may vary slightly, depending on the makeup of your data and the depth of your ampacity
studies. If you only wish to calculate basic derated values without integrating them into your model, only steps
1 and 2 apply.

MODELING CABLES
As with any analysis, the results of cable studies depend on the quality of your model data, especially your
cable conductor models. When you work with cable conductors, you should be aware that the associated
data can serve two distinct purposes:

Ampacity studies

Impedance calculations

Ampacity studies refer to SynerGEE Cable, a licensed module that allows you to model cable duct banks and
calculate derated amperage for the associated cables. Impedance calculations, on the other hand, are an
integral part of any load-flow study. Therefore, your impedance-related data must be accurate for all cable
conductors, but ampacity-related data is only applicable if you plan to use SynerGEE Cable.
For more information on SynerGEE Cable, see SynerGEE Cable on page 785.

Overview of cable conductor data

Cable conductor data is considered equipment data, like all conductor data. When you create and manage
conductors, you generally work in the Warehouse tab of the model explorer. In the Warehouse tab, conductor
types are created and managed like any other equipment type. For more information, see Creating a device
type on page 319 and Editing a device type on page 320.
In the Warehouse tab, SynerGEE separates bare and cable conductors into two different groups. It makes
this determination by the conductor model specified in the Conductor editor. All conductors specified as bare
conductors are listed as bare conductors, and all others are considered cables.
After making changes to conductor data, you must save your equipment data set to preserve those changes.
For more information on working with equipment data, see Equipment data on page 64.
Tip:

User Guide

Explanations of the various fields in the Conductor editor, including those applicable to cables, can
be found under Editing a conductor type on page 305.

SynerGEE Electric 5.0

SynerGEE Cable

787

Types of cable conductors

SynerGEE supports several different types of cables. These cable types are discussed in the topics listed
below.

Simple impedance cable model on page 787

Separate neutral cable model on page 787

Concentric neutral cable model on page 787

Tape shield conductor model on page 788

Three-core cable model on page 789

Simple impedance cable model

As the name implies, the simple impedance model is the most basic, requiring only the positive and zero
sequence impedance and conductance. For sections that use simple impedance conductors, SynerGEE
ignores any neutral phasing and/or spacing data, assuming that the effects of these parameters are included
in the specified impedance.
Because simple impedance conductors lack information such as spacing and construction materials, they
cannot be used for cable ampacity studies.

Separate neutral cable model

From a data perspective, the separate neutral model is similar to the simple impedance model, except that
you can allow SynerGEE to calculate GMR and zero-sequence impedances based on core R/core GMR and
spacing/neutral conductor data at the respective section. Therefore, the use of this model generally requires
that your section spacing data is accurate. For other parameters that are not available, SynerGEE makes
assumptions as appropriate. Note that the conductor diameter in this case is not relevant.
Because spacing data is assumed to be available, separate neutral cables are available for cable ampacity
studies.

Concentric neutral cable model

The concentric neutral model is a more detailed model, requiring the conductor, insulation, and outside
diameters for impedance calculations. For ampacity studies, it also requires the core resistance, core GMR,
strand diameters, strand resistance, and strand count. When you apply a concentric neutral conductor to a
section, you should generally specify same as phase (or the same conductor type) for the neutral. If you do,
SynerGEE assumes that all return current passes through the neutral strands. If you specify a different
conductor type for the neutral, SynerGEE assumes a separate neutral return.

SynerGEE Electric 5.0

User Guide

788

SynerGEE Cable

Outside diameter
Insulation diameter
Conductor
diameter

Insulation

Jacket

Sheath

Core strand
diameter

Neutral strand
diameter

Diameter to
strand ring
Concentric neutral components

If you are using a concentric neutral cable for ampacity studies, you may need to contact the respective cable
manufacturer to obtain all the necessary data. In many cases, cable catalogs do not provide all the attributes
that SynerGEE requires.

Tape shield conductor model

The tape shield model is very similar to the concentric neutral, without the concentric stranding. The data
requirements are nearly the same, with the same importance on diameters and section spacing data. For
tape shield conductors, the neutral conductor specified at the section level is an important factor and should
accurately reflect your actual configuration.

User Guide

SynerGEE Electric 5.0

SynerGEE Cable

789

Outside diameter
Insulation diameter
Conductor
diameter

Insulation

Core strand
diameter

Sheath

Shield
Jacket

Tape shield cable components

Three-core cable model

A three-core cable model contains three individual conductors bound into a single round cable. Modeling this
type of cable with SynerGEE is a fairly simple process. All Conductor editors have a check box in the Cable
tab. When the box is checked, SynerGEE assumes a three-core cable model. As a result, you will see a
larger single circle on duct bank displays and a slight increase in ampacity. This increase is due to the netting
of less thermal insulation from the jacket compared to three single-phase cables held close together.

Applying conductor types to sections

Conductors are assigned to sections in the Construction tab of the Section editor. You can also make broad
conductor assignments with the Multiple Editor. For more information on the Multiple Editor, see Using the
Multiple Editor on page 177.
When assigning cable conductors, it is important to note your spacing values, especially if you are not using
equivalent spacing. For example, if you are modeling triplexed cable, you should be sure to use small
spacing values that represent the actual spacing of phase conductors within the cable. To help ensure
consistent and accurate spacing, you may consider using configuration types. For more information, see
Configuration types (detailed spacing) on page 311.

SynerGEE Electric 5.0

User Guide

790

SynerGEE Cable

CREATING A DUCT BANK

Perform the following procedure to create a new duct bank.

TO CREATE A DUCT BANK

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Duct Bank.

In the Enter Device ID dialog box, type a name for the new duct bank and then click OK.

Use the Duct Bank editor and the Duct Bank view to edit the duct bank. For more information, see
Editing a duct bank using the Cable Duct Bank view on page 793 and Editing a duct bank using
the Duct Bank editor on page 790.

EDITING DUCT BANKS

Duct banks are a SynerGEE equipment type, with data stored in the DevDuctBank and DevDuctBankCircuit
tables. Referential integrity rules are in place such that if you delete a duct bank record from the
DevDuctBank table, all associated DevDuctBankCircuit records are also deleted.
SynerGEE provides two different tools for editing duct banks. Both tools configure the same data and
therefore perform analogous functions. These tools are:

The standard SynerGEE editor. For more information on the editor, see Using the SynerGEE
Editor on page 151.

The Cable Duct Bank graphic view. For more information on this window, see Editing a duct bank
using the Cable Duct Bank view on page 793.

In most cases, you will probably use both tools together, since each has its own advantages. If you have both
the editor and a Cable Duct Bank view open, the two are fully interactive. That is, any changes you make in
the editor are automatically reflected in the graphic view, and vice-versa. Also, certain settings can only be
configured in the editor, not the graphic view.
A duct bank can include any number of three-phase circuits. Each circuit is configured independently of the
rest, and the mutual effects of all circuits are considered during amperage calculations. You can add new
circuits to a duct bank using the editor or the Cable Duct Bank view. If and when you apply a duct bank to a
section, you apply one specific circuit only.

Editing a duct bank using the Duct Bank editor

The duct bank editor contains all the settings needed to configure a duct bank for ampacity calculations.
These settings include all those that can be manipulated in the Cable Duct Bank view, as well as certain
additional, important items. For more information on the Cable Duct Bank view, see Editing a duct bank
using the Cable Duct Bank view on page 793.

User Guide

SynerGEE Electric 5.0

SynerGEE Cable

791

TO EDIT A DUCT BANK USING THE DUCT BANK EDITOR

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Duct Banks and then double-click the name of the duct bank that you want to edit.

On the left side of the Duct Bank editor, select from the different tab names to access the available
settings for the duct bank. The following topics describe the different tasks that you can perform:

Editing general data for a duct bank on page 791

Editing circuits for a duct bank on page 792

Click Apply to accept your changes, and then click X to close the editor.

Editing general data for a duct bank

TO EDIT GENERAL DATA FOR A DUCT BANK
1

In the Warehouse tab of the SynerGEE model explorer, expand Duct Banks and double-click on the
duct bank that you want to edit.

In the Duct Bank editor, select the Duct Bank tab. The following table describes the different options
that you can set.
Description

Optional description for the duct bank.

Construction

Use the Construction area to edit the following settings:

Type. Select the construction type for the duct bank.

Available choices are Direct Buried and Duct Bank.

Bank Material. If you selected Duct Bank as the Type, use

this options list to select the construction material for the
duct bank.

Configuration. Select the configuration for the duct bank.

Ambient Earth. Specify the ambient ground temperature at

the duct bank.

If you select Direct Buried, the Cable Duct Bank view will still show an
outline of a duct bank, according to the configuration specified below.
For more information on modeling direct buried cables, see A word
on direct buried cables in the duct bank view on page 796.
Dimensions

SynerGEE Electric 5.0

Enter the Height, Width, and Depth of the duct bank. In the Cable
Duct Bank view, you can change these dimensions by clicking and
dragging the duct bank walls.

User Guide

792

SynerGEE Cable

Ducts

If you selected Duct Bank as the construction type, select the duct
Material and specify the Diameter and Thickness of the material. If
you selected Direct Buried as the construction type, you only need to
specify the Thickness of the duct.
Note that these values cannot be changed in the Cable Duct Bank
view.

Circuit loading

Specify the loading levels among circuits in a duct bank. The

following options are available: Equal loading, Proportional to AC
resistance, and Proportional to loading constant. This option is
ideal for running studies on duct banks with different types of cables.

Soil

Select a Soil Type for the duct bank. If you selected Direct Buried as
the construction type, then you can also select the Fill/Backfill type.

Click Apply to accept your changes, and then click X to close the editor.

Editing circuits for a duct bank

TO EDIT CIRCUITS FOR A DUCT BANK
1

In the Warehouse tab of the SynerGEE model explorer, expand Duct Banks and double-click on the
duct bank that you want to edit.

In the Duct Bank editor, select the Circuits tab.

In the list of circuits at the top of the editor, select the circuit that you want to edit. From this list, you
can also click Add to add a new circuit to the duct bank, and Delete to delete the selected circuit.

Once you have selected a circuit, use the remaining fields in the Duct Bank editor to edit the data for
the circuit. The following table describes the different options that you can set. Select other circuits
and repeat this step to edit additional circuits, as desired.
Nominal KV

Specify the nominal KV for the circuit.

Load Factor

Specify a multiplier used to determine the level of conductor loading,

according to the conductor maximum capacity. A load factor of 1
indicates that the conductors are 100% loaded.
Click the
duct bank.

Max. Neutral Loading

button to copy the load factor to all other circuits in the

Specify the maximum percentage of load assigned to the neutral

phase.
Click the
button to copy the max neutral load values to all other
circuits in the duct bank.

User Guide

SynerGEE Electric 5.0

SynerGEE Cable

793

Use Max Amp Rating

Select this check box to set a manually applied maximum amp rating
for the circuit. When this option is selected (checked), the specified
Rating value is assigned as the circuits amp rating and no derating
calculations are performed for the circuit. In turn, this value, rather
than a calculated value, is used during derating calculations for other
duct bank circuits, as applicable.

Loading Constant

Specify the loading constant for the circuit.

Cables

Use this area to select the conductor type for the Phase and Neutral
conductors. Cable ampacity does not support different conductors by
phase. For a conductor to appear in the list, it must be present in your
equipment data source and enabled for ampacity studies. For more
information on enabling a conductor, see Editing a conductor type
on page 305.

Color

Select a color to represent the circuit conductor in the Cable Duct

Bank view.

Phasing

Use this area to enable phasing and specify the location of the
conductors within the bank. The Row and Col fields determine which
duct contains each phase, and the X and Y fields determine precise
positioning within the duct.
You can also edit these values by dragging conductors in the Cable
Duct Bank view.
In a duct bank, the phase positions are represented by numerical
values. When you apply a duct bank to a section, you must also
specify a transposition value that assigns your current phase
designations to these positions. For more information on assigning
duct banks to sections, see Applying Duct Banks to Sections on
page 797.

Click Apply to accept your changes, and then click X to close the editor.

Editing a duct bank using the Cable Duct Bank view

The Cable Duct Bank view is a visual tool that you can use to configure your duct banks. It displays a
simulated duct bank cross-section that enables simple drag-and-drop tools to arrange conductors, establish
spacings, and specify depth. It also shows actual derated values in the legend, which update automatically
when a change is made to a bank.

SynerGEE Electric 5.0

User Guide

794

SynerGEE Cable

Cable Duct Bank view graphic window

When you are making changes to a duct bank using the Cable Duct Bank view, you will notice that the
accompanying values in the bank editor update automatically to reflect the changes you are making.
Refer to the topics listed below for more information.

Opening the Cable Duct Bank view on page 794

Working in the Cable Duct Bank view on page 795

Zooming the duct bank view on page 796

Duct bank view display properties on page 796

A word on direct buried cables in the duct bank view on page 796

Troubleshooting calculation errors shown in the duct bank legend on page 797

Duct bank ampacity report on page 797

Opening the Cable Duct Bank view

Perform the following procedure to open the Cable Duct Bank view.

TO OPEN THE CABLE DUCT BANK VIEW

In the SynerGEE ribbon bar, select the ANALYSIS tab. In the Applications group, click Cable Duct Bank.
or
In the SynerGEE ribbon bar, select the VIEWS tab. In the Views group, click Cable Duct Bank.
or
In the Warehouse tab of the SynerGEE model explorer, expand Duct Banks. Right-click on the duct bank
that you want to view and select Duct Bank View.

User Guide

SynerGEE Electric 5.0

SynerGEE Cable

795

Working in the Cable Duct Bank view

The Cable Duct Bank view is a graphical interface that simplifies the process of configuring your conductors,
duct spacing, and bank dimensions. Any change you make in the view is immediately applied to the duct
bank record in memory and the duct bank editor, if you have it open.
The following table summarizes the functions that you can perform within the Cable Duct Bank view:
To

Do this:

Create a new duct bank

In the Duct Warehouse tab, under Configurations, drag one of the

configuration types and drop it on the view.

Add an existing duct bank to

the view

In the Duct Banks tab, drag the desired bank and drop it on the view.

Add a circuit to the bank

In the Duct Banks tab, under Cables, drag the desired conductor type and
drop it in a duct. The Cables list represents all cable conductors in your
equipment data source that are enabled for ampacity studies. If one of
your cables is not showing up, it may not be properly enabled in the
Conductor editor. For more information on editing a conductor, see
Editing a conductor type on page 305.

Move a conductor to a
different duct

With the mouse, click and drag the conductor to the desired duct. Note
that SynerGEE does not allow accidental overlapping.

Resize the bank

Click on the appropriate bank boundary and drag it to the desired

dimension.

Change the bank depth

Click somewhere in the bank (but not on a duct) and drag it to the desired
depth. Note that horizontal dragging is provided for interface convenience
and has no effect on ampacity calculations.

Change duct positions in the

bank, as a group

Click on any duct (except the lower right) and drag the ducts to the desired
position.

Change duct spacing

Click on the lower right duct and drag it, which alters all spacings
proportionally.

Find the derated

amperage(s) within the
current configuration

Simply look at the legend. Calculations are performed automatically

whenever you make changes. If the legend shows errors instead of
values, you may have some minor configuration problems. For more
information on correcting duct bank configuration problems, see
Troubleshooting calculation errors shown in the duct bank legend on
page 797.

SynerGEE Electric 5.0

User Guide

796

SynerGEE Cable

Zooming the duct bank view

The easiest means of zooming in and out of the duct bank view is by using a wheel mouse. As an alternative,
you can click the following buttons on the CONTROLS tab of the SynerGEE ribbon bar.
Button

Function

In

Puts the mouse in zoom in mode. Click anywhere in the view to zoom in.

Out

Puts the mouse in zoom out mode. Click anywhere in the view to zoom out.

Bounds

Zooms the view to the edges of the bank.

Duct bank view display properties

With the display properties, you have control over the coloring, fonts, and patterns of a duct bank view. To
open the display properties editor, you can either:

In the CONTROLS tab of the SynerGEE ribbon bar, click Properties.

or

Double-click in the view somewhere outside of the bank.

If you want any changes to be applied by default to future duct bank views, be sure to check Save As
Defaults before clicking OK.

A word on direct buried cables in the duct bank view

Cable ampacity studies can include direct buried cables, which can be configured and applied to sections
much like duct banks. The Direct Buried setting is found in the Duct Bank tab of the duct bank editor. For
more information, see Editing general data for a duct bank on page 791.
When you are configuring direct buried cables, the Cable Duct Bank view still shows an outline of a duct
bank, using dashed lines. And, SynerGEE still enforces duct bank rules, such as disallowing the placement
of cables outside the ducts.

Direct buried cable in the Cable Duct Bank view

Clearly, the concept of a duct bank is not applicable to direct buried cables. However, SynerGEE maintains
the framework of the duct bank modeling environment to preserve relationships between the conductors,
thereby facilitating ampacity calculations. If you are modeling direct buried cables using the Cable Duct Bank
view, it is recommended that you place one conductor per duct in a configuration that matches phasing and
burial style. For example, if you want to model a direct buried three-phase cable set, you might use a one-bythree duct bank as shown above.

User Guide

SynerGEE Electric 5.0

SynerGEE Cable

797

If you wish to model direct buried cable with conduit, you should create duct banks with the bank material
specified as Native Ground, or soil. You should not specify the bank as direct buried, because SynerGEE
will assume that there is no conduit, and will not permit you to select a conduit material or thickness.

Troubleshooting calculation errors shown in the duct bank

legend
SynerGEE automatically displays derated amperage values in the legend for each circuit in the bank.
However, certain configuration problems may cause SynerGEE to display error messages instead. If you are
getting errors, check for the following problems:

Overlapping conductors. If any conductors overlap, SynerGEE cannot perform the calculations.
Check your conductor spacing carefully, noting that it is possible for one conductor to be completely
hidden behind another in the view.

Missing conductor types. If the phase and ground conductors of a circuit are not assigned a valid
conductor type from your equipment data source, SynerGEE cannot perform the calculations. In the
duct bank editor, check each circuit to ensure that conductor types are assigned. For more
information on the duct bank editor, see Editing a duct bank using the Duct Bank editor on
page 790.

Duct bank ampacity report

From the duct bank graphic view, you can produce a duct bank ampacity report by clicking Ampacity Report
on the CONTROLS tab of the SynerGEE ribbon bar. The report lists all circuits in the bank with their derated
values, as well as detailed information on duct construction and conductor spacing.

APPLYING DUCT BANKS TO SECTIONS

Duct banks are applied to sections using the Construction settings in the Section editor. Each section can
only use one particular circuit from a duct bank.
When you apply a duct bank circuit to a section, SynerGEE uses the cable conductors from that circuit for
impedance calculations, rather than any conductors shown in the Construction tab of the Section editor. The
only part of the Construction tab that remains applicable after applying a duct bank circuit is the Transposition
setting, which is used to assign your phase designations to the phases 1, 2, and 3 of the duct bank circuit. Be
sure to create a name for the instance field and apply it to all associated sections. Once an instance is
created, it is stored and can be accessed through an options menu. This feature manages data and ties
individual sections together to prepare for the duct bank evaluation. For more information, see Duct Bank
Evaluation on page 798.
When you apply a duct bank to a section, derated amp values are not applied automatically. To apply the
derated values associated with the bank, you must run the duct bank evaluation. The duct bank evaluation
incorporates section derating and has the ability to update section ratings from thermal ampacity calculations.
It also looks at the thermal loading capacity based on the current flows in model cables.
Once you have the derated amp value specified in the section record and SynerGEE set to use it, you have
successfully derated a section using a duct bank. Exceptions related to amperage will now be based on that
derated value. Keep in mind that the derated amp values are not updated unless you manually run the duct

SynerGEE Electric 5.0

User Guide

798

SynerGEE Cable
bank evaluation. Therefore, if you make any changes to your duct bank configurations, you must run the
evaluation if you want to update section derating values in your model.

TO APPLY A DUCT BANK TO A SECTION

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Construction tab.

Under Construction Model, do the following:

a

Select Duct Bank.

Next to Duct Bank, select the name of the duct bank that you want to apply to the model.
Tip:

Click the

button if you want to edit the duct bank using the Duct Bank editor.

Next to Ckt, select the number of the circuit that you want to apply to the section. Only one
circuit from the duct bank can be used on a section.

Under Instance, select an existing instance name or type a new name. Instances are used
to tie individual sections together in preparation for the duct bank evaluation. For more
information, see Duct Bank Evaluation on page 798.

Click OK to accept your changes, and then click X to close the editor.

DUCT BANK EVALUATION

The duct bank evaluation uses loading values from the load-flow analysis on the current model as ampacity
values within a duct bank. The evaluation calculates temperatures at the core of the hottest cable for each
section and finds available capacity on each cable so that a load increase will not create a thermal overload.
The duct bank evaluation analyzes duct bank instances, which are created in the Construction tab of the
Section editor. When you associate sections with a particular instance, the same duct bank type, and
independent circuit numbers, SynerGEE constructs duct banks from these sections and runs the necessary
ampacity studies.
Section derating and the duct bank evaluation work together to allow you to update section ratings from
thermal ampacity calculations. You can also look at the thermal loading and capacity based on the current
flows in model cables. For more information, see About section derating on page 800.
Refer to the topics listed below for more information.

Setting up a duct bank evaluation on page 798

Performing a duct bank evaluation on page 799

About section derating on page 800

Setting up a duct bank evaluation

Certain steps must be taken to properly apply duct banks to your model and perform duct bank analysis. For
more information, see General Steps for SynerGEE Cable Analysis on page 785.

User Guide

SynerGEE Electric 5.0

SynerGEE Cable

799

Once a duct bank is applied and all components are set up for evaluation, perform the following procedure to
set up the duct bank evaluation.

TO SET UP A DUCT BANK EVALUATION

1

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Fundamentals group, click the text label Duct Bank Studies and then select Settings.

Use the Duct Bank Evaluation editor to set up the following options:

Type of analysis. Select the type of analysis that you want to perform.

Amps on assigned circuits. Select whether to use maximum or average phase amps on
assigned circuits.

Amps on unassigned circuits. Select whether to use duct bank or zero loading on
unspecified circuits.

Neutral loading. Select whether to use neutral loading from the model or from the duct
bank type.

Updating duct banks. Select how the duct bank type will be updated.

Click Apply to accept your changes, and then click X to close the editor.

Performing a duct bank evaluation

Perform the following procedure to run a duct bank evaluation. When the evaluation is complete, the duct
bank evaluation report is displayed. This report contains a Run Summary, a Duct Bank Summary, and a
separate chapter for each duct bank. Each duct bank chapter, in turn, contains the following reports:

Model loading. This report provides a thermal profile of the duct bank when using the loading from
load-flow analysis.

Max loading. This report provides the maximum loading that each circuit can reach without creating
a thermal overload.

Warehouse only. This report provides the ampacity of the duct bank as it exists in the warehouse.

If a section is unfed during a duct bank evaluation, then the thermal rating from the stand alone duct bank is
used for the results.

TO RUN A DUCT BANK EVALUATION

1

If you have not already done so, use the Duct Bank Evaluation editor to configure options related to
the analysis. For more information, see Setting up a duct bank evaluation on page 798.

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Fundamentals group, click the Duct Bank Studies icon.

SynerGEE Electric 5.0

User Guide

800

SynerGEE Cable

About section derating

This function of the duct bank evaluation runs automatically with the evaluation and derates section
amperage ratings based on applied cable duct banks, using SynerGEE cable. It searches the model for any
section with a duct bank applied and updates the amperage rating based on that bank. For any section with a
duct bank applied, section derating populates the Amp Rating text box in the Properties tab of the Section
editor.
In order for this function to apply the amperage rating, these two conditions must be met:

The section must have a duct bank applied, as described in Applying Duct Banks to Sections on
page 797.

The section must be set to use the amp rating from the duct bank.

If the section has an applied duct bank but the second condition is not met, then the duct bank evaluation will
produce an error message and a value will not be applied to the amp rating.

DETAILED CABLE STUDIES USING SCRIPTS

As an alternative to modeling duct banks, you can use a study script to perform derating calculations. A
study script has no interaction with the map or the model, and is strictly a calculation engine designed to
handle complex configurations that would be difficult to model.
Scripts should be used whenever you have a duct configuration that is too complex to model with the
standard interface tools. SynerGEEs calculation engine can handle detailed configurations, well beyond
what can be modeled with the duct bank view and associated tools. Because these tools were designed for
simplicity, the script approach was implemented to allow detailed studies, while maintaining a friendly and
intuitive interface.
Note that the use of scripts has no interaction with the interface, other than the steps required to launch the
script and report the results. If you want to implement the results in your model, it will be your responsibility
afterwards to do so.
For more information on cable study scripts, see Cable Study Scripts on page 721.

User Guide

SynerGEE Electric 5.0

CHAPTER

17
Time-Related
Features
SynerGEE provides a set of time-related features and tools that have a variety of uses and allow you to move
beyond traditional static, peak-day studies. You can use these tools alone, in combination, or not at all,
depending on your specific needs. As an advanced user of SynerGEE time-related features, you will be able
to perform detailed time-related studies and multi-year planning, all with a single model.
Refer to the topics listed below for more information.

Load Growth on page 801

Customer Load Curves/Time-of-Day Analysis on page 808

Controls on page 821

LOAD GROWTH
The most simple time-related load manipulation tool is load growth. Load growth acts as a simple multiplier
against load, specified at the section level. It is not a dynamic feature that considers the passage of time, like
load curves and multi-year analysis. Rather, it is a simple multiplier that is either applied, or is not.
As an example, you can specify growth rates on sections. If you enable those growth rates, SynerGEE
multiplies them against the specified load, for analysis purposes only. Once you disable those growth rates,
section loading returns to normal for analysis purposes. For example, assume that you have a subdivision
demand that you expect to grow by 150% over the next five years. In SynerGEE, you might:
1

Apply a 1.5 growth rate to all sections in the subdivision. This can be done section-by-section in the
Properties tab of the Section editor. Or, you can edit multiple sections at once using the multiple
editor.

In the Growth Options editor, select No growth rate and then run a load-flow analysis to simulate
present-day conditions.

In the Growth Options editor, select Apply yearly growth rate in section records and then run
another load-flow analysis to simulate conditions 5 years from now.

Compare system performance for planning purposes.

The Section editor is not the only location where you can specify growth rates. As described in Specifying
growth rates on page 804, you can also specify growth rates in feeders, customer zones, and growth curves,

SynerGEE Electric 5.0

User Guide

802

Time-Related Features
as well as in the Growth Options editor. Before running an analysis, you can use the Growth Options editor to
choose which growth rates, if any, you would like to use.
Refer to the topics listed below for more information.

Enabling load growth rates on page 802

Specifying growth rates on page 804

Growth curves on page 804

Enabling load growth rates

Use the Growth Options editor to select which growth rates, if any, should be considered for all analyses
except load allocation. Information on the different types of growth rates that you can apply is provided in
Specifying growth rates on page 804.

TO ENABLE A LOAD GROWTH OPTION

1

Perform the following steps to open the Growth Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Growth.

In the Growth Options editor, the Groups list can be used to pre-configure a number of different
Growth Rate combinations. The group that is selected with a check box will be the group that is
applied when you run a SynerGEE analysis. The group that is selected by highlighting the group
name is the current group whose settings you can view and edit in the editor.
The following list describes the tasks that you can perform regarding Growth Rate groups:

To add a group to the list, click the Add a group button.

To remove a group from the list, select the group (by highlighting the group name) and click
the Delete the selected group button.

To edit the settings for a group, select the group (by highlighting the group name) and then
edit the available settings as described in the rest of this procedure. Click Apply to apply
the changes to the group.

Edit the following settings for the current group (the group that is selected by highlighting the group
name). When you are done, click Apply to apply the changes to the group.
Description

User Guide

Name of the growth group.

SynerGEE Electric 5.0

Time-Related Features

Growth Options

Affected Loads

Years of Growth

Capacity Factors

SynerGEE Electric 5.0

803

Select from one of the following options:

No growth rate. No load growth is applied.

Apply multiplier in feeder record. Applies the growth rate

multipliers that are specified on the Feeder tab of the Feeder
editor.

Apply yearly growth rate in section records. Applies the

growth rate multipliers that are specified on the Properties
tab of the Section editor. The growth rate will be applied for
the length of time that is selected under the Years of
growth option.

Apply yearly growth rate in customer zone. Applies the

growth rate multipliers that are specified in the Customer
Zone editor for each customer zone. The growth rate will be
applied for the length of time that is selected under the
Years of growth option.

Use growth curves with multi-year model. Applies the

growth rate multipliers that are specified in the in Growth
Curve editor for each growth curve. The growth rate will be
applied for the length of time that is selected under the
Years of growth option.

Apply load multiplier. Applies specified load multipliers for

distributed loads, spot loads, large customers, projects, and
speculative loads.

Choose the types of load you wish to have affected by the growth
rate. Available choices are follows:

Distributed loads only

Spot loads only

Both distributed and spot loads.

Specifies the number of years that growth rates will be applied when
you select one of the three Apply yearly growth options. Available
choices are as follows:

Grow to analysis year. Growth rates will be applied from

the base year to the current analysis year.

Specify years to grow. Growth rates will be applied starting

at the base year and continuing for the specified number of
model years.

Select one or both check boxes to apply capacity factors for

distributed loads and spot loads, respectively, to the growth load. For
each option, the capacity factor value that corresponds to the analysis
year will be applied. The second option multiplies the kW and kvar
values by the capacity factor.

User Guide

804

Time-Related Features
4

Click Apply to apply the changes to the group.

Repeat the steps in this procedure to edit additional groups, as required.

Click X to close the editor.

Specifying growth rates

You can specify growth rates in a number of different places in SynerGEE, as described in the following lists.
SynerGEE provides a variety of different places where you can specify a growth multiplier, including:

Feeders. In the Feeder tab of the Feeder editor, feeder growth rates are specified as the Feeder
Multiplier. When feeder growth rates are enabled in the Growth Options editor, the growth rates are
applied to all sections owned by the respective feeder. For more information on editing a feeder, see
Editing a feeder or subtran node on page 247.

Sections. In the Properties tab of the Section editor, section growth rates are specified as the %
Growth Rate / Year. When section growth rates are enabled in the Growth Options editor, the
growth rates are applied to their respective sections only. Section growth rates are specified as
percentages, and in the Growth Options editor, you must enter the total number of years for
SynerGEE to calculate the actual multiplier. For more information on the actual multiplier
calculations, see the SynerGEE Technical Reference.

Customer zones. In the Customer Zone editor, customer zone growth rates are specified as the
Zone Growth Rate. When customer zone growth rates are enabled in the Growth Options editor,
the growth rates are applied to any sections that are within the respective zones. Customer zone
growth rates are specified as percentages, and in the Growth Options editor, you must enter the
total number of years for SynerGEE to calculate the actual multiplier. For more information on the
actual multiplier calculations, see the SynerGEE Technical Reference.

Growth curves. Growth curves are a collection of independent, annual growth rates that are mostly
used in the multi-year modeling environment. Growth rates may be negative, to simulate declining
demand. For more information, see Growth curves on page 804.

Growth Options editor. In the Growth Options editor, you may specify different load multipliers for
distributed loads, spot loads, large customers, projects, and speculative loads. Use a value of zero
to simulate the removal of load altogether.

It is important to note that load growth does not facilitate a time range-type of analysis that steps through time
and incrementally increases or decreases load. Rather, it is simply a quick means of simulating load growth
at the outset of analysis. In the case of growth curves, SynerGEE can look to future years to calculate the
final growth factor, but still does not perform any dynamic, time-sensitive analyses, such as those allowed by
customer load curves.

Growth curves
A growth curve is a collection of annual growth rates that you can assign to sections as a zone, rather than
using individual, granular growth rates. Assigning growth rates by means of growth curves has the following
advantages:

User Guide

They are spatial, allowing growth rates to be assigned quickly and geographically.

SynerGEE Electric 5.0

Time-Related Features

805

They serve as a central management point for growth rate data. Once section assignments are
made, you can edit the data in a single place to make sweeping changes in your model, perhaps to
quickly simulate changing trends.

Each year has an independent growth rate. Therefore, they can enhance growth simulations when
used in a multi-year modeling environment. For example, you can use a growth curve to simulate
trends such as an area that may grow quickly for the next few years and then saturate.

Growth curves have the most value when used in a multi-year modeling environment, but you can still use
them to apply growth spatially to any SynerGEE model. If you do not use multi-year modeling but still want to
apply growth with growth curves, see Using growth curves in a single-year environment on page 808.

Creating a growth curve

Perform the following procedure to create a new growth curve in your model.

TO CREATE A GROWTH CURVE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Growth Curve.

In the Enter Device ID dialog box, type a name for the new growth curve and then click OK.

Use the Growth Curve editor to edit the settings for the growth curve. For more information on the
options you can set, see Editing a growth curve on page 805.

Editing a growth curve

To edit a growth curve, double-click the growth curve name in the Warehouse tab of the SynerGEE model
explorer. From the Zone tab in the Section editor, you can also click the edit button that is located next to the
name of the selected growth curve.
Refer to the following procedure for more information.

TO EDIT A GROWTH CURVE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Growth Curves and then double-click the name of the growth curve that you want to edit.

Use the Growth Curve editor to edit the following options:

Description

Optional description for the growth curve.

Color

Select a color to represent sections that have been assigned to

this growth curve when you color the map by growth curves
settings. For more information on coloring the map, see
Selecting a Coloring Scheme for Sections on page 216.

SynerGEE Electric 5.0

User Guide

806

Time-Related Features

Growth Rate

Use the growth rate chart to specify a growth rate for each
analysis year. If desired, you can click the Toggle button to
change the graph to a table that you can also use to enter the
yearly growth rates.
Keep in mind that you are specifying percentages, and not flat
multipliers like other growth rates in SynerGEE. For more
information on growth rates as they are used in growth curves,
see Using growth curves in a multi-year environment on
page 807.

Click Apply to accept your changes, and then click X to close the editor.

Configuring SynerGEE to use growth curves

Perform the following procedure to configure SynerGEE to use growth curves.

TO CONFIGURE SYNERGEE TO USE GROWTH CURVES

1

Perform the following steps to open the Growth Options editor:

a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Growth.

In the Growth Options editor, under Growth Options, select Use growth curves with multi-year
model.

Next to Growth Years, set the number of years over which to apply the growth curve.

Click Apply to accept your changes, and then click X to close the editor.

Applying a growth curve to a section

Perform the following procedure to apply a growth curve to a section.

TO APPLY A GROWTH CURVE TO A SECTION

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Zone tab.

Next to Growth Curve, select the name of the growth curve that you want to assign to the section.

Click Apply to accept your changes, and then click X to close the editor.
Tip:

If you have multiple sections to assign, you may find it more convenient to use the Multiple
Editor. For more information on the Multiple Editor, see Using the Multiple Editor on
page 177.

Deleting a growth curve

Perform the following procedure to delete a growth curve from your model.

User Guide

SynerGEE Electric 5.0

Time-Related Features

807

TO DELETE A GROWTH CURVE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Growth Curves and then select the name of the growth curve that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Using growth curves in a multi-year environment

A growth rate in a growth zone functions as a flat multiplier against load like any growth rate, except with the
multi-year component. For example, if you have SynerGEE operating in Year 4, analyses will use the Year
4 load multiplied by the Year 4 growth rate.
Growth curves also support a more advanced, non-linear projection of future growth, by means of a growth
years setting in the growth options. When this number is greater than one year, SynerGEE applies future
growth rates in a cumulative fashion, according to the number of years specified. To illustrate this concept,
consider the following partial data from a growth curve:
Year

Growth rate

2011

5%

2012

10%

2013

15%

2014

10%

2015

5%

2016

2%

2017

1%

To demonstrate how these rates would work, assume that you have this growth curve applied to a section
and the interface is set to 2014. The following examples demonstrate how different growth years could affect
growth rate application:
Number of
years

Effect on section load

No growth applied

Growth rate for 2014 only, applied to 2014 load (10%)

Growth rate for 2014 and 2015 applied to 2014 load, progressively (rate 10%, then 5%)

Growth rate for 2014, 2015, and 2016 applied to 2014 load, progressively (rate 10%,
then 5%, then 2%)

SynerGEE Electric 5.0

User Guide

808

Time-Related Features
If multiple years of growth are applied, the rates are applied in progression. For example, if the three rates
10%, 5%, and 2% were applied to a load, the general formula would be:
Eq 171

(load) * 1.1 * 1.05 * 1.02

SynerGEE never looks backwards for load or rate information, nor does it accumulate rates from past years
when analyzing any given year. It always starts with the current years load and the current rate, and may
apply future rates depending on the growth years setting. For instance, in the previous example, growth rates
for any year previous to 2014 would not be used in any case.
For more information on multi-year modeling, see Multi-Year Analysis on page 579.

Using growth curves in a single-year environment

Growth curves have the most value in a multi-year modeling environment, but they can be used in a singleyear environment to apply growth rates spatially, versus specifying them directly as section growth rates. If
you do not use multi-year modeling but you want to use growth curves anyway, you could do the following:
1

Define your growth curves with only the first year (base year) rate specified.

Apply growth curves to sections.

Set your growth options to use growth curves, specifying the growth years as 1.

If you do not change the interface year, and you always have the growth years setting at 1, a growth rate in
a growth curve functions like a section-level growth rate. If you use growth curves in this manner, multi-year
features will be mostly invisible and should not be of concern.

CUSTOMER LOAD CURVES/TIME-OF-DAY ANALYSIS

SynerGEE supports the modeling of loads using 24-hour daily load curves. By creating and applying load
curves, you can conduct much more comprehensive analyses than with traditional peak loading alone. With
daily load curves, you can study your system on- or off-peak, at a chosen hour, day, and month. For example,
you could study your system at peak loading or at minimum loading for an upcoming season. Or, you could
study the trends in load movement across or between feeders during the daylight hours of a weekday in July.
Load curves are optional. If you do not specifically use them, by default your studies will be traditional peak
load in nature, and load curves will be non-applicable and largely invisible. However, if you do use load
curves, be aware that they integrate at a fundamental level. Most SynerGEE applications will consider load
curves and the time-of-day that you select for analysis. For more information on enabling load curves and
setting the time-of-day for analysis, see Enabling load curves on page 818.
If you use load curves, you should first have a properly allocated model. While you can model your loads on
your sections the normal way, through load allocation of peak values, it is preferable to allocate with
consideration of time-of-day instead. For more information, see Load curves and load allocation on
page 819.
Refer to the topics listed below for more information. For more information on load curve calculations, see the
SynerGEE Technical Reference.

User Guide

Load curve benefits on page 809

SynerGEE Electric 5.0

Time-Related Features

Getting started with load curves/time-of-day on page 809

Customer classes on page 810

Customer zones on page 815

Enabling load curves on page 818

Load curves and load allocation on page 819

Load curves and large customers on page 821

Load curve summary on page 821

809

Load curve benefits

Load curves can fuel SynerGEE simulations and engineering studies in many ways. Some of the primary
ways include the following:

Reconfiguration studies can be more complete by looking at loading on- and off-peak.

Load curves are built from historical load data. Their use gives some degree of foresight into feeder
and system demand.

Running an analysis over time allows the consideration of energy delivery and loss.

SynerGEE can find peak and minimum loading times on given months or over the year. It can
present information about loading or voltage trends over that period.

Load curves are a basis for powerful and detailed simulations. It should be noted that the intention of the
feature is not to facilitate exact replication of the distribution system. Rather, the goal is to support a
consistent and predictable model that supports time-of-day and time range simulation. This type of modeling
is essential for making decisions that are most beneficial to customers and the utility throughout daily,
monthly, and yearly operation.

Getting started with load curves/time-of-day

Implementing load curves requires multiple steps, due to the tier fashion in which the data is organized. To
fully implement load curves, you should follow these basic steps:
1

Decide how you are going to create your curves, in regards to a data source. You have a variety of
options, including the following:
-

Use existing curve or usage data. If you have existing data that represents 24-hour usage
trends, you might use this to create your SynerGEE load curves. This data could be input
manually in SynerGEE, or you could construct a method of importing the data directly into
your equipment data source. Your methods would depend on the amount of data you have
and your level of IT support and/or data management resources.

Use traditional or hypothetical load shapes. By making educated judgment of your system
and its demands, you could use SynerGEE to create load curves that follow common
usage trends, perhaps found in other reference material.

Build curves from scratch. If you have a good idea of specific usage trends in your system,
you could build your own customized curves directly in SynerGEE. However, this process

SynerGEE Electric 5.0

User Guide

810

Time-Related Features
could be time-consuming, depending on how many curves you need to create. SynerGEE
does provide some tools to make the process quicker, including curve copy/paste and
automatic curve extrapolation. You can find these tools in the Customer Class editor, as
described in Editing a customer class on page 811.
2

In SynerGEE, establish your load curves by creating customer classes, which are stored as
equipment data. For more information, see Customer classes on page 810.

With customer classes established, combine them to create customer zones, which are also stored
as equipment data. For more information, see Customer zones on page 815.

Apply customer zones to sections. For more information, see Applying customer zones to sections
in the model on page 817.

Allocate load with consideration of time-of-day. For more information, see Load curves and load
allocation on page 819.

Establish a time-of-day for analysis and run analyses. For more information, see Enabling load
curves on page 818.

Customer classes
A customer class stores your basic load curve data. A customer class consists of at least 36 curves, including
a percent kW curve for a weekday, weekend, and peak day for each of the twelve months in a year. In
addition, you can optionally specify another 36 curves for percent kvar.
SynerGEEs Customer Class editor can help you create, view, copy, and modify curves in a customer class.
Customer classes are stored in your equipment data source and can be managed through the Warehouse
tab of the model explorer.
Refer to the topics listed below for more information.

Creating a customer class on page 810

Editing a customer class on page 811

Deleting a customer class on page 815

Creating a customer class

Perform the following procedure to create a new customer class in your model.

TO CREATE A CUSTOMER CLASS

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Customer Class.

In the Enter Device ID dialog box, type a name for the new customer class and then click OK.

Use the Customer Class editor to edit the settings for the customer class. For more information on
the options you can set, see Editing a customer class on page 811.

Creating a customer class is identical to creating any zone or equipment type. For more information, see
Creating a device type on page 319.

User Guide

SynerGEE Electric 5.0

Time-Related Features

811

Editing a customer class

To edit a customer class, double-click the customer class name in the Warehouse tab of the SynerGEE
model explorer. From the Customer Zone editor, you can also click the edit button that is located next to the
name of a selected customer class.

TO EDIT A CUSTOMER CLASS

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Customer Classes and then double-click the name of the customer class that you want to
edit.

On the left side of the Customer Class editor, select from the different tab names to access the
available settings for the customer class. The following topics describe the different tasks that you
can perform:

Editing load curves for a customer class on page 811

Editing class information for a customer class on page 812

Editing coincidence settings for a customer class on page 813

Click Apply to accept your changes, and then click X to close the editor.

Editing load curves for a customer class

A customer class can have up to 72 individual load curves associated with it, including Peakday, Weekday,
and Weekend load curves for each month in the year for both kW and kvar load curves, depending on how
your options are set. All of these load curves are created in the Load Curves tab of the Customer Class
editor. You can create and edit each curve individually, by selecting the appropriate Day Type and Month and
then editing the hourly load percentage values in either a graph or a table-based format. However, you may
find it more efficient to create your first curve, use the buttons in the Customer Class editor to copy that curve
to other Day Types and Months, and then further modify the other curves if necessary.
Refer to the following procedure for more information on editing load curves for a customer class.

TO EDIT CUSTOMER CLASS LOAD CURVES

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Customer Classes and then double-click the name of the customer class that you want to
edit.

In the Customer Class editor, select the Load Curves tab.

Select the Day Type and Month for the first load curve that you want to edit. If enabled, select the
kW or kvar option button to specify whether you are creating a curve or real or reactive power.
(These two option buttons are enabled only when you have selected the Customer load based on
kW and kvar curves option on the Information tab of the editor.)

The graph in the Customer Class editor provides average hourly load percentages for the selected
day type and month. Click any bar in the graph and drag it to a new location to set the new value.
The current value is shown in a text popup that appears next to the mouse cursor.
You can also do any of the following:

SynerGEE Electric 5.0

User Guide

812

Time-Related Features
-

Use the Pf (%) text box to set the Pf percentage for the selected Day Type and Month.
(This text box is enabled only when you have selected the Customer load based on kW
and pf curves option on the Information tab of the editor.)

Click the Toggle button to change the graph to a table that you can also use to enter the
hourly load percentage values.

Toggle button, Customer Class editor

Click the Shift Left and Shift Right buttons to shift the hourly load percentage values for
every curve in the customer class by one hour in either direction. Note that these two
buttons affect all curves, and not just the one curve that you are currently viewing.

Shift Left and Shirt Right buttons, Customer Class editor

Click the Copy button to copy the values from the current curve that you are viewing. You
can then select a different Day Type or Month and then click the Paste button to apply the
copied load curve to the newly selected day type and month.

Copy and Paste buttons, Customer Class editor

Click the Create Scaled Load Curves button to generate curves for the entire year,
including all months and all day types, based on the curve you are currently viewing. You
can provide multiplier values, if desired, to adjust the curves for each of the remaining 11
months. Or, you can leave the multiplier at 1.0 to create exact duplicates of the current
curve for each day type and month.

Created Scaled Load Curves button, Customer Class editor

Repeat these steps to edit the load curve data for each Day Type and Month in your profile.

Click OK to accept your changes, and then click X to close the editor.

Editing class information for a customer class

Perform the following procedure to edit class information for a customer class.

TO EDIT CLASS INFORMATION FOR A CUSTOMER CLASS

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Customer Classes and then double-click the name of the customer class that you want to
edit.

User Guide

SynerGEE Electric 5.0

Time-Related Features
3

813

In the Customer Class editor, select the Information tab. The following table describes the different
options that you can set.
Description

Optional description for the customer class.

Curve Basis

Species the criteria on which the load curves are based. The
following options are available:

Customer load based on kW and kvar curves. If you

select this option, you will need to specify individual curves
for real and reactive power demand in the Load Curves tab
of the Customer Class editor.

Customer load based on kW and pf curves. If you select

this option, the Pf (%) text box in the Load Curves tab of the
Customer Class editor is activated, and you must specify
curves for the real component only.

For more information on editing customer load curves, see Editing

load curves for a customer class on page 811.

Calculate peaks from

load curves

Select this check box to have SynerGEE summer and winter peak
values from the load curves defined for the customer curve. If the
check box is cleared, SynerGEE will use the factors that you define
here for summer and winter months.

Non-Time of day load

multipliers

Use these fields to set kW Load and kvar Load factors based on a
percentage of the peak load. These values are used when time of day
modeling is turned off.

Weather settings

Use these fields to set monthly weather load factors. For more
information on these weather-related options, see Modeling weather
using weather profiles on page 825.

Load model

Use these fields to set the Current, Impedance, and Power values
for the load.

Click OK to accept your changes, and then click X to close the editor.

Editing coincidence settings for a customer class

Perform the following procedure to edit coincidence settings for a customer class.

TO EDIT COINCIDENCE SETTINGS FOR A CUSTOMER CLASS

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Customer Classes and then double-click the name of the customer class that you want to
edit.

SynerGEE Electric 5.0

User Guide

814

Time-Related Features
3

In the Customer Class editor, select the Coincidence tab. The following table describes the different
options that you can set.
Cold Load Pickup

Cold load pickup refers to the increased currents encountered when

re-energizing a circuit after an extended outage. The short term
increase in currents, due to loss of load diversity and feeder inrush,
can require accommodation in the protective relay settings, or affect
performance of the protection scheme.
In the Cold Load Pickup area, enter the percentage of current that is
encountered at each time interval after an outage event for both
Summer and Winter conditions. For example, enter 115% if the
current has increased by 15% at a specified time interval. Enter 100%
if there is no change in the current.

Coincidence Factors
Per Number of
Customers

Specify coincidence values for the given customer counts. The

coincidence factor is a function of the number of customers in the
customer class. The demand created by two or more customers is
normally less than the sum of their individual demands because the
peak demand for each customer occurs at a different time. For
example, one customers peak demand may occur in the early
morning and another customers peak may occur in the early
evening. Peak load (demand) per customer drops as more customers
are added to the group.
For more information on coincidence factors, see the SynerGEE
Technical Reference.

Click OK to accept your changes, and then click X to close the editor.

Editing economic data for a customer class

Perform the following procedure to edit economic data for a customer class.

TO EDIT ECONOMIC DATA FOR A CUSTOMER CLASS

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Customer Classes and then double-click the name of the customer class that you want to
edit.

In the Customer Class editor, select the Economics tab. The following table describes the different
options that you can set.
Outage costs

User Guide

Use the following fields to set outage costs for when service is
interrupted:

Outage Cost

Sustained Interrupt Cost

Momentary Interrupt Cost

SynerGEE Electric 5.0

Time-Related Features
4

815

Click OK to accept your changes, and then click X to close the editor.

Deleting a customer class

Perform the following procedure to delete a customer class from your model.

TO DELETE A CUSTOMER CLASS

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Customer Classes and then select the name of the customer class that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Customer zones
Once you have set up customer classes, as described in Customer classes on page 810, you are ready to
define customer zones. Customer zones are essentially a mixture of up to three customer classes in
specified proportions that determine how much of a sections spot and distributed load pertain to each class.
Once established, customer zones can be applied to the sections in a model using the Section editor.
Customer zones serve as an intermediary between the raw load curve data and the model. This intermediate
step is necessary to avoid detailed and granular curve data at the section level. It would be burdensome to
apply customer classes and percentages at the section level for an entire model. The concept of customer
zones makes the process much simpler, consolidating load curves into a single data item that can be applied
at the section level. And, because proximal distribution loads tend to have a similar customer makeup,
customer zones make it convenient to populate the same curve data to large regions of your model. Consider
the following diagram, with three hypothetical zones sketched on it.

Customer zones sketched on a sample model

Ideally, a system should be divided into zones based on the approximate demand or usage of various
customer types. For example, the zone on the left may be a mixture of approximately 30% all-electric
customers and 70% gas heat customers, while the zone on the right may be 100% all-electric customers.
Customer zone assignments are optional and can be assigned independently to sections for spot loads and
distributed loads. If a customer zone is not specified on a section for either or both load types, then nominal
kW and kvar is used, as applicable.

SynerGEE Electric 5.0

User Guide

816

Time-Related Features

Creating a customer zone

Perform the following procedure to create a new customer zone in your model.

TO CREATE A CUSTOMER ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Customer Zone.

In the Enter Device ID dialog box, type a name for the new customer zone and then click OK.

Use the Customer Zone editor to edit the settings for the customer zone. For more information on
the options you can set, see Editing a customer zone on page 816.

Editing a customer zone

To edit a customer zone, double-click the customer zone name in the Warehouse tab of the SynerGEE model
explorer. From the Load - Dist and Load - Spot tabs of the Section editor, you can also click the edit button
that is located next to the name of the selected customer zones, if applied.
Refer to the following procedure for more information.

TO EDIT A CUSTOMER ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Zones - Customer and then double-click the name of the customer zone that you want to
edit.

Use the Customer Zone editor to edit the following options:

Description

Optional description for the customer zone.

Customer Class

Select up to three customer classes to apply to the customer

zone, and specify a percentage of that class that will be applied
to the zone. As you change the percentage for one class, the
percentages of the other classes will be modified automatically
be modified to always total 100%.
For more information on customer classes, see Customer
classes on page 810.

User Guide

Composite Load Curve

(read-only)

Displays a read-only view of the combined customer class load

curves for the selected Day Type and Month. The curve in this
read-only view will change as you apply different customer zones
and change the percentages that are applied to each zone.

Zone Growth Rate

Specify a zone growth rate. For more information on growth

rates, see Load Growth on page 801.

SynerGEE Electric 5.0

Time-Related Features

Color

817

Select a color to represent sections that have been assigned to

this customer zone when you color the map by customer zones
settings. For more information on coloring the map, see
Selecting a Coloring Scheme for Sections on page 216.

Click Apply to accept your changes, and then click X to close the editor.

Applying customer zones to sections in the model

Customer zones can be applied to sections directly by using the Section editor or in bulk by using the Multiple
Editor. Refer to the procedures listed below for more information.

To apply customer zones to sections using the Section editor on page 817

To apply customer zones to sections using the Multiple Editor on page 817

TO APPLY CUSTOMER ZONES TO SECTIONS USING THE SECTION EDITOR

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

Perform the following steps to apply customer zones to your model:

To ...
Apply a customer zone to
distributed loads

Do This ...
a

In the Section editor, select the Load - Dist tab.

Select the Use Customer Zone check box.

Use the customer zone options list to select the name of

the customer zone that you want to apply to the section
for distributed loads.

For more information on working in the Load - Dist tab, see

Adding distributed loads to a section on page 284.
Apply a customer zone to
spot loads

In the Section editor, select the Load - Spot tab.

Select the Use Customer Zone check box.

Use the customer zone options list to select the name of

the customer zone that you want to apply to the section
for spot loads.

For more information on working in the Load - Spot tab, see

Adding spot loads to a section on page 287.
3

Click Apply to accept your changes, and then click X to close the editor.

TO APPLY CUSTOMER ZONES TO SECTIONS USING THE MULTIPLE EDITOR

1

Build a query set that includes the sections that you want to edit. For more information, see Using
the Query Set on page 173.

Perform the following steps to open the Multiple Editor:

SynerGEE Electric 5.0

User Guide

818

Time-Related Features
a

In the SynerGEE ribbon bar, select the TOOLS tab.

In the Model group, click Multiple Editor.

Along the top of the Multiple Editor, click the Zones button.

On the left side of the Multiple Editor, select Customer.

Use the check boxes on the right side of the Multiple Editor to select the actions that you want to
perform for both distributed and spot load modeling. The selected actions will be applied to all
sections in the query set that you created in step 1.
The available actions are as follows:

Change Zone Usage Status. Select this check box to enable, disable, or toggle the status
of the Use Customer Zone check box for the queried sections.

Change Customer Zones. Select this check box to apply a selected customer zone to the
queried sections.

Change I, Z, PQ Status. Select this check box to enable, disable, or toggle the status of
the Use %I, %Z, %PQ values from customer classes check box for the queried sections.

Click OK to apply the changes to the model and close the Multiple Editor.
For additional information on working in the Multiple Editor, see Using the Multiple Editor on
page 177.

Deleting a customer zone

Perform the following procedure to delete a customer zone from your model.

TO DELETE A CUSTOMER ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Zones - Customer and then select the name of the exposure zone that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

Enabling load curves

To enable load curves, you only need to specify a time-of-day for analysis. Time-of-day specification is done
on the Hour/Day tab of the Time and Weather Options editor, as described in Selecting the analysis year and
time of day on page 434.
When you specify a time-of-day, you have the option of selecting a specific date, which can include a year.
Note that this year is not applicable to multi-year modeling/analysis. If you are performing analyses in a multiyear environment, the only year that affects multi-year data is the year that the interface is set to. For more
information on multi-year modeling, see Multi-Year Analysis on page 579.
The current time-of-day is not conspicuous anywhere in the interface, other than in the Time and Weather
Options editor. Analysis reports do indicate if a current time-of-day is active, but you should always remain
aware of the current setting because the usage of load curves can have a significant impact on results.

User Guide

SynerGEE Electric 5.0

Time-Related Features

819

Load curves and load allocation

If you intend to perform time-of-day analyses, you should first properly allocate load. SynerGEEs load
allocation engine can fully consider time-of-day and can be an important step toward accurate time-related
analysis. While you can perform time-of-day studies on a model allocated at traditional peak load values, the
results may be less realistic.
For more information on load allocation, see Load Allocation Analysis on page 549. For information on the
results produced during time-sensitive allocation, see Understanding time-sensitive allocation results on
page 820.
Refer to the topics listed below for more information.

Choosing the time to allocate load on page 819

Preparing the model for time-sensitive allocation on page 819

Understanding time-sensitive allocation results on page 820

Handling the model after time-sensitive allocation on page 820

Choosing the time to allocate load

In theory, you can choose to allocate load at any time, provided that the following are true:

You have accurate metered demands information for that time.

Your curves are accurate and properly applied.

When you allocate, SynerGEE uses curve values at that particular time point to calculate peak distributed
load. This distributed load, then, should be appropriate for any other time-of-day as well. For more
information on how these calculations are performed, see Understanding time-sensitive allocation results
on page 820.
If possible, it is generally recommended to select a time of peak loading for allocation, based on your
judgment. That is, you should determine a day and hour of overall peak loading, and specify that time in the
Hour/Day tab of the Time and Weather Options editor, as described in Selecting the analysis year and time
of day on page 434. You should not use the automatic Peak load time on peak day option, because this
option refers to analyses conducted after allocation and evaluates existing distributed load only.
It is important to understand that no method is absolutely correct for every situation. When you use load
curves, many layers of data and mathematics are working simultaneously and you must employ your best
judgment to use them responsibly. It may take several iterations of allocation and test analyses to ensure that
your setup is appropriate. For example, if you allocate at a self-determined time of peak load, you might run
load-flow analyses afterward to see if SynerGEE agrees with the time you selected and produces reasonable
numbers. To do so, in the Hour/Day tab of the Time and Weather Options editor, select the Peak load time
on peak day option, run a load-flow analysis, and observe the time indicated on the report.

Preparing the model for time-sensitive allocation

In general, you should not need to perform any major preparations for time-sensitive allocations. Before
allocating, though, be sure that:

All load curves/classes/zones are fully established and assigned as appropriate.

SynerGEE Electric 5.0

User Guide

820

Time-Related Features

Metered demands at sources and elsewhere accurately reflect the particular time-of-day you
choose for allocation.

Depending on your workflow, you may find demands subsets much more convenient for configuring
demands, rather than manual work in the SynerGEE editors. For more information, see Subsets on
page 82.

Understanding time-sensitive allocation results

One of the primary challenges of time-sensitive allocation is understanding the results. To perform effective
time-sensitive allocation, you should have a good understanding of the SynerGEE methodology behind it.
When you allocate at a certain time-of-day, SynerGEE still attempts to allocate peak load through
extrapolation of the current load curve settings and demands. In essence, SynerGEE regards the specified
demands as specific to the current load curve percentages and attempts to derive a peak load from them,
section by section. For this reason, allocation results may initially appear significantly higher when performing
time-sensitive allocations, and this is normally correct.
For example, assume that you have a feeder with a total of 1000 kVA in specified demands at the source via
meter, and an equal 1000 ckVA in transformer load. If you allocate without a time-of-day setting, that is,
traditional peak load/demand, you would probably see close to 1000 kVA of total allocation, minus line loss
and other factors. However, if you allocate using a time-of-day when the average usage is around 50%, you
could expect to see twice the amount allocated. This is because SynerGEE extrapolates the peak load by
using the load curve percentages in reverse, and assigns those values to sections. In this manner, allocated
load should be appropriate then for any time-of-day, while allocated more accurately than through a timeinsensitive peak load/demand allocation. Also, this is why it is important that your demands are accurate for
the particular time-of-day. In the previous example, if 1000 kVA represents peak demand, your specified
demands for time-sensitive allocation at 50% should be closer to 500 kVA, which will keep your results more
realistic in comparison to peak-load, time-insensitive allocation.
When viewing time-sensitive allocation results, you must always keep in mind that the numbers are
somewhat meaningless outside of the context of applied load curves. When evaluating the numbers, look at
them from the perspective of curve percentages when the allocation was performed, and recognize that in
the end, you are still looking at peak loading that was calculated based on those percentages. If the numbers
are still too high, you likely have data problems, either with your curve data, or perhaps your demands are too
high for the specified time.
For detailed information on the calculations performed during time-sensitive allocation, see the SynerGEE
Technical Reference.

Handling the model after time-sensitive allocation

After you have allocated, you should be able to run time-sensitive analyses at will, using the Hour/Day tab of
the Time and Weather Options editor to configure the time-of-day as desired. If the allocation was performed
correctly, you should not need to allocate again unless your model is updated with new load or demand data.
As noted elsewhere, however, be sure that you do not use the model for traditional, time-insensitive studies
unless you reallocate with that method. That is, before performing an analysis with the Ignore time of day
option selected, you should reallocate with that option, using peak feeder/subtran demands.

User Guide

SynerGEE Electric 5.0

Time-Related Features

821

Load curves and large customers

With a large customer, you can specify a separate customer zone for the load component and the generation
component. In the Large Customer editor, the zone is referred to as scheduling. When you apply a
customer zone to the generation component of a large customer, it functions similarly to a load, except that it
controls the percentage of generation capacity, rather than a load. For more information on large customers,
see Large Customers and Distributed Generation on page 503.

Load curve summary

Customer load curves, zones, and so on are analytically straightforward in SynerGEE. Their handling and the
data used to generate them can have tremendous impacts on engineering studies. Their use can provide
valuable insight into the best overall operation of a distribution system.
In summary:

The use of load curves is optional. By default, they are not used. For more information on enabling
the use of load curves, see Enabling load curves on page 818.

Loads should be allocated once using known demands at a known time point. After allocating,
applications such as load-flow can be run at different time points. The quality of the load models at
other time points depends on the quality of the customer load curves and the formulation of
customer zones. For more information, see Load curves and load allocation on page 819.

Billing data is important to the formulation of load curves and the formulation of zones. For
advanced users, it is possible to construct load data completely outside of SynerGEE without the
use of load allocation at all. External load data can then be imported into SynerGEE, perhaps by use
of subsets. For more information on subsets, see Subsets on page 82.

CONTROLS
SynerGEE has a script-based controls module that allows complex control systems to be modeled in the time
or frequency domain. A vast number of possibilities may be executed with the controls system. Such projects
include a load-pulse analysis to simulate load pulses over time, or developing a frequency domain model for
an induction motor. Please refer to the SynerGEE Technical Reference for more details regarding types of
control systems, and sample scripts and equations.

TO CREATE A CONTROL SYSTEM SCRIPT

1

Perform the following steps to open the Control Options editor:

a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Controls and then select Settings.

In the text box below the list of control system scripts, type the name of the script that you want to
create.

Click New. Notepad opens in a new window where you can type the script.

When you are finished writing the script, select File > Save from the Notepad main menu.

SynerGEE Electric 5.0

User Guide

822

Time-Related Features

TO RUN A CONTROL SYSTEM

1

Perform the following steps to open the Control Options editor:

a

In the SynerGEE ribbon bar, select the ANALYSIS tab.

In the Applications group, click the text label Controls and then select Settings.

In the list of control scripts, select the name of the control system script that you want to run.

Click Apply to accept the selection and then click X to close the editor.

From the ANALYSIS tab in the SynerGEE ribbon bar, click the Controls icon. This will run the script
that you selected in the Control Options editor.

User Guide

SynerGEE Electric 5.0

CHAPTER

18
Weather
Weather can have a variety of impacts on a distribution model. For example, temperature, wind speed, and
relative humidity can each have an impact on load. Temperature can also impact overhead conductor
resistance, and conductors can have summer and winter rating load limits that need to be considered.
SynerGEEs weather modeling features allow you to realistically model the behavior that occurs in the grid as
weather changes occur over the course of a year. This chapter summarizes the edits that you will need to
make to model the effects of weather on your system. A more detailed discussion on weather modeling in
SynerGEE is provided in the SynerGEE Technical Reference.
Refer to the topics listed below for more information on modeling the impact of weather in SynerGEE.

An Overview of Weather Modeling in SynerGEE on page 823

Defining Weather Conditions on page 824

Adjusting Loads Based on Weather Conditions on page 828

Configuring Seasonal Weather Modeling on page 831

Using Weather Zones to Model Variations in Cloud Cover on page 834

AN OVERVIEW OF WEATHER MODELING IN

SYNERGEE
Weather modeling is set up using a number of different editors in SynerGEE. The following list discusses
many of the options that you can configure in SynerGEE.

Weather conditions. Weather conditions are defined using the Weather tab of the Time and Weather
Options editor. Several options are available. For example, you can use a simple set of weather set
points to define constant values for humidity, irradiance, temperature, and wind speed. You can also
select to use more advanced weather profiles, which allow you to vary these four weather conditions
on both an hourly and a monthly basis.
For more information on defining the weather conditions for your model, see Defining Weather
Conditions on page 824.

Weather-based impacts on loads. SynerGEE provides two ways to adjust distributed and spot loads
based on changes in weather conditions. In the Time and Weather Options editor, you can define
global settings for weather factors and latency effects. These global settings can be enabled for spot
loads, distributed loads, or both spot and distributed loads for both summer and winter months. As a

SynerGEE Electric 5.0

User Guide

824

Weather
second option, instead of the global settings, you can configure SynerGEE to consider these same
inputs but on a more regional basis through the use of customer zones and customer classes.
For more information on configuring a model to simulate the impact of changing weather conditions
on loads, see Adjusting Loads Based on Weather Conditions on page 828.

Seasonal ratings. Conductors, regulators, and transformers can be set up with summer ratings and
winter ratings for continuous amps and emergency amps. The continuous amps ratings are used in
SynerGEE analyses to calculate the percent loading and to display overload exceptions. The
emergency amps rating is used in balanced and by-phase analyses and capacitor placement to flag
overloaded sections and to display regulator overload exceptions. The season that is used by the
SynerGEE model is selected on the Exceptions tab of the Model and Analysis Options editor.
For more information on using seasonal ratings in SynerGEE, see Configuring Seasonal Weather
Modeling on page 831.

Weather profiles. Weather profiles allow you to supply more detailed information about weather
conditions over the course of a year. Weather profiles are often used to model variations for different
weather conditions. For example, you can create weather profiles for a mild summer and also a
severe summer, and then run an analysis on each profile so you can compare the results. Each
weather profile specifies hourly temperature averages for each month of the year, and also average
monthly values for wind speed, relative humidity, and number of latent days.
For more information on using weather profiles in SynerGEE, see Modeling weather using weather
profiles on page 825.

Weather zones. Weather zones are used to model the variation in cloud cover in different parts of a
system. Solar plants in one section of a model, for example, may experience significant differences
in cloud cover from solar plants in another section of the model. This could result in a large MVA
input from one plant and a substantial MVA drop in another, and the resulting power swing will affect
flow and regulator and LTC tapping. Weather zones can be used to help simulate this kind of impact
on your model.
For more information on using weather zones in SynerGEE, see Using Weather Zones to Model
Variations in Cloud Cover on page 834.

DEFINING WEATHER CONDITIONS

Before you can simulate the impact of changing weather conditions temperature, wind, humidity, and
irradiance on your model, you must first define what those weather conditions are. SynerGEE provides a
couple different ways to do this, all of which are enabled in the Weather tab of the Time and Weather Options
editor.

Weather set points. The simplest approach to defining weather conditions is to specify a set of fixed
weather conditions, either as set weather values or as maximum weather values. This rather
approach assumes that the same weather conditions exist at all hours of the day and for all months
of the year.

Weather profiles. A more detailed approach to defining weather conditions is to use weather
profiles. Weather profiles allow you to apply a percentage-based adjust to a defined maximum
weather value on an hourly basis for each month in the year. Different weather profiles can be
created to define different weather patterns for example, a cold year for temperatures versus a

User Guide

SynerGEE Electric 5.0

Weather

825
warmer year for temperatures. By changing which weather profile is applied to the model before you
run an analysis, you can evaluate the impact that these different weather conditions will have on
your model.

Refer to the topics listed below for more information.

Modeling weather based on set weather conditions on page 825

Modeling weather using weather profiles on page 825

Modeling weather based on set weather conditions

SynerGEEs weather modeling set points allow you to set a single value for temperature, wind, humidity, and
irradiance. These four values define the weather condition that will be applied throughout your model. If you
are running a time-based analysis, the weather conditions will not change due to the time of day or the month
in the year.
Weather set points are enabled in the Weather tab of the Time and Weather Options editor. Refer to the
following procedure for more information.

TO MODEL WEATHER BASED ON SET WEATHER CONDITIONS

1

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Time & Weather.

In the Time and Weather Options editor, select the Weather tab.

In the Weather tab, under Weather Modeling, select Weather Set Points.

Under Set Points, specify values to apply to your model for each of the following categories:
-

Temperature

Wind

Humidity

Irradiance

Next to Cloud Cover, specify a value from 0 to 100 to represent the percentage of cloud cover for
the model.

Click Apply to accept your changes, and then click X to close the editor.

Modeling weather using weather profiles

Weather profiles contain hourly weather patterns for each month during a year. You can create weather
profiles in SynerGEE to model the impact of humidity, irradiance, temperature, and wind.
It is important to note that a weather profile does not define a specific weather value. Instead, the weather
profile specifies a percentage that is applied to a maximum weather value (which is defined in the Weather
tab of the Time and Weather Options editor) to calculate the actual value. For example, if a temperature
profile has a value of 80 for a particular hour in a particular month, that does not mean the temperature for
that hour of that month is 80C. Instead, the temperature is 80% of whatever maximum value is defined in

SynerGEE Electric 5.0

User Guide

826

Weather
the Time and Weather Options editor. If the maximum temperature is 35C, then the profile-adjusted
temperature is 28C. If the maximum temperature is 30C, then the profile-adjust temperature is 24C.
Weather profiles allow you to quickly and easily run different studies on your model to consider the impact of
different weather patterns. For example, you can create a moderate summer temperature profile and also a
severe summer temperature profile, and then run a contingency study using each profile. Weather profiles
eliminate the need to manually edit weather values each time an analysis is run.
Weather modeling based on weather profiles is enabled on the Weather tab of the Time and Weather
Options editor. In addition, all four weather profile types (humidity, irradiance, temperature, and wind) are
created from the Warehouse tab of the model explorer. Refer to the topics listed below for more information.

Creating a weather profile on page 826

Editing a weather profile on page 826

Configuring a model to use weather profiles on page 827

Deleting a weather profile on page 828

Creating a weather profile

Weather profiles are created in the Warehouse tab of the SynerGEE model explorer. Refer to the following
procedure for more information.

TO CREATE A WEATHER PROFILE

1

From the SynerGEE model explorer, select the Warehouse tab.

In the Warehouse tab, right-click on Weather profiles and select New Device > Weather Profile.

In the Enter Device ID dialog box, type the name of the weather profile, and then click OK.

Use Weather Profile editor to select the weather profile type and to edit the settings for the new
weather profile. For information on the options that you can set, see Editing a weather profile on
page 826.

Editing a weather profile

To edit a weather profile, double-click the weather profile name in the Warehouse tab of the SynerGEE model
explorer. Refer to the following procedure for more information.

TO EDIT A WEATHER PROFILE

1

From the SynerGEE model explorer, select the Warehouse tab and then expand the Climate
category for the weather profile type that you want to edit. Double-click the name of the weather
profile that you want to edit.

In the Weather Profile editor, under Profile Type, select the type of weather profile you are creating
or editing. Available choices are Temperature, Wind speed, Irradiance, and Humidity.

In the list of months, select the month for the weather data that you want to edit.

The graph in the Weather Profile editor provides hourly percentage values for the selected month.
As described in Modeling weather using weather profiles on page 825, these hourly percentages

User Guide

SynerGEE Electric 5.0

Weather

827
are applied to a defined maximum weather value to determine the actual temperature for a given
hour in a given month. To edit a value, simply click any bar in the graph and drag it to a new
location. The current value is shown in a text popup that appears next to the mouse cursor, and the
average value for the entire month is listed in the upper-right corner of the editor.
You can also do any of the following:
-

Click the Toggle button to change the graph to a table that you can also use to enter the
hourly weather percentages.

Toggle button, Weather Profile editor

Click the Plus and Minus buttons to shift the hourly weather percentages by one percent in
either direction.

Plus and Minus buttons, Weather Profile editor

Click the Copy button to copy the percentages from the current month to all other months
in the profile.

Copy button, Weather Profile editor

If you are editing a Temperature profile, use the Rel. Humidity and Latent Days text boxes to enter
the average relative humidity and number of latent days for the selected month.

Repeat these steps to edit the percentages for each month in the profile.

Click Apply to accept your changes, and then click X to close the editor.

Configuring a model to use weather profiles

Once you have created the weather profiles for your model, you can apply them to the model using the
Weather tab of the Time and Weather Options editor. Refer to the following procedure for more information.

TO APPLY WEATHER PROFILES TO A MODEL

1

From the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, select Time & Weather.

In the Time and Weather Options editor, select the Weather tab.

Under Weather Modeling, select one of the following options:

-

Weather Profiles: Time of Day. Selecting the time of day option will calculate separate
hourly values for each month based on the values that are defined in the applied weather
profiles.

Weather Profiles: Averages. Selecting the averages option will use calculate a single
value for each month, based on the average of the hourly values that are defined in the

SynerGEE Electric 5.0

User Guide

828

Weather
profile. (The average value for each month is shown in the upper-right corner of the
Temperature Profile editor.)
5

In the Maximums column, specify the maximum weather value for Temperature (degrees C), Wind
(feet per second), Humidity (percent relative humidity), and Irradiance (watts per square meter).
Note:

Remember that the percentages defined in the weather profiles will be applied to the
maximum weather values you define here to determine the actual weather values that will
be used by the SynerGEE model.)

In the Weather Profiles column, select the profiles that you want to apply for Temperature, Wind,
Humidity, and Irradiance.
Note:

For information on creating and editing weather profiles, see Creating a weather profile
on page 826 and Editing a weather profile on page 826.

Next to Cloud Cover, specify a value from 0 to 100 to represent the percentage of cloud cover.

Click Apply to accept your changes, and then click X to close the editor.

Deleting a weather profile

Perform the following procedure to delete a weather profile from your equipment warehouse. If you delete the
weather profile that is currently applied to your model in the Weather tab of the Time and Weather Options
editor, the current weather profile will be changed to Unknown.

TO DELETE A WEATHER PROFILE

1

From the SynerGEE model explorer, select the Warehouse tab.

Select Weather Profiles and then select the name of the weather profile that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

ADJUSTING LOADS BASED ON WEATHER CONDITIONS

SynerGEE provides two different ways to adjust distributed and spot loads based on changes in weather
conditions. In the Time and Weather Options editor, you can define global settings for weather factors and
latency effects. These global settings can be enabled for spot loads, distributed loads, or both spot and
distributed loads for both summer and winter months. As a second option, instead of the global settings, you
can configure SynerGEE to consider these same inputs but on a more regional basis through the use of
customer zones and customer classes. A third option is to disable any impact of weather conditions on your
loads.
Whether you use the global settings or class-based settings, the inputs that you must provide are the same.
(For customer classes, however, you can input different values on a month-by-month basis, whereas with the
global settings you can only use one set of values for all months in the year). Each input consists of a factor
that is applied to the customer load based on the change in a certain weather condition. For example, the first
factor is labeled %kW / C. The value that you enter will be a factor that is applied to the load for every
degree change in the temperature. For example, if the factor that you provide is 1.1, then the load will be
increased by a factor of 1.1 for each degree-rise in temperature.

User Guide

SynerGEE Electric 5.0

Weather

829

The six weather factors that you can apply for both summer and winter months (and individually for each of
the 12 months if you are applying the factors based on customer classes) are as follows:

%kW / C

%kvar / C

%kW / ft/s

%kvar / ft/s

%kW / %RH

%kvar / %RH

In addition to these six weather factors, you can also configure latency factors for temperature, wind speed,
and relative humidity. Latency assumes that successive days of unusual weather will result in higher loads
than single days of such weather. The three latency factors are expressed in percent per day. A temperature
latency factor of 1.5% per day, for example, will increase the impact of temperature variation on load by 1.5%
for each latent day. Following this example, if an extended heat wave kept temperatures above normal for 7
days, the temperature impact on load would increase by 10.5% (7 days x 1.5% latency factor = 10.5%). It is
very important to note that this is not a 10.5% increase in load. It is a 10.5% increase in the temperature
factor applied to the load. Additional information on latency and the impact of weather on loads in general is
provided in the SynerGEE Electric Technical Reference.
The following procedures discuss how to configure SynerGEE to adjust loads either globally or on a classbased approach, or to disable weather load modeling, if desired.

To enable global-based weather load modeling on page 829

To enable class-based weather load modeling on page 830

To disable weather load modeling on page 831

TO ENABLE GLOBAL-BASED WEATHER LOAD MODELING

1

Perform the following steps to open the Time and Weather Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Time & Weather.

In the Time and Weather Options editor, select the Weather tab.

Select Load Response: Global Settings.

Select the Weather/Load tab.

In the Weather/Load tab, use the Spot and Distributed check boxes to specify whether the weather
factors and latency effects will be applied to spot loads, distributed loads, or both spot and
distributed loads.

Under Weather factors, specify summer and winter values for the following categories:
-

%kW / C. Change in kW loads (as a percentage value) per change in temperature.

%kvar / C. Change in kvar loads (as a percentage value) per change in temperature.

%kW / ft/s. Change in kW loads (as a percentage value) per change in wind speed.

SynerGEE Electric 5.0

User Guide

830

Weather

%kvar / ft/s. Change in kvar loads (as a percentage value) per change in wind speed.

%kW / %RH. Change in kW loads (as a percentage value) per change in relative humidity.

%kvar / %RH. Change in kvar loads (as a percentage value) per change in relative
humidity.

Under Latency effects, specify summer and winter values for the following categories for latent
days:
-

Temp % / day. Change in temperature (as a percentage value) per day (for latent days).

Wind % / day. Change in wind speed (as a percentage value) per day (for latent days).

RH % / day. Change in relative humidity (as a percentage value) per day (for latent days).

Click Apply to accept your changes, and then click X to close the editor.

TO ENABLE CLASS-BASED WEATHER LOAD MODELING

1

Perform the following steps to open the Time and Weather Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Time & Weather.

In the Time and Weather Options editor, select the Weather tab.

Select Load Response: Class based.

Under Loads Normalized At, specify values to apply to your model for each of the following
categories:
-

Temperature

Wind

Humidity

Click Apply to accept your changes, and then click X to close the editor.

Configure the sections in your model so that the spot loads and distributed loads, as appropriate,
are linked to customer zones, which in turn are linked to customer classes.
-

Customer classes. A customer class stores basic load curve data. A customer class
consists of at least 36 curves, including a percent kW curve for a weekday, weekend, and
peak day for each of the 12 months in a year. In addition, you can optionally specify
another 36 curves for percent kvar. If you are not using time-of-day modeling, you can also
specify factors for % peak kW and % peak kvar for each customer class. This allows you to
take advantage of weather modeling using customer classes without having to set up or
use the actual load curves.
Some of the customer classes that are included in the sample model that is provided with
SynerGEE include Apartments, Industrial, Municipal, and Residential.
For more information on working with customer classes, see

User Guide

Customer zones. Customer zones combine up to three customer classes in specified

proportions to determine how much of a sections spot and distributed load pertain to each
class. A heavy industrial customer zone, for example, might be configured to include 80%

SynerGEE Electric 5.0

Weather

831
Industrial customers (whose loads are defined in the Industrial customer class described
above) and 20% of up to two other classes. A light industrial zone, however, might be
configured to include only 40% Industrial customers and 60% of up to two other classes.
Customer zones are applied to the sections of your model using the Load - Dist and Load Spot tabs of the Section editor.

TO DISABLE WEATHER LOAD MODELING

1

Perform the following steps to open the Time and Weather Options editor:
a

In the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Time & Weather.

In the Time and Weather Options editor, select the Weather tab.

Select No load response to weather.

Click Apply to accept your changes, and then click X to close the editor.

CONFIGURING SEASONAL WEATHER MODELING

Conductors, regulators, and transformers can be set up with summer ratings and winter ratings for
continuous amps and emergency amps. The continuous amps ratings are used in SynerGEE analyses to
calculate the percent loading and to display overload exceptions. The emergency amps rating is used in
balanced and by-phase analyses and capacitor placement to flag overloaded sections and to display
regulator overload exceptions. The season that is used by the SynerGEE model is selected on the
Exceptions tab of the Model and Analysis Options editor.
Refer to the topics listed below for more information.

Setting the season (summer or winter) for a SynerGEE model on page 831

Setting up conductors to use seasonal ratings on page 832

Setting up regulators to use seasonal ratings on page 832

Setting up transformers to use seasonal ratings on page 833

Performing a Summer/Winter analysis on page 833

Setting the season (summer or winter) for a SynerGEE

model
Use the Exceptions tab in the Model and Analysis Options editor to set the model to apply summer rating or
winter ratings. The season that is currently enabled is shown in the SynerGEE status bar. It is also shown in
the Run Summary chapter for many SynerGEE analysis reports.

TO SET THE SEASON FOR A SYNERGEE MODEL

1

From the SynerGEE ribbon bar, select the MODEL tab.

In the Settings group, click Model.

SynerGEE Electric 5.0

User Guide

832

Weather
3

In the Model and Analysis Options editor, select the Exceptions tab.

Under Seasonal Ratings, select either Summer ratings or Winter ratings. You can also select an
option to use winter ratings when the temperature is less than a defined temperature value.

Click Apply to accept your changes, and then click X to close the editor.

Setting up conductors to use seasonal ratings

Summer and winter ratings for continuous amps and emergency amps are available for both bare and
underground conductors. These ratings are configured on conductor types in the equipment warehouse,
which in turn are linked to individual conductors in your model.
Refer to the following procedure for more information on setting up conductors to use seasonal ratings. For
more information on working with conductors, see Conductors on page 304.

TO SET UP CONDUCTORS TO USE SEASONAL RATINGS

1

From the SynerGEE model explorer, select the Warehouse tab.

In the Warehouse tab, expand Conductors (Bare) or Conductors (Cable). Double-click the name
of the conductor that you want to edit.

In the Conductor editor, select the Ratings tab.

In the Ratings section, specify Summer and Winter values for the following:

Continuous Amp Rating. The continuous amp rating is used during SynerGEE analyses
to calculate the percent loading and to display overload exceptions.

Emergency Amp Rating. The emergency amp rating is used in balanced and by-phase
analysis and capacitor placement to flag overloaded sections and to display overload
exceptions.

Click Apply to accept your changes, and then click X to close the editor.

Setting up regulators to use seasonal ratings

Summer and winter ratings for continuous amps and emergency amps are available for regulators. These
ratings are configured on regulator types in the equipment warehouse, which in turn are linked to individual
regulators in your model.
Refer to the following procedure for more information on setting up regulators to use seasonal ratings. For
more information on working with regulators, see Regulators on page 383.

TO SET UP REGULATORS TO USE SEASONAL RATINGS

1

From the SynerGEE model explorer, select the Warehouse tab.

In the Warehouse tab, expand Regulator Types. Double-click the name of the regulator type that
you want to edit.

In the Regulator Type editor, select the Ratings tab.

User Guide

SynerGEE Electric 5.0

Weather

833
4

n the Regulator Type editor, under Summer Ratings (Amps) and Winter Ratings (Amps), specify
summer and winter values for the following:
-

Continuous. The continuous amp rating is used during SynerGEE analyses to calculate
the percent loading and to display overload exceptions.

Emergency. The emergency amp rating is used in balanced and by-phase analysis and
capacitor placement to flag overloaded sections and to display overload exceptions.

Click Apply to accept your changes, and then click X to close the editor.

Setting up transformers to use seasonal ratings

Summer and winter ratings for continuous amps and emergency amps are available for transformers. These
ratings are configured on transformer types in the equipment warehouse, which in turn are linked to individual
transformers in your model.
Refer to the following procedure for more information on setting up transformers to use seasonal ratings. For
more information on working with transformers, see Transformers on page 415.

TO SET UP TRANSFORMERS TO USE SEASONAL RATINGS

1

From the SynerGEE model explorer, select the Warehouse tab.

In the Warehouse tab, expand Transformer Types. Double-click the name of the transformer type
that you want to edit.

In the Transformer Type editor, select the Ratings tab.

In the Summer KVA Ratings and Winter KVA Ratings sections, specify summer and winter values
for the following:

Continuous. The continuous amp rating is used during SynerGEE analyses to calculate
the percent loading and to display overload exceptions.

Emergency. The emergency amp rating is used in balanced and by-phase analysis and
capacitor placement to flag overloaded sections and to display overload exceptions.

Click Apply to accept your changes, and then click X to close the editor.

Performing a Summer/Winter analysis

SynerGEEs Summer/Winter analysis runs your model at summer and winter peaks conditions. The analysis
provides important information about how the system varies between summer and winter months.
There are no settings required to set up the analysis. The resulting analysis report will show values in your
model for summer and winter conditions for results such as feeder demand, feeder loading, and pickup
capacity. The reports will also show the difference as a percentage value between the summer and winter
values.
Take note that load values will be different at those peaks if they client has diurnal modeling in place.

SynerGEE Electric 5.0

User Guide

834

Weather

TO PERFORM A SUMMER/WINTER ANALYSIS

1

In the SynerGEE ribbon bar, select the PLANNING tab.

In the Time group, click the Summer and Winter button.

USING WEATHER ZONES TO MODEL VARIATIONS IN

CLOUD COVER
Weather zones are used to model the variation in cloud cover in different parts of a system. Solar plants in
one section of a model, for example, may experience significant differences in cloud cover from solar plants
in another section of the model. This could result in a large MVA input from one plant and a substantial MVA
drop in another, and the resulting power swing will affect flow and regulator and LTC tapping. Weather zones
can be used to help simulate this kind of impact on your model.
Weather zones, like any other type of zone, are created and edited from the model warehouse. You then
apply a weather zone to a specific section by editing the Zones tab of the Section editor.
Refer to the topics listed below for more information on working with weather zones.

Creating a weather zone on page 834

Editing a weather zone on page 834

Assigning a weather zone to a section on page 835

Deleting a weather zone on page 835

Creating a weather zone

Weather zones are created and stored as a part of the model warehouse. Refer to the following procedure for
more information.

TO CREATE A WEATHER ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Weather Zone.

In the Enter Device ID dialog box, type a name for the new weather zone and then click OK.

Use the Weather Zone editor to edit the settings for the weather zone. For more information on the
options you can set, see Editing a weather zone on page 834.

Editing a weather zone

To edit a weather zone, double-click the weather zone name in the Warehouse tab of the SynerGEE model
explorer. From the Zone tab in the Section editor, you can also click the edit button that is located next to the
name of the weather zone that has been selected for that particular section.
Refer to the following procedure for more information.

User Guide

SynerGEE Electric 5.0

Weather

835

TO EDIT A WEATHER ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Zones - Weather and then double-click the name of the weather zone that you want to edit.

Use the Weather Zone editor to set minimum and maximum limits for the following values:

Average cloud cover (percent)

Average cloud duration (seconds)

Gap between clouds (seconds)

Base overcast level (percent)

Cloud ramp rate (percent/sec.)

Click Apply to accept your changes, and then click X to close the editor.

Assigning a weather zone to a section

Weather zones are assigned to individual sections by editing the Zones tab in the Section editor. Refer to the
following procedure for more information.

TO ASSIGN A WEATHER ZONE TO A SECTION

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Zone tab.

Next to Weather Zones, select the name of the weather zone that you want to assign to the section.

Click Apply to accept your changes, and then click X to close the editor.

Deleting a weather zone

Perform the following procedure to delete a weather zone from your model. If the zone has been applied to a
section in your model, that section will revert back to an Unknown selection for the weather zone option.

TO DELETE A WEATHER ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Zones - Weather and then select the name of the weather zone that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

SynerGEE Electric 5.0

User Guide

836

User Guide

Weather

SynerGEE Electric 5.0

CHAPTER

19
Customer
Management Module
SynerGEEs Customer Management Module (CMM) allows you to use your customer information in
SynerGEE models. CMM takes customer information, distribution transformers, poles, monthly billing
records, hourly load records, and factors (diversity, load, and power) from a CSV file, processes the data, and
updates the SynerGEE model. The CSV file contains data taken out of your Customer Information System
(CIS database). SynerGEE can process these CSV files with the CMM wizard, or through a batch process
using a CMM script.
After CMM assigns customers to distribution transformers and sections in the model, calculates transformer
utilization, creates and assigns customer zones and classes, and performs other related tasks, it updates the
model. Using this data in a SynerGEE model allows a variety of functions, including the following:

Calculating the demand on specific distribution transformers to prevent overload damage or

inefficient operation.

Determining the customer makeup of a poorly performing area.

Testing the feasibility of system changes, based on the number/type of customers affected.

Validating the accuracy of your current load models and load allocation methods.

Keeping track of customers and transformers in the model. Each customer can have its own
connection ID and be tied to the same transformer.

Writing Error tables if MiddleLink or processing problems occur.

Checking customer phasing against a feeding distribution transformer. Phasing can differ from the
distribution transformer; phasing is set by the customer and retained in the CMM dataset.

Associating multiple projects with the same section. Each customer that is configured to a projecttype load will result in a separate project item on the Section editor.

You should note that customer data is never a permanent part of a model, but load data is updated in the
model. CMM uses tools to generate reports from the customer data and updates load data, as necessary.
Refer to the topics listed below for more information.

The CMM Process on page 838

The CMM and the DSA on page 838

Using the CMM Wizard on page 839

CMM and the SQL Dashboard on page 849

SynerGEE Electric 5.0

User Guide

838

Customer Management Module

Security and Support via Lock ID on page 850

THE CMM PROCESS

The basic CMM process can be accomplished in four major steps. These steps are a general outline of how
to process your own CMM data. If you feel your CMM process may be different, our Technical Support staff is
available to assist you.
1

Save CSV file(s) containing CMM data to the Scripts folder. This type of data can include billing
records, customer information (name, address, class, and so on), distribution transformers, and
poles. The CSV file must contain data in MiddleLink format, a series of codes and commands that
point to, and gather data from, your Access, Oracle, or other databases. For more information on
the CMM MiddleLink commands, see Viewing CMM script commands on page 843.

Create a Data Source Alias (DSA) for the database target that will store CMM data. Add a CMM
DSA using the DSA wizard. For more information on creating a DSA, see The CMM and the DSA
on page 838.

Use the CMM wizard to import MiddleLink files, process data, and update the model. You can use
either the typical or automated process to accomplish these tasks, although the automatic process
requires more up-front configuration on your part. For more information, see Using the CMM
Wizard on page 839 and Automating the CMM process on page 842.

Use the SQL Dashboard to run queries on the CMM database tables. For more information on the
SQL Dashboard, see CMM and the SQL Dashboard on page 849.

THE CMM AND THE DSA

The use of the Customer Management Module hinges on the creation of a data source alias (DSA) for the
CIS database. Before the CMM can be processed and the model updated, a DSA must exist. CMM
processes data using command scripts, and then saves the data with the new assignment information into
the CMM database and updates the loads in the SynerGEE model. For more information on DSAs, see Data
Source Aliases (DSAs) on page 75.

TO CREATE OR EDIT A DSA

1

At the left end of the SynerGEE ribbon bar, click the Pole icon and then select Data Sources.

In the Data Sources editor, click Add to create a new DSA. Through the Add Data Sources wizard,
you will create a name for your DSA, specify the path to the file, and specify the contents of the data
source.

Highlight a DSA and click Edit to reconfigure an existing DSA. The Edit DSA wizard allows you to
change the name, path, and contents of the DSA.

User Guide

SynerGEE Electric 5.0

Customer Management Module

839

USING THE CMM WIZARD

The CMM wizard is the starting point for performing customer management tasks in SynerGEE. A number of
different tasks are possible through the wizard, including a typical/manual CMM loading process, an
automatic loading process, and maintenance. The wizard will automatically save the settings you select
during each process.

TO OPEN THE CMM WIZARD

1

Perform the following steps to open the Customer Management Module wizard:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Customers & Billing.

The options in the CMM wizard are separated into three categories: Typical CMM Process,
Automation, and Maintenance. Refer to the topics listed below for more information on the options
that are available in each of these categories.
-

Updating a model with customer data on page 839

Automating the CMM process on page 842

Maintaining CMM data sets on page 846

Updating a model with customer data

The typical CMM process involves three important functions that work together to import customer data,
process it, and update your model. These actions are typically performed in the order they are listed in the
CMM wizard. Refer to the topics listed below for more information.

Importing MiddleLink files into a CMM data set on page 839

Processing CMM data set bills and loads on page 840

Updating model loads with a CMM data set on page 841

Importing MiddleLink files into a CMM data set

The first step in a typical CMM process is to load data from the MiddleLink-format text file into a data set in
the CMM database. This process will read data from the MiddleLink text files, consolidate it, and write it into
the appropriate CMM tables. You should perform this step whenever new billing sets are available.
You may skip this step if the data is written directly to the data set from other systems.

TO IMPORT MIDDLELINK FILE(S) INTO A CMM DATA SET

1

Perform the following steps to open the Customer Management Module wizard:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Customers & Billing.

On the first page of the CMM wizard, under Typical CMM Process, select Import MiddleLink file(s)
into a CMM data set. Click Next to continue.

SynerGEE Electric 5.0

User Guide

840

Customer Management Module

3

On the next page of the wizard, select the Source MiddleLink file (the file you will import data from)
and the Target database (the file you will import the data to). Click Next to continue.

On the next page of the wizard, select a data set within your target database where the imported
data will be saved. You can also create and delete data sets from this page of the wizard.
-

To create a data set: Type a Name and Description for the new data set, and then click
Add. Click Yes to confirm the addition.

To delete a data set: Select the name of the data set that you want to delete, and then click
Delete. Click Yes to confirm the deletion.

Once you have selected the data set where you want to save the imported data, click Next to
continue.
5

On the next page of the wizard, confirm that the source database and the target data set are correct.
You can also select from the following options:
-

Import customer records

Import billing records

Abort save if there are errors importing the data

Generate error records for customers that have no bills

Click Finish to begin importing the data. When the import is complete, the CMM Operations
Complete window will appear, providing details on the actions that were performed. After reviewing
this report, click OK to close the window and return to the CMM wizard.

Processing CMM data set bills and loads

The second step in a typical CMM process is to calculate load values from billing data and connectivity. This
step is used only when adjustments are needed in calculations or when new billing data is imported.

TO PROCESS CMM DATA SET BILLS, LOADS, ETC.

1

Perform the following steps to open the Customer Management Module wizard:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Customers & Billing.

On the first page of the CMM wizard, under Typical CMM Process, select Process CMM data set
bills, loads, etc. Click Next to continue.

On the next page of the wizard, select the Source database and Data set that contains the data
you want to process. Click Next to continue.

On the next page of the wizard, select the Data set that contains the billing records that you want to
process. You may also do the following:

User Guide

SynerGEE Electric 5.0

Customer Management Module

841

Select the Process all billing records check box to process all records within the data set.
Or, you can clear the check box and select a specific date range for the records you want
to process.

Select whether you want to process demand bills, usage bills, or both. Available choices
are Prefer demand bills, Prefer usage bills, or Combine bills.

Click Next to continue.

5

On the next page of the wizard, under Coincidence calculations, select from one of the following
options:
-

No coincidence. SynerGEE will not use curves, but will sum up customer load and ignore
customers of common class.

Coincidence by transformer. SynerGEE will look for customers belonging to the same
class who are attached to the same transformer, and apply the coincidence factor for each
group of customers.

Coincidence by data set. SynerGEE will calculate customer count by class for all
customers in the data set and apply coincidence for the customer totals.

In addition, under Undesignated load types, specify undesignated spot loads and large customer
loads. Click Next to continue.
6

Click Finish to begin processing the data. When the data processing is complete, the CMM
Operations Complete window will appear, providing details on the actions that were performed. After
reviewing this report, click OK to close the window and return to the CMM wizard.

Updating model loads with a CMM data set

The final step in a typical CMM process is used whenever a different load profile is needed. If there are many
data sets for a model, this option will be used most frequently. Prior to this step, all processing was done with
data files and data sets. This final step is performed with a model loaded. The wizard will ultimately copy load
values from the CMM tables and update or create loads in SynerGEE.

TO UPDATE MODEL LOADS WITH A CMM DATA SET

1

Perform the following steps to open the Customer Management Module wizard:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Customers & Billing.

On the first page of the CMM wizard, under Typical CMM Process, select Update model loads with
a CMM data set. Click Next to continue.

On the next page of the wizard, select the Source database and Data set that contains the data
you want to use to update your model. Click Next to continue.

On the next page of the wizard, select from a series of options that will instruct SynerGEE on how to
update the model. The following categories are available:
-

SynerGEE Electric 5.0

Add to model loads. Use this set of options to select which load types will be used to
update the model. Available choices are Distributed loads, Spot loads, Large customers,
and Projects.

User Guide

842

Customer Management Module

Initialize model loads. Use this set of options to specify which, if any, loads you would like
to zero out or delete. Available choices are Distributed loads, Spot loads, Large customers,
and Projects. Your selections do not need to correspond to the options you selected in the
Add to model loads category.

Values to modify. Use this set of options to specify which, if any, values you would like to
update. Typically, kW, kvar will be among your selections. There are certain situations in
which only connected values need to be updated.

Click Finish to begin updating the data. When the update is complete, the CMM Operations
Complete window will appear, providing details on the actions that were performed. After reviewing
this report, click OK to close the window.

Automating the CMM process

CMM scripts can be used to automate a lengthy or complex set of CMM options. You can edit the scripts
through SynerGEEs script editor or directly in Notepad. CMM scripts are then run from the Automation option
in the CMM wizard.
Refer to the topics listed below for more information.

Running a CMM script on page 842

Writing CMM scripts on page 843

Running a CMM script

CMM scripts can be run from the Automation section of the CMM wizard. Refer to the following procedure for
more information.

TO RUN A CMM SCRIPT

1

Perform the following steps to open the Customer Management Module wizard:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Customers & Billing.

From the first page of the CMM wizard, under Automation, select Run CMM Script. Click Next to
continue.

On the next page of the wizard, select the name of the script you want to run. This page of the
wizard includes several options that allow you to create and edit CMM scripts, as described below.

User Guide

To edit a script in SynerGEE: Select the script name and then click Edit. The SynerGEE
script window opens, where you can add and delete commands from the script. For more
information on working in the script editor, see Using the Script Editor on page 725.

To edit a script in Notepad: Select the script name and then click Notepad. The CMM
script in MiddleLink format will open in the Notepad application. Once you have edited the
script, select File > Save in Notepad to save the modified script.

To create a new script: Type the script name in the text box in the wizard and then click
Edit (to write the script in SynerGEE) or Notepad (to write the script in Notepad).

SynerGEE Electric 5.0

Customer Management Module

843

When you are ready to run the script, select the script name and click Next.
4

On the next page of the wizard, confirm that you have selected the script you want to run, and then
click Finish to run the script.

Writing CMM scripts

Command scripts give you the flexibility to run CMM in different ways, without needing to use a complex
graphical interface. These scripts automate processes such as loading customer data, assigning
relationships, and performing billing calculations. Command scripts need to be run in order to assign and
validate customers and perform other functions.
CMM scripts are text files and must be saved with a *.CMM file extension in a folder that you designate in the
Paths tab of the Preferences editor. Text files used by CMM are formatted in the MiddleLink style, beginning
with a record number to indicate the type of data. A CMM script affects one specific CMM database, which
must exist and have a DSA associated with it. The DSA must be identified in the CMM script with a 10100
command.
While CMM scripts can be written comprehensively in a single file, they can also be broken up so that the
process is managed in multiple stages. You may prefer the latter approach, as it allows for more flexibility.
Tip:

The CMM process does not have to be completely manual or completely based on scripts. It often
makes sense to use a combination of scripts and manual steps with the CMM wizard.

Viewing CMM script commands

A complete list of the CMM script commands and their respective field parameters can be viewed within
SynerGEE. You will need to access this information as you write scripts for use with CMM.
Refer to the following procedure for more information.

TO VIEW CMM SCRIPT COMMANDS

1

In the SynerGEE ribbon bar, select the SUPPORT tab.

In the Tools group, click the text label Schemas and then select Supporting Data > Customer
(CMM).
The list of CMM commands and field parameters appears in a new SynerGEE window. Use this list
as a reference when you write CMM scripts. The following table summarizes the CMM commands
that are available in SynerGEE:
Command

Purpose

10100

Specify which database DSA is to be used to store data set.

10101

Import a CMM data file into a data set. SynerGEE will create the data set if it
does not already exist.

10102

Create/initialize a data set.

10103

Delete a data set.

10104

Merge one data set (A) into another (B).

SynerGEE Electric 5.0

User Guide

844

User Guide

Customer Management Module

Command

Purpose

10107

Process a data set and calculate load values.

10108

Specify start and end dates for bill processing. If this record is not indicated in
the script, SynerGEE will process all bills in the data set.

10109

Process a coincidence.

10110

Update the current model with a data set.

10112

Initialize loads in the model. Specify categories of loads.

10113

Specify the load categories to update.

10114

Specify the load values to update.

10117

Indicate if customer class or capacity factor should be updated.

10118

Specify whether error records will be generated for customers that have no
bills.

10120

Set the default percent power factor for demand customer.

10130

Define usage loads if type intervals are unspecified.

10131

Define demand loads if type intervals are unspecified.

10132

Indicate that a load type must always be used.

10190

Create a DSA for a CMM database.

10201

Create and defines a customer.

10202

Assign a class ID to a customer.

10203

Assign a phase to a customer.

10204

Define a customers X and Y coordinates.

10205

Specify a customers load type.

10208

Specify a customers name.

10209

Specify a customers address.

10212

Assign a customer to a transformer.

10213

Assign a customer to a section ID.

10214

Assign a customer a connection ID.

10215

Assign a customer to a feeder.

10220

Define a customers usage and days within a billing period.

10221

Define a customers usage without a billing period.

10230

Define a customers demand using kW and kvar.

SynerGEE Electric 5.0

Customer Management Module

845

Command

Purpose

10231

Define a customers demand using kW only.

10232

Define a customers demand using kW and the percent power factor.

10233

Define a customers demand using kVA only.

10301

Define a transformer ID.

10302

Define a transformer rating. Single-phase transformers listed in 10302 records

are combined to form transformer banks.

10303

Define the location of a transformer.

10304

Define a transformers X and Y coordinates.

10306

Define a transformers primary meter.

10312

Tie a transformer to a section ID.

10314

Assign a transformer a connection ID.

10315

Assign a transformer to a feeder.

10317

Allow kVA and pf values to be specified directly on transformers.

10318

Allow customer class values to be specified directly on transformers.

10501

Define a customer class.

10505

Define a class percent power factor.

10507

Define a class load factor.

10510

Define a class coincidence curve.

10515

Define hourly meter data within a customer class.

10517

Define the maximum kWh within a customer class.

10518

Define the maximum kW within a customer class.

CMM script examples

Example 1: A typical CMM script
The following CMM script is a record that represents customer Fred Johnson and his address, class,
transformer, and billing information. The order of these script commands does not matter and they can even
be spread out over different CMM text files if doing so is more suitable.
10201,
10208,
10209,
10301,
10312,
10212,

99832331, Res 2
99832331, Johnson, Fred
99832331, 1602, Brook St., Newville
DT3984621
DT3984621, Cstr_32231
99832331, DT3984621

SynerGEE Electric 5.0

User Guide

846

Customer Management Module

10220, 99832331, 03/09/2007, 945, 30
10220, 99832331, 04/08/2007, 1100, 29

Example 2: Seasonal data set script

The following example shows a portion of a script that is used to create summer and winter data sets for
District 2 of a utility. In this script, data sets have been created for two different seasons: Dist2Sum07 and
Dist2Fall07. Multiple files with *.CSV extensions are used to populate each data set.
10101,
10101,
10101,
10101,
10101,
10101,
10101,
10101,
10101,
10101,

Dist2Sum07, D:\BillingData\Dist2\CustomerConnectivity.csv
Dist2Sum07, D:\BillingData\Dist2\June07.csv
Dist2Sum07, D:\BillingData\Dist2\July07.csv
Dist2Sum07, D:\BillingData\Dist2\August07.csv
Dist2Sum07, D:\BillingData\Dist2\September07.csv
Dist2Fall07, D:\BillingData\Dist2\CustomerConnectivity.csv
Dist2Fall07, D:\BillingData\Dist2\October07.csv
Dist2Fall07, D:\BillingData\Dist2\November07.csv
Dist2Fall07, D:\BillingData\Dist2\December07.csv
Dist2Fall07, D:\BillingData\Dist2\January08.csv

Example 3: Determine the nearest model node to a transformer

SynerGEE contains an algorithm that pinpoints the closest model nodes to a given distribution transformers
X,Y coordinates. The following script represents distribution transformer data for dtran #443501. A section
will be selected for transformer connection only if the section is the closest and contains all the phases and
neutral that the transformer needs.
10301, 443501
10302, 443501, 37, 2
10304, 443501, 1843349.34007978, 518279.446046565

Maintaining CMM data sets

The maintenance options within the CMM wizard allow you to create and delete data sets, merge data sets,
and generate data set reports. Once you have been working with CMM for a while, it is recommended that
you periodically use this tool to keep your records and model updated.
Refer to the topics listed below for more information.

Reporting on a CMM data set on page 846

Creating and destroying data sets on page 847

Merging data sets on page 848

Using the model in memory to update data set connectivity on page 848

Reporting on a CMM data set

Perform the following procedure to generate a report for a selected CMM data set. CMM is designed to
process very large and data-intensive customer data sets. Because of this, the reporting is general and highlevel, and has no effect on the model itself. With the exception of the Queried section customer

User Guide

SynerGEE Electric 5.0

Customer Management Module

847

assignments report chapter, customer information does not need to be loaded into the model in order to run
this report.

TO REPORT ON CMM DATA SET

1

Perform the following steps to open the Customer Management Module wizard:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Customers & Billing.

On the first page of the CMM wizard, under Maintenance, select Report on CMM data set. Click
Next to continue.

On the next page of the wizard, select the Source database and Data set that contains the data
you want to report. Click Next to continue.

On the next page of the wizard, select the report chapters that you want to generate. Available
choices are as follows:

Distribution transformer summary information

Customer class summary information

Load summary results

Queried section customer assignments

Click Finish to generate the report. The report will be created as a separate SynerGEE window and
include the report chapters that you selected in the wizard.

Creating and destroying data sets

Perform the following procedure to create and delete data sets in a CMM database. This option will also
generate the CMM data set report that is described in Reporting on a CMM data set on page 846. All report
chapters will be included in the report when generated in this manner.

TO CREATE AND DESTROY DATA SETS

1

Perform the following steps to open the Customer Management Module wizard:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Customers & Billing.

On the first page of the CMM wizard, under Maintenance, select Create / destroy data sets. Click
Next to continue.

On the next page of the wizard, select the database that you want to work with. Click Next to
continue.

On the next page of the wizard, perform the following tasks to create or destroy data sets:
-

To create a data set, type a Name and Description for the new data set, and then click
Add. Click Yes to confirm the addition.

To delete a data set, select the name of the data set that you want to delete, and then click
Delete. Click Yes to confirm the deletion.

SynerGEE Electric 5.0

User Guide

848

Customer Management Module

5

Click Finish to exit the CMM wizard. A CMM report window will open in SynerGEE, displaying all
available report chapters from the Report on CMM data set option in the CMM wizard.
Tip:

If you do not want to view the report, you can click Back to return to the first page of the
CMM wizard. The edits you made to the data sets will be saved.

Merging data sets

Perform the following procedure to combine two data sets from the same database. This process can be
used in instances when it is more reasonable to create a new record and merge it into an existing one, rather
than edit an extensive data set containing a large amount of data.

TO MERGE DATA SETS

1

Perform the following steps to open the Customer Management Module wizard:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Customers & Billing.

On the first page of the CMM wizard, under Maintenance, select Merge data sets. Click Next to
continue.

On the next page of the wizard, select the database that you want to work with. Click Next to
continue.

On the next page of the wizard, do the following:

-

On the upper half of the page, select the data set that you want to merge data into.

On the lower half of the page, select the data set that you want to copy data out of.

Click Next to continue.

5

On the next page of the wizard, confirm that the database, the target data set, and the source data
set are correct.

Click Finish to merge the data sets. When the merge is complete, the CMM Operations Complete
window will appear, providing details on the actions that were performed. After reviewing this report,
click OK to close the window and return to the CMM wizard.

Using the model in memory to update data set connectivity

Perform the following procedure to update a CMM data set with the data that is already stored in a model.

TO USE MODEL IN MEMORY TO UPDATE DATA SET CONNECTIVITY

1

Perform the following steps to open the Customer Management Module wizard:
a

In the SynerGEE ribbon bar, select the FORGE tab.

In the Model Forge group, click Customers & Billing.

On the first page of the CMM wizard, under Maintenance, select Use model in memory to update
data set connectivity. Click Next.

User Guide

SynerGEE Electric 5.0

Customer Management Module

849

On the next page of the wizard, select the database and data set that you want to work with. Click
Next to continue.

On the next page of the wizard, confirm the options you have selected on the previous page of the
wizard, and then click Finish to perform the update. When the update is complete, the CMM
Operations Complete window will appear, providing details on the actions that were performed. After
reviewing this report, click OK to close the window and return to the CMM wizard.

CMM AND THE SQL DASHBOARD

The SQL Dashboard is a SynerGEE tool that allows you to run queries directly against the tables in any
database that has a DSA. Queries can be written and run against models, customer tables, and other
SynerGEE data stored in the database for countless views, joins, updates, and overviews. You can write a
query once and run it against any database by selecting the appropriate DSA. To access the SQL
Dashboard, select the FORGE tab in the SynerGEE ribbon bar, and in the Database group, click SQL
Dashboard. For more information see SQL Dashboard on page 772.

SQL Dashboard controls

There are three distinct parts to the SQL Dashboard: the query, data source, and results. The controls on the
left side of the dashboard are used to select the data source with a DSA. CMM data sources will also allow
the selection of a data set. Queries are written in the SQL window located in the top half of the view. The
results of the query are shown in the lower half of the view.

Queries can be run individually or as a group. If you write multiple queries but wish to run one at a time, place
your cursor on the desired query and click Run Selection. Click Run to run the query as a group. With
multiple SELECT commands, the SQL Dashboard will run the last SELECT statement only. For more
information on SQL commands, see Common SQL commands on page 780.
Results from a query can be opened in Excel for further sorting and editing. From the CONTROLS tab in the
SynerGEE ribbon bar (visible when viewing a SQL Dashboard window), click Open in Excel.

SynerGEE Electric 5.0

User Guide

850

Customer Management Module

CMM queries in the SQL Dashboard

The SQL Dashboard is the preferred reporting tool for CMM data. Its look is simple, but contains a powerful
engine. The following is an example of how the SQL Dashboard can be used to query CMM data. This query
will ultimately verify that all of our customers are accounted for in the generated spot and distributed loads.
1

This query first determines the number of customers in the customer table:
SELECT COUNT (*) FROM @CMM@Customers;

This query results in 316,917 customers.

2

The next query determines the number of customers assigned to spot loads:
SELECT SUM(Ph1Cust+Ph2Cust+Ph3Cust) FROM @CMM@ResSpot;

This query results in 106,322 customers.

3

The last query determines the number of customers assigned to distributed loads:
SELECT SUM(Ph1Cust+Ph2Cust+Ph3Cust) FROM @CMM@ResDist;

This query results in 210,595 customers. The total of spot and distributed load customers is
316,917, the same as the number of customers in the customer table.
Following are more useful queries that apply to the CMM, which can be modified based on your own needs:

The following query lists all customers tied to a particular distribution transformer:
SELECT LastName AS Name, Address, City, CustClassId AS Class ID
DRanId AS Transformer FROM @CMM@Customers WHERE DTranID =
N0027EG4100
ORDER BY LastName ASC;

The following query lists distribution transformers with utilization factors over 70%:
SELECT DTranId, SectionID, UtilFac FROM @CMM@DISTTRANS WHERE UtilFac >
0.7

This query lists transformers, customers, and utilization:

SELECT DTranId AS Transformer, Section Id AS Section, DemCustCount
AS Customers, ROUND(UtilFac,2) AS Utilization FROM
CMM_COT_DistTrans WHERE UtilFac > 1 ORDER BY UtilFac;

SECURITY AND SUPPORT VIA LOCK ID

Similar to the security feature associated with the enterprise database, a Lock ID column exists in the lookup
table within the CMM data set. This column allows sections to be associated with users so that more than one
user can work within the same data set at the same time.
If you are working with legacy data sets, you may have to either add a compound key field or delete the
lookup table, then regenerate the data set tables. Regenerating the data set should not harm existing
records. For more information on lock IDs, see Feeder locks and lock IDs on page 121.

User Guide

SynerGEE Electric 5.0

CHAPTER

20
Economics
SynerGEEs Economics module focuses on the economics of engineering. This module provides a venue for
many important tools to study distribution systems in light of Smart Grid, Applied Intelligence, and alternative
energy options.
The Economics module focuses on maintenance costs, as opposed to capital costs. The trend in the electric
utility industry seems to be moving toward the operations side as being responsible for maintenance costs
and issues. The Economics module is designed to determine the efficiency and cost-effectiveness of
maintenance on feeders and substations.
To set up your model for economic analysis, you must create cost zones, and assign them to applicable
sections in your model. Cost zones define maintenance costs for feeders and substations, as well as cost
multipliers for fuses, equipment, distribution transformers, and customers. Cost zones are created as
individual devices in your equipment warehouse and then assigned to the sections in your model. For more
information, see Managing Cost Zones on page 851.
Once these tasks have been performed, you are ready to perform an economic analysis on your model. For
more information, see Economic Analysis on page 597.

MANAGING COST ZONES

Cost zones provide maintenance costs for feeders and substations, as well as cost multipliers for fuses,
equipment, distribution transformers, and customers. These values are combined with performance metrics,
such as load factor, utilization, and efficiency, to determine the cost per MW or MWHr.
Refer to the topics listed below for more information.

Creating a cost zone on page 851

Editing a cost zone on page 852

Assigning a cost zone to a section on page 853

Deleting a cost zone on page 853

Creating a cost zone

Perform the following procedure to create a new cost zone in your model.

SynerGEE Electric 5.0

User Guide

852

Economics

TO CREATE A COST ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Right-click and select New Device > Cost Zone.

In the Enter Device ID dialog box, type a name for the new cost zone and then click OK.

Use the Cost Zone editor to edit the settings for the cost zone. For more information on the options
you can set, see Editing a cost zone on page 852.

Editing a cost zone

To edit a cost zone, double-click the cost zone name in the Warehouse tab of the SynerGEE model explorer.
From the Zone tab in the Section editor, you can also click the edit button that is located next to the name of
the selected cost zone.
Refer to the following procedure for more information.

TO EDIT A COST ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Zones - Cost and then double-click the name of the cost zone that you want to edit.

Use the Cost Zone editor to edit the following options:

Line Maintenance Costs

Specifies the yearly maintenance costs per mile for 1 Phase

Lines, 2 Phase Lines, and 3 Phase Lines. If you are performing
multi-year modeling, you can also type a yearly percentage
increase in the % Increase text box.

Maintenance Cost
Multipliers

Specifies a cost factor for each of the following equipment types.

If you do not want to apply a multiplier, use 1.0 as the multiplier.

Color

Fuses

Equipment

Dist. Trans.

Customers

Specifies a color that will represent any sections where this cost
zone has been applied, when the SynerGEE map displays color
by scheme is set to Cost Zones. The color is also shown in the
list of cost zones in the Model tab of the model explorer.
For more information on applying color by schemes, see
Selecting a Coloring Scheme for Sections on page 216.

User Guide

Click Apply to accept your changes, and then click X to close the editor.

SynerGEE Electric 5.0

Economics

853

Assigning a cost zone to a section

Perform the following procedure to assign a cost zone to a section in your model.

TO ASSIGN A COST ZONE TO A SECTION

1

In the SynerGEE map display or model explorer, double-click on the section that you want to edit.

In the Section editor, select the Zone tab.

Next to Cost Zones, select the name of the cost zone that you want to assign to the section.

Click Apply to accept your changes, and then click X to close the editor.

Deleting a cost zone

Perform the following procedure to delete a cost zone from your model.

TO DELETE A COST ZONE

1

In the SynerGEE model explorer, select the Warehouse tab.

Expand Zones - Cost and then select the name of the cost zone that you want to delete.

Right-click and select Delete.

Click Yes to confirm the deletion.

SynerGEE Electric 5.0

User Guide

854

User Guide

Economics

SynerGEE Electric 5.0

APPENDIX

A
Numerical Recipe
Commands
The topics listed below provide information on the numerical recipe command format that is available in
SynerGEE. For general information on setting up recipes and recipe files, see Recipe Scripts on page 700.
For information on the text-based recipe command format, see Text-Based Recipe Commands on
page 907.

Graphical User Interface Commands on page 855

Program Operation Commands on page 856

Data IO Recipe Commands on page 858

Map Coloring Recipe Commands on page 873

Analysis Recipe Commands on page 881

Model Modification Recipe Commands on page 890

Results Handling Recipe Commands on page 892

Selection Recipe Commands on page 893

List Recipe Commands on page 898

Licensing Recipe Commands on page 900

Messaging Script Recipe Commands on page 902

Recipe Parameter Reference on page 903

GRAPHICAL USER INTERFACE COMMANDS

Use the graphical user interface recipe commands to perform tasks such as displaying a message box,
refreshing the map display, and zooming to the selected feeders in the SynerGEE map display. Refer to the
topics listed below for more information.

3010 Generating a message box on page 856

3013 Refreshing the map display on page 856

3014 Zooming to selected feeders on page 856

SynerGEE Electric 5.0

User Guide

856

Numerical Recipe Commands

3010 Generating a message box

Use the 3010 recipe command to generate a message box. This command is helpful for providing information
to the user during a multi-task recipe.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Message

string

Message that will be displayed in the message box.

The following is an example of the 3010 recipe command, as well as the message box that will be displayed
when this command example is run.
3010, Will now run load-flow!

3013 Refreshing the map display

Use the 3013 recipe command to refresh the map display and model explorer. This command does not
require any inputs.

3014 Zooming to selected feeders

Use the 3014 recipe command to zoom to the feeders that are selected in your model. This command does
not require any inputs.

PROGRAM OPERATION COMMANDS

Use the program operation recipe commands to interact with external files and applications. Refer to the
topics listed below for more information.

3030 Running an executable file on page 857

3031 Playing a sound file on page 858

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

857

3032 Opening an HTML file in SynerGEE on page 858

3034 Deleting a file on page 858

3035 Shutting down SynerGEE on page 858

3030 Running an executable file

Use the 3030 recipe command to launch any application file (EXE file) using optional command line
parameters, if specified. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

EXE path

string

Full path, file name, and file extension for the EXE
file that you want to launch with this command.
If the application is properly registered in your
system, you may be able to omit the full path to the
EXE, and even the EXE extension itself.

Command line

string

Optional command line parameters that may be

supported by the application you want to launch.
Use the same syntax that you would to launch the
application directly from a command line.

Wait for exe to finish

Boolean

Boolean value that specifies whether SynerGEE

should wait for the EXE to shut down before
resuming the recipe.

0 No (dont wait for the application to

shut down)

1 Yes (wait for the application to shut

down)

If you choose this option, you will not be able to

access SynerGEE until the launched EXE process
has shut down. Therefore, this command is
generally intended for an EXE that provides a
command line option for auto-shutdown.
The following list provides several examples of the 3030 recipe command.

Launch a second instance of SynerGEE and run the MyRecipe recipe on startup:
3030, "C:\Program Files\SynerGEE Electric 5.0\SynerGEE.exe", -r
MyRecipe, 0

Launch Microsoft Word:

3030, C:\Program Files\Microsoft Office\OFFICE11\Winword.exe, , 0

Launch Microsoft Word and open MyDocument.doc:

SynerGEE Electric 5.0

User Guide

858

Numerical Recipe Commands

3030, C:\Program Files\Microsoft Office\OFFICE11\Winword.exe,
"C:\MyDocs\MyDocument.doc", 0

3031 Playing a sound file

Use the 3031 recipe command to play a WAV sound file. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

Path to sound file

string

Name of the sound file that you want to run. The file
must be a valid WAV file (*.wav) and must be stored in
your main SynerGEE documents folder.

3032 Opening an HTML file in SynerGEE

Use the 3032 recipe command to open a file in SynerGEEs HTML report viewer. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

File path

string

Full path, file name, and file extension for the HTML file
that you want to open.

3034 Deleting a file

Use the 3034 recipe command to delete a file from your system. The inputs for this command are described
in the following table.
Field
1

Name

Type

Description

File path

string

Full path, file name, and file extension for the file that
you want to delete.

3035 Shutting down SynerGEE

Use the 3035 recipe command to shut down SynerGEE. This command does not require any inputs.

DATA IO RECIPE COMMANDS

Data IO recipe commands allow the management of DSAs and the loading and saving of most data types
from any supported format. Refer to the topics listed below for more information.

3050 Creating a DSA on page 859

3051 Deleting a DSA on page 861

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

3052 Testing a DSA connection on page 862

3053 Loading feeders on page 862

3054 Saving feeders on page 862

3055 Loading equipment data on page 863

3056 Saving equipment data on page 864

3057 Loading a protection database on page 865

3058 Loading a partials data source file on page 866

3059 Creating a regression file on page 866

3060 Comparing two regression files on page 866

3061 Loading a subset on page 867

3062 Saving a subset on page 868

3063 Creating a new model on page 869

3064 Creating a new warehouse on page 869

3065 Prompting the user to load a model on page 869

3066 Prompting the use to load a warehouse on page 870

3071 Creating a table for MiddleLink loading on page 870

3072 Creating a file for MiddleLink loading on page 870

3073 Creating MiddleLink table on page 870

3080 Checking and repairing a model schema on page 871

3081 Checking and repairing an equipment schema on page 871

3090 Adding a document to the document library on page 871

3091 Running a SQL Dashboard script on page 872

859

3050 Creating a DSA

Use the 3050 recipe command to create a data source alias (DSA). If the DSA already exists (by name), this
command has differing effects depending on which parameters you select. For example, if the DSA exists as
a link to an Access database and you use the 3050 command to link the DSA as an Oracle database, then
the DSA will be linked to an Access database. However, if the DSA is already configured for Model data and
you use the 3050 command to configure the DSA for Equipment data, then the DSA will be configured for
both Model data and Equipment data.

SynerGEE Electric 5.0

User Guide

860

Numerical Recipe Commands

The inputs for this command are described in the following table. For more information on DSAs, see Data
Source Aliases (DSAs) on page 75.
Field

Name

Type

Description

DSA name

string

Name of the DSA that you want to create. In the

SynerGEE DSA editor, this is the value entered in the
Description field.

Data type

double

Numerical value that represents the data type contained

in the data source. Acceptable values are as follows:

User Guide

Provider

double

0 Model

1 Equipment

2 Partial

3 Subset

4 Results

5 ML Table

6 Events

7 Version

8 CMM

9 Custom

10 Mining

11 Data Mart

Numerical value that represents the provider type for

the data source. Acceptable values are as follows:

0 Access

1 Oracle

2 SQL Svr

3 Binary

4 MiddleLink

5 MiddleLink 3.4

9 MultiSpeak

SynerGEE Electric 5.0

Numerical Recipe Commands

Field
4

861

Name

Type

Description

Server/path

string

Server name, if the provider is an enterprise database.

Otherwise, specify the full path, file name, and file
extension, if the provider is a personal file. Do not
enclose this value in quotes.
If you specify a file name that does not yet exist, the file
will be created the first time you save data to that DSA.
The data source file is not created automatically simply
because you created a DSA for it.

User name
(optional)

string

User name to access an enterprise database. Only

used when the provider is an enterprise database.

Password
(optional)

string

Password to access an enterprise database. Only used

when the provider is an enterprise database.

Model ID (optional)

string

ID of the model requested from an enterprise database.

Only used when the provider is an enterprise database.

Custom table
(optional)

string

Custom table that can be created only if a custom DSA

type is used.

The following list provides several examples of the 3050 recipe command.

Create a DSA to a personal file:

3050, Sample DB, 0, 0, C:\Program Files\SynerGEE Electric 5.0\Sample
Data\SampleModel.mdb

Create a DSA to an Oracle enterprise database model:

3050, MyEnterpriseModel, 0, 1, SynModelServer, MyName, MyPassword,
Model_1

3051 Deleting a DSA

Use the 3051 recipe command to delete a DSA from your model. The inputs for this command are described
in the following table.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA that you want to delete. In SynerGEE,

this is the value in the Description field for the DSA.

SynerGEE Electric 5.0

User Guide

862

Numerical Recipe Commands

3052 Testing a DSA connection

Use the 3052 recipe command to test a DSA connection. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA whose connection you want to test. In

SynerGEE, this is the value in the Description field for
the DSA.

3053 Loading feeders

Use the 3053 recipe command to load multiple feeders, as identified by an optional script list. If you do not
provide a script list name, then the default feeders for the specified DSA will be loaded.
The inputs for this command are described in the following table. For more information on script lists, see
List Recipe Commands on page 898.
Field

Name

Type

Description

DSA name

string

Name of the DSA that includes the feeders that you

want to load. In SynerGEE, this is the value in the
Description field for the DSA.

Feeder list
(optional)

string

Optional list of feeders, created using SynerGEEs list

recipe commands. For more information in the list
commands, see List Recipe Commands on page 898.
If no feeder list is specified, then the default feeders and
subtrans for the specified model will be loaded. (The
default feeders and subtrans are those where the
Display on Load option has been selected on the
Feeder tab of the Feeder editor, or the Source tab of the
Subtrans editor.)

Lock feeders
(optional)

Boolean

Optional Boolean value specifying whether or not

feeders will be locked after the load process is
complete.

0 No (feeders will not be locked)

1 Yes (feeders will be locked)

If no value is specified, then the feeders will not be

locked.

3054 Saving feeders

Use the 3054 recipe command to save all feeders in memory to the specified DSA. The current feeder
selection does not affect this command.

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

863

The inputs for this command are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA where you want to save the feeders.

In SynerGEE, this is the value in the Description field for
the DSA.

Keep feeders
locked (optional)

Boolean

Optional Boolean value specifying whether or not

feeders will be locked or remain locked after the save
process is complete.

0 No (feeders will not be locked)

1 Yes (feeders will be locked)

If no value is specified, then the feeders will not be

locked.

3055 Loading equipment data

Use the 3055 recipe command to load equipment data. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA from which you want to load

equipment data. In SynerGEE, this is the value in the
Description field for the DSA.

SynerGEE Electric 5.0

User Guide

864

Numerical Recipe Commands

Field
2

Name

Type

Description

Category (optional)

string

Optional category name, if you only want to load a

portion of the equipment data and not the entire data
set. If no value is specified, then all categories will be
loaded.
Acceptable values are as follows. You can only specify
one category in a 3055 command. If you want to load
multiple categories from an equipment data source, you
must use multiple 3055 commands in your script.

config Configurations

cust class Customer classes

cust zone Customer zones

duct Duct banks

exp Exposure and mitigation zones

gen Generators

grow Growth zones

harm Harmonic curves

line Lines and cables

motor Motors

prot Protective devices

reg Regulators

switch Switches

tran Transformers

weather Weather

3056 Saving equipment data

Use the 3056 recipe command to save equipment data. The inputs for this command are described in the
following table.
Field
1

User Guide

Name

Type

Description

DSA name

string

Name of the DSA where you want to save equipment

data. In SynerGEE, this is the value in the Description
field for the DSA.

SynerGEE Electric 5.0

Numerical Recipe Commands

Field
2

865

Name

Type

Description

Category (optional)

string

Optional category name, if you only want to load a

portion of the equipment data and not the entire data
set. If no value is specified, then all categories will be
loaded.
Acceptable values are as follows. You can only specify
one category in a 3056 command. If you want to save
multiple categories to an equipment data source, you
must use multiple 3056 commands in your script.

config Configurations

cust class Customer classes

cust zone Customer zones

duct Duct banks

exp Exposure and mitigation zones

gen Generators

grow Growth zones

harm Harmonic curves

line Lines and cables

motor Motors

prot Protective devices

reg Regulators

switch Switches

tran Transformers

weather Weather

3057 Loading a protection database

Use the 3057 recipe command to load a protection curve library. The inputs for this command are described
in the following table.
Field
1

Name

Type

Description

Path (optional)

string

Full path, file name, and file extension for the protection
database. If you do not specify a value, SynerGEE
searches for the normal SynProtectionDb.mdb file in
your SynerGEE installation folder.

SynerGEE Electric 5.0

User Guide

866

Numerical Recipe Commands

3058 Loading a partials data source file

Use the 3058 recipe command to load a partials data source file. The inputs for this command are described
in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA that includes the partials data source

file that you want to load. In SynerGEE, this is the value
in the Description field for the DSA.

Report

Boolean

Boolean value specifying whether or not you want to

generate the partials report.

0 No (report will not be generated)

1 Yes (report will be generated)

3059 Creating a regression file

Use the 3059 recipe command to create a regression file. The inputs for this command are described in the
following table.
Field

Name

Type

Description

Path

string

Full path, file name, and file extension for the regression
file that will be created. Regression files typically use
the suffix SYNREG.

For more information on regression, see Regression on page 759.

3060 Comparing two regression files

Use the 3060 recipe command to compare two regression files. The inputs for this command are described in
the following table.
Field

Name

Type

Description

Path 1

string

Full path, file name, and file extension for the first
regression file that will be compared. Regression files
typically use the suffix SYNREG.

Path 2

string

Full path, file name, and file extension for the second
regression file that will be compared. Regression files
typically use the suffix SYNREG.

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

Field
3

867

Name

Type

Description

Prompt for report

(optional)

Boolean

Boolean value specifying whether the user will be

shown a summary message of the comparison results
before the comparison report is generated. (The user
must click the OK button to accept the message before
the script will continue and the report is generated.)

0 No (the comparison report will be

generated automatically, without the summary
message)

1 Yes (the summary message will be shown

first, and once accepted, the comparison
report will be generated)

If no value is specified, then the script will perform the

actions associated with option 1 above.
For more information on regression, see Regression on page 759.

3061 Loading a subset

Use the 3061 recipe command to load a subset. The inputs for this command are described in the following
table.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA that includes the partials data source

file that you want to load. In SynerGEE, this is the value
in the Description field for the DSA.

SynerGEE Electric 5.0

User Guide

868

Numerical Recipe Commands

Field

Name

Type

Description

Type

double

Numerical value that represents the subset type.

Acceptable values are as follows:

Name

string

1 Distributed loads

2 Spot loads

3 Distributed and spot loads

4 Switches

5 Elbows

6 Meters

7 Capacitors

8 Large customers

9 Mobile items

10 Query set

11 Regulators

12 Projects

Name of the subset that you want to load.

For more information on subsets, see Subsets on page 82.

3062 Saving a subset

Use the 3062 recipe command to save a subset. The inputs for this command are described in the following
table.
Field
1

User Guide

Name

Type

Description

DSA name

string

Name of the DSA where you want to save the subset. In

SynerGEE, this is the value in the Description field for
the DSA.

SynerGEE Electric 5.0

Numerical Recipe Commands

869

Field

Name

Type

Description

Type

double

Numerical value that represents the subset type.

Acceptable values are as follows:

Name

string

1 Distributed loads

2 Spot loads

3 Distributed and spot loads

4 Switches

5 Elbows

6 Meters

7 Capacitors

8 Large customers

9 Mobile items

10 Query set

11 Regulators

12 Projects

Name of the subset that you want to save. If a subset by

that name already exists, it will be updated and/or
appended as needed. Saving to an existing subset does
not necessarily cause a complete replacement.

For more information on subsets, see Subsets on page 82.

3063 Creating a new model

Use the 3063 recipe command to create a new model. This command does not require any inputs.

3064 Creating a new warehouse

Use the 3064 recipe command to create a new warehouse. This command does not require any inputs.

3065 Prompting the user to load a model

Use the 3065 recipe command to prompt the user to load a model. This command will display the Load
Feeders/Stations editor, where the user can select a model data source to load. The script will resume once
the user accepts or cancels the editor.
This command does not require any inputs.

SynerGEE Electric 5.0

User Guide

870

Numerical Recipe Commands

3066 Prompting the use to load a warehouse

Use the 3066 recipe command to prompt the user to load a warehouse. This command will display the Load
Warehouse editor, where the user can select a warehouse data source to load. The script will resume once
the user accepts or cancels the editor.
This command does not require any inputs.

3071 Creating a table for MiddleLink loading

Use the 3071 recipe command to create a table for MiddleLink loading. The inputs for this command are
described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA where you want to create a table. In

SynerGEE, this is the value in the Description field for
the DSA.

Table

string

Name of the table that will be created.

3072 Creating a file for MiddleLink loading

Use the 3072 recipe command to create a file for MiddleLink loading. The inputs for this command are
described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA where you want to create a file. In

SynerGEE, this is the value in the Description field for
the DSA.

File

string

Name of the file that will be created.

3073 Creating MiddleLink table

Use the 3073 recipe command to create a MiddleLink table. The inputs for this command are described in the
following table.
Field

User Guide

Name

Type

Description

DSA name

string

Name of the DSA where you want to create a table. In

SynerGEE, this is the value in the Description field for
the DSA.

File

string

Name of the table that will be created.

SynerGEE Electric 5.0

Numerical Recipe Commands

871

3080 Checking and repairing a model schema

Use the 3080 recipe command to run the check and repair model schema tool. The inputs for this command
are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA that you want to check and repair. In

SynerGEE, this is the value in the Description field for
the DSA.

Report

Boolean

Boolean value specifying whether or not you want to

view the associated report after the check and repair
process is complete.

0 No (report will not be generated)

1 Yes (report will be generated)

3081 Checking and repairing an equipment schema

Use the 3081 recipe command to run the check and repair equipment schema tool. The inputs for this
command are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA that you want to check and repair. In

SynerGEE, this is the value in the Description field for
the DSA.

Report

Boolean

Boolean value specifying whether or not you want to

view the associated report after the check and repair
process is complete.

0 No (report will not be generated)

1 Yes (report will be generated)

3090 Adding a document to the document library

Use the 3090 recipe command to add a document to the SynerGEE document library. The inputs for this
command are described in the following table.
Field

Name

Type

Description

Name

string

Name that you want to use to identify the document in

the document library.

Path

string

Full path, file name, and file extension for the document
that you want to add to the document library.

SynerGEE Electric 5.0

User Guide

872

Numerical Recipe Commands

Field
3

Name

Type

Description

Open in dialog

Boolean

Boolean value specifying whether you want the

document will be configured to open in a SynerGEE
window or SynerGEE dialog.

0 Window

1 Dialog

Note that this parameter will not actually open the

document as a part of your script. It only sets the option
that configures how the document will be opened,
should it be opened later from the library.
For more information on the document library, see Library on page 770.

3091 Running a SQL Dashboard script

Use the 3091 recipe command to open the SQL Dashboard and run a specific recipe. The inputs for this
command are described in the following table.
Field

Name

Type

Description

Group

string

Group name where the recipe is saved.

Name

string

Name of the recipe you want to run.

Target DSA

string

Name of the DSA that you want to query. In SynerGEE,

this is the value in the Description field for the DSA.

Data type

double

Numerical value that represents the data source type.

Acceptable values are as follows:

User Guide

Data set (optional)

string

0 CMM

1 Equipment

2 Events

3 Mining

4 Model

5 Pi

6 Subset

7 Results

8 Data Mart

9 Historian

Optional data set from either an Oracle or SQL server, if

applicable.

SynerGEE Electric 5.0

Numerical Recipe Commands

Field
6

873

Name

Type

Description

Export type
(optional)

Boolean

Boolean value specifying whether you want to export

your SQL results to a CSV file or Excel file.

CSV path
(optional)

string

0 Save as CSV

1 Open in Excel

Full path, file name, and file extension to where the

optional CSV file is saved.

MAP COLORING RECIPE COMMANDS

Map coloring recipe commands allow you to apply map coloring schemes and perform other map-related
functions. Refer to the topics listed below for more information.

3100 Setting the legend title on page 874

3101 Coloring all sections on page 874

3102 Coloring by overhead or underground construction on page 874

3103 Coloring by conductor type on page 875

3104 Coloring by results within range on page 875

3105 Coloring by sections with bad phasing on page 876

3106 Coloring within two ranges on page 876

3107 Coloring by the product of two result parameters on page 877

3108 Coloring by the quotient of two result parameters on page 878

3109 Coloring by section prefix on page 878

3110 Applying display style on page 879

3111 Coloring sections fed from wandering lateral on page 879

3112 Coloring sections fed from a loop on page 879

3113 Applying a Geobackground on page 880

3114 Coloring sections by the delta/ground status of lines on page 880

SynerGEE Electric 5.0

User Guide

874

Numerical Recipe Commands

3100 Setting the legend title

Use the 3100 recipe command to set the title for the SynerGEE map legend. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

Title

string

Custom title that will appear at the top of the SynerGEE

map legend.

3101 Coloring all sections

Use the 3101 recipe command to color all sections in the selected feeders. The inputs for this command are
described in the following table.
Field

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the selected

sections. See Colors for recipes on page 903 for a
complete list of acceptable values.

3102 Coloring by overhead or underground

construction
Use the 3102 recipe command to color all sections in the selected feeders by overhead or underground
construction. The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

Over/Under

string

Text value designating whether overhead or

underground construction will be colored. Acceptable
values are as follows:

Over

Under

SynerGEE Electric 5.0

Numerical Recipe Commands

Field
4

875

Name

Type

Description

Line style (optional)

double

Numerical value that represents the line style for the

section lines in the map display. Acceptable values are
as follows:

Line width
(optional)

double

1 None

2 Dashed

3 Dotted

4 Dash-dot

5 Dash-dot-dot

6 Solid

Numerical value that represents the thickness of the

section lines in the map display. Specify a value from 1
to 10.

3103 Coloring by conductor type

Use the 3103 recipe command to color all sections in the selected feeders by conductor type. The inputs for
this command are described in the following table.
Field

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

Cond type

string

Name of the conductor type that you want to use to

color sections. You must specify an exact conductor
name from the equipment data in memory.

3104 Coloring by results within range

Use the 3104 recipe command to color all sections in the selected feeders by a specified result type that falls
within a maximum and minimum range. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

SynerGEE Electric 5.0

User Guide

876

Numerical Recipe Commands

Field

Name

Type

Description

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

Result

string

Result type that you want to use to color sections in the

map display. See Results for recipes on page 904 for
a complete list of acceptable values.

Min

double

Minimum acceptable value for the result range.

Max

double

Maximum acceptable value for the result range.

3105 Coloring by sections with bad phasing

Use the 3105 recipe command to color all sections in the selected feeders if the phasing specified in the
section does not match the phasing propagated through it. For example, a phase CN section fed by an
ABN section would be colored, while a phase CN section fed by an ACN section would not.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

3106 Coloring within two ranges

Use the 3106 recipe command to color all sections in the selected feeders that fall within both specified
ranges of two independent results parameters. For example, this command could color a section if it falls
within a certain voltage range and a specified connected kVA range. If only one of the specified ranges is
met, the section is not colored.
The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

SynerGEE Electric 5.0

Numerical Recipe Commands

877

Field

Name

Type

Description

Result1

string

First result type that you want to use to color sections in

the map display. See Results for recipes on page 904
for a complete list of acceptable values.

Min

double

Minimum acceptable value for the first result range.

Max

double

Maximum acceptable value for the first result range.

Result2

string

Second result type that you want to use to color

sections in the map display. See Results for recipes on
page 904 for a complete list of acceptable values.

Min

double

Minimum acceptable value for the second result range.

Max

double

Maximum acceptable value for the second result range.

3107 Coloring by the product of two result

parameters
Use the 3107 recipe command to color all sections in the selected feeders based on the numerical product of
two results parameters, if it falls within a specified range. The inputs for this command are described in the
following table.
Field

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

Result1

string

First result type that you want to use to color sections in

the map display. See Results for recipes on page 904
for a complete list of acceptable values.

Result2

string

Second result type that you want to use to color

sections in the map display. See Results for recipes on
page 904 for a complete list of acceptable values.

Min

double

Minimum acceptable value for the product of the two

result ranges.

Max

double

Maximum acceptable value for the product of the two

result ranges.

SynerGEE Electric 5.0

User Guide

878

Numerical Recipe Commands

3108 Coloring by the quotient of two result

parameters
Use the 3108 recipe command to color all sections in the selected feeders based on the quotient of two
results parameters. This command allows you to compare a parameter per unit type of term against a
specified range.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

Result1

string

First result type that you want to use to color sections in

the map display. See Results for recipes on page 904
for a complete list of acceptable values.

Result2

string

Second result type that you want to use to color

sections in the map display. See Results for recipes on
page 904 for a complete list of acceptable values.

Min

double

Minimum acceptable value for the quotient of the two

result ranges.

Max

double

Maximum acceptable value for the quotient of the two

result ranges.

Consider the case where you want to isolate and color sections that fall within a particular connected kVA per
foot range. In this case, you could use the 3108 command, such as in the following example:
3108, Loading density 1, Purple, ConnKva, Length, 0.3, 1.5

This example command takes the connected kVA of each section and divides it by the respective length,
producing a kVA/ft value. If the value falls within the specified range (0.3 to 1.5), the section will be colored
purple.

3109 Coloring by section prefix

Use the 3109 recipe command to color all sections in the selected feeders if their IDs begin with a certain
prefix string. For example, if the prefix is Sect and a section ID is Sect_01, the section will be colored.

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

879

The inputs for this command are described in the following table.
Field

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

Prefix

string

Prefix string that you want to use to color sections in the

map display.

3110 Applying display style

Use the 3110 recipe command to apply a specified display style to the SynerGEE map display. The inputs for
this command are described in the following table.
Field
1

Name

Type

Description

Display style

string

Name of the display style that you want to apply to the

SynerGEE map display.

3111 Coloring sections fed from wandering lateral

Use the 3111 recipe command to color all sections in the selected feeders that are fed from a wondering
lateral. The inputs for this command are described in the following table.
Field

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

3112 Coloring sections fed from a loop

Use the 3112 recipe command to color all sections in the selected feeders that are fed from a loop. The
inputs for this command are described in the following table.
Field
1

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

SynerGEE Electric 5.0

User Guide

880

Numerical Recipe Commands

Field

Name

Type

Description

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

3113 Applying a Geobackground

Use the 3113 recipe command to apply a specified Geobackground to the SynerGEE map display. The inputs
for this command are described in the following table.
Field
1

Name

Type

Description

Geobackground

string

Name of the Geobackground that you want to apply to

the SynerGEE map display.

3114 Coloring sections by the delta/ground status of

lines
Use the 3114 recipe command to color all sections in the selected feeders by the delta/ground status of the
lines. The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

Legend text

string

Custom label that will be associated with the specified

color in the SynerGEE map legend.

Color

string

Name of the color that will be applied to the map. See

Colors for recipes on page 903 for a complete list of
acceptable values.

Delta/neutral

string

Text value designating whether the map will be colored

by delta status or neutral status. Acceptable values are
as follows:

Delta

Neutral

SynerGEE Electric 5.0

Numerical Recipe Commands

Field
4

881

Name

Type

Description

Line style (optional)

double

Numerical value that represents the line style for the

section lines in the map display. Acceptable values are
as follows:

Line width
(optional)

double

1 None

2 Dashed

3 Dotted

4 Dash-dot

5 Dash-dot-dot

6 Solid

Numerical value that represents the thickness of the

section lines in the map display. Specify a value from 1
to 10.

ANALYSIS RECIPE COMMANDS

Analysis recipe commands allow you to control SynerGEE analysis and other scripting functions. Refer to the
topics listed below for more information.

3200 Running an analysis on page 882

3201 Running a Model Cleanup script on page 882

3203 Running an Outage Import script on page 883

3204 Exporting an SVG file on page 883

3205 Exporting a Model Viewer file on page 884

3206 Running a CMM script on page 884

3207 Running another recipe on page 884

3208 Exporting the most recent report on page 885

3210 Setting the analysis year on page 886

3211 Running a report script on page 886

3212 Loading and saving an application settings group on page 886

3230 Setting the growth option on page 887

3231 Setting a single load multiplier as the growth option on page 887

3232 Setting different load multipliers as the growth option on page 888

3233 Setting the time of day on page 888

3250 Setting fault levels in the fault location application on page 889

SynerGEE Electric 5.0

User Guide

882

Numerical Recipe Commands

3251 Specifying fault types in the fault location application on page 889

3200 Running an analysis

Use the 3200 recipe command to run a specified analysis type. The inputs for this command are described in
the following table.
Field

Name

Type

Description

App name

string

Text string that represents the analysis type that you

want to run. See Analysis types for recipes on
page 905 for a complete list of acceptable values.

Report

Boolean

Boolean value specifying whether or not you want to

view the associated analysis report after the analysis is
complete.

0 No (report will not be generated)

1 Yes (report will be generated)

3201 Running a Model Cleanup script

Use the 3201 recipe command to run the Model Cleanup tool using a specified script name. The inputs for
this command are described in the following table.
Field

Name

Type

Description

Script name

string

Name of the Model Cleanup script that you want to run.

Specify the script name only, without the file path or
extension type.

Report

Boolean

Boolean value specifying whether or not you want to

generate the Model Cleanup report after the Model
Cleanup script is complete.

0 No (report will not be generated)

1 Yes (report will be generated)

For more information on the model cleanup tool, see Model Cleanup Scripts on page 718.

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

883

3203 Running an Outage Import script

Use the 3203 recipe command to run a specified Outage Import script. The inputs for this command are
described in the following table.
Field

Name

Type

Description

Script name

string

Name of the Outage Import script that you want to run.

Specify the script name only, without the file path or
extension type.

Report

Boolean

Boolean value specifying whether or not you want to

generate the Outage Import report after the Outage
Import script is complete.

0 No (report will not be generated)

1 Yes (report will be generated)

3204 Exporting an SVG file

Use the 3204 recipe command to export an image of the selected feeders to a specified SVG file. This
command makes use of SynerGEEs Publishing Export tool, as described on Publishing Export on
page 739. The inputs for this command are described in the following table.
Field

Name

Type

Description

Path

string

Full path, file name, and file extension for the SVG file
that you want to export. If you do not specify a fully
qualified path, the file will be created in your SynerGEE
installation directory.

Report

Boolean

Boolean value specifying whether or not you want to

view the Publishing report after the export is complete.

SynerGEE Electric 5.0

0 No (report will not be generated)

1 Yes (report will be generated)

User Guide

884

Numerical Recipe Commands

3205 Exporting a Model Viewer file

Use the 3205 recipe command to export an image of the selected feeders to a specified Model Viewer file.
This command makes use of SynerGEEs Publishing Export tool, as described on Publishing Export on
page 739. The inputs for this command are described in the following table.
Field

Name

Type

Description

Path

string

Full path, file name, and file extension for the Model
Viewer file that you want to export. If you do not specify
a fully qualified path, the file will be created in your
SynerGEE installation directory.

Report

Boolean

Boolean value specifying whether or not you want to

view the Publishing report after the export is complete.

Title (optional)

string

0 No (report will not be generated)

1 Yes (report will be generated)

Optional title for the Model Viewer interface.

3206 Running a CMM script

Use the 3206 recipe command to run a CMM script. The inputs for this command are described in the
following table.
Field

Name

Type

Description

Script name

string

Name of the CMM script that you want to run. Specify

the script name only, without the file path or extension
type.

Report

Boolean

Boolean value specifying whether or not you want to

generate the CMM report.

0 No (report will not be generated)

1 Yes (report will be generated)

3207 Running another recipe

Use the 3207 recipe command to run a second recipe from within the current recipe. This command can be
used repeatedly up to five recipes deep. For example, a recipe can call another recipe, which in turn can call
a second recipe, and so on until five recipes are called.
The inputs for this command are described in the following table.
Field
1

User Guide

Name

Type

Description

Recipe name

string

Name of the recipe that you want to run.

SynerGEE Electric 5.0

Numerical Recipe Commands

885

The following is an example of the 3207 recipe command. Three recipes are presented here. The first recipe,
Script_Analysis, runs two SynerGEE analyses, while the second recipe, Script_Coloring, applies coloring
schemes to the SynerGEE map display. The third recipe, Scripts_Combined, uses the 3207 recipe command
to run the other two recipes.
Recipe: Script_Analysis
--------------------3200, Load flow, 0
3200, Reliability, 0
Recipe: Script_Coloring
------------------------3100, My Map Colors
3101, No Criteria, White
3104, Target kva, Red, ConnKva, 50, 75
3104, Good Volts, Green, VoltsOut, 120, 122
3104, Mid Length, Purple, Length, 500, 1000
3102, Undgd, Yellow, Under
3102, 336 stuff, Blue, 336 ACSR
3104, 2 < SAIFI < 4, DarkOrange, SAIFI, 2.0, 4.0
3109, My Sects, Purple, 21
Recipe: Scripts_Combined
---------------------3207, Script_Analysis
3207, Script_Coloring

3208 Exporting the most recent report

Use the 3208 recipe command to export the most recent report to a CSV file or one of several HTML styles.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Path

string

Full path, file name, and file extension for the file that
you want to save. If you do not specify a fully qualified
path, the file will be created in your SynerGEE
installation directory.

Type

string

Text value representing the style of the report that you

want to save. Acceptable values are as follows:

SynerGEE Electric 5.0

CSV

HTML

No Frames

No TOC

User Guide

886

Numerical Recipe Commands

3210 Setting the analysis year

Use the 3210 recipe command to set the models analysis year. The inputs for this command are described in
the following table.
Field

Name

Type

Description

Year

string

Analysis year that you want to set for the model. Use 0
for the base year, or 1 through 10 for each subsequent
year.

3211 Running a report script

Use the 3211 recipe command to run a report script. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

Script name

string

Name of the report script that you want to run. Specify

the script name only, without the file path or extension
type.

3212 Loading and saving an application settings

group
Use the 3212 recipe command to load and save an applications settings group. The inputs for this command
are described in the following table.
Field

User Guide

Name

Type

Description

Settings name

string

Name of the application settings group that you want to

load or save.

Load

Boolean

Boolean value specifying whether you want to load or

save the application settings group.

0 Save

1 Load

SynerGEE Electric 5.0

Numerical Recipe Commands

887

3230 Setting the growth option

Use the 3230 recipe command to set the models growth option. The inputs for this command are described
in the following table.
Field

Name

Type

Description

Option

double

Numerical value that represents the growth option that

you want to set. Acceptable values are as follows:

0 No growth rate

1 Apply multiplier in feeder record

2 Apply yearly growth rate in section records

3 Apply yearly growth rate in customer zone

To select the Load Multiplier option as the growth option, see 3231 Setting a single load multiplier as the
growth option on page 887 and 3232 Setting different load multipliers as the growth option on page 888.

3231 Setting a single load multiplier as the growth

option
Use the 3231 recipe command to set the models growth option to the Load Multiplier option and also to
specify the multiplier value. With this recipe command, the same multiplier value will be applied to all load
categories. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Load multiplier

double

Value of the load increase. The same value will be

applied to all load categories (Distributed Loads, Spot
Loads, Large Customers, Projects, and Speculative
Loads).

To set individual multiplier values for each load category, see 3232 Setting different load multipliers as the
growth option on page 888. To select other options as the growth option, see 3230 Setting the growth
option on page 887.

SynerGEE Electric 5.0

User Guide

888

Numerical Recipe Commands

3232 Setting different load multipliers as the growth

option
Use the 3232 recipe command to set the models growth option to the Load Multiplier option and also to
specify the multiplier value. With this recipe command, individual multiplier values can be applied to each
load category. The inputs for this command are described in the following table.
Field

Name

Type

Description

Distributed load
multiplier

double

Value of the distributed load increase.

Spot load multiplier

double

Value of the spot load increase.

Large customer
load multiplier

double

Value of the large customer load increase.

Project load
multiplier

double

Value of the project load increase.

Speculative load
multiplier

double

Value of the speculative load increase.

To select other options as the growth option, see 3230 Setting the growth option on page 887.

3233 Setting the time of day

Use the 3233 recipe command to enable or disable the time of day feature in the recipe, and also to set the
time of day, if desired. The inputs for this command are described in the following table.
Field

Name

Type

Description

Is On

Boolean

Boolean value specifying whether the time of day

feature will be enabled or disabled.

User Guide

0 Disabled

1 Enabled

Month (optional)

string

Month that you want to set. Enter this value as the full
spelling of the desired month (January, February, etc.).

Day type (optional)

double

Numerical value that represents the day type that you

want to set. Acceptable values are as follows:

0 Weekend

1 Weekday

2 Peakday

SynerGEE Electric 5.0

Numerical Recipe Commands

Field
4

889

Name

Type

Description

Hour (optional)

string

Time of day that you want to set. Enter as a 12-hour

format, adding PM to indicate a PM value. For example:

6 = 6:00 AM

6PM = 6:00 PM

12 = Noon

12PM = Midnight

3250 Setting fault levels in the fault location

application
Use the 3250 recipe command to set fault levels in the fault location application. This command is analogous
to setting the Fault level information fields in the Fault Location Analysis editor.
The inputs for this command are described in the following table. Note that a value of zero indicates no fault
level, while a negative number indicates an unknown and is ignored.
Field

Name

Type

Description

Value 0

double

Phase 1 value for the fault location application (typically

Phase A).

Value 1

double

Phase 2 value for the fault location application (typically

Phase B).

Value 2

double

Phase 3 value for the fault location application (typically

Phase C).

Neutral

double

Phase N value for the fault location application (typically

Neutral).

3251 Specifying fault types in the fault location

application
Use the 3251 recipe command to set fault types in the fault location application. This command is analogous
to setting the Faults to consider options in the Fault Location Analysis editor.

SynerGEE Electric 5.0

User Guide

890

Numerical Recipe Commands

The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Line-grnd

Boolean

Boolean value specifying whether Line-ground faults

will be considered by the fault location application.

Line-line

Three-phase

Line-line-grnd
(optional)

Boolean

Boolean

Boolean

0 No (will not be considered)

1 Yes (will be considered)

Boolean value specifying whether Line-line faults will be

considered by the fault location application.

0 No (will not be considered)

1 Yes (will be considered)

Boolean value specifying whether three-phase faults

will be considered by the fault location application.

0 No (will not be considered)

1 Yes (will be considered)

Boolean value specifying whether line-line-ground faults

will be considered by the fault location application.

0 No (will not be considered)

1 Yes (will be considered)

MODEL MODIFICATION RECIPE COMMANDS

Refer to the topics listed below for more information.

3300 Setting a custom result for all sections in memory on page 890

3301 Setting a custom result for a single section in the model on page 891

3302 Setting the open/closed status for a device on page 891

3303 Setting the open/closed status for an elbow on page 892

3300 Setting a custom result for all sections in

memory
Some recipe commands, particularly those that color the map, can function based on the evaluation of one or
more SynerGEE results. The results available for this function are a fixed set, as described in Results for
recipes on page 904. This results set includes four customizable slots, which act as placeholders that you
can use to store your own values on a section-by-section basis. Thus, you can use the custom result slots to
operate these recipe commands based on any values that you set for those slots.

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

891

Use the 3300 recipe command to set the same value for one of the custom results slots for every section in
the model. The inputs for this command are described in the following table.
Field

Name

Type

Description

Slot

long

Number of the slot that you want to initialize. Specify a

value of 1 to 4.

Value

double

Value that will be placed in the specified slot for every

section in memory.

3301 Setting a custom result for a single section in the

model
Some recipe commands, particularly those that color the map, can function based on the evaluation of one or
more SynerGEE results. The results available for this function are a fixed set, as described in Results for
recipes on page 904. This results set includes four customizable slots, which act as placeholders that you
can use to store your own values on a section-by-section basis. Thus, you can use the custom result slots to
operate these recipe commands based on any values that you set for those slots.
Use the 3301 recipe command to set a value for one of the custom results slots for a single section in the
model. The inputs for this command are described in the following table.
Field

Name

Type

Description

Section ID

string

ID of the section where you want to set the custom

result.

Slot

long

Number of the slot that you want to initialize. Specify a

value of 1 to 4.

Value

double

Value that will be placed in the specified slot for the

specified section.

3302 Setting the open/closed status for a device

Use the 3302 recipe command to set the open/closed status for a switchable device. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

Section ID

string

ID of the section that contains the device you want to

edit. Since only one device of a particular type may exist
on any given section, the device ID is not needed.

SynerGEE Electric 5.0

User Guide

892

Numerical Recipe Commands

Field

Name

Type

Description

Device

string

Text string representing the device type. Acceptable

values are as follows:

Is Open

Boolean

Sw Switch

Br Breaker

Re Recloser

Se Sectionalizer

Fu Fuse

Boolean value specifying whether the device will be

open or closed.

0 Closed

1 Open

3303 Setting the open/closed status for an elbow

Use the 3303 recipe command to set the open/closed status for an elbow. The inputs for this command are
described in the following table.
Field

Name

Type

Description

Section ID

string

ID of the section that you want to edit.

From / To

string

Text string specifying whether the elbow that will be

edited is near the from-node or the to-node of the
section. Acceptable values are as follows:

Is Open

Boolean

From Near the from-node

To Near the to-node

Boolean value specifying whether the elbow will be

open or closed.

0 Closed

1 Open

RESULTS HANDLING RECIPE COMMANDS

Refer to the topics listed below for more information.

User Guide

3400 Exporting a results set to a database on page 893

SynerGEE Electric 5.0

Numerical Recipe Commands

893

3400 Exporting a results set to a database

Use the 3400 recipe command to export a results set to a database. The inputs for this command are
described in the following table.
Field

Name

Type

Description

Results set

string

Name of the results set that you want to export.

Target DSA

string

Name of the DSA that you want to export to. In

SynerGEE, this is the value in the Description field for
the DSA.

Replace, Empty,
Append

string

Text string specifying whether you want to replace,

empty, or append the existing data in the database.
Acceptable values are as follows:

A Append (the newly exported data is added

to the existing table in the data source, in
addition to any existing data that was already
there)

E Empty (the data in the existing table in the

data source is deleted, but the table is left in
place and filled with the new data you are
exporting)

R Replace (the existing table in the data

source is completely deleted and replaced with
the newly exported table definition and data)

For more information on the results import/export process, see Importing and exporting analysis results on
page 452.

SELECTION RECIPE COMMANDS

The selection recipe commands provide a variety of functions for identifying sections, producing the editor,
selecting feeders, and managing a query set. The commands only affect feeders that are currently selected
when the recipe is run.
Refer to the topics listed below for more information.

3500 Selecting a section on page 894

3501 Opening the Section editor for the selected section on page 894

3502 Tracing the selected section to its source and adding the results to the query set on
page 894

3503 Clearing the query set on page 895

3504 Selecting the section with a highest or lowest result on page 895

SynerGEE Electric 5.0

User Guide

894

Numerical Recipe Commands

3505 Selecting a feeder or subtran on page 895

3506 De-selecting a feeder or subtran on page 895

3507 Selecting all feeders and subtrans on page 896

3508 De-selecting all feeders and subtrans on page 896

3509 Zooming to a selected section on page 896

3510 De-selecting feeders with low metering on page 896

3511 Adding sections identified by substring to the query set on page 896

3512 Setting a section for analysis on page 898

Selection Recipe Example on page 898

3500 Selecting a section

Use the 3500 recipe command to identify a section so that it can be used by other recipe commands. The
selection is not applicable outside the context of recipes.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Section ID

string

ID of a section from a currently selected feeder.

3501 Opening the Section editor for the selected

section
Use the 3501 recipe command to open the Section editor for the section that has been identified for use in
your script by another recipe command, such as the 3500 command. This command does not require any
inputs.

3502 Tracing the selected section to its source and

adding the results to the query set
Use the 3502 recipe command to add to the query set all sections along a trace from the identified section
back to the source. The identified sections will be added to the query set, in addition to any sections that are
already included there.
Before you can use this command, you must use another recipe command, such as the 3500 command, to
identify the section you want to trace. This command does not require any inputs.
Tip:

User Guide

Use the 3503 recipe command if you want to clear the query set before running this command. For
more information, see 3503 Clearing the query set on page 895.

SynerGEE Electric 5.0

Numerical Recipe Commands

895

3503 Clearing the query set

Use the 3503 recipe command to clear the query set. This command does not require any inputs.

3504 Selecting the section with a highest or lowest

result
Use the 3504 recipe command to identify a section based on a results parameter so that it can be used in
other scripts. The section with the highest or lowest value for the specified parameter gets identified. The
selected section is then made available for use by other recipe commands. This selection is not applicable
outside the context of recipes.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Result

string

Result type that you want to use to identify a section.

See Results for recipes on page 904 for a complete
list of acceptable values.

LT / GT

string

Text string that represents whether you want to identify

the section within the selected feeders that has the
highest or lowest value for the specified result type.
Acceptable values are as follows:

LT Lowest result

GT Highest result

3505 Selecting a feeder or subtran

Use the 3505 recipe command to select a feeder or subtran. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

Feeder ID

string

ID of the feeder or subtran that you want to select.

3506 De-selecting a feeder or subtran

Use the 3506 recipe command to de-select a feeder or subtran. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

Feeder ID

string

ID of the feeder or subtran that you want to de-select.

SynerGEE Electric 5.0

User Guide

896

Numerical Recipe Commands

3507 Selecting all feeders and subtrans

Use the 3507 recipe command to select all feeders and subtrans in the current model. This command does
not require any inputs.

3508 De-selecting all feeders and subtrans

Use the 3508 recipe command to de-select all feeders and subtrans in the current model. This command
does not require any inputs.

3509 Zooming to a selected section

Use the 3509 recipe command to zoom to a section that has been identified for use in your script by another
recipe command, such as the 3500 command. This command does not require any inputs.

3510 De-selecting feeders with low metering

Use the 3510 recipe command to de-select all feeders with metering below a specified limit. The value
compared is the minimum numerical value from the Phase1Value, Phase2Value, and Phase3Value fields in
the data source, for any meter in the selected feeders.
This command is generally intended to eliminate feeders from the selection set that have bad data for
metering. It is generally not intended for precision feeder selection based on meter values.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Min value / ph

double

Minimum meter value for any phase, below which a

feeder will be de-selected.

3511 Adding sections identified by substring to the

query set
Use the 3511 recipe command to locate sections that are identified by a specified substring that is included in
the section ID and/or description. The identified sections will be added to the query set, in addition to any
sections that are already included there.
Tip:

Use the 3503 recipe command if you want to clear the query set before running this command. For
more information, see 3503 Clearing the query set on page 895.

The inputs for this command are described in the following table.
Field
1

User Guide

Name

Type

Description

Substring

string

Text string that will be used to identify sections that will

be added the query set.

SynerGEE Electric 5.0

Numerical Recipe Commands

Field
2

897

Name

Type

Description

Check ID

Boolean

Boolean value specifying whether the specified

substring will be checked against the sections ID field.
If this field is enabled and the substring appears
anywhere in the section ID field, then the section will be
added to the query set.

0 Disabled (section ID field will not be

evaluated)

1 Enabled (section ID field will be evaluated

for the specified substring)

Note that if both the Check ID field and Check

location fields are enabled, then the substring must
appear in both fields in order for the section to be added
to the query set.
If you want to check for the substring in the section ID or
the section Description, include two 3511 commands in
your recipe one where the Check ID field is enabled
only, and another where the Check location field is
enabled only.
3

Check location
(optional)

Boolean

Boolean value specifying whether the specified

substring will be checked against the sections
Description field. If this field is enabled and the
substring appears anywhere in the sections Description
field, then the section will be added to the query set.

0 Disabled (section Description field will not

be evaluated)

1 Enabled (section Description field will be

evaluated for the specified substring)

Note that if both the Check ID field and Check

location fields are enabled, then the substring must
appear in both fields in order for the section to be added
to the query set.
If you want to check for the substring in the section ID or
the section Description, include two 3511 commands in
your recipe one where the Check ID field is enabled
only, and another where the Check location field is
enabled only.

SynerGEE Electric 5.0

User Guide

898

Numerical Recipe Commands

3512 Setting a section for analysis

Use the 3512 recipe command to set a section for analysis. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

Section ID

string

ID of the section that you want to set for analysis.

Selection Recipe Example

The following recipe finds the section with the lowest voltage out, clears the query set, and adds to the query
set all sections from the identified section back to the source. It then produces the editor for the identified
section.
' Identify the section with the lowest voltage out
3504, voltsout, lt
' Clear the current query set
3503
' Add all sections from the identified section back to the source
' to the query set
3502
' Produce the editor for the identified section
3501

LIST RECIPE COMMANDS

The list-related recipe commands are used to form lists for other recipe commands. For example, when
loading selected feeders with a 3053 command, the feeder list must be passed as a recipe-formed list.
Refer to the topics listed below for more information.

3550 Creating a list on page 899

3551 Destroying a list on page 899

3552 Clearing a list on page 899

3553 Adding an item to list on page 899

3554 Removing an item from list on page 900

3555 Loading a list from a file on page 900

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

899

3550 Creating a list

Use the 3550 recipe command to create a list for use in your recipe script. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

List name

string

Name of the list that you want to create. If a list currently

exists with the specified name, it will be overwritten.

3551 Destroying a list

Use the 3551 recipe command to destroy, or deallocate, a list. If you use long lists or multiple lists, this
command is recommended to release memory after you are finished with the list.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

List name

string

Name of the list that you want destroy

3552 Clearing a list

Use the 3552 recipe command to clear all items from a list. Unlike the 3551 command, which completely
destroys the list, the 3552 command leaves the empty list intact in case you want to continue using it.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

List name

string

Name of the list that you want clear

3553 Adding an item to list

Use the 3553 recipe command to add an item to a list. The inputs for this command are described in the
following table.
Field

Name

Type

Description

List name

string

Name of the list that you want to add an item to.

Item name

string

Item to be added to the list.

SynerGEE Electric 5.0

User Guide

900

Numerical Recipe Commands

3554 Removing an item from list

Use the 3554 recipe command to remove an item from a list. The inputs for this command are described in
the following table.
Field

Name

Type

Description

List name

string

Name of the list that you want to remove an item from.

Item name

string

Item to be removed from the list.

3555 Loading a list from a file

Use the 3555 recipe command to load items into a list from a specified file. The inputs for this command are
described in the following table.
Field

Name

Type

Description

List name

string

Full path, file name, and file extension for the file you
want to load.

Item name

string

Name of the list that you want to add items to.

LICENSING RECIPE COMMANDS

Refer to the topics listed below for more information.

3600 Checking out a module on page 901

3601 Checking in a module on page 902

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

901

3600 Checking out a module

Use the 3600 recipe command to check out a SynerGEE module. The inputs for this command are described
in the following table.
Field

Name

Type

Description

Module

string

Name of the module that you want to check out.

Acceptable values are as follows:

SynerGEE Electric 5.0

plan Planning

harm Harmonics

motor Motors

switch Switching

pub Publishing

prot Protection

reli Reliability

mid MiddleLink

cable Cable

cmm CMM

User Guide

902

Numerical Recipe Commands

3601 Checking in a module

Use the 3601 recipe command to check in a SynerGEE module. The inputs for this command are described
in the following table.
Field

Name

Type

Description

Module

string

Name of the module that you want to check in.

Acceptable values are as follows:

plan Planning

harm Harmonics

motor Motors

switch Switching

pub Publishing

prot Protection

reli Reliability

mid MiddleLink

cable Cable

cmm CMM

MESSAGING SCRIPT RECIPE COMMANDS

Refer to the topics listed below for more information.

3650 Running a messaging script on page 902

3651 Running a messaging script with a prompt on page 903

3650 Running a messaging script

Use the 3650 recipe command to run a messaging script. The inputs for this command are described in the
following table.
Field
1

User Guide

Name

Type

Description

Script name

string

Name of the messaging script that you want to run.

Specify the script name only, without the file path or
extension type.

SynerGEE Electric 5.0

Numerical Recipe Commands

903

3651 Running a messaging script with a prompt

Use the 3651 recipe command to run a messaging script with a prompt. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

Script name

string

Name of the messaging script that you want to run.

Specify the script name only, without the file path or
extension type.

RECIPE PARAMETER REFERENCE

Some recipes use parameters that require specific entries. These sections list the valid entries that
SynerGEE will recognize in a recipe.
Refer to the topics listed below for more information.

Colors for recipes on page 903

Results for recipes on page 904

Analysis types for recipes on page 905

Colors for recipes

AliceBlue

AntiqueWhite

Aquamarine

Azure

Beige

Bisque

Black

BlanchedAlmond

Blue

BlueViolet

Brown

Burlywood

CadetBlue

Chartreuse

Chocolate

Coral

CornflowerBlue

Cornsilk

Cyan

DarkGoldenrod

DarkGreen

DarkKhaki

DarkOliveGreen

DarkOrange

DarkOrchid

DarkSalmon

DarkSeaGreen

DarkSlateBlue

DarkSlateGray

DarkTurquoise

DarkViolet

DeepPink

DeepSkyBlue

DodgerBlue

Firebrick

FloralWhite

ForestGreen

Gainsboro

GhostWhite

Gold

Goldenrod

Gray

Gray0

Gray1

Gray2

Gray3

Gray4

Gray5

Gray6

Gray7

Gray8

Gray9

Gray10-Gray99

Green

GreenYellow

Honeydew

SynerGEE Electric 5.0

User Guide

904

Numerical Recipe Commands

HotPink

IndianRed

Ivory

Khaki

Lavender

LavenderBlush

LawnGreen

LemonChiffon

LightBlue

LightCoral

LightCyan

LightGoldenrod

LightGoldenrodYellow

LightGray

LightPink

LightSalmon

LightSeaGreen

LightSkyBlue

LightSlateBlue

LightSlateGray

LightSteelBlue

LightYellow

LimeGreen

Linen

Magenta

Maroon

MediumAquamarine

MediumBlue

MediumOrchid

MediumPurple

MediumSeaGreen

MediumSlateBlue

MediumSpringGreen

MediumTurquoise

MediumVioletRed

MidnightBlue

MintCream

MistyRose

Moccasin

NavajoWhite

NavyBlue

OldLace

OliveDrab

Orange

OrangeRed

Orchid

PaleGoldenrod

PaleGreen

PaleTurquoise

PaleVioletRed

PapayaWhip

PeachPuff

Peru

Pink

Plum

PowderBlue

Purple

Red

RosyBrown

RoyalBlue

SaddleBrown

Salmon

SandyBrown

SeaGreen

Seashell

Sienna

SkyBlue

SlateBlue

SlateGray

Snow

SpringGreen

SteelBlue

Tan

Thistle

Tomato

Turquoise

Violet

VioletRed

Wheat

White

Yellow

YellowGreen

Results for recipes

3ph

accvolts

ampsin

ampsinto

conncust

connkva

connkvathr

connkwh

custthr

distance

kvarin

kvarinto

kvarloss

kvarlossinto

kwin

kwinto

kwloss

kwlossinto

length

maifi

milesthr

neutralamps

nomvolts

pctloading

pctpfinto

phgmax

phgmin

phph

User Guide

SynerGEE Electric 5.0

Numerical Recipe Commands

905

saidi

saifi

slot1 *

slot2 *

slot3 *

slot4 *

spotkvar

spotkw

symfault

symground

voltdrop

voltsout

*The slots are customizable values that you control with 3300 and 3301 records and then call from other
recipe commands like the normal SynerGEE-generated results.

Analysis types for recipes

load flow

fault

check coord

reliability

allocation

locked rotor

multiyear

facility sel

motor start

network loadflow

network fault

design cond

design reg

node reduction

contingency

harmonic

fault location

arc flashover

time range

SynerGEE Electric 5.0

User Guide

906

User Guide

Numerical Recipe Commands

SynerGEE Electric 5.0

APPENDIX

B
Text-Based Recipe
Commands
The topics listed below provide information on the text-based recipe commands that are available in
SynerGEE. For general information on setting up recipes and recipe files, see Recipe Scripts on page 700.
For information on the older numerical style recipe commands, see Numerical Recipe Commands on
page 855.

Analysis Commands on page 908

Automation Commands on page 937

CMM Commands on page 909

Contingency Commands on page 910

Fault Location Commands on page 910

File Commands on page 912

Recipe Control Commands on page 913

Load Allocation Commands on page 914

Load Flow Commands on page 915

List Commands on page 915

Map Commands on page 917

Model Forge Commands on page 918

Model I/O Commands on page 918

Model Management Commands on page 930

Multi-Model Commands on page 934

Phase Balancing Commands on page 940

QA Commands on page 941

Reliability Commands on page 941

Settings Commands on page 943

SQL Commands on page 943

Throw-Over Commands on page 944

SynerGEE Electric 5.0

User Guide

908

Text-Based Recipe Commands

Warehouse Commands on page 945

ANALYSIS COMMANDS
The Analysis recipe commands include commands that you can use to run a cleanup script, view the Check
Data and Topology reports, and close report windows. Refer to the topics listed below for more information.

Analysis.RunCleanupScript on page 908

Analysis.CloseAllReports on page 908

Analysis.CheckData on page 909

Analysis.Topology on page 909

Analysis.RunCleanupScript
Use the Analysis.RunCleanupScript recipe command to run a Model Cleanup script on the model in memory.
It is important to note that this recipe command will automatically commit any changes to the model. This
differs from running a Model Cleanup script manually, where you are given the option to accept the changes
or just view a report of the changes.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Full path to cleanup

script

string

Full path, file name, and file extension for the model
cleanup script that you want to run.

Report

Boolean

Boolean value specifying whether you want to generate

the Model Cleanup report.

0 No (do not generate the report)

1 Yes (generate the report)

If no value is specified, then the report will be

generated.

Analysis.CloseAllReports
Use the Analysis.CloseAllReports recipe command to close all open report windows in SynerGEE. This
command performs the same task as pressing the F10 button in your SynerGEE session, or clicking the
Close All Reports button from the CONTROLS tab of any Report view window.
This command does not require any inputs.

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

909

Analysis.CheckData
Use the Analysis.CheckData recipe command to generate a Check Data report. The Check Data report,
which is a part of the Digest report, presents the findings of a full evaluation of the model data in memory,
including checks for topological errors and data mismatches.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Full path for HTML

report (optional)

string

Full path and file name for SynerGEE to create an

HTML version of the Check Data report. If this
parameter is not specified or if the path is invalid, then
SynerGEE will not save an HTML version of the report.
(The Check Data report will still be displayed in
SynerGEEs report window.)

For more information on the Check Data report, see Check Data report on page 137.

Analysis.Topology
Use the Analysis.Topology recipe command to generate a Topology report. The Topology report, which is a
part of the Digest report, provides a comprehensive look at your model from a topology and connectivity
standpoint, including data such as node information, equipment locations, and section orientation.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Full path for HTML

report (optional)

string

Full path and file name for SynerGEE to create an

HTML version of the Topology report. If this parameter
is not specified or if the path is invalid, then SynerGEE
will not save an HTML version of the report. (The
Topology report will still be displayed in SynerGEEs
report window.)

CMM COMMANDS
The CMM recipe commands include commands that you can use to run a CMM script. Refer to the topics
listed below for more information.

Cmm.RunScript on page 910

SynerGEE Electric 5.0

User Guide

910

Text-Based Recipe Commands

Cmm.RunScript
Use the Cmm.RunScript recipe command to run a CMM script on the model in memory. The inputs for this
command are described in the following table.
Field

Name

Type

Description

Full path to cleanup

script

string

Full path, file name, and file extension for the CMM
script that you want to run.

Report

Boolean

Boolean value specifying whether you want to generate

the CMM report.

0 No (do not generate the report)

1 Yes (generate the report)

If no value is specified, then the report will be

generated.

CONTINGENCY COMMANDS
Use the Contingency recipe commands to run a Contingency analysis. Refer to the topics listed below for
more information.

Contingency.Run on page 910

Contingency.Run
Use the Contingency.Run recipe command to run a Contingency analysis on the model in memory. The
inputs for this command are described in the following table.
Field
1

Name

Type

Description

Show Report

Boolean

Boolean value specifying whether you want to generate

the Contingency report after the analysis is complete.

0 No (do not generate the report)

1 Yes (generate the report)

If no value is specified, then the report will be

generated.

FAULT LOCATION COMMANDS

Use the FaultLoc recipe commands to set up and run a Fault Location analysis. Refer to the topics listed
below for more information.

User Guide

FaultLoc.FaultsToConsider on page 911

SynerGEE Electric 5.0

Text-Based Recipe Commands

911

FaultLoc.Run on page 911

FaultLoc.SetFaultAmps on page 912

FaultLoc.FaultsToConsider
Use the FaultLoc.FaultsToConsider recipe command to select which fault types will be analyzed in the Fault
Location analysis. This command performs the same task as selecting or clearing the corresponding check
boxes in the Faults to consider section of the Fault Location Analysis editor.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

LG

Boolean

Boolean value specifying whether Line-Gnd faults will

be considered in the Fault Location analysis.

LL

3Ph

LLG

Boolean

Boolean

Boolean

0 No (Line-Gnd faults will not be considered)

1 Yes (Line-Gnd faults will be considered)

Boolean value specifying whether Line-Line faults will

be considered in the Fault Location analysis.

0 No (Line-Line faults will not be considered)

1 Yes (Line-Line faults will be considered)

Boolean value specifying whether Three-Phase faults

will be considered in the Fault Location analysis.

0 No (Three-Phase faults will not be

considered)

1 Yes (Three-Phase faults will be

considered)

Boolean value specifying whether Line-Line G faults will

be considered in the Fault Location analysis.

0 No (Line-Line G faults will not be

considered)

1 Yes (Line-Line G faults will be considered)

FaultLoc.Run
Use the FaultLoc.Run recipe command to run a Fault Location analysis on the model in memory. Note that
before you run a Fault Location analysis, it is recommended that you do the following:

Set a section in your model for analysis. Although you can set a section for analysis manually before
starting your recipe script, you can also use one of several recipe commands to set the section to
analyze. For more information, see Model.SetAnalysisSection on page 930,
Model.SetAnalysisSectionByFirstBreaker on page 931, or Model.AnalysisSection on page 933.

SynerGEE Electric 5.0

User Guide

912

Text-Based Recipe Commands

Select which fault types will be considered by the analysis. Again, while this can be set manually
before the script is run, you can also use a recipe command to select the fault types that will be
considered. For more information, see FaultLoc.FaultsToConsider on page 911.

Set fault amps for each phase for the analysis, either manually or by using a recipe command. For
more information, see FaultLoc.SetFaultAmps on page 912.

Other analysis settings are used as configured in the Fault Location Analysis editor. For more information,
see Setting up a fault location analysis on page 656.
The inputs for the FaultLoc.Run command are described in the following table.
Field
1

Name

Type

Description

Show Report

Boolean

Boolean value specifying whether you want to generate

the Fault Location report after the analysis is complete.

0 No (do not generate the report)

1 Yes (generate the report)

If no value is specified, then the report will be

generated.

FaultLoc.SetFaultAmps
Use the FaultLoc.SetFaultAmps recipe command to set the known fault levels for each phase for the Fault
Location analysis. This command performs the same task as setting the corresponding values in the Fault
level information section of the Fault Location Analysis editor.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Amps Phase 1

double

Known fault level for phase 1.

Amps Phase 2

double

Known fault level for phase 2.

Amps Phase 3

double

Known fault level for phase 3.

Amps Neutral

double

Known fault level for neutral.

FILE COMMANDS
Use the File recipe commands to write text to a specified file. Refer to the topics listed below for more
information.

User Guide

File.WriteLine on page 913

SynerGEE Electric 5.0

Text-Based Recipe Commands

913

File.WriteLine
Use the File.WriteLine recipe command to write a specified text string to a specified file. This command can
be used on a number of different file formats, including TXT files and DOC files. To prevent the loss of data,
the script will not write the text string to the designated file when a lock file is detected. As an option, you can
configure this command to wait for a designated time period for the lock file to close. After the time period has
expired, if the lock file is still present, the script will continue without writing the text string to the file.
The inputs for this command are described in the following table.
Field

Name

Type

Description

File path

string

Full path, file name, and file extension for the file that
you want to write to.

Text

string

Text string that you want to write to the designated file.

Wait for file lock

(optional)

Boolean

Boolean value specifying whether you want the script to

pause if a lock file is detected for the file you want to
write to. This feature can help prevent data from being
lost when another user is working in the same file.

Wait time in
seconds (optional)

long

0 Dont wait for the lock file to close (in this

case, the text string will not be written to the
file, and the script will instantly move on)

1 Wait for the lock file to close (in this case,

the script will pause and wait for the lock file to
close; if the lock file is still open at the end of
the designated time period, then the text string
will not be written to the file)

Time period in seconds to wait for the lock file to close.

If you have selected to wait for the lock file and the lock
file is still open at the end of this time period, the script
will continue without writing the text string to the
designated file.

RECIPE CONTROL COMMANDS

The recipe control commands indicate the beginning and end of a new style recipe with text-based recipe
commands. Refer to the topics listed below for more information.

Recipe.Start on page 914

Recipe.StartAutomated on page 914

Recipe.End on page 914

SynerGEE Electric 5.0

User Guide

914

Text-Based Recipe Commands

Recipe.Start
Use the Recipe.Start recipe command to indicate the beginning of a new style recipe with text-based recipe
commands. A script with text-based recipe commands will not work if the Recipe.Start command is not
included.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Title (optional)

string

Optional title of the recipe. This parameter is for

informational purposes only and does not have any
impact on the recipe.

Recipe.StartAutomated
Use the Recipe.StartAutomated recipe command to indicate the beginning of an automated recipe script. A
script with text-based and automated recipe commands will not work if the Recipe.StartAutomated command
is not included.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Title (optional)

string

Optional title of the recipe. This parameter is for

informational purposes only and does not have any
impact on the recipe.

Recipe.End
Use the Recipe.End recipe command to indicate the end of a new style recipe with text-based recipe
commands. This command does not require any inputs.

LOAD ALLOCATION COMMANDS

Use the LoadAlloc recipe commands to run a Load Allocation analysis. Refer to the topics listed below for
more information.

User Guide

LoadAlloc.Run on page 915

SynerGEE Electric 5.0

Text-Based Recipe Commands

915

LoadAlloc.Run
Use the LoadAlloc.Run recipe command to run a Load Allocation analysis. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

Show Report

Boolean

Boolean value specifying whether you want to generate

the Load Allocation report after the analysis is complete.

0 No (do not generate the report)

1 Yes (generate the report)

If no value is specified, then the report will be

generated.

LOAD FLOW COMMANDS

Use the LoadFlow recipe commands to run a Load Flow analysis. Refer to the topics listed below for more
information.

LoadFlow.Run on page 915

LoadFlow.Run
Use the LoadFlow.Run recipe command to run a Load Flow analysis. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

Show Report

Boolean

Boolean value specifying whether you want to generate

the Load Flow report after the analysis is complete.

0 No (do not generate the report)

1 Yes (generate the report)

If no value is specified, then the report will be

generated.

LIST COMMANDS
The list-related recipe commands are used to form lists for other recipe commands. Refer to the topics listed
below for more information.

ScriptList.Create on page 916

ScriptList.Destroy on page 916

SynerGEE Electric 5.0

User Guide

916

Text-Based Recipe Commands

ScriptList.Empty on page 916

ScriptList.AddItem on page 917

ScriptList.RemoveItem on page 917

ScriptList.LoadFromFile on page 917

ScriptList.Create
Use the ScriptList.Create recipe command to create a list for use in your recipe script. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

List name

string

Name of the list that you want to create. If a list currently

exists with the specified name, it will be overwritten.

ScriptList.Destroy
Use the ScriptList.Destroy recipe command to destroy, or deallocate, a list. If you use long lists or multiple
lists, this command is recommended to release memory after you are finished with the list.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

List name

string

Name of the list that you want destroy

ScriptList.Empty
Use the ScriptList.Empty recipe command to clear all items from a list. Unlike the ScriptList.Destroy
command, which completely destroys the list, the ScriptList.Empty command leaves the empty list intact in
case you want to continue using it.
The inputs for this command are described in the following table.
Field
1

User Guide

Name

Type

Description

List name

string

Name of the list that you want clear

SynerGEE Electric 5.0

Text-Based Recipe Commands

917

ScriptList.AddItem
Use the ScriptList.AddItem recipe command to add an item to a list. The inputs for this command are
described in the following table.
Field

Name

Type

Description

List name

string

Name of the list that you want to add an item to.

Item name

string

Item to be added to the list.

ScriptList.RemoveItem
Use the ScriptList.RemoveItem recipe command to remove an item from a list. The inputs for this command
are described in the following table.
Field

Name

Type

Description

List name

string

Name of the list that you want to remove an item from.

Item name

string

Item to be removed from the list.

ScriptList.LoadFromFile
Use the ScriptList.LoadFromFile recipe command to load items into a list from a specified file. The inputs for
this command are described in the following table.
Field

Name

Type

Description

List name

string

Full path, file name, and file extension for the file you
want to load.

Item name

string

Name of the list that you want to add items to.

MAP COMMANDS
Use the Map recipe commands to perform tasks related to the SynerGEE map display. Refer to the topics
listed below for more information.

Map.ZoomNetwork on page 917

For additional map commands, see Model I/O Commands on page 918.

Map.ZoomNetwork
Use the Map.ZoomNetwork recipe command to zoom the SynerGEE map display to the network bounds of
the selected feeders. This command does not require any inputs.

SynerGEE Electric 5.0

User Guide

918

Text-Based Recipe Commands

MODEL FORGE COMMANDS

Use the Model Forge recipe commands to run processes that are related to SynerGEEs Model Forge tools.
Refer to the topics listed below for more information.

ModelForge.RunProcess on page 918

DataHammer.SigedMidway on page 918

ModelForge.RunProcess
Use the ModelForge.RunProcess recipe command to run a specified Model Forge script. This command will
run the entire script. An optional Boolean parameter can be used to run the script directly in the model in
memory, or run the script in a temporary model that is then merged with the model in memory.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Full path to script

string

Full path, file name, and file extension for Model Forge
script file you want to run.

Immediately merge
(optional)

string

Boolean value specifying whether you want to run the

script directly in the model in memory, or run the script
on a temporary model that is then merged with the
model in memory.

0 Run the script directly in the model in

memory

1 Run the script on a temporary model that is

then merged with the model in memory

If no value is specified, then option 1 above (run the

script on a temporary model first) will be applied.

DataHammer.SigedMidway
The DataHammer.SigedMidway recipe command is not intended for general use, and thus it is not
documented here.

MODEL I/O COMMANDS

Use the Model I/O recipe commands to create and delete DSAs and perform other tasks related to data
management. Refer to the topics listed below for more information.

DSA.Create on page 919

DSA.Delete on page 921

DSA.DropModel on page 921

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

919

DSA.DropSubstation on page 922

DSA.DeleteFeeder on page 922

DSA.DeleteFeederList on page 922

DSA.ExecStoredProc on page 923

DSA.LoadFeeders on page 924

DSA.LoadSubBySection on page 925

DSA.LoadModelBySub on page 925

DSA.LoadWarehouse on page 926

DSA.ResultsSetSave on page 926

DSA.SaveFeeders on page 926

DSA.TestConnection on page 927

DSA.ExportLastReport on page 927

DSA.ExportLastReport2 on page 928

DSA.LoadProtectionDb on page 929

DSA.SaveWarehouse on page 929

DSA.Create
Use the DSA.Create recipe command to create a data source alias (DSA). If the DSA already exists (by
name), this command has differing effects depending on which parameters you select. For example, if the
DSA exists as a link to an Access database and you use the DSA.Create command to link the DSA as an
Oracle database, then the DSA will be linked to an Access database. However, if the DSA is already
configured for Model data and you use the DSA.Create command to configure the DSA for Equipment data,
then the DSA will be configured for both Model data and Equipment data.
The inputs for this command are described in the following table. For more information on DSAs, see Data
Source Aliases (DSAs) on page 75.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA that you want to create. In the

SynerGEE DSA editor, this is the value entered in the
Description field.

SynerGEE Electric 5.0

User Guide

920

Text-Based Recipe Commands

Field

Name

Type

Description

Type

string

Numerical value that represents the data type contained

in the data source. Acceptable values are as follows:

Provider

Server/path

string

string

0 Model

1 Equipment

2 Partial

3 Subset

4 Results

5 ML Table

6 Events

7 Version

8 CMM

9 Custom

10 Mining

11 Data Mart

Numerical value that represents the provider type for

the data source. Acceptable values are as follows:

0 Access

1 Oracle

2 SQL Server

3 Binary

4 MiddleLink

5 MiddleLink 3.4

6 MultiSpeak

Server name, if the provider is an enterprise database.

Otherwise, specify the full path, file name, and file
extension, if the provider is a personal file. Do not
enclose this value in quotes.
If you specify a file name that does not yet exist, the file
will be created the first time you save data to that DSA.
The data source file is not created automatically simply
because you created a DSA for it.

User Guide

Model ID (optional)

string

User name to access an enterprise database. Only

used when the provider is an enterprise database.

SynerGEE Electric 5.0

Text-Based Recipe Commands

Field

921

Name

Type

Description

User Name
(optional)

string

Password to access an enterprise database. Only used

when the provider is an enterprise database.

Password
(optional)

string

ID of the model requested from an enterprise database.

Only used when the provider is an enterprise database.

Custom table
(optional)

string

Custom table that can be created only if a custom DSA

type is used.

DSA.Delete
Use the DSA.Delete recipe command to delete a specified DSA. The inputs for this command are described
in the following table.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA that you want to delete. In the

SynerGEE DSA editor, this is the value entered in the
Description field.

DSA.DropModel
Use the DSA.DropModel recipe command to initialize an Oracle or SQL database by deleting all of the
model data (feeders, sections, devices, and so on) from it. This command may be useful, for example, when
you are running Model Forge and you want to delete the existing data from a specified database before you
save the Model Forge data to it.
The inputs for this command are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA from which you want to delete a

model. In the SynerGEE DSA editor, this is the value
entered in the Description field.

Drop Tables

Boolean

Boolean value specifying whether you want to delete all

of the tables in the database (with the exception of the
INSTMODELS and SAI_CONTROL tables), in addition
to the data within the tables.

SynerGEE Electric 5.0

0 No (delete model data only, but not the

database tables)

1 yes (delete both model data and the

database tables)

User Guide

922

Text-Based Recipe Commands

Field

Name

Type

Description

Prompt

Boolean

Boolean value specifying whether you a prompt will be

provided before the deletion action is performed.

0 No (user will not be prompted before data

is deleted)

1 yes (user will be prompted before data is

deleted)

DSA.DropSubstation
Use the DSA.DropSubstation recipe command to delete a substation and all associated model data (feeders,
sections, devices, and so on) from a specified Oracle or SQL Server DSA. An optional suffix can be provided
to delete multiple substations that all start with the same sequence of characters.
The inputs for this command are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA from which you want to delete a

substation. In the SynerGEE DSA editor, this is the
value entered in the Description field.

Substation name

string

Name of the substation that you want to delete from the

specified data source.

Suffix (optional)

string

Optional substation name suffix. This will allow you to

delete all substations that begin with the same
sequence of characters.

DSA.DeleteFeeder
Use the DSA.DeleteFeeder recipe command to delete a specified feeder from a specified DSA. The inputs
for this command are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA from which you want to delete a

feeder. In the SynerGEE DSA editor, this is the value
entered in the Description field.

Feeder

string

Name of the feeder that you want to delete.

DSA.DeleteFeederList
Use the DSA.DeleteFeederList recipe command to delete multiple feeders, as identified by a script list. The
inputs for this command are described in the following table. For more information on script lists, see List

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

923

Commands on page 915.

Field

Name

Type

Description

DSA name

string

Name of the DSA from which you want to delete

feeders. In the SynerGEE DSA editor, this is the value
entered in the Description field.

List name

string

Name of the script list that includes the feeder names

that you want to delete.

DSA.ExecStoredProc
Use the DSA.ExecStoredProc recipe command to call a stored procedure from an Oracle or SQL Server
database. You can optionally specify up to three parameters with this recipe command.
The inputs for this command are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA for which you want to execute a

stored procedure. In the SynerGEE DSA editor, this is
the value entered in the Description field.

Stored procedure
name

string

Name of the stored procedure that you want to run.

Parameter 1 type
(optional)

double

Parameter type for optional parameter 1 for the stored

procedure. Acceptable values are as follows:

0 text

1 integer

2 float

Parameter 1
(optional)

string

Value for optional parameter 1 for the stored procedure.

Parameter 2 type
(optional)

double

Parameter type for optional parameter 2 for the stored

procedure. Acceptable values are as follows:

Parameter 2
(optional)

SynerGEE Electric 5.0

string

0 text

1 integer

2 float

Value for optional parameter 2 for the stored procedure.

User Guide

924

Text-Based Recipe Commands

Field
7

Name

Type

Description

Parameter 3 type
(optional)

double

Parameter type for optional parameter 3 for the stored

procedure. Acceptable values are as follows:

Parameter 3
(optional)

string

0 text

1 integer

2 float

Value for optional parameter 3 for the stored procedure.

DSA.LoadFeeders
Use the DSA.LoadFeeders recipe command to load multiple feeders, as identified by an optional script list. If
you do not provide a script list name, then the default feeders for the specified DSA will be loaded.
The inputs for this command are described in the following table. For more information on script lists, see
List Commands on page 915.
Field

Name

Type

Description

DSA name

string

Name of the DSA from which you want to load feeders.

In the SynerGEE DSA editor, this is the value entered in
the Description field.

Feeder list
(optional)

string

Optional list of feeders, created using SynerGEEs list

recipe commands. For more information in the list
commands, see List Commands on page 915.
If no feeder list is specified, then the default feeders and
subtrans for the specified model will be loaded. (The
default feeders and subtrans are those where the
Display on Load option has been selected on the
Feeder tab of the Feeder editor, or the Source tab of the
Subtrans editor.)

Lock feeders
(optional)

Boolean

Optional Boolean value specifying whether or not

feeders will be locked after the load process is
complete.

0 No (feeders will not be locked)

1 Yes (feeders will be locked)

If no value is specified, then the feeders will not be

locked.

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

925

DSA.LoadSubBySection
Use the DSA.LoadSubBySection recipe command to load the substation that is associated with a specified
section name in a specified DSA. The inputs for this command are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA from which you want to load a

subsection. In the SynerGEE DSA editor, this is the
value entered in the Description field.

Section ID

string

Name of the section that identifies the substation that

you want to load.

Lock feeders
(optional)

Boolean

Optional Boolean value specifying whether or not

feeders will be locked after the load process is
complete.

0 No (feeders will not be locked)

1 Yes (feeders will be locked)

If no value is specified, then the feeders will not be

locked.

DSA.LoadModelBySub
Use the DSA.LoadModelBySub recipe command to load feeders and subtrans from a specified DSA that are
associated with a specified substation name. The inputs for this command are described in the following
table.
Field

Name

Type

Description

DSA name

string

Name of the DSA from which you want to load a model.

In the SynerGEE DSA editor, this is the value entered in
the Description field.

Subsection ID

string

Name of the substation for which you want to load

feeders and subtrans.

Lock feeders
(optional)

Boolean

Optional Boolean value specifying whether or not

feeders will be locked after the load process is
complete.

0 No (feeders will not be locked)

1 Yes (feeders will be locked)

If no value is specified, then the feeders will not be

locked.

SynerGEE Electric 5.0

User Guide

926

Text-Based Recipe Commands

DSA.LoadWarehouse
Use the DSA.LoadWarehouse recipe command to load equipment data. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA from which you want to load

equipment data. In SynerGEE, this is the value in the
Description field for the DSA.

DSA.ResultsSetSave
Use the DSA.ResultsSetSave recipe command to export a results set to a database. The inputs for this
command are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA to which you want to save the results

set. In the SynerGEE DSA editor, this is the value
entered in the Description field.

Table to Create

string

Name of the database table in the target data source

where the results set will be save.

Results Set File

string

Name of the results set file that contains the data you
want to save to the specified table in the target data
source. Results set files are saved in your Output file
directory after an analysis is run. For this parameter,
specify the name of the results set file only for
example, LFlow_Balanced. Do not specify the path to
the results set file or the file extension for the file (which
is *.BRF).
For information on locating and editing your Output file
directory, see Defining file paths on page 167.

Field to Export
(optional)

string

Optional name of a specific data field that you want to

export to the specified table. If no field name is supplied,
then all fields will be exported to the table.

DSA.SaveFeeders
Use the DSA.SaveFeeders recipe command to save all feeders in memory to the specified DSA. The current
feeder selection does not affect this command.

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

927

The inputs for this command are described in the following table.
Field

Name

Type

Description

DSA name

string

Name of the DSA to which you want to save feeders. In

the SynerGEE DSA editor, this is the value entered in
the Description field.

Keep locked
(optional)

Boolean

Optional Boolean value specifying whether or not

feeders will be locked or kept locked after the save
process is complete.

0 No (feeders will not be locked)

1 Yes (feeders will be locked)

If no value is specified, then the feeders will not be

locked.

DSA.TestConnection
Use the DSA.TestConnection recipe command to test the connection to the data source defined within a
specified DSA. This performs the same task as clicking the Test Connection button on the second page of
the Edit Data Source wizard.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA for which you want to test a database

connection. In the SynerGEE DSA editor, this is the
value entered in the Description field.

DSA.ExportLastReport
Use the DSA.ExportLastReport recipe command to export the most recent report to a database file. This is
equivalent to clicking the Export to database button on the CONTROLS tab in the SynerGEE ribbon bar.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA that you want to export the data to. In
the SynerGEE DSA editor, this is the value entered in
the Description field.

SynerGEE Electric 5.0

User Guide

928

Text-Based Recipe Commands

Field
2

Name

Type

Description

Export type

string

Select one of the following options to specify how the

report data is saved to the database file:

0 Append table. Select this option to append

new data to the end of an existing table in the
database.

1 Empty table. Select this option to add the

new data into an empty table if there is one
available.

2 Replace table. Select this option to replace

an existing table with the new data.

Tag (optional)

string

Optional text string that is saved to the

REPORT_APP_SETTINGS table in the database file.
This text string helps identify the number of the analysis
run in the database.

Detailed chapters

Boolean

Boolean value specifying whether some detailed report

chapters, such as feeder-based distributed and load
reports, will be included or excluded in the exported
report.

0 Exclude

1 Include

If no value is specified, the detailed reports will be

included in the database.
5

Include year
column (optional)

Boolean

Boolean value specifying whether the analysis year will

be included in the data that is exported to the database.

0 Excluded

1 Include

If no value is specified, the analysis year will not be

included in the database.

DSA.ExportLastReport2
Use the DSA.ExportLastReport2 recipe command to export the most recent report to either CSV or HTML
format. This is equivalent to clicking the Export button on the CONTROLS tab in the SynerGEE ribbon bar.
The inputs for this command are described in the following table.
Field
1

User Guide

Name

Type

Description

Export path

string

Full path, file name, and file extension for the file you
want to save.

SynerGEE Electric 5.0

Text-Based Recipe Commands

929

Field

Name

Type

Description

Type

string

Numerical value that represents the type of file that you

want to export. Acceptable values are as follows:

Detailed chapters
(optional)

Boolean

1 CSV

2 HTML

3 No Frames

4 No TOC

Boolean value specifying whether some detailed report

chapters, such as feeder-based distributed and load
reports, will be included or excluded in the exported
report.

0 Exclude

1 Include

If no value is specified, the detailed reports will be

included in the file.

DSA.LoadProtectionDb
Use the DSA.LoadProtectionDb recipe command to load a protection curve library. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

Db path (optional)

string

Full path, file name, and file extension for the protection
database. If you do not specify a value, SynerGEE
searches for the normal SynProtectionDb.mdb file in
your SynerGEE installation folder.

DSA.SaveWarehouse
Use the DSA.SaveWarehouse recipe command to save the current equipment data to a specified data
source. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

DSA name

string

Name of the DSA to which you want to save the

warehouse. In the SynerGEE DSA editor, this is the
value entered in the Description field.

SynerGEE Electric 5.0

User Guide

930

Text-Based Recipe Commands

MODEL MANAGEMENT COMMANDS

Use the Model Management recipe commands to perform various tasks related to your model, such as
selecting feeders, setting the analysis section, and setting the analysis year. Refer to the topics listed below
for more information.

Model.DropAllFeeders on page 930

Model.SetAnalysisSection on page 930

Model.ZoomToSelectedFeeders on page 930

Model.SetAnalysisSectionByFirstBreaker on page 931

Model.SetMeterAmps on page 931

Model.SetSwitchableDeviceStatusUsingSubstring on page 931

Model.SetRegulatorsManualMode on page 932

Model.SelectFeeder on page 932

Model.DeselectAllFeeders on page 932

Model.SetMeterDataType on page 933

Model.Dtran_PlaceWithXY on page 933

Model.AnalysisSection on page 933

Model.AnalysisYear on page 933

Model.DropAllFeeders
Use the Model.DropAllFeeders recipe command to delete all feeders from the current model. This command
does not require any inputs.

Model.SetAnalysisSection
Use the Model.SetAnalysisSection recipe command to set the analysis section for the model in memory. The
inputs for this command are described in the following table.
Field
1

Name

Type

Description

Section for analysis

string

Name of the section that you want to set for analysis.

Model.ZoomToSelectedFeeders
Use the Model.ZoomToSelectedFeeders recipe command to zoom the SynerGEE map display to the
network bounds of the selected feeders. This command does not require any inputs.

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

931

Model.SetAnalysisSectionByFirstBreaker
Use the Model.SetAnalysisSectionByFirstBreaker recipe command to set the analysis section based on the
first breaker that is on a specified feeder. The inputs for this command are described in the following table.
Field

Name

Type

Description

Feeder

string

Name of the feeder for which you want to set the

section for analysis, based on the first breaker in that
feeder.

Model.SetMeterAmps
Use the Model.SetMeterAmps recipe command to set the phase 1, 2, and 3 amps for a specified meter. If the
meter is currently set up to define demands in kVA instead of amps, this command will switch the option to
amps and then set the specified values.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Meter ID

string

Name of the meter where you want to set amp values.

Amps phase 1

double

Amp value for phase 1 on the specified meter.

Amps phase 2

double

Amp value for phase 2 on the specified meter.

Amps phase 3

double

Amp value for phase 3 on the specified meter.

Model.SetSwitchableDeviceStatusUsingSubstring
Use the Model.SetSwitchableDeviceStatusUsingSubstring recipe command to set the open/closed status of
a specified switchable device in the current model in memory. The inputs for this command are described in
the following table.
Field

Name

Type

Description

Device name

string

Name of the device that you want to edit.

Device type

string

Type of device that you want to edit. Acceptable values

are as follows:

SynerGEE Electric 5.0

Breaker

Fuse

Recloser

Sectionalizer

User Guide

932

Text-Based Recipe Commands

Field

Name

Type

Description

Open

Boolean

Boolean value specifying whether the specified device

will be set to Open or Closed.

0 Closed

1 Open

Model.SetRegulatorsManualMode
Use the Model.SetRegulatorsManualMode recipe command to set all regulators in the model in memory to
either manual mode or automatic mode. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Manual mode

Boolean

Boolean value specifying whether all regulators in the

model in memory will be set to manual mode or
automatic mode.

0 Automatic

1 Manual

Model.SelectFeeder
Use the Model.SelectFeeder recipe command to select a feeder in the current model. The inputs for this
command are described in the following table.
Field

Name

Type

Description

Feeder

string

Name of the feeder that you want to select.

Model.DeselectAllFeeders
Use the Model.DeselectAllFeeders recipe command to deselect all feeders in the current model. This
command does not require any inputs.

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

933

Model.SetMeterDataType
Use the Model.SetMeterDataType recipe command to set the data type for all meters to either kw, kvar or
kva, %pf. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Data type

double

Acceptable values are as follows:

0 kW, kvar

1 kva, % pf

Model.Dtran_PlaceWithXY
Use the Model.Dtran_PlaceWithXY recipe command to move distribution transformers within the model
based on their XY coordinates. If the XY coordinates for a distribution transformer are closer to a section
(within 50 feet) that is different than the section the distribution transformer is currently assigned to, then this
recipe command will move the distribution transformer to the closer section.
This command does not require any inputs.

Model.AnalysisSection
Use the Model.AnalysisSection recipe command to set or unset a specified section for analysis. The inputs
for this command are described in the following table.
Field

Name

Type

Description

Section ID

string

Section name that you want to either set or unset for

analysis.

Set for analysis

Boolean

Boolean value specifying whether will be set or unset

for analysis.

0 Section will be unset from analysis

1 Section will be set for analysis

Model.AnalysisYear
Use the Model.AnalysisYear recipe command to set the analysis year for the model. The inputs for this
command are described in the following table.
Field

Name

Type

Description

Year

long

Analysis year that you want to set for the model. Use 0
for the base year, or 1 through 10 for each
subsequent year.

SynerGEE Electric 5.0

User Guide

934

Text-Based Recipe Commands

MULTI-MODEL COMMANDS
Use the MultiModel recipe commands to set up and run a multi-model analysis. With these commands, you
can add and remove data sources to the analysis, set up with applications you want to run (Check
Coordination, Check Data. etc.), and configure which model years you want to analyze.
Refer to the topics listed below for more information.

MultiModel.AddDataSource on page 934

MultiModel.CheckCoordination on page 934

MultiModel.CheckData on page 935

MultiModel.Contingency on page 935

MultiModel.CreateZonesAndProcessEvents on page 936

MultiModel.Fault on page 936

MultiModel.LoadAllocation on page 936

MultiModel.LoadFlow on page 937

MultiModel.Reliability on page 937

MultiModel.RemoveAllDataSources on page 938

MultiModel.Run on page 938

MultiModel.ThrowOver on page 938

MultiModel.Years1 on page 938

MultiModel.Years2 on page 939

MultiModel.AddDataSource
Use the MultiModel.AddDataSource recipe command to add a DSA to the multi-model analysis. This
command performs the same task as selecting a data source to analyze in the Data Sources tab of the MultiModel Analysis editor.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Data source

string

Name of the DSA that you want to add to the multimodel analysis. In the SynerGEE DSA editor, this is the
value entered in the Description field.

MultiModel.CheckCoordination
Use the MultiModel.CheckCoordination recipe command to specify whether the Check Coordination
application will be included in the Multi-Model analysis. This command performs the same task as selecting
or clearing the corresponding check box on the Analysis tab of the Multi-Model Analysis editor.

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

935

The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Run

Boolean

Boolean value specifying whether the Check

Coordination application will be included in the
Multi-Model analysis.

0 No (Check Coordination will be disabled for

the Multi-Model analysis)

1 Yes (Check Coordination will be included

in the Multi-Model analysis)

MultiModel.CheckData
Use the MultiModel.CheckData recipe command to specify whether the Check Data application will be
included in the Multi-Model analysis. This command performs the same task as selecting or clearing the
corresponding check box on the Analysis tab of the Multi-Model Analysis editor.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Run

Boolean

Boolean value specifying whether the Check Data

application will be included in the Multi-Model analysis.

0 No (Check Data will be disabled for the

Multi-Model analysis)

1 Yes (Check Data will be included in the

Multi-Model analysis)

MultiModel.Contingency
Use the MultiModel.Contingency recipe command to specify whether the Contingency application will be
included in the Multi-Model analysis. This command performs the same task as selecting or clearing the
corresponding check box on the Analysis tab of the Multi-Model Analysis editor.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Run

Boolean

Boolean value specifying whether the Contingency

application will be included in the Multi-Model analysis.

SynerGEE Electric 5.0

0 No (Contingency will be disabled for the

Multi-Model analysis)

1 Yes (Contingency will be included in the

Multi-Model analysis)

User Guide

936

Text-Based Recipe Commands

MultiModel.CreateZonesAndProcessEvents
Use the MultiModel.CreateZonesAndProcessEvents recipe command to add a DSA and a data set to the
multi-model analysis. This command is designed for use with running a Reliability analysis through the MultiModel analysis. To use this command, you would also have to use the MultiModel.Reliability command to
enable a Reliability analysis as part of the multi-model analysis, plus the MultiModel.Run command to run the
multi-model analysis.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Data source

string

Name of the DSA that you want to add to the multimodel analysis. In the SynerGEE DSA editor, this is the
value entered in the Description field.

Data set

string

Name of the reliability data set where you want to create

exposure zones.

MultiModel.Fault
Use the MultiModel.Fault recipe command to specify whether the Fault application will be included in the
Multi-Model analysis. This command performs the same task as selecting or clearing the corresponding
check box on the Analysis tab of the Multi-Model Analysis editor.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Run

Boolean

Boolean value specifying whether the Fault application

will be included in the Multi-Model analysis.

0 No (Fault will be disabled for the MultiModel analysis)

1 Yes (Fault will be included in the MultiModel analysis)

MultiModel.LoadAllocation
Use the MultiModel.LoadAllocation recipe command to specify whether the Load Allocation application will be
included in the Multi-Model analysis. This command performs the same task as selecting or clearing the
corresponding check box on the Analysis tab of the Multi-Model Analysis editor.

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

937

The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Run

Boolean

Boolean value specifying whether the Load Allocation

application will be included in the Multi-Model analysis.

0 No (Load Allocation will be disabled for the

Multi-Model analysis)

1 Yes (Load Allocation will be included in the

Multi-Model analysis)

MultiModel.LoadFlow
Use the MultiModel.LoadFlow recipe command to specify whether the Load Flow application will be included
in the Multi-Model analysis. This command performs the same task as selecting or clearing the
corresponding check box on the Analysis tab of the Multi-Model Analysis editor.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Run

Boolean

Boolean value specifying whether the Load Flow

application will be included in the Multi-Model analysis.

0 No (Load Flow will be disabled for the

Multi-Model analysis)

1 Yes (Load Flow will be included in the

Multi-Model analysis)

MultiModel.Reliability
Use the MultiModel.Reliability recipe command to specify whether the Reliability application will be included
in the Multi-Model analysis. This command performs the same task as selecting or clearing the
corresponding check box on the Analysis tab of the Multi-Model Analysis editor.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Run

Boolean

Boolean value specifying whether the Reliability

application will be included in the Multi-Model analysis.

SynerGEE Electric 5.0

0 No (Reliability will be disabled for the MultiModel analysis)

1 Yes (Reliability will be included in the MultiModel analysis)

User Guide

938

Text-Based Recipe Commands

MultiModel.RemoveAllDataSources
Use the MultiModel.RemoveAllDataSources recipe command to remove all DSAs from the Multi-Model
analysis. This command does not require any inputs.
After using this command, you can use the MultiModel.AddDataSource command to add DSAs back into the
analysis. For more information, see MultiModel.AddDataSource on page 934.

MultiModel.Run
Use the MultiModel.Run recipe command to run the Multi-Model analysis. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

Only load selected

substations
(optional)

Boolean

Boolean value specifying whether the Multi-Model

analysis will only analyze the selected substations for
each model, or will analyze all substations for each
model.

0 Analyze all substations

1 Analyze selected substations only

MultiModel.ThrowOver
Use the MultiModel.ThrowOver recipe command to specify whether the Throw-Over application will be
included in the Multi-Model analysis. This command performs the same task as selecting or clearing the
corresponding check box on the Analysis tab of the Multi-Model Analysis editor.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Run

Boolean

Boolean value specifying whether the Throw-Over

application will be included in the Multi-Model analysis.

0 No (Throw-Over will be disabled for the

Multi-Model analysis)

1 Yes (Throw-Over will be included in the

Multi-Model analysis)

MultiModel.Years1
Use the MultiModel.Years1 recipe command to specify whether the models base year and years 1 through 5
will be analyzed by the Multi-Model analysis. This command performs the same task as selecting and
clearing the corresponding Years to analyze check boxes on the Analysis tab of the Multi-Model Analysis
editor.

User Guide

SynerGEE Electric 5.0

Text-Based Recipe Commands

939

The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Base year

Boolean

Boolean value specifying whether the models Base

Year will be analyzed by the Multi-Model analysis.

Year 1

Year 2

Year 3

Year 4

Year 5

Boolean

Boolean

Boolean

Boolean

Boolean

0 No (Base year will not be analyzed)

1 Yes (Base year will be analyzed)

Boolean value specifying whether Year 1 will be

analyzed by the Multi-Model analysis.

0 No (Year 1 will not be analyzed)

1 Yes (Year 1 will be analyzed)

Boolean value specifying whether Year 2 will be

analyzed by the Multi-Model analysis.

0 No (Year 2 will not be analyzed)

1 Yes (Year 2 will be analyzed)

Boolean value specifying whether Year 3 will be

analyzed by the Multi-Model analysis.

0 No (Year 3 will not be analyzed)

1 Yes (Year 3 will be analyzed)

Boolean value specifying whether Year 4 will be

analyzed by the Multi-Model analysis.

0 No (Year 4 will not be analyzed)

1 Yes (Year 4 will be analyzed)

Boolean value specifying whether Year 5 will be

analyzed by the Multi-Model analysis.

0 No (Year 5 will not be analyzed)

1 Yes (Year 5 will be analyzed)

MultiModel.Years2
Use the MultiModel.Years2 recipe command to specify whether years 6 through 10 will be analyzed by the
Multi-Model analysis. This command performs the same task as selecting and clearing the corresponding
Years to analyze check boxes on the Analysis tab of the Multi-Model Analysis editor.

SynerGEE Electric 5.0

User Guide

940

Text-Based Recipe Commands

The inputs for this command are described in the following table.
Field

Name

Type

Description

Year 6

Boolean

Boolean value specifying whether Year 6 will be

analyzed by the Multi-Model analysis.

Year 7

Year 8

Year 9

Year 10

Boolean

Boolean

Boolean

Boolean

0 No (Year 6 will not be analyzed)

1 Yes (Year 6 will be analyzed)

Boolean value specifying whether Year 7 will be

analyzed by the Multi-Model analysis.

0 No (Year 7 will not be analyzed)

1 Yes (Year 7 will be analyzed)

Boolean value specifying whether Year 8 will be

analyzed by the Multi-Model analysis.

0 No (Year 8 will not be analyzed)

1 Yes (Year 8 will be analyzed)

Boolean value specifying whether Year 9 will be

analyzed by the Multi-Model analysis.

0 No (Year 9 will not be analyzed)

1 Yes (Year 9 will be analyzed)

Boolean value specifying whether Year 10 will be

analyzed by the Multi-Model analysis.

0 No (Year 10 will not be analyzed)

1 Yes (Year 10 will be analyzed)

PHASE BALANCING COMMANDS

Use the PhaseBalancing recipe commands to run a Phase Balancing analysis. Refer to the topics listed
below for more information.

PhaseBalancing.Run on page 940

PhaseBalancing.Run
Use the PhaseBalancing.Run recipe command to run a Load Allocation analysis. The inputs for this
command are described in the following table.
Field
1

User Guide

Name

Type

Description

Feeder/subtran

string

Name of the feeder or subtran that you want to analyze.

SynerGEE Electric 5.0

Text-Based Recipe Commands

Field
2

941

Name

Type

Description

Rephase past
analysis section

Boolean

Boolean value specifying whether the phase balancing

improvement will only be performed for locations that
are downstream from the section that is currently
selected for analysis.

0 No (rephase all sections on the specified

feeder or subtran)

1 Yes (rephase only for locations that are

downstream from the section that is selected
for analysis))

You can set a section for analysis manually before

starting your script, or you can also use one of several
recipe commands to set the section to analyze. For
more information, see Model.SetAnalysisSection on
page 930, Model.SetAnalysisSectionByFirstBreaker
on page 931, or Model.AnalysisSection on page 933.

QA COMMANDS
Use the QA recipe commands to generate an outage script file for your model. Refer to the topics listed below
for more information.

SynQA.GenRemDataFile on page 941

SynQA.GenRemDataFile
Use the SynQA.GenRemDataFile recipe command to generate an outage script file. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

Full path

string

Full path, file name, and file extension for the outage
script that is generated by this command.

RELIABILITY COMMANDS
Use the Reliability recipe commands to run the Reliability Event Management wizard with the Create model
exposure zones and process reports option. The Reliability Event Management wizard is described in more
detail in Reliability Event Management Wizard on page 697.
Refer to the topics listed below for more information.

Reliability.CreateZonesAndProcessEvents on page 942

SynerGEE Electric 5.0

User Guide

942

Text-Based Recipe Commands

Reliability.CreateDataSet on page 942

Reliability.DeleteDataSet on page 943

Reliability.CreateZonesAndProcessEvents
Use the Reliability.CreateZonesAndProcessEvents recipe command to run a specified data set through the
Reliability Event Management wizard. This recipe command performs the same task that you would perform
manually by selecting the Create model exposure zones and process events option in the Reliability Event
Management wizard.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Data source

string

Name of the DSA that you want to run through the

Reliability Event Management wizard. In the SynerGEE
DSA editor, this is the value entered in the Description
field.

Data set

string

Name of the reliability data set where you want to create

exposure zones.

Show results

Boolean

Boolean value specifying whether the Errors message

box will be displayed after the wizard is complete.

0 No (Errors will not display)

1 Yes (Errors will display)

Reliability.CreateDataSet
Use the Reliability.CreateDataSet recipe command to create a reliability data set on a specified data source.
This recipe command performs the same task that you would perform manually by selecting the Create/
Destroy reliability data sets option in the Reliability Event Management wizard.
The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

Data source

string

Name of the DSA where you want to create a reliability

data set. In the SynerGEE DSA editor, this is the value
entered in the Description field.

Data set

string

Name of the data set that you want to create.

Description
(optional)

string

Optional description for the new data set.

SynerGEE Electric 5.0

Text-Based Recipe Commands

943

Reliability.DeleteDataSet
Use the Reliability.DeleteDataSet recipe command to delete a reliability data set from a specified data
source. This recipe command performs the same task that you would perform manually by selecting the
Create/Destroy reliability data sets option in the Reliability Event Management wizard.
The inputs for this command are described in the following table.
Field

Name

Type

Description

Data source

string

Name of the DSA where you want to delete a reliability

data set. In the SynerGEE DSA editor, this is the value
entered in the Description field.

Data set

string

Name of the data set that you want to delete.

SETTINGS COMMANDS
Use the Settings recipe commands to interact with SynerGEE application settings files. Refer to the topics
listed below for more information.

Settings.LoadXML on page 943

Settings.LoadXML
Use the Settings.LoadXML recipe command to load an applications settings group. You specify the settings
group that you want to load by providing the full path and file name for the XML file where the Settings group
is saved. Settings files are described in more detail in Settings Groups and Settings Files on page 189.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

Full Path to
Settings File

string

Full path and file name of the application Settings file

that you want to load. Settings files are saved by default
as XML files in your Settings file directory.
For information on locating and editing your Settings file
directory, see Defining file paths on page 167.

SQL COMMANDS
Use the SQL recipe commands to interact with the SynerGEE SQL Dashboard. Refer to the topics listed
below for more information.
Refer to the topics listed below for more information.

SQL.RunFromFile on page 944

SynerGEE Electric 5.0

User Guide

944

Text-Based Recipe Commands

SQL.RunFromFile
Use the SQL.RunFromFile recipe command to open the SQL Dashboard and run a specific recipe. The
inputs for this command are described in the following table.
Field

Name

Type

Description

Group

string

Group name where the recipe is saved.

Name

string

Name of the recipe you want to run.

Target DSA

string

Name of the DSA that you want to query. In SynerGEE,

this is the value in the Description field for the DSA.

Data Type

double

Numerical value that represents the data source type.

Acceptable values are as follows:

0 CMM

1 Equipment

2 Events

3 Mining

4 Model

5 Pi

6 Subset

7 Results

8 Data Mart

9 Historian

Data Set (optional)

string

Optional data set from either an Oracle or SQL server, if

applicable.

Export Type
(optional)

Boolean

Boolean value specifying whether you want to export

your SQL results to a CSV file or Excel file.

Export Path
(optional)

string

0 Save as CSV

1 Open in Excel

Full path, file name, and file extension to where the

optional CSV file is saved.

THROW-OVER COMMANDS
Use the ThrowOver recipe commands to run a Throw-Over analysis. Refer to the topics listed below for more
information.

User Guide

ThrowOver.Run on page 945

SynerGEE Electric 5.0

Text-Based Recipe Commands

945

ThrowOver.Run
Use the ThrowOver.Run recipe command to run a Throw-Over analysis. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

Show Report

Boolean

Boolean value specifying whether you want to generate

the Throw-Over Analysis report after the analysis is
complete.

0 No (do not generate the report)

1 Yes (generate the report)

If no value is specified, then the report will be

generated.

WAREHOUSE COMMANDS
Use the Warehouse recipe commands to perform tasks related to the SynerGEE equipment warehouse.
Refer to the topics listed below for more information.

Warehouse.Drop on page 945

For additional warehouse commands, see Model I/O Commands on page 918.

Warehouse.Drop
Use the Warehouse.Drop recipe command to remove the current equipment warehouse from memory. This
command is useful to prepare for loading a new DSA into SynerGEE.
This command does not require any inputs.

SynerGEE Electric 5.0

User Guide

946

User Guide

Text-Based Recipe Commands

SynerGEE Electric 5.0

APPENDIX

C
Model Forge
Commands
Refer to the topics listed below for information on the Model Forge commands that are available for use in
SynerGEE.

Areas of Interest on page 948

Breakers on page 953

Capacitors on page 966

CMM on page 981

Conductors on page 1025

Distribution Transformers on page 987

Facilities on page 991

Feeders on page 993

Fuses on page 1000

Generators on page 1002

Large Customers on page 1004

Loads on page 1016

Meters on page 1027

Model Forge functions on page 1075

Nodes on page 1035

Projects on page 1036

Reclosers on page 1038

Regulators on page 1070

REM on page 1082

Sectionalizers on page 1083

Sections on page 1086

Sources on page 1096

SynerGEE Electric 5.0

User Guide

948

Model Forge Commands

Switches on page 1097

Substations on page 1100

Transformers on page 1104

AREAS OF INTEREST
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit areas of interest.

AOI_101 Creating/editing an area of interest on page 948

AOI_102 Editing the X,Y coordinates for an area of interest on page 949

AOI_103 Creating/editing an area of interest on page 950

AOI_104 Editing the X,Y coordinates for an area of interest on page 951

AOI_105 Creating/editing an area of interest on page 952

AOI_106 Editing the X,Y coordinates for an area of interest on page 953

AOI_101 Creating/editing an area of interest

Use the AOI_101 Model Forge command to create a new area of interest on a specified section, or to edit
basic settings for an existing area of interest on a specified section. The inputs for this command are
described in the following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section where you want to add a new

area of interest or edit an existing area of interest.

If an area of interest already exists on the

section, then the area of interest will be
updated with the specified settings. If
multiple areas of interest exist on the
specified section, then only the first area
of interest (as listed in the model explorer)
will be edited.

If an area of interest does not already

exist on the section, then a new area of
interest will be created and assigned the
specified settings. Note that you must use
the AOI_102 Model Forge command at
the same time as the AOI_101 command,
to assign X,Y coordinates to the area of
interest. See AOI_102 Editing the X,Y
coordinates for an area of interest on
page 949 for more information.

SynerGEE Electric 5.0

Model Forge Commands

Field

949

Name

Type

Description

SynDescription

string

Description to be assigned to the area of interest.

SynHatchPatterNum

long

Numerical value, from 0 to 5, corresponding to the

six fill patterns available on the Area tab of the Area
of Interest editor.

SynRGB

string

Color to be applied to the area of interest, specified

as RGB values. Use a comma to separate each
numerical value, which can have a value of 0 to
255. For example, the following RGB value will set
the area of interest to yellow:
255,255,0

SynType

string

Area of interest type. Specify one of the following

values:

GRA Growth area

SP Speculative load

AOI Area of interest

This field corresponds to the Type option on the

Area tab of the Area of Interest editor.
6

SynAOIIsOn

Boolean

Boolean value indicating whether the area of

interest will be set to On or Off.

0 Off

1 On

This field corresponds to the Turn Off check box

on the Area tab of the Area of Interest editor.

AOI_102 Editing the X,Y coordinates for an area of

interest
Use the AOI_102 Model Forge command to edit the X,Y coordinates for an area of interest that is identified
by its associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the area of interest

you want to edit. If the specified section does not exist,
then no edits will be made. If multiple areas of interest
exist on the specified section, then only the first area of
interest (as listed in the model explorer) will be edited.

SynXCoord

double

X coordinate location for the area of interest.

SynerGEE Electric 5.0

User Guide

950

Model Forge Commands

Field
3

Name

Type

Description

SynYCoord

double

Y coordinate location for the area of interest.

AOI_103 Creating/editing an area of interest

Use the AOI_103 Model Forge command to create a new area of interest on a section that is identified by a
DTran ID, or to edit basic settings for an existing area of interest on a section identified by a DTran ID. The
inputs for this command are described in the following table.
Field

Name

Type

Description

SynDtranID

string

Name of a DTran ID, which identifies the section

where you want to create a new area of interest or
edit an existing area of interest. If multiple DTran
IDs exist with the same name, then only the first
associated section (as listed in the model explorer)
will be edited. If multiple areas of interest exist on
the section associated with the specified DTran ID,
then only the first area of interest (as listed in the
model explorer) will be edited.

SynDescription

string

Description to be assigned to the area of interest.

SynHatchPatterNum

long

Numerical value, from 0 to 5, corresponding to the

six fill patterns available on the Area tab of the Area
of Interest editor.

SynRGB

string

Color to be applied to the area of interest, specified

as RGB values. Use a comma to separate each
numerical value, which can have a value of 0 to
255. For example, the following RGB value will set
the area of interest to yellow:
255,255,0

SynType

string

Area of interest type. Specify one of the following

values:

GRA Growth area

SP Speculative load

AOI Area of interest

This field corresponds to the Type option on the

Area tab of the Area of Interest editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

Field
6

951

Name

Type

Description

SynAOIIsOn

Boolean

Boolean value indicating whether the area of

interest will be set to On or Off.

0 Off

1 On

This field corresponds to the Turn Off check box

on the Area tab of the Area of Interest editor.

AOI_104 Editing the X,Y coordinates for an area of

interest
Use the AOI_104 Model Forge command to edit the X,Y coordinates for an area of interest. The area of
interest that will be edited by this command is identified by the section that is associated with a specified
DTran ID. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynDtranID

string

Name of a DTran ID, which identifies the section where

you want to edit the area of interest. If the specified
DTran ID does not exist, then no edits will be made. If
multiple DTran IDs exist with the same name, then only
the first associated section (as listed in the model
explorer) will be edited. If multiple areas of interest exist
on the section associated with the specified DTran ID,
then only the first area of interest (as listed in the model
explorer) will be edited.

SynXCoord

double

X coordinate location for the area of interest.

SynYCoord

double

Y coordinate location for the area of interest.

SynerGEE Electric 5.0

User Guide

952

Model Forge Commands

AOI_105 Creating/editing an area of interest

Use the AOI_105 Model Forge command to create a new area of interest or edit an existing area of interest
on a section that is identified by the AMS link of a large customer that is also on the same section. The inputs
for this command are described in the following table.
Field
1

Name

Type

Description

SynLCAMSLink

string

AMS link that identifies the large customer on the

section that you want to edit. The AMS link is
specified on the Large Cust tab of the Large
Customer editor.
If a large customer does not exist with the specified
AMS link name, then no edits will be made. If
multiple large customers exist with the same AMS
link name, then only one of those large customers
will be updated.

SynDescription

string

Description to be assigned to the area of interest.

SynHatchPatterNum

long

Numerical value, from 0 to 5, corresponding to the

six fill patterns available on the Area tab of the Area
of Interest editor.

SynRGB

string

Color to be applied to the area of interest, specified

as RGB values. Use a comma to separate each
numerical value, which can have a value of 0 to
255. For example, the following RGB value will set
the area of interest to yellow:
255,255,0

SynType

string

Area of interest type. Specify one of the following

values:

GRA Growth area

SP Speculative load

AOI Area of interest

This field corresponds to the Type option on the

Area tab of the Area of Interest editor.
6

SynAOIIsOn

Boolean

Boolean value indicating whether the area of

interest will be set to On or Off.

0 Off

1 On

This field corresponds to the Turn Off check box

on the Area tab of the Area of Interest editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

953

AOI_106 Editing the X,Y coordinates for an area of

interest
Use the AOI_106 Model Forge command to edit the X,Y coordinates for an area of interest that is identified
by the AMS link of a large customer that is also on the same section. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

SynLCAMSLink

string

AMS link that identifies the large customer on the

section that you want to edit. The AMS link is specified
on the Large Cust tab of the Large Customer editor.
If a large customer does not exist with the specified
AMS link name, then no edits will be made. If multiple
large customers exist with the same AMS link name,
then only one of those large customers will be updated.

SynXCoord

double

X coordinate location for the area of interest.

SynYCoord

double

Y coordinate location for the area of interest.

BREAKERS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit breakers.

BKR_101 Editing a breaker on page 954

BKR_102 Creating/editing a breaker on page 954

BKR_103 Editing the breaker rating and interrupt rating for a breaker on page 955

BKR_104 Editing the mechanical response type for a breaker on page 955

BKR_105 Adding/editing a relay on a breaker on page 956

BKR_106 Activating a breaker relay stage on page 957

BKR_107 Editing the operation type, curve family, and instantaneous curve for a breaker relay
stage on page 957

BKR_108 Editing the pickup type for a breaker relay stage on page 958

BKR_109 Editing primary and secondary amp ratings for a breaker relay stage on page 959

BKR_110 Editing the CT turns ratio for a breaker relay stage on page 959

BKR_111 Editing the tap and time dial value for a breaker relay stage on page 960

BKR_112 Editing multipliers and adders for a breaker relay stage on page 961

BKR_113 Specifying the location of a breaker on page 962

BKR_114 Editing the reclosing status for a breaker relay stage on page 962

SynerGEE Electric 5.0

User Guide

954

Model Forge Commands

BKR_115 Editing the mechanical response type for a breaker on page 963

BKR_116 Editing the breaker rating and interrupt rating for a breaker on page 964

BKR_117 Editing the note text for a breaker on page 964

BKR_118 Enabling/disabling a breaker relay on page 965

BKR_119 Editing the connection phase for a breaker on page 965

BKR_120 Editing the primary amps for a breaker relay stage on page 966

BKR_101 Editing a breaker

The BKR_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Breakers on page 953 for a complete list of breaker Model Forge commands.

BKR_102 Creating/editing a breaker

Use the BKR_102 Model Forge command to create a breaker on a specified section, and also to edit the
breaker name and set the Open/Closed status for an existing breaker on a specified section. If you are
creating a new breaker, the breaker will be created on the base year of the model and applied to all model
years. In addition, if the model is currently set to display any year other than the base year, it will be updated
first to display the base year before adding the new breaker.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a new

breaker or edit an existing breaker.

If a breaker already exists on the section, then

the breaker will be updated with the specified
settings.

If a breaker does not already exist on the

section, then a new breaker will be created
and assigned the specified settings.

SynName

string

Name that will be applied to the breaker on the

designated section.

SynStatus

Boolean

Boolean value indicating whether the breaker status will

be set to Open or Closed.

0 Closed

1 Open

This field corresponds to the Status option on the

Breaker tab of the Breaker editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

955

BKR_103 Editing the breaker rating and interrupt

rating for a breaker
Use the BKR_103 Model Forge command to edit the breaker rating and interrupt rating for a breaker that is
identified by its associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the breaker you want

to edit. If a breaker does not exist on the specified
section, then no edits will be made.

SynRating

double

Breaker rating for the breaker. This is equivalent to

setting the Breaker Rating option on the Breaker tab of
the Breaker editor.

SynInterrupt

double

Interrupt rating for the breaker. This is equivalent to

setting the Interrupt Rating option on the Breaker tab
of the Breaker editor.

BKR_104 Editing the mechanical response type for a

breaker
Use the BKR_104 Model Forge command to edit the mechanical response type for a breaker that is identified
by its associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the breaker you

want to edit. If a breaker does not exist on the
specified section, then no edits will be made.

SynMechResponse

string

Mechanical response type for the breaker. You

must specify an exact match to one of the available
options on the Breaker tab of the Breaker editor.
Otherwise, the mechanical response type will be
set to Unknown.

SynerGEE Electric 5.0

User Guide

956

Model Forge Commands

BKR_105 Adding/editing a relay on a breaker

Use the BKR_105 Model Forge command to create a new relay or edit an existing relay for a breaker on a
section that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

User Guide

SynDescription

string

Description for the relay.

If a relay already exists with the specified

description, then that relay will be updated with
the new description and the other parameters
specified in this Model Forge command.

If a relay with the description does not exist,

then a new relay will be created with the
specified description and other parameters
specified in this Model Forge command.

SynType

string

Relay type. Available choices are Phase, Ground, and

HIER.

SynManufacturer

string

Manufacturer name for the relay.

SynModel

string

Model name for the relay.

SynGroup

string

Group number for the relay. Available choices are 1, 2,

3, and 4.

SynerGEE Electric 5.0

Model Forge Commands

957

BKR_106 Activating a breaker relay stage

Use the BKR_106 Model Forge command to set a specified relay stage for a specified breaker relay as active
or inactive. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to

edit. The AMS link is specified on the Breaker tab
of the Breaker editor.
If a breaker does not exist with the specified AMS
link name, then no edits will be made. If multiple
breakers exist with the same AMS link name, then
only one of those breakers will be updated.

SynDescription

string

Description that identifies the relay you want to edit.

If a relay with the specified description does not
exist, then no edits will be made.

SynStage

long

Relay stage number that you want to edit. Specify a

value of 1, 2, or 3.

SynIsActive

Boolean

Boolean value indicating whether the specified

relay stage will be Active or Inactive.

0 Inactive

1 Active

This field corresponds to the appropriate Stage

number check box on the Relays tab of the
Breaker editor.

BKR_107 Editing the operation type, curve family, and

instantaneous curve for a breaker relay stage
Use the BKR_107 Model Forge command to edit the operation type, curve family, and instantaneous curve
for a specified relay stage for a specified breaker relay. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to

edit. The AMS link is specified on the Breaker tab
of the Breaker editor.
If a breaker does not exist with the specified AMS
link name, then no edits will be made. If multiple
breakers exist with the same AMS link name, then
only one of those breakers will be updated.

SynerGEE Electric 5.0

User Guide

958

Model Forge Commands

Field

Name

Type

Description

SynDescription

string

Description that identifies the relay you want to edit.

If a relay with the specified description does not
exist, then no edits will be made.

SynStage

long

Relay stage number that you want to edit. Specify a

value of 1, 2, or 3.

SynOperationType

string

Operation type for the specified relay stage,

specified as a two-letter abbreviation. Specify one
of the following values:

IT Inv Time

IN Inst

IC Inst Curve

DT Dist Time

This field corresponds to the Operation option on

the Relays tab of the Breaker editor.
5

SynCurveFamily

string

Curve family for the specified relay stage.

SynInstCurve

string

Instantaneous curve for the specified relay stage.

BKR_108 Editing the pickup type for a breaker relay

stage
Use the BKR_108 Model Forge command to edit the pickup type for a specified relay stage for a specified
breaker relay. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

User Guide

SynDescription

string

Description that identifies the relay you want to edit. If a

relay with the specified description does not exist, then
no edits will be made.

SynStage

long

Relay stage number that you want to edit. Specify a

value of 1, 2, or 3.

SynPickupType

string

Pickup type for the specified relay stage.

SynerGEE Electric 5.0

Model Forge Commands

959

BKR_109 Editing primary and secondary amp ratings

for a breaker relay stage
Use the BKR_109 Model Forge command to edit the primary and secondary amp ratings for a specified relay
stage for a specified breaker relay. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

SynDescription

string

Description that identifies the relay you want to edit. If a

relay with the specified description does not exist, then
no edits will be made.

SynStage

long

Relay stage number that you want to edit. Specify a

value of 1, 2, or 3.

SynPriCTAmp

double

Primary amp rating for the specified relay stage. This is

equivalent to setting the first CT value on the Relays
tab of the Breaker editor.

SynSecCTAmp

double

Secondary amp rating for the specified relay stage. This

is equivalent to setting the second CT value on the
Relays tab of the Breaker editor.

BKR_110 Editing the CT turns ratio for a breaker relay

stage
Use the BKR_110 Model Forge command to edit the CT turns ratio for a specified relay stage for a specified
breaker relay. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

SynerGEE Electric 5.0

User Guide

960

Model Forge Commands

Field

Name

Type

Description

SynDescription

string

Description that identifies the relay you want to edit. If a

relay with the specified description does not exist, then
no edits will be made.

SynStage

long

Relay stage number that you want to edit. Specify a

value of 1, 2, or 3.

SynCTRatio

double

CT turns ratio for the relay stage. This is equivalent to

setting the I(n) value on the Relays tab of the Breaker
editor.

BKR_111 Editing the tap and time dial value for a

breaker relay stage
Use the BKR_111 Model Forge command to edit the tap value and also the time dial value for a specified
relay stage for a specified breaker relay. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

User Guide

SynDescription

string

Description that identifies the relay you want to edit. If a

relay with the specified description does not exist, then
no edits will be made.

SynStage

long

Relay stage number that you want to edit. Specify a

value of 1, 2, or 3.

SynTap

double

Tap value for the relay stage. This is equivalent to

setting the Tap value on the Relays tab of the Breaker
editor.

SynTimeDial

double

Time dial value for the relay stage. This is equivalent to

setting the Time Dial value on the Relays tab of the
Breaker editor.

SynerGEE Electric 5.0

Model Forge Commands

961

BKR_112 Editing multipliers and adders for a breaker

relay stage
Use the BKR_112 Model Forge command to edit multiplier and adder values for a specified relay stage for a
specified breaker relay. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

SynDescription

string

Description that identifies the relay you want to edit. If a

relay with the specified description does not exist, then
no edits will be made.

SynStage

long

Relay stage number that you want to edit. Specify a

value of 1, 2, or 3.

SynTimeMultiplier

double

Time multiplier value for the relay stage. This is

equivalent to setting the first Time/Amp Mult value on
the Relays tab of the Breaker editor.

SynAmpMultiplier

double

Amp multiplier value for the relay stage. This is

equivalent to setting the second Time/Amp Mult value
on the Relays tab of the Breaker editor.

SynTimeAdder

double

Time adder value for the relay stage. This is equivalent

to setting the first Time/Amp Add value on the Relays
tab of the Breaker editor.

SynAmpAdder

double

Amp adder value for the relay stage. This is equivalent

to setting the second Time/Amp Add value on the
Relays tab of the Breaker editor.

SynMinResponse

double

Minimum response time value for the relay stage. This

is equivalent to setting the Min Resp Time value on
the Relays tab of the Breaker editor.

SynerGEE Electric 5.0

User Guide

962

Model Forge Commands

BKR_113 Specifying the location of a breaker

Use the BKR_113 Model Forge command to specify whether a breaker is located near the from-node or the
to-node of a specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SectionID

string

Name of the section that contains the breaker you want

to edit. If a breaker does not exist on the section, then
no edits will be made.

SynFromNode

Boolean

Boolean value indicating whether the breaker will be

located near the from-node or the to-node of the
section.

0 To-node end

1 From-node end

This will perform the same task as using SynerGEEs

move device feature to position the breaker at either
end of the section. Only one breaker can exist on a
section.

BKR_114 Editing the reclosing status for a breaker

relay stage
Use the BKR_114 Model Forge command to edit the reclosing status for a specified relay stage for a
specified breaker relay. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

User Guide

SynDescription

string

Description that identifies the relay you want to edit. If a

relay with the specified description does not exist, then
no edits will be made.

SynStage

long

Relay stage number that you want to edit. Specify a

value of 1, 2, or 3.

SynerGEE Electric 5.0

Model Forge Commands

Field
4

963

Name

Type

Description

SynIsReclosing

Boolean

Boolean value indicating whether the breaker relay

stage will be reclosing or not reclosing.

0 Not reclosing

1 Reclosing

This field corresponds to the Operation check box on

the Relays tab of the Breaker editor.

BKR_115 Editing the mechanical response type for a

breaker
Use the BKR_115 Model Forge command to edit the mechanical response type for a breaker that is identified
by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to

edit. The AMS link is specified on the Breaker tab
of the Breaker editor.
If a breaker does not exist with the specified AMS
link name, then no edits will be made. If multiple
breakers exist with the same AMS link name, then
only one of those breakers will be updated.

SynMechResponse

SynerGEE Electric 5.0

string

Mechanical response type for the breaker. You

must specify an exact match to one of the available
options on the Breaker tab of the Breaker editor.
Otherwise, the mechanical response type will be
set to Unknown.

User Guide

964

Model Forge Commands

BKR_116 Editing the breaker rating and interrupt

rating for a breaker
Use the BKR_116 Model Forge command to set the breaker rating and interrupt rating for a breaker that is
identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

SynRating

double

Breaker rating for the breaker. This is equivalent to

setting the Breaker Rating option on the Breaker tab of
the Breaker editor.

SynInterrupt

double

Interrupt rating for the breaker. This is equivalent to

setting the Interrupt Rating option on the Breaker tab
of the Breaker editor.

BKR_117 Editing the note text for a breaker

Use the BKR_117 Model Forge command to edit the note text for a breaker that is identified by an AMS link.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

User Guide

SynNote

string

Text to be assigned to the Note field for the breaker.

SynerGEE Electric 5.0

Model Forge Commands

965

BKR_118 Enabling/disabling a breaker relay

Use the BKR_118 Model Forge command to enable or disable a specified relay for a specified breaker relay.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to

edit. The AMS link is specified on the Breaker tab
of the Breaker editor.
If a breaker does not exist with the specified AMS
link name, then no edits will be made. If multiple
breakers exist with the same AMS link name, then
only one of those breakers will be updated.

SynDescription

string

Description that identifies the relay you want to edit.

If a relay with the specified description does not
exist, then no edits will be made.

SynIsRelayEnabled

Boolean

Boolean value indicating whether the breaker relay

will be enabled or disabled.

0 Disabled

1 Enabled

This field corresponds to the Enabled check box

for the respective relay on the Relay tab of the
Breaker editor.

BKR_119 Editing the connection phase for a breaker

Use the BKR_119 Model Forge command to edit the connection phase for a breaker that is identified by its
associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the breaker you want

to edit. If a breaker does not exist on the specified
section, then no edits will be made.

SynPhasing

string

Connection phase that will be applied to the breaker.

Specify this value as a text string that includes the
characters A, B, and C. Acceptable values include A,
B, C, AB, BC, AC, and ABC.

SynerGEE Electric 5.0

User Guide

966

Model Forge Commands

BKR_120 Editing the primary amps for a breaker relay

stage
Use the BKR_120 Model Forge command to edit the primary amps for a specified relay stage for a specified
breaker relay. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which breaker you want to edit.

The AMS link is specified on the Breaker tab of the
Breaker editor.
If a breaker does not exist with the specified AMS link
name, then no edits will be made. If multiple breakers
exist with the same AMS link name, then only one of
those breakers will be updated.

SynDescription

string

Description that identifies the relay you want to edit. If a

relay with the specified description does not exist, then
no edits will be made.

SynStage

long

Relay stage number that you want to edit. Specify a

value of 1, 2, or 3.

SynPrimaryAmps

double

Primary amp value for the specified relay stage.

CAPACITORS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit capacitors.

CAP_101 Editing a capacitor on page 967

CAP_102 Editing a capacitor on page 967

CAP_103 Creating/editing a capacitor on page 967

CAP_104 Editing the fixed kvar, operating status, and operating type for a capacitor on page 968

CAP_105 Editing the operating type and metering phase for a capacitor on page 969

CAP_106 Editing voltage override settings for a capacitor on page 970

CAP_107 Editing the PT ratio and CT rating for a capacitor on page 971

CAP_108 Editing Module 1 settings for a capacitor on page 971

CAP_109 Editing the control type for a capacitor on page 972

CAP_110 Editing the Module 1 kvar per phase value for a capacitor on page 973

CAP_111 Editing the Module 1 close value for a capacitor on page 973

CAP_112 Editing the Module 1 trip value for a capacitor on page 974

User Guide

SynerGEE Electric 5.0

Model Forge Commands

967

CAP_113 Editing the voltage rating for a capacitor on page 974

CAP_114 Editing the metering phase for a capacitor on page 975

CAP_115 Editing the operating status and metering phase for a capacitor on page 975

CAP_116 Editing the PT ratio and CT rating for a capacitor on page 976

CAP_117 Editing Module 1 settings for a capacitor on page 976

CAP_118 Editing the control type for a capacitor on page 977

CAP_119 Setting the energize year and retire year for a capacitor on page 978

CAP_120 Specifying whether a capacitor will operate on weekends on page 978

CAP_121 Editing the Module 2 and Module 3 kvar per phase value for a capacitor on page 979

CAP_122 Editing the Module 2 close and trip values for a capacitor on page 979

CAP_123 Editing the Module 3 close and trip values for a capacitor on page 980

CAP_101 Editing a capacitor

The CAP_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Capacitors on page 966 for a complete list of capacitor Model Forge commands.

CAP_102 Editing a capacitor

The CAP_102 Model Forge command has been superseded by other, more recent Model Forge commands.
See Capacitors on page 966 for a complete list of capacitor Model Forge commands.

CAP_103 Creating/editing a capacitor

Use the CAP_103 Model Forge command to create a capacitor on a specified section, and also to edit basic
settings for an existing capacitor on a specified section. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a new

capacitor or edit an existing capacitor.

SynName

SynerGEE Electric 5.0

string

If a capacitor already exists on the section,

then the capacitor will be updated with the
specified settings.

If a capacitor does not already exist on the

section, then a new capacitor will be created
and assigned the specified settings.

Name that will be applied to the capacitor on the

designated section.

User Guide

968

Model Forge Commands

Field
3

Name

Type

Description

SynPhase

string

Active switch phases for the capacitor. This is

equivalent to selecting the Active Switch Phase check
boxes on the Settings tab of the Capacitor editor.
Specify this value as a text string that includes the
characters A, B, and C. Acceptable values include A,
B, C, AB, BC, AC, and ABC.

SynConnection

string

Connection type for the capacitor. This is equivalent to

selecting the Connection option on the Capacitor tab
of the Capacitor editor.
Specify one of the following values:

Y Wye

YG Wye-Gnd

D Delta

CAP_104 Editing the fixed kvar, operating status, and

operating type for a capacitor
Use the CAP_104 Model Forge command to edit the fixed kvar, operating status, and operating type for a
capacitor that is identified by its associated section name. The inputs for this command are described in the
following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the capacitor you

want to edit. If a capacitor does not exist on the
specified section, then no edits will be made.

SynFixedKvar

double

Fixed kvar value for the capacitor. This is equivalent to

setting the Fixed kvar values on the Capacitor tab of
the Capacitor editor.
The value you specify here will be distributed equally
between the active switch phases, which are specified
on the Settings tab of the Capacitor editor.

SynStatus

Boolean

Boolean value indicating whether the capacitor status

will be set to On or Off.

0 Off

1 On

This field corresponds to the Turn Off check box on

the Capacitor tab of the Capacitor editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

Field
4

969

Name

Type

Description

SynManualOp

Boolean

Boolean value indicating whether the capacitor

operation is Automatic or Manual.

0 Automatic

1 Manual

This field corresponds to the Operation option on the

Capacitor tab of the Capacitor editor.

CAP_105 Editing the operating type and metering

phase for a capacitor
Use the CAP_105 Model Forge command to edit the operating type and metering phase for a capacitor that
is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to

edit. The AMS link is specified on the Settings tab
of the Capacitor editor.
If a capacitor does not exist with the specified AMS
link name, then no edits will be made. If multiple
capacitors exist with the same AMS link name, then
only one of those capacitors will be updated.

SynIsOn

Boolean

Boolean value indicating whether the capacitor will

be turned On or Off.

0 Off

1 On

This field corresponds to the Turn Off check box

on the Capacitor tab of the Capacitor editor.
3

SynMeteringPhase

string

Text value indicating whether the metering phase

for the capacitor will be set to Phase A, B, or C.
Specify one of the following values:

A Phase A

B Phase B

C Phase C

This field corresponds to the Metering Phase

option on the Settings tab of the Capacitor editor.

SynerGEE Electric 5.0

User Guide

970

Model Forge Commands

CAP_106 Editing voltage override settings for a

capacitor
Use the CAP_106 Model Forge command to turn the voltage override option On or Off and also set the
override setting and bandwidth range for a capacitor that is identified by an AMS link. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to

edit. The AMS link is specified on the Settings tab
of the Capacitor editor.
If a capacitor does not exist with the specified AMS
link name, then no edits will be made. If multiple
capacitors exist with the same AMS link name, then
only one of those capacitors will be updated.

SynVoltOverrideActive

Boolean

Boolean value indicating whether the voltage

override option for the capacitor will be turned On
or Off.

0 Off

1 On

This field corresponds to the Voltage Override

check box on the Settings tab of the Capacitor
editor.

User Guide

SynVoltOverrideSet

double

Specifies the upper limit of acceptable voltage for

the capacitor. This is equivalent to setting the
Settings option on the Settings tab of the
Capacitor editor.

SynVoltOverrideBW

double

Specifies the bandwidth range where the voltage

control begins overriding the selected control type.
This is equivalent to setting the BW option on the
Settings tab of the Capacitor editor.

SynerGEE Electric 5.0

Model Forge Commands

971

CAP_107 Editing the PT ratio and CT rating for a

capacitor
Use the CAP_107 Model Forge command to set the PT ratio and CT rating for a capacitor that is identified by
an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to edit.

The AMS link is specified on the Settings tab of the
Capacitor editor.
If a capacitor does not exist with the specified AMS link
name, then no edits will be made. If multiple capacitors
exist with the same AMS link name, then only one of
those capacitors will be updated.

SynPTRatio

double

PT ratio value for the capacitor. This is equivalent to

editing the PT Ratio text box on the Settings tab of the
Capacitor editor.

SynCTRating

double

CT rating value for the capacitor. This is equivalent to

editing the CT Rating text box on the Settings tab of
the Capacitor editor.

CAP_108 Editing Module 1 settings for a capacitor

Use the CAP_108 Model Forge command to edit the Module 1 values for Kvar/Ph, Close, and Trip for a
capacitor that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to

edit. The AMS link is specified on the Settings tab
of the Capacitor editor.
If a capacitor does not exist with the specified AMS
link name, then no edits will be made. If multiple
capacitors exist with the same AMS link name, then
only one of those capacitors will be updated.

SynM1KvarPerPhase

double

Kvar/Ph value for Module 1 on the capacitor. This

field corresponds to the Kvar/Ph value for Mod. 1
on the Capacitor tab of the Capacitor editor.

SynM1CloseValue

double

Close value for Module 1 on the capacitor. This

field corresponds to the Close value for Mod. 1 on
the Capacitor tab of the Capacitor editor.

SynerGEE Electric 5.0

User Guide

972

Model Forge Commands

Field
4

Name

Type

Description

SynM1TripValue

double

Trip value for Module 1 on the capacitor. This field

corresponds to the Trip value for Mod. 1 on the
Capacitor tab of the Capacitor editor.

CAP_109 Editing the control type for a capacitor

Use the CAP_109 Model Forge command to edit the control type for a capacitor that is identified by an AMS
link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to edit.

The AMS link is specified on the Settings tab of the
Capacitor editor.
If a capacitor does not exist with the specified AMS link
name, then no edits will be made. If multiple capacitors
exist with the same AMS link name, then only one of
those capacitors will be updated.

User Guide

SynControlMode

string

Text string that identifies the control mode that you want
to set for the capacitor. Specify one of the following
values:

AMPS Current (amps)

KVAR kvar

PF Power Factor (%)

SUBKVAR Sub kvar

SUBPF Sub pf (%)

TEMP Temperature

TOD Time of Day

VO Voltage (120V)

SynerGEE Electric 5.0

Model Forge Commands

973

CAP_110 Editing the Module 1 kvar per phase value

for a capacitor
Use the CAP_110 Model Forge command to set the Module 1 Kvar/Ph value for a capacitor that is identified
by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to

edit. The AMS link is specified on the Settings tab
of the Capacitor editor.
If a capacitor does not exist with the specified AMS
link name, then no edits will be made. If multiple
capacitors exist with the same AMS link name, then
only one of those capacitors will be updated.

SynM1KvarPerPhase

double

Kvar/Ph value for Module 1 on the capacitor. This

field corresponds to the Kvar/Ph value for Mod. 1
on the Capacitor tab of the Capacitor editor.

CAP_111 Editing the Module 1 close value for a

capacitor
Use the CAP_111 Model Forge command to set the Module 1 close value for a capacitor that is identified by
an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to

edit. The AMS link is specified on the Settings tab
of the Capacitor editor.
If a capacitor does not exist with the specified AMS
link name, then no edits will be made. If multiple
capacitors exist with the same AMS link name, then
only one of those capacitors will be updated.

SynM1CloseValue

double

Close value for Module 1 on the capacitor. This

field corresponds to the Close value for Mod. 1 on
the Capacitor tab of the Capacitor editor.

To edit the close value for module 2 on a capacitor, see CAP_122 Editing the Module 2 close and trip
values for a capacitor on page 979.
To edit the close value for module 3 on a capacitor, see CAP_123 Editing the Module 3 close and trip
values for a capacitor on page 980.

SynerGEE Electric 5.0

User Guide

974

Model Forge Commands

CAP_112 Editing the Module 1 trip value for a

capacitor
Use the CAP_112 Model Forge command to set the Module 1 trip value for a capacitor that is identified by an
AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to edit.

The AMS link is specified on the Settings tab of the
Capacitor editor.
If a capacitor does not exist with the specified AMS link
name, then no edits will be made. If multiple capacitors
exist with the same AMS link name, then only one of
those capacitors will be updated.

SynM1TripValue

double

Trip value for Module 1 on the capacitor. This field

corresponds to the Trip value for Mod. 1 on the
Capacitor tab of the Capacitor editor.

To edit the trip value for module 2 on a capacitor, see CAP_122 Editing the Module 2 close and trip values
for a capacitor on page 979.
To edit the trip value for module 3 on a capacitor, see CAP_123 Editing the Module 3 close and trip values
for a capacitor on page 980.

CAP_113 Editing the voltage rating for a capacitor

Use the CAP_113 Model Forge command to edit the voltage rating for a capacitor that is identified by its
associated section name. The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the capacitor you

want to edit. If a capacitor does not exist on the
specified section, then no edits will be made.

SynVoltRating

double

Volt rating for the capacitor. This is equivalent to setting

the Rated kV value in the Capacitor tab of the
Capacitor tab.

SynerGEE Electric 5.0

Model Forge Commands

975

CAP_114 Editing the metering phase for a capacitor

Use the CAP_114 Model Forge command to edit the metering phase for a capacitor that is identified by its
associated section name. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to

edit. The AMS link is specified on the Settings tab
of the Capacitor editor.
If a capacitor does not exist with the specified AMS
link name, then no edits will be made. If multiple
capacitors exist with the same AMS link name, then
only one of those capacitors will be updated.

SynMeteringPhase

string

Text value indicating whether the metering phase

for the capacitor will be set to Phase A, B, or C.
Specify one of the following values:

A Phase A

B Phase B

C Phase C

This field corresponds to the Metering Phase

option on the Settings tab of the Capacitor editor.

CAP_115 Editing the operating status and metering

phase for a capacitor
Use the CAP_115 Model Forge command to edit the operating status and metering phase for a capacitor that
is identified by its associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the capacitor you

want to edit. If a capacitor does not exist on the
specified section, then no edits will be made.

SynIsOn

Boolean

Boolean value indicating whether the capacitor will

be turned On or Off.

0 Off

1 On

This field corresponds to the Turn Off check box

in the Capacitor tab of the Capacitor editor.

SynerGEE Electric 5.0

User Guide

976

Model Forge Commands

Field
3

Name

Type

Description

SynMeteringPhase

string

Text value indicating whether the metering phase

for the capacitor will be set to Phase A, B, or C.
Specify one of the following values:

A Phase A

B Phase B

C Phase C

This field corresponds to the Metering Phase

option on the Settings tab of the Capacitor editor.

CAP_116 Editing the PT ratio and CT rating for a

capacitor
Use the CAP_116 Model Forge command to edit the PT ratio and CT rating for a capacitor that is identified by
its associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the capacitor you

want to edit. If a capacitor does not exist on the
specified section, then no edits will be made.

SynPTRatio

double

PT ratio value for the capacitor. This is equivalent to

editing the PT Ratio text box on the Settings tab of the
Capacitor editor.

SynCTRating

double

CT rating value for the capacitor. This is equivalent to

editing the CT Rating text box on the Settings tab of
the Capacitor editor.

CAP_117 Editing Module 1 settings for a capacitor

Use the CAP_117 Model Forge command to set the Module 1 values for Kvar/Ph, Close, and Trip for a
capacitor that is identified its associated section name. The inputs for this command are described in the
following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the capacitor you

want to edit. If a capacitor does not exist on the
specified section, then no edits will be made.

SynerGEE Electric 5.0

Model Forge Commands

Field

977

Name

Type

Description

SynM1KvarPerPhase

double

Kvar/Ph value for Module 1 on the capacitor. This

field corresponds to the Kvar/Ph value for Mod. 1
on the Capacitor tab of the Capacitor editor.

SynM1CloseValue

double

Close value for Module 1 on the capacitor. This

field corresponds to the Close value for Mod. 1 on
the Capacitor tab of the Capacitor editor.

SynM1TripValue

double

Trip value for Module 1 on the capacitor. This field

corresponds to the Trip value for Mod. 1 on the
Capacitor tab of the Capacitor editor.

CAP_118 Editing the control type for a capacitor

Use the CAP_118 Model Forge command to edit the control type for a capacitor that is identified by its
associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the capacitor you

want to edit. If a capacitor does not exist on the
specified section, then no edits will be made.

SynControlMode

string

Text string that identifies the control mode that you want
to set for the capacitor. Specify one of the following
values:

SynerGEE Electric 5.0

AMPS Current (amps)

KVAR kvar

PF Power Factor (%)

SUBKVAR Sub kvar

SUBPF Sub pf (%)

TEMP Temperature

TOD Time of Day

VO Voltage (120V)

User Guide

978

Model Forge Commands

CAP_119 Setting the energize year and retire year for

a capacitor
Use the CAP_119 Model Forge command to edit the energize and retire years for a capacitor on a specified
section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the capacitor you

want to edit. If a capacitor does not exist on the
specified section, then no edits will be made.

SynEnergizeYr

long

Number that represents the energize year for the

capacitor. Use 0 for the base year for your model, or
1 through 10 for each subsequent year.

SynRetireYr

long

Number that represents the retire year for the capacitor.

Use 1 through 10 to represent years 1 through 10 for
your model, or use 0 to represent the setting of
Never.

CAP_120 Specifying whether a capacitor will operate

on weekends
Use the CAP_120 Model Forge command to select or clear the Off on weekends check box for a capacitor
that is identified by its associated section name. The inputs for this command are described in the following
table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the capacitor you

want to edit. If a capacitor does not exist on the
specified section, then no edits will be made.

SynIsOn

Boolean

Boolean value indicating whether the capacitors

Off on weekends option will be enabled or
disabled.

0 Capacitor will operate on weekends

(that is, the Off on weekends check box
will be cleared)

1 Capacitor will not operate on

weekends (that is, the Off on weekends
check box will be selected)

SynerGEE Electric 5.0

Model Forge Commands

979

CAP_121 Editing the Module 2 and Module 3 kvar per

phase value for a capacitor
Use the CAP_121 Model Forge command to set the Module 2 and Module 3 kvar and phase values for a
capacitor that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to

edit. The AMS link is specified on the Settings tab
of the Capacitor editor.
If a capacitor does not exist with the specified AMS
link name, then no edits will be made. If multiple
capacitors exist with the same AMS link name, then
only one of those capacitors will be updated.

SynM2KvarPerPhase

double

Kvar/Ph value for Module 2 on the capacitor. This

field corresponds to the Kvar/Ph value for Mod. 2
on the Capacitor tab of the Capacitor editor.

SynM3KvarPerPhase

double

Kvar/Ph value for Module 3 on the capacitor. This

field corresponds to the Kvar/Ph value for Mod. 3
on the Capacitor tab of the Capacitor editor.

To edit the kvar per phase for module 1 on a capacitor, see CAP_110 Editing the Module 1 kvar per phase
value for a capacitor on page 973.

CAP_122 Editing the Module 2 close and trip values

for a capacitor
Use the CAP_122 Model Forge command to set the Module 2 close value and trip value for a capacitor that
is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to

edit. The AMS link is specified on the Settings tab
of the Capacitor editor.
If a capacitor does not exist with the specified AMS
link name, then no edits will be made. If multiple
capacitors exist with the same AMS link name, then
only one of those capacitors will be updated.

SynM2CloseValue

SynerGEE Electric 5.0

double

Close value for Module 2 on the capacitor. This

field corresponds to the Close value for Mod. 2 on
the Capacitor tab of the Capacitor editor.

User Guide

980

Model Forge Commands

Field
3

Name

Type

Description

SynM2TripValue

double

Trip value for Module 2 on the capacitor. This field

corresponds to the Trip value for Mod. 2 on the
Capacitor tab of the Capacitor editor.

To edit the close and trip values for module 1 on a capacitor, see CAP_111 Editing the Module 1 close
value for a capacitor on page 973 and CAP_112 Editing the Module 1 trip value for a capacitor on
page 974.
To edit the close and trip values for module 3 on a capacitor, see CAP_123 Editing the Module 3 close and
trip values for a capacitor on page 980.

CAP_123 Editing the Module 3 close and trip values

for a capacitor
Use the CAP_123 Model Forge command to set the Module 3 close value and trip value for a capacitor that
is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which capacitor you want to

edit. The AMS link is specified on the Settings tab
of the Capacitor editor.
If a capacitor does not exist with the specified AMS
link name, then no edits will be made. If multiple
capacitors exist with the same AMS link name, then
only one of those capacitors will be updated.

SynM3CloseValue

double

Close value for Module 3 on the capacitor. This

field corresponds to the Close value for Mod. 3 on
the Capacitor tab of the Capacitor editor.

SynM3TripValue

double

Trip value for Module 3 on the capacitor. This field

corresponds to the Trip value for Mod. 3 on the
Capacitor tab of the Capacitor editor.

To edit the close and trip values for module 1 on a capacitor, see CAP_111 Editing the Module 1 close
value for a capacitor on page 973 and CAP_112 Editing the Module 1 trip value for a capacitor on
page 974.
To edit the close and trip values for module 2 on a capacitor, see CAP_122 Editing the Module 2 close and
trip values for a capacitor on page 979.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

981

CMM
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit customers, distribution transformers, and customer billing records for use with SynerGEEs CMM
functionality.

CMM_110 Creating a new customer on page 981

CMM_113 Assigning a load type to a customer on page 982

CMM_114 Assigning a class to a customer on page 982

CMM_120 Creating a distribution transformer on page 982

CMM_121 Updating an existing distribution transformer on page 983

CMM_123 Setting a distribution transformer as a primary meter on page 983

CMM_124 Setting the XY coordinates for a distribution transformer on page 983

CMM_127 Adding a customer to a distribution transformer on page 984

CMM_128 Assigning a distribution transformer to a section on page 984

CMM_130 Adding a customer demand billing record with kW on page 984

CMM_131 Adding a customer demand billing record with kvar on page 985

CMM_132 Adding a customer demand billing record with PctPf on page 985

CMM_140 Adding a customer usage billing record on page 985

CMM_162 Creating a customer class on page 986

CMM_164 Setting the coincidence factor for a customer class on page 986

CMM_211 Creating a customer class curve on page 986

CMM_212 Creating a customer class curve and matching customer zone curve on page 987

CMM_214 Adding metered demand data to a customer curve on page 987

CMM_110 Creating a new customer

Use the CMM_110 Model Forge command to create a new customer. The inputs for this command are
described in the following table.
Field

Name

Type

Description

CustomerID

string

ID that will identify the new customer.

Last_Name

string

Last name of the new customer.

First_Name

string

First name of the new customer.

Address

string

Address of the new customer.

Phase

string

Phasing for the new customer.

SynerGEE Electric 5.0

User Guide

982

Model Forge Commands

CMM_113 Assigning a load type to a customer

Use the CMM_113 Model Forge command to assign a load type to an existing customer. The inputs for this
command are described in the following table.
Field

Name

Type

Description

CustomerID

string

ID of the customer that you want to update.

LoadType

string

Load type that you want to assign to the specified

customer. Acceptable values are as follows:

D Distributed load

L Large customer load

P Project load

S Spot load

CMM_114 Assigning a class to a customer

Use the CMM_114 Model Forge command to assign a customer class to an existing customer. The inputs for
this command are described in the following table.
Field

Name

Type

Description

CustomerID

string

ID of the customer that you want to update.

ClassID

string

ID of the customer class that you want to assign to the

specified customer.

CMM_120 Creating a distribution transformer

Use the CMM_120 Model Forge command to create a new distribution transformer. The inputs for this
command are described in the following table.
Field

User Guide

Name

Type

Description

TransformerID

string

ID that will identify the new distribution transformer.

kVA_Rating

double

kVA rating for the new distribution transformer.

Phase

string

Phasing for the new distribution transformer.

SynerGEE Electric 5.0

Model Forge Commands

983

CMM_121 Updating an existing distribution

transformer
Use the CMM_121 Model Forge command to set the kVA rating and phasing for an existing distribution
transformer. The inputs for this command are described in the following table.
Field

Name

Type

Description

TransformerID

string

ID of the distribution transformer that you want to

update.

kVA_Rating

double

kVA rating for the distribution transformer.

Phase

string

Phasing for the distribution transformer.

CMM_123 Setting a distribution transformer as a

primary meter
Use the CMM_123 Model Forge command to set a distribution transformer as a primary meter. The inputs for
this command are described in the following table.
Field
1

Name

Type

Description

TransformerID

string

ID of the distribution transformer that you want to set as

the primary meter.

CMM_124 Setting the XY coordinates for a

distribution transformer
Use the CMM_124 Model Forge command to set the X and Y coordinates for an existing distribution
transformer. The inputs for this command are described in the following table.
Field

Name

Type

Description

TransformerID

string

ID of the distribution transformer that you want to

update.

X_MUL

double

X coordinate for the distribution transformer.

Y_MUL

double

Y coordinate for the distribution transformer.

SynerGEE Electric 5.0

User Guide

984

Model Forge Commands

CMM_127 Adding a customer to a distribution

transformer
Use the CMM_127 Model Forge command to assign a customer to a distribution transformer. The inputs for
this command are described in the following table.
Field

Name

Type

Description

CustomerID

string

ID of the customer that you want to update.

TransformerID

string

ID of the distribution transformer that you want to add to

the specified customer.

CMM_128 Assigning a distribution transformer to a

section
Use the CMM_128 Model Forge command to assign a distribution transformer to a section. The inputs for this
command are described in the following table.
Field

Name

Type

Description

TransformerID

string

ID of the distribution transformer that you want to

update.

SectionID

string

ID of the section that you want to assign to the specified

distribution transformer.

CMM_130 Adding a customer demand billing record

with kW
Use the CMM_130 Model Forge command to add a customer billing record with kW data. The inputs for this
command are described in the following table.
Field

User Guide

Name

Type

Description

CustomerID

string

ID of the customer that you want to create a billing

record for.

Read_Date

date

Billing date for the customer billing record.

kW

double

Billed kW demand for the specified customer.

SynerGEE Electric 5.0

Model Forge Commands

985

CMM_131 Adding a customer demand billing record

with kvar
Use the CMM_131 Model Forge command to add a customer billing record with kvar data. The inputs for this
command are described in the following table.
Field

Name

Type

Description

CustomerID

string

ID of the customer that you want to create a billing

record for.

Read_Date

date

Billing date for the customer billing record.

kvar

double

Calculated billed kvar for the specified customer.

CMM_132 Adding a customer demand billing record

with PctPf
Use the CMM_132 Model Forge command to add a customer billing record with a percent power factor. The
inputs for this command are described in the following table.
Field

Name

Type

Description

CustomerID

string

ID of the customer that you want to create a billing

record for.

Read_Date

date

Billing date for the customer billing record.

PctPf

double

Percent power factor for the specified customer.

CMM_140 Adding a customer usage billing record

Use the CMM_140 Model Forge command to add a customer billing record with kWh data. The inputs for this
command are described in the following table.
Field

Name

Type

Description

CustomerID

string

ID of the customer that you want to create a billing

record for.

Read_Date

date

Billing date for the customer billing record.

kWh

double

Billed kWh for the billing period.

Billing_Days

double

Number of days in the billing period.

SynerGEE Electric 5.0

User Guide

986

Model Forge Commands

CMM_162 Creating a customer class

Use the CMM_162 Model Forge command to create a new customer class. The inputs for this command are
described in the following table.
Field

Name

Type

Description

ClassID

string

ID that will identify the new customer class.

PctPF

double

Percent power factor for the new customer class.

PctLF

double

Load factor for the new customer class.

CMM_164 Setting the coincidence factor for a

customer class
Use the CMM_164 Model Forge command to set the coincidence factor for a specified number of customers
for an existing customer class. The inputs for this command are described in the following table.
Field

Name

Type

Description

ClassID

string

ID of the customer class that you want to update.

NumCust

long

Number of customers for the coincidence factor that you

want to update.

CoinFac

double

Coincidence factor for the customer class for the

specified number of customers.

CMM_211 Creating a customer class curve

Use the CMM_211 Model Forge command to create a new customer class curve. The inputs for this
command are described in the following table.
Field
1

User Guide

Name

Type

Description

CurveId

string

ID that will identify the new customer class curve.

SynerGEE Electric 5.0

Model Forge Commands

987

CMM_212 Creating a customer class curve and

matching customer zone curve
Use the CMM_212 Model Forge command to create a new customer class curve and a matching customer
zone curve. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

CurveId

string

ID that will identify the new customer class curve and

matching customer zone curve.

CMM_214 Adding metered demand data to a

customer curve
Use the CMM_214 Model Forge command to add metered demand data to an existing customer curve. The
inputs for this command are described in the following table.
Field

Name

Type

Description

CurveId

string

ID of the customer class curve or customer zone curve

that you want to update.

kW

double

Demand value in kW for the metered demand reading.

kvar

double

Demand kvar for the metered demand reading.

SynMonth

long

Numerical value from 0 to 11 that represents the month

of the metered demand reading, where 0 = January, 1 =
February, and so on.

SynWeekDay

long

Numerical value from 0 to 6 that represents the week

day of the metered demand reading, where 0 = Monday,
1 = Tuesday, and so on. Values of 0 through 4 are
interpreted as weekdays, and 5 and 6 are interpreted as
weekend days.

SynHour

long

Numerical value from 0 to 24 that represents the hour of

the metered demand reading.

DISTRIBUTION TRANSFORMERS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit distribution transformers.

DTR_101 Creating/editing a distribution transformer on page 988

DTR_102 Editing the kVA for a distribution transformer on page 988

DTR_103 Editing the X,Y coordinates for a distribution transformer on page 989

SynerGEE Electric 5.0

User Guide

988

Model Forge Commands

DTR_104 Editing the demand kVA for a distribution transformer on page 989

DTR_105 Editing the number of customers for a distribution transformer on page 990

DTR_106 Editing the connection phase for a distribution transformer on page 990

DTR_107 Editing the demand kVA, number of customers, and connection phase for a distribution
transformer on page 991

DTR_101 Creating/editing a distribution transformer

Use the DTR_101 Model Forge command to create a distribution transformer on a specified section, and also
to edit the description for an existing distribution transformer on a specified section. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a

distribution transformer or edit the description for an
existing distribution transformer.

If a distribution transformer with the specified

name already exists on the section, then the
existing distribution transformer will be
updated with the new description.

If a distribution transformer with the specified

name does not already exist on the section,
then a new distribution transformer will be
created and assigned the specified name and
description.

SynName

string

Name that will be applied to the distribution transformer

on the designated section.

SynDescription

string

Description for the distribution transformer.

DTR_102 Editing the kVA for a distribution

transformer
Use the DTR_102 Model Forge command to edit the kVA value for a distribution transformer. The distribution
transformer that will be edited by this command is identified by a specified section name and distribution
transformer name.
If the specified distribution transformer does not exist on the specified section, or the specified section does
not exist, then no edits will be made.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the distribution

transformer you want to edit.

SynerGEE Electric 5.0

Model Forge Commands

Field

989

Name

Type

Description

SynName

string

Name of the distribution transformer that you want to

edit.

SynLoadkVAT

double

Total kVA capacity of the distribution transformer,

excluding spot load connected kVA.

DTR_103 Editing the X,Y coordinates for a distribution

transformer
Use the DTR_103 Model Forge command to set the X,Y coordinates for a distribution transformer. The
distribution transformer that will be edited by this command is identified by a specified section name and
distribution transformer name.
If the specified distribution transformer does not exist on the specified section, or the specified section does
not exist, then no edits will be made.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the distribution

transformer you want to edit.

SynName

string

Name of the distribution transformer that you want to

edit.

SynX

double

X coordinate value for the distribution transformer.

SynY

double

Y coordinate value for the distribution transformer.

DTR_104 Editing the demand kVA for a distribution

transformer
Use the DTR_104 Model Forge command to edit the demand KVA value for a distribution transformer. The
distribution transformer that will be edited by this command is identified by a specified section name and
distribution transformer name.
If the specified distribution transformer does not exist on the specified section, or the specified section does
not exist, then no edits will be made.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the distribution

transformer you want to edit.

SynName

string

Name of the distribution transformer that you want

to edit.

SynDemandkVAT

double

Total metered kVa for the distribution transformer.

SynerGEE Electric 5.0

User Guide

990

Model Forge Commands

DTR_105 Editing the number of customers for a

distribution transformer
Use the DTR_105 Model Forge command to edit the number of customers for a distribution transformer. The
distribution transformer that will be edited by this command is identified by a specified section name and
distribution transformer name.
If the specified distribution transformer does not exist on the specified section, or the specified section does
not exist, then no edits will be made.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the distribution

transformer you want to edit.

SynName

string

Name of the distribution transformer that you want

to edit.

SynConCustomers

double

Total number of customers for the distribution

transformer.

DTR_106 Editing the connection phase for a

distribution transformer
Use the DTR_106 Model Forge command to edit the connection phase for a distribution transformer. The
distribution transformer that will be edited by this command is identified by a specified section name and
distribution transformer name.
If the specified distribution transformer does not exist on the specified section, or the specified section does
not exist, then no edits will be made.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the distribution

transformer you want to edit.

SynName

string

Name of the distribution transformer that you want to

edit.

SynPhasing

string

Connection phase that will be applied to the distribution

transformer. Specify this value as a text string that
includes the characters A, B, and C. Acceptable values
include A, B, C, AB, BC, AC, and ABC.

SynerGEE Electric 5.0

Model Forge Commands

991

DTR_107 Editing the demand kVA, number of

customers, and connection phase for a distribution
transformer
Use the DTR_107 Model Forge command to edit the demand kVA, number of customers, and connection
phase for a distribution transformer. The distribution transformer that will be edited by this command is
identified by a specified section name and distribution transformer name.
If the specified distribution transformer does not exist on the specified section, or the specified section does
not exist, then no edits will be made.
If the specified distribution transformer does not exist on the specified section, or the specified section does
not exist, then no edits will be made.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the distribution

transformer you want to edit.

SynName

string

Name of the distribution transformer that you want

to edit.

SynDemandKVAT

double

Total metered kVa for the distribution transformer.

SynConCustomers

double

Total number of customers for the distribution

transformer.

SynPhasing

string

Connection phase that will be applied to the

distribution transformer. Specify this value as a text
string that includes the characters A, B, and C.
Acceptable values include A, B, C, AB, BC,
AC, and ABC.

FACILITIES
Refer to the topics listed below for information on the Model Forge commands that are used to edit facilities.

FAC_110 Editing the location link, AMS link, and note text for a facility on page 992

FAC_111 Editing the location link for a facility on page 992

FAC_112 Editing the AMS link for a facility on page 993

FAC_113 Editing the note text for a facility on page 993

SynerGEE Electric 5.0

User Guide

992

Model Forge Commands

FAC_110 Editing the location link, AMS link, and note

text for a facility
Use the FAC_110 Model Forge command to edit the location link, AMS link, and note text for a specified
facility type on a specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the facility you want

to edit.

SynFacType

string

Name of the facility type that you want to edit on the

specified section. If the specified facility type does not
exist on the specified section, then no edits will be
made.

SynLocLink

string

Location link to be assigned to the specified facility type

on the specified section.

SynAmsLink

string

AMS link to be assigned to the specified facility type on

the specified section. AMS links are used to identify a
specific facility in both your model and your external
data source.

SynNote

string

Text to be assigned to the Note field on the specified

facility type on the specified section.

FAC_111 Editing the location link for a facility

Use the FAC_111 Model Forge command to edit the location link for a specified facility type on a specified
section. The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the facility you want

to edit.

SynFacType

string

Name of the facility type that you want to edit on the

specified section. If the specified facility type does not
exist on the specified section, then no edits will be
made.

SynLocLink

string

Location link to be assigned to the specified facility type

on the specified section.

SynerGEE Electric 5.0

Model Forge Commands

993

FAC_112 Editing the AMS link for a facility

Use the FAC_112 Model Forge command to edit an AMS link for a specified facility type on a specified
section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the facility you want

to edit.

SynFacType

string

Name of the facility type that you want to edit on the

specified section. If the specified facility type does not
exist on the specified section, then no edits will be
made.

SynAmsLink

string

AMS link to be assigned to the specified facility type on

the specified section. AMS links are used to identify a
specific facility in both your model and your external
data source.

FAC_113 Editing the note text for a facility

Use the FAC_113 Model Forge command to edit the note text for a specified facility type on a specified
section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the facility you want

to edit.

SynFacType

string

Name of the facility type that you want to edit on the

specified section. If the specified facility type does not
exist on the specified section, then no edits will be
made.

SynNote

string

Text to be assigned to the Note field on the specified

facility type on the specified section.

FEEDERS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit feeders.

FDR_101 Converting a node to a feeder on page 994

FDR_102 Editing minimum and maximum source impedance values for a feeder on page 994

FDR_103 Editing the balanced voltage level for a feeder on page 995

FDR_104 Editing positive sequence and zero sequence values for a feeder on page 996

SynerGEE Electric 5.0

User Guide

994

Model Forge Commands

FDR_105 Editing the note text for a feeder on page 996

FDR_106 Editing the continuous amp rating and emergency amp rating for a feeder on page 997

FDR_107 Setting the color for a feeder on page 997

FDR_108 Setting the voltage and angle for phase 1 of a feeder on page 998

FDR_109 Setting the voltage and angle for phase 2 of a feeder on page 998

FDR_110 Setting the voltage and angle for phase 3 of a feeder on page 998

FDR_111 Setting the region ID for a feeder on page 999

FDR_112 Editing maximum source impedance values for a feeder on page 999

FDR_101 Converting a node to a feeder

Use the FDR_101 Model Forge command to convert a specified node into a feeder and then to edit the
nominal kV value, substation ID, and connection type for the new feeder. The inputs for this command are
described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the node that you want to convert to a feeder. If

a node does not exist with the specified name, then no
edits will be made.

SynNomKv

double

Nominal kV value for the feeder.

SynSubId

string

Substation ID for the feeder.

SynConnection

string

Connection type for the feeder. Specify one of the

following values:

Wye

Wye-Gnd

Delta

FDR_102 Editing minimum and maximum source

impedance values for a feeder
Use the FDR_102 Model Forge command to edit both the minimum and maximum source impedance values
for a feeder. The inputs for this command are described in the following table.
Field
1

User Guide

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no edits will
be made.

SynerGEE Electric 5.0

Model Forge Commands

Field

995

Name

Type

Description

SynPosSeqR

double

Minimum and maximum Positive Sequence R value

for the feeder. This is equivalent to setting both the
minimum and maximum Positive Sequence > R
values on the Volts/Ohms tab of the Feeder editor.

SynPosSeqX

double

Minimum and maximum Positive Sequence X value

for the feeder. This is equivalent to setting both the
minimum and maximum Positive Sequence > X option
on the Volts/Ohms tab of the Feeder editor.

SynZeroSeqR

double

Minimum and maximum Zero Sequence R value for

the feeder. This is equivalent to setting both the
minimum and maximum Zero Sequence > R option on
the Volts/Ohms tab of the Feeder editor.

SynZeroSeqX

double

Minimum and maximum Zero Sequence X value for

the feeder. This is equivalent to setting both the
minimum and maximum Zero Sequence > X option on
the Volts/Ohms tab of the Feeder editor.

FDR_103 Editing the balanced voltage level for a

feeder
Use the FDR_103 Model Forge command to edit the balanced voltage level for a feeder. The inputs for this
command are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no edits will
be made.

SynBusVolts

double

Balanced voltage level for the feeder. This is equivalent

to setting the Use Balanced Voltage Level > Volts
option on the Volts/Ohms tab of the Feeder editor.

SynerGEE Electric 5.0

User Guide

996

Model Forge Commands

FDR_104 Editing positive sequence and zero sequence

values for a feeder
Use the FDR_104 Model Forge command to edit the positive sequence R and X values and the zero
sequence R and X for a feeder. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSrc

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no edits will
be made.

SynR1

double

Positive Sequence R value for the feeder. This is

equivalent to setting the Positive Sequence > R option
on the Volts/Ohms tab of the Feeder editor.

SynX1

double

Positive Sequence X value for the feeder. This is

equivalent to setting the Positive Sequence > X option
on the Volts/Ohms tab of the Feeder editor.

SynR0

double

Zero Sequence R value for the feeder. This is

equivalent to setting the Zero Sequence > R option on
the Volts/Ohms tab of the Feeder editor.

SynX0

double

Zero Sequence X value for the feeder. This is

equivalent to setting the Zero Sequence > X option on
the Volts/Ohms tab of the Feeder editor.

FDR_105 Editing the note text for a feeder

Use the FDR_105 Model Forge command to edit the note text for a feeder. The inputs for this command are
described in the following table.
Field

User Guide

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no edits will
be made.

SynNote

string

Text to be assigned to the Note field for the feeder.

SynerGEE Electric 5.0

Model Forge Commands

997

FDR_106 Editing the continuous amp rating and

emergency amp rating for a feeder
Use the FDR_106 Model Forge command to edit the continuous amp rating and emergency amp rating text
for a feeder. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no
edits will be made.

SynContAmpRating

double

Continuous amp rating for the feeder. This is

equivalent to editing the Cont. Amp Rating field
on the Feeder tab of the Feeder editor.

SynEmergAmpRating

double

Emergency amp rating for to the feeder. This is

equivalent to editing the Emer. Amp Rating field
on the Feeder tab of the Feeder editor.

FDR_107 Setting the color for a feeder

Use the FDR_107 Model Forge command to set the color for a feeder. The inputs for this command are
described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no
edits will be made.

SynRGB

string

Color to be applied to the feeder, specified as RGB

values. Use a comma to separate each numerical
value, which can have a value of 0 to 255. For
example, the following RGB value will set the
feeder color to yellow:
255,255,0

SynerGEE Electric 5.0

User Guide

998

Model Forge Commands

FDR_108 Setting the voltage and angle for phase 1 of

a feeder
Use the FDR_108 Model Forge command to set voltage and angle for phase 1 of a feeder. The inputs for this
command are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no
edits will be made.

SynPh1Volts

double

Voltage for phase 1 of the feeder.

SynPh1Angle

double

Angle for phase 1 of the feeder.

FDR_109 Setting the voltage and angle for phase 2 of

a feeder
Use the FDR_109 Model Forge command to set voltage and angle for phase 2 of a feeder. The inputs for this
command are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no
edits will be made.

SynPh1Volts

double

Voltage for phase 2 of the feeder.

SynPh1Angle

double

Angle for phase 2 of the feeder.

FDR_110 Setting the voltage and angle for phase 3 of

a feeder
Use the FDR_110 Model Forge command to set voltage and angle for phase 3 of a feeder. The inputs for this
command are described in the following table.
Field

User Guide

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no
edits will be made.

SynPh1Volts

double

Voltage for phase 3 of the feeder.

SynPh1Angle

double

Angle for phase 3 of the feeder.

SynerGEE Electric 5.0

Model Forge Commands

999

FDR_111 Setting the region ID for a feeder

Use the FDR_111 Model Forge command to set the region ID for a feeder. The inputs for this command are
described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no
edits will be made.

SynRegionID

string

Name of the region that you want to assign to the

feeder. This is equivalent to editing the Region
field on the Feeder tab of the Feeder editor.

FDR_112 Editing maximum source impedance values

for a feeder
Use the FDR_112 Model Forge command to edit the maximum source impedance values for a feeder. The
inputs for this command are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the feeder that you want to edit. If a feeder

does not exist with the specified name, then no edits will
be made.

SynPosSeqRMax

double

Maximum Positive Sequence R value for the feeder.

This is equivalent to setting the maximum Positive
Sequence > R values on the Volts/Ohms tab of the
Feeder editor.

SynPosSeqXMax

double

Maximum Positive Sequence X value for the feeder.

This is equivalent to setting the maximum Positive
Sequence > X option on the Volts/Ohms tab of the
Feeder editor.

SynZeroSeqRMax

double

Maximum Zero Sequence R value for the feeder. This

is equivalent to setting the maximum Zero Sequence >
R option on the Volts/Ohms tab of the Feeder editor.

SynZeroSeqXMax

double

Maximum Zero Sequence X value for the feeder. This

is equivalent to setting the maximum Zero Sequence >
X option on the Volts/Ohms tab of the Feeder editor.

SynerGEE Electric 5.0

User Guide

1000

Model Forge Commands

FUSES
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit fuses.

FUS_101 Adding a fuse to a section on page 1000

FUS_102 Editing the manufacturer, model, and amp and volt ratings for a fuse on page 1001

FUS_103 Specifying the location of a fuse on page 1001

FUS_104 Editing the connection phase for a fuse on page 1002

FUS_101 Adding a fuse to a section

Use the FUS_101 command to add a new fuse to a section. The fuse will be created on the base year of the
model and applied to all model years. In addition, if the model is currently set to display any year other than
the base year, it will be updated first to display the base year before adding the new fuse.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section where you want to add a fuse. If a

fuse already exists on the section, then no edits will be
made.

SynName

string

Name of the fuse that will be added to the designated

section.

SynStatus

Boolean

Boolean value indicating whether the fuse status will be

set to Open or Closed. The value will be set for each
year starting at the active year and ending at the last
model year.

0 Closed

1 Open

This field corresponds to the Status option on the

Fuse tab of the Fuse editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1001

FUS_102 Editing the manufacturer, model, and amp

and volt ratings for a fuse
Use the FUS_102 Model Forge command to edit a number of different options for a fuse on a specified
section, including the manufacturer, model, and amp and volt ratings. The inputs for this command are
described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the fuse you want to

edit. If a fuse does not exist on the specified section,
then no edits will be made.

SynManuf

string

Manufacturer name from your protection database that

will be applied to the fuse. If the manufacturer name
does not exist, then the first available manufacturer
name will be applied.

SynModel

string

Model name from your protection database that will be

applied to the fuse. The model name must correspond
to the specified manufacturer name. If the model name
does not exist, then the first available model name will
be applied.

SynAmp

string

Amp rating from your protection database that will be

applied to the fuse. The amp rating must correspond to
the specified manufacturer name and model name. If
the specified amp rating does not exist, then the first
available amp rating option will be applied.

SynVolt

string

Volt rating from your protection database that will be

applied to the fuse. The volt rating must correspond to
the specified manufacturer name and model name. If
the specified volt rating does not exist, then the first
available volt rating option will be applied.

FUS_103 Specifying the location of a fuse

Use the FUS_103 Model Forge command to specify whether a fuse is located near the from-node or the tonode of a specified section. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section that contains the fuse you want to

edit. If a fuse does not exist on the section, then no edits
will be made.

SynerGEE Electric 5.0

User Guide

1002

Model Forge Commands

Field
2

Name

Type

Description

SynFromNode

Boolean

Boolean value indicating whether the fuse will be

located near the from-node or the to-node of the
section.

0 To-node end

1 From-node end

This will perform the same task as using SynerGEEs

move device feature to position the fuse at either end
of the section. Only one fuse can exist on a section.

FUS_104 Editing the connection phase for a fuse

Use the FUS_104 Model Forge command to edit the connection phase for a fuse that is identified by its
associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the fuse you want to

edit. If a fuse does not exist on the specified section,
then no edits will be made.

SynPhasing

string

Connection phase that will be applied to the fuse.

Specify this value as a text string that includes the
characters A, B, and C. Acceptable values include A,
B, C, AB, BC, AC, and ABC.

GENERATORS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit generators.

GEN_101 Editing a generator on page 1002

GEN_102 Creating/editing a generator on page 1003

GEN_103 Selecting a generator type and connection phase on page 1003

GEN_104 Turning a generator on or off on page 1004

GEN_105 Creating/editing a generator on page 1004

GEN_101 Editing a generator

The GEN_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Generators on page 1002 for a complete list of generator Model Forge commands.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1003

GEN_102 Creating/editing a generator

Use the GEN_102 Model Forge command to create a generator on a section where a generator does not
exist, or to rename the generator if the generator does exist. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a generator

or edit an existing generator name.

SynName

string

If a generator already exists on the section,

then the generator name will be updated with
the specified name.

If a generator does not already exist on the

section, then a new generator will be created
and assigned the specified name.

Name that will be applied to the generator on the

designated section.

GEN_103 Selecting a generator type and connection

phase
Use the GEN_103 Model Forge command to select a generator type and connection phase for a generator
on a specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the generator you

want to edit. If a generator does not exist on the
specified section, then no edits will be made.

SynType

string

Name of a generator type from your equipment

warehouse that will be applied to the generator. This is
equivalent to selecting the Type option on the
Generator tab of the Generator editor.
If the generator type name does not exist in the current
warehouse, then the generator type will be set to
Unknown.

SynPhase

SynerGEE Electric 5.0

string

Connection phase that will be applied to the generator.

Acceptable values are A, B, and C. This is equivalent to
selecting the Connection option on the Generator tab
of the Generator editor.

User Guide

1004

Model Forge Commands

GEN_104 Turning a generator on or off

Use the GEN_104 Model Forge command to turn a generator on a specified section On or Off. The inputs for
this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the generator you

want to edit. If a generator does not exist on the section,
then no edits will be made.

SynIsOn

Boolean

Boolean value indicating whether the generator will be

turned On or Off.

0 Off

1 On

This performs the same task as right-clicking on the

generator in SynerGEE and selecting the Turn On or
Turn Off option, as appropriate.

GEN_105 Creating/editing a generator

Use the GEN_105 Model Forge command to specify the output percentage for a generator on a specified
section. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a generator

or edit an existing generator name.

SynPctOutput

double

If a generator already exists on the section,

then the generator name will be updated with
the specified name.

If a generator does not already exist on the

section, then a new generator will be created
and assigned the specified name.

Output percentage that will be applied to the generator.

This is equivalent to setting the Specify Output %
value on the Generator tab of the Generator editor.

LARGE CUSTOMERS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit large customers.

User Guide

LGC_101 Editing a large customer on page 1005

SynerGEE Electric 5.0

Model Forge Commands

1005

LGC_102 Creating/editing a large customer on page 1006

LGC_103 Editing kW values for a large customer on page 1006

LGC_104 Editing kvar values for a large customer on page 1007

LGC_105 Editing current and impedance values for a large customer on page 1007

LGC_106 Editing customer load values for a large customer on page 1008

LGC_107 Editing connected kVA load values for a large customer on page 1008

LGC_108 Editing kW values and the power factor percentage for a large customer on page 1009

LGC_109 Turning a large customers load settings on or off on page 1010

LGC_110 Setting the rated kVA and Pf values for a larger customer on page 1011

LGC_111 Editing kW values for a large customer on page 1011

LGC_112 Editing kvar values for a large customer on page 1011

LGC_113 Editing customer load values for a large customer on page 1012

LGC_114 Editing connected kVA load values for a large customer on page 1012

LGC_115 Editing kW and kvar values for a large customer for each phase for a specific year on
page 1013

LGC_116 Editing the load status for a large customer on page 1014

LGC_117 Enabling and disabling the distributed generator on a large customer on page 1015

LGC_118 Editing the generator type for a large customer on page 1015

LGC_119 Setting the rated kVA and Pf values for a large customer on page 1015

LGC_120 Editing the capacity factor for a large customer on page 1016

LGC_101 Editing a large customer

The LGC_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Large Customers on page 1004 for a complete list of large customer Model Forge commands.

SynerGEE Electric 5.0

User Guide

1006

Model Forge Commands

LGC_102 Creating/editing a large customer

Use the LGC_102 Model Forge command to create a large customer on a section where a large customer
does not exist, or rename the large customer if the large customer does exist. The inputs for this command
are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a large

customer or edit an existing large customer name.

SynName

string

If a large customer already exists on the

section, then the large customer name will be
updated with the specified name.

If a large customer does not already exist on

the section, then a new large customer will be
created and assigned the specified name.

Name that will be applied to the large customer on the

designated section.

LGC_103 Editing kW values for a large customer

Use the LGC_103 Model Forge command to edit the kW values for phases A, B, and C for a large customer
that is identified by an AMS link. This command will apply the edits to all years in the model. If the model is
not currently displaying the base year, it will be updated first to display the base year before the edits are
applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which large customer you want

to edit. The AMS link is specified on the Large Cust tab
of the Large Customer editor.
If a large customer does not exist with the specified
AMS link name, then no edits will be made. If multiple
large customers exist with the same AMS link name,
then only one of those large customers will be updated.

User Guide

SynLoadkW_A

double

Phase A kW value that will be applied to the large

customer.

SynLoadkW_B

double

Phase B kW value that will be applied to the large

customer.

SynLoadkW_C

double

Phase C kW value that will be applied to the large

customer.

SynerGEE Electric 5.0

Model Forge Commands

1007

LGC_104 Editing kvar values for a large customer

Use the LGC_104 Model Forge command to edit the kvar values for phases A, B, and C for a large customer
that is identified by an AMS link. This command will apply the edits to all years in the model. If the model is
not currently displaying the base year, it will be updated first to display the base year before the edits are
applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which large customer you want

to edit. The AMS link is specified on the Large Cust tab
of the Large Customer editor.
If a large customer does not exist with the specified
AMS link name, then no edits will be made. If multiple
large customers exist with the same AMS link name,
then only one of those large customers will be updated.

SynLoadkvar_A

double

Phase A kvar value that will be applied to the large

customer.

SynLoadkvar_B

double

Phase B kvar value that will be applied to the large

customer.

SynLoadkvar_C

double

Phase C kvar value that will be applied to the large

customer.

LGC_105 Editing current and impedance values for a

large customer
Use the LGC_105 Model Forge command to edit the current and impedance values for a large customer that
is identified by an AMS link. This command will apply the edits to all years in the model. If the model is not
currently displaying the base year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which large customer you want

to edit. The AMS link is specified on the Large Cust tab
of the Large Customer editor.
If a large customer does not exist with the specified
AMS link name, then no edits will be made. If multiple
large customers exist with the same AMS link name,
then only one of those large customers will be updated.

SynCustI

SynerGEE Electric 5.0

double

Current value that will be applied to the large customer.

User Guide

1008

Model Forge Commands

Field
3

Name

Type

Description

SynCustZ

double

Impedance value that will be applied to the large

customer.

LGC_106 Editing customer load values for a large

customer
Use the LGC_106 Model Forge command to edit the customer load values for phases A, B, and C for a large
customer that is identified by an AMS link. This command will apply the edits to all years in the model. If the
model is not currently displaying the base year, it will be updated first to display the base year before the edits
are applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which large customer you want

to edit. The AMS link is specified on the Large Cust tab
of the Large Customer editor.
If a large customer does not exist with the specified
AMS link name, then no edits will be made. If multiple
large customers exist with the same AMS link name,
then only one of those large customers will be updated.

SynLoadCust_A

double

Phase A customer load value that will be applied to the

large customer.

SynLoadCust_B

double

Phase B customer load value that will be applied to the

large customer.

SynLoadCust_C

double

Phase C customer load value that will be applied to the

large customer.

LGC_107 Editing connected kVA load values for a

large customer
Use the LGC_107 Model Forge command to edit the connected kVA load values for phases A, B, and C for a
large customer that is identified by an AMS link. This command will apply the edits to all years in the model. If
the model is not currently displaying the base year, it will be updated first to display the base year before the
edits are applied.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1009

The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which large customer you want

to edit. The AMS link is specified on the Large Cust tab
of the Large Customer editor.
If a large customer does not exist with the specified
AMS link name, then no edits will be made. If multiple
large customers exist with the same AMS link name,
then only one of those large customers will be updated.

SynLoadCKva_A

double

Phase A connected kVA load value that will be applied

to the large customer.

SynLoadCKva_B

double

Phase B connected kVA load value that will be applied

to the large customer.

SynLoadCKva_C

double

Phase C connected kVA load value that will be applied

to the large customer.

LGC_108 Editing kW values and the power factor

percentage for a large customer
Use the LGC_108 Model Forge command to edit the total kW values for each model year for a large
customer that is identified by an AMS link. You can also use this command to edit the power factor
percentage for the large customer, which determine the total kvar given the total kW. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

SynMeterAmsLink

string

AMS link that identifies which large customer you

want to edit. The AMS link is specified on the Large
Cust tab of the Large Customer editor.
If a large customer does not exist with the specified
AMS link name, then no edits will be made. If
multiple large customers exist with the same AMS
link name, then only one of those large customers
will be updated.

SynOffSet

long

Offset value that impacts how the SynYear# values

in the LGC_108 command are applied to the
model. For example, if you have a SynOffSet value
of 2, then the SynYear1 value will be applied to
year 2 in the model (which is the third model year,
when considering the base year), and SynYear2
will be applied to year 3, and so on.

SynDefPctPf

double

Power factor percentage for the large customer.

SynerGEE Electric 5.0

User Guide

1010

Model Forge Commands

Field

Name

Type

Description

SynYear1

double

Total kW for the base year for the large customer

(unless the year is offset by the SynOffSet value).

SynYear2

double

Total kW for year 1 for the large customer (unless

the year is offset by the SynOffSet value).

SynYear3

double

Total kW for year 2 for the large customer (unless

the year is offset by the SynOffSet value).

SynYear4

double

Total kW for year 3 for the large customer (unless

the year is offset by the SynOffSet value).

SynYear5

double

Total kW for year 4 for the large customer (unless

the year is offset by the SynOffSet value).

SynYear6

double

Total kW for year 5 for the large customer (unless

the year is offset by the SynOffSet value).

10

SynYear7

double

Total kW for year 6 for the large customer (unless

the year is offset by the SynOffSet value).

11

SynYear8

double

Total kW for year 7 for the large customer (unless

the year is offset by the SynOffSet value).

12

SynYear9

double

Total kW for year 8 for the large customer (unless

the year is offset by the SynOffSet value).

13

SynYear10

double

Total kW for year 9 for the large customer (unless

the year is offset by the SynOffSet value).

LGC_109 Turning a large customers load settings on

or off
Use the LGC_109 Model Forge command to turn the load settings for a large customer on a specified section
On or Off. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the specified section, then no edits will be made.

SynType

string

Boolean value indicating whether the load settings for

the large customer will be On or Off.

0 Off

1 On

This field corresponds to the On and Off options on

the Load tab of the Large Customer editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1011

LGC_110 Setting the rated kVA and Pf values for a

larger customer
Use the LGC_110 Model Forge command to set the rated kVA and Pf values for a large customer on a
specified section. This command will set the same value for phases A, B, and C on the large customer. This
command will also apply the edits to all years in the model. If the model is not currently displaying the base
year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the specified section, then no edits will be made.

SynGenKVA

double

Rated kVA value that will be applied to the large

customer.

SynGenPF

double

Rated Pf value that will be applied to the large

customer.

LGC_111 Editing kW values for a large customer

Use the LGC_111 Model Forge command to edit the kW values for phases A, B, and C for a large customer
on a specified section. This command will apply the edits to all years in the model. If the model is not currently
displaying the base year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the section, then no edits will be made.

SynLoadkW_A

double

Phase A kW value that will be applied to the large

customer.

SynLoadkW_B

double

Phase B kW value that will be applied to the large

customer.

SynLoadkW_C

double

Phase C kW value that will be applied to the large

customer.

LGC_112 Editing kvar values for a large customer

Use the LGC_112 Model Forge command to edit the kvar values for phases A, B, and C for a large customer
on a specified section. This command will apply the edits to all years in the model. If the model is not currently
displaying the base year, it will be updated first to display the base year before the edits are applied.

SynerGEE Electric 5.0

User Guide

1012

Model Forge Commands

The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the specified section, then no edits will be made.

SynLoadkvar_A

double

Phase A kvar value that will be applied to the large

customer.

SynLoadkvar_B

double

Phase B kvar value that will be applied to the large

customer.

SynLoadkvar_C

double

Phase C kvar value that will be applied to the large

customer.

LGC_113 Editing customer load values for a large

customer
Use the LGC_113 Model Forge command to edit the customer load values for phases A, B, and C for a large
customer on a specified section. This command will apply the edits to all years in the model. If the model is
not currently displaying the base year, it will be updated first to display the base year before the edits are
applied.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the specified section, then no edits will be made.

SynLoadCust_A

double

Phase A customer load value that will be applied to the

large customer.

SynLoadCust_B

double

Phase B customer load value that will be applied to the

large customer.

SynLoadCust_C

double

Phase C customer load value that will be applied to the

large customer.

LGC_114 Editing connected kVA load values for a

large customer
Use the LGC_114 Model Forge command to edit the connected kVA load values for phases A, B, and C for a
large customer on a specified section. This command will apply the edits to all years in the model. If the
model is not currently displaying the base year, it will be updated first to display the base year before the edits
are applied.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1013

The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the specified section, then no edits will be made.

SynLoadckVA_A

double

Phase A connected kVA load value that will be applied

to the large customer.

SynLoadckVA_B

double

Phase B connected kVA load value that will be applied

to the large customer.

SynLoadckVA_C

double

Phase C connected kVA load value that will be applied

to the large customer.

LGC_115 Editing kW and kvar values for a large

customer for each phase for a specific year
Use the LGC_115 Model Forge command to edit the kW and kvar values for phases A, B, and C for a specific
year for a large customer on a specified section. The inputs for this command are described in the following
table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the section, then no edits will be made.

SynYearNum

long

Year number that the edit will be applied to. Use 0 for
the base year for your model, or 1 through 10 for
each subsequent year.

SynLoadkW_A

double

Phase A kW value that will be applied to the large

customer. Note that this edit will be made to the
specified year only. Previous and subsequent years will
not be modified.

SynLoadkW_B

double

Phase B kW value that will be applied to the large

customer. Note that this edit will be made to the
specified year only. Previous and subsequent years will
not be modified.

SynLoadkW_C

double

Phase C kW value that will be applied to the large

customer. Note that this edit will be made to the
specified year only. Previous and subsequent years will
not be modified.

SynerGEE Electric 5.0

User Guide

1014

Model Forge Commands

Field

Name

Type

Description

SynLoadkvar_A

double

Phase A kvar value that will be applied to the large

customer. Note that this edit will be made to the
specified year only. Previous and subsequent years will
not be modified.

SynLoadkvar_B

double

Phase B kvar value that will be applied to the large

customer. Note that this edit will be made to the
specified year only. Previous and subsequent years will
not be modified.

SynLoadkvar_C

double

Phase C kvar value that will be applied to the large

customer. Note that this edit will be made to the
specified year only. Previous and subsequent years will
not be modified.

LGC_116 Editing the load status for a large customer

Use the LGC_116 Model Forge command to specify whether the load status for a large customer is On, Off,
or Scheduled. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the specified section, then no edits will be made.

SynLoadStatus

string

Load status for the large customer. Specify one of the

following values:

o Off

c Scheduled

Any other value On

This value corresponds to the load status options on the

Load tab of the Large Customer editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1015

LGC_117 Enabling and disabling the distributed

generator on a large customer
Use the LGC_117 Model Forge command to specify whether the distributed generator on a large customer is
turned on or off. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the specified section, then no edits will be made.

SynGenerationIsO
n

Boolean

Boolean value indicating whether the distributed

generator for the large customer is turned On or Off.

0 Off

1 On

This field corresponds to the Generation On check box

on the Generation tab of the Large Customer editor.

LGC_118 Editing the generator type for a large

customer
Use the LGC_118 Model Forge command to edit the generator type for a large customer. The inputs for this
command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the specified section, then no edits will be made.

SynGenType

string

Name of a generator type from your equipment

warehouse that will be applied to the generator. This is
equivalent to selecting the Type option on the
Generation tab of the Large Customer editor.
If the generator type name does not exist in the current
warehouse, then the generator type will be set to
Unknown.

LGC_119 Setting the rated kVA and Pf values for a

large customer
Use the LGC_119 Model Forge command to set the rated kVA values for phases A, B, and C for a large
customer on a specified section, and to also set the Pf for all phases for the large customer. This command

SynerGEE Electric 5.0

User Guide

1016

Model Forge Commands

will apply the edits to all years in the model. If the model is not currently displaying the base year, it will be
updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the large customer

you want to edit. If a large customer does not exist on
the specified section, then no edits will be made.

SynGenKVA_A

double

Rated kVA value that will be applied to phase A for the

large customer.

SynGenKVA_B

double

Rated kVA value that will be applied to phase B for the

large customer.

SynGenKVA_C

double

Rated kVA value that will be applied to phase C for the

large customer.

SynGenPF

double

Rated Pf value that will be applied to the large customer

for phases A, B, and C.

LGC_120 Editing the capacity factor for a large

customer
Use the LGC_120 Model Forge command to edit the capacity factor for a large customer that is identified by
an AMS link. This command will apply the edits to all years in the model. If the model is not currently
displaying the base year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which large customer you want

to edit. The AMS link is specified on the Large Cust tab
of the Large Customer editor.
If a large customer does not exist with the specified
AMS link name, then no edits will be made. If multiple
large customers exist with the same AMS link name,
then only one of those large customers will be updated.

SynCapacityFactor

double

Capacity factor value that will be applied to the large

customer.

LOADS
Refer to the topics listed below for information on the Model Forge commands that are used to edit loads.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1017

LOD_101 Editing a load on page 1017

LOD_103 Editing kVA values for a meters load on page 1017

LOD_104 Editing % pf values for a meters load on page 1018

LOD_105 Setting the override option for a meters load on page 1019

LOD_106 Editing amp values for a meters load on page 1019

LOA_120 Editing connected kVA load values for a sections distributed load on page 1020

LOA_121 Editing kWh values for a sections distributed load on page 1020

LOA_122 Editing the number of customers for a sections distributed load on page 1021

LOA_123 Editing KW values for a sections distributed load on page 1022

LOA_124 Editing kvar values for a sections distributed load on page 1022

LOA_130 Editing connected kVA load values for a sections spot load on page 1023

LOA_131 Editing the number of customers for a sections spot load on page 1023

LOA_132 Editing the description for a sections spot load on page 1024

LOA_133 Enabling/disabling a sections spot load on page 1024

LOA_140 Editing KW values for a sections spot load on page 1025

LOA_141 Editing kvar values for a sections spot load on page 1025

LOA_142 Editing the capacity factor for a sections spot load on page 1026

LOD_101 Editing a load

The LOD_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Loads on page 1016 for a complete list of load Model Forge commands.

LOD_103 Editing kVA values for a meters load

Use the LOD_103 Model Forge command to edit the kVA values for phases A, B, and C for a meter that is
identified by an AMS link. This command will apply the edits to all years in the model. If the model is not
currently displaying the base year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want to edit.

If a meter does not exist with the specified AMS link
name, then no edits will be made. If multiple meters
exist with the same AMS link name, then only one of
those loads will be updated.

SynerGEE Electric 5.0

User Guide

1018

Model Forge Commands

Field

Name

Type

Description

SynPh1Kva

double

kVA value for phase A on the meter. This is equivalent

to editing the first kVA value on the Demands tab of
the Meter editor.

SynPh2Kva

double

kVA value for phase B on the meter. This is equivalent

to editing the second kVA value on the Demands tab
of the Meter editor.

SynPh3Kva

double

kVA value for phase C on the meter. This is equivalent

to editing the third kVA value on the Demands tab of
the Meter editor.

LOD_104 Editing % pf values for a meters load

Use the LOD_104 Model Forge command to edit the % pf values for phases A, B, and C for a meter that is
identified by an AMS link. This command will apply the edits to all years in the model. If the model is not
currently displaying the base year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want to edit.

If a meter does not exist with the specified AMS link
name, then no edits will be made. If multiple meters
exist with the same AMS link name, then only one of
those loads will be updated.

User Guide

SynPh1Pf

double

% pf value for phase A on the meter. This is equivalent

to editing the first % pf value on the Demands tab of
the Meter editor.

SynPh2Pf

double

% pf value for phase B on the meter. This is equivalent

to editing the second % pf value on the Demands tab
of the Meter editor.

SynPh3Pf

double

% pf value for phase C on the meter. This is equivalent

to editing the third % pf value on the Demands tab of
the Meter editor.

SynerGEE Electric 5.0

Model Forge Commands

1019

LOD_105 Setting the override option for a meters

load
Use the LOD_105 Model Forge command to select or clear the Overridden by upstream meters option for a
meter that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want to edit.

If a meter does not exist with the specified AMS link
name, then no edits will be made. If multiple meters
exist with the same AMS link name, then only one of
those loads will be updated.

SynOverridden

Boolean

Boolean value indicating whether the meters override

option will be selected or cleared.

0 Not selected (the metered values will not

be overridden by upstream meters)

1 Selected (the metered values will be

overridden by upstream meters)

This field corresponds to the Overridden by Upstream

Meters check box for on the Demands tab of the Meter
editor.

LOD_106 Editing amp values for a meters load

Use the LOD_106 Model Forge command to edit the amp values for phases A, B, and C for a meter that is
identified by an AMS link. This command will apply the edits to all years in the model. If the model is not
currently displaying the base year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want to edit.

If a meter does not exist with the specified AMS link
name, then no edits will be made. If multiple meters
exist with the same AMS link name, then only one of
those loads will be updated.

SynPh1Amp

double

Amp value for phase A on the meter. This is equivalent

to editing the first Amp value on the Demands tab of
the Meter editor.

SynPh2Amp

double

Amp value for phase B on the meter. This is equivalent

to editing the second Amp value on the Demands tab
of the Meter editor.

SynerGEE Electric 5.0

User Guide

1020

Model Forge Commands

Field
4

Name

Type

Description

SynPh3Amp

double

Amp value for phase C on the meter. This is equivalent

to editing the third Amp value on the Demands tab of
the Meter editor.

LOA_120 Editing connected kVA load values for a

sections distributed load
Use the LOA_120 Model Forge command to edit the connected kVA load values for phases A, B, and C for a
specified sections distributed load. This command will apply the edits to all years in the model. If the model is
not currently displaying the base year, it will be updated first to display the base year before the edits are
applied.
he inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the distributed load

you want to edit. If the specified section does not exist,
then no edits will be made.

SynLoadKva1

double

Total kVA capacity of the transformers on phase A for

the section, excluding spot load connected kVA. This is
equivalent to setting the conn. kVA value for phase A
on the Load - Dist tab of the Section editor.

SynLoadKva2

double

Total kVA capacity of the transformers on phase B for

the section, excluding spot load connected kVA. This is
equivalent to setting the conn. kVA value for phase B
on the Load - Dist tab of the Section editor.

SynLoadKva3

double

Total kVA capacity of the transformers on phase C for

the section, excluding spot load connected kVA. This is
equivalent to setting the conn. kVA value for phase C
on the Load - Dist tab of the Section editor.

LOA_121 Editing kWh values for a sections

distributed load
Use the LOA_121 Model Forge command to edit the kWh values for phases A, B, and C for a specified
sections distributed load. This command will apply the edits to all years in the model. If the model is not
currently displaying the base year, it will be updated first to display the base year before the edits are applied.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1021

The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the distributed load

you want to edit. If the specified section does not exist,
then no edits will be made.

SynLoadKwh1

double

Total peak-month kWh usage in phase A of the section,

excluding spot load kWh. This is equivalent to setting
the conn. kWh value for phase A on the Load - Dist tab
of the Section editor.

SynLoadKwh2

double

Total peak-month kWh usage in phase B of the section,

excluding spot load kWh. This is equivalent to setting
the conn. kWh value for phase B on the Load - Dist tab
of the Section editor.

SynLoadKwh3

double

Total peak-month kWh usage in phase C of the section,

excluding spot load kWh. This is equivalent to setting
the conn. kWh value for phase C on the Load - Dist
tab of the Section editor.

LOA_122 Editing the number of customers for a

sections distributed load
Use the LOA_122 Model Forge command to edit the number of customers for phases A, B, and C for a
specified sections distributed load. This command will apply the edits to all years in the model. If the model is
not currently displaying the base year, it will be updated first to display the base year before the edits are
applied.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the distributed load

you want to edit. If the specified section does not exist,
then no edits will be made.

SynLoadCust1

double

Total number of customers for phase A for the section.

This is equivalent to setting the Customers value for
phase A on the Load - Dist tab of the Section editor.

SynLoadCust2

double

Total number of customers for phase B for the section.

This is equivalent to setting the Customers value for
phase B on the Load - Dist tab of the Section editor.

SynLoadCust3

double

Total number of customers for phase C for the section.

This is equivalent to setting the Customers value for
phase C on the Load - Dist tab of the Section editor.

SynerGEE Electric 5.0

User Guide

1022

Model Forge Commands

LOA_123 Editing KW values for a sections distributed

load
Use the LOA_123 Model Forge command to edit the KW values for phases A, B, and C for a specified
sections distributed load. This command will apply the edits to all years in the model. If the model is not
currently displaying the base year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the distributed load

you want to edit. If the specified section does not exist,
then no edits will be made.

SynLoadKW1

double

Distributed kW load for phase A on the section. This is

equivalent to setting the KW value for phase A on the
Load - Dist tab of the Section editor.

SynLoadKW2

double

Distributed kW load for phase B on the section. This is

equivalent to setting the KW value for phase B on the
Load - Dist tab of the Section editor.

SynLoadKW3

double

Distributed kW load for phase C on the section. This is

equivalent to setting the KW value for phase C on the
Load - Dist tab of the Section editor.

LOA_124 Editing kvar values for a sections

distributed load
Use the LOA_124 Model Forge command to edit the kvar values for phases A, B, and C for a specified
sections distributed load. This command will apply the edits to all years in the model. If the model is not
currently displaying the base year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the distributed load

you want to edit. If the specified section does not exist,
then no edits will be made.

SynLoadKvar1

double

Distributed kvar load for phase A on the section. This is

equivalent to setting the kvar value for phase A on the
Load - Dist tab of the Section editor.

SynLoadKvar2

double

Distributed kvar load for phase B on the section. This is

equivalent to setting the kvar value for phase B on the
Load - Dist tab of the Section editor.

SynerGEE Electric 5.0

Model Forge Commands

Field
4

1023

Name

Type

Description

SynLoadKvar3

double

Distributed kvar load for phase C on the section. This is

equivalent to setting the kvar value for phase C on the
Load - Dist tab of the Section editor.

LOA_130 Editing connected kVA load values for a

sections spot load
Use the LOA_130 Model Forge command to edit the connected kVA load values for phases A, B, and C for a
specified sections spot load. This command will apply the edits to all years in the model. If the model is not
currently displaying the base year, it will be updated first to display the base year before the edits are applied.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the spot load you

want to edit. If the specified section does not exist, then
no edits will be made.

SynLoadKva1

double

Total transformer connected KVA for phase A on the

section. This is equivalent to setting the conn. kVA
value for phase A on the Load - Spot tab of the Section
editor.

SynLoadKva2

double

Total transformer connected KVA for phase B on the

section. This is equivalent to setting the conn. kVA
value for phase B on the Load - Spot tab of the Section
editor.

SynLoadKva3

double

Total transformer connected KVA for phase C on the

section. This is equivalent to setting the conn. kVA
value for phase C on the Load - Spot tab of the Section
editor.

LOA_131 Editing the number of customers for a

sections spot load
Use the LOA_131 Model Forge command to edit the number of customers for phases A, B, and C for a
specified sections spot load. This command will apply the edits to all years in the model. If the model is not
currently displaying the base year, it will be updated first to display the base year before the edits are applied.

SynerGEE Electric 5.0

User Guide

1024

Model Forge Commands

The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the spot load you

want to edit. If the specified section does not exist, then
no edits will be made.

SynLoadCust1

double

Total number of customers for phase A for the section.

This is equivalent to setting the Customers value for
phase A on the Load - Dist tab of the Section editor.

SynLoadCust2

double

Total number of customers for phase B for the section.

This is equivalent to setting the Customers value for
phase B on the Load - Spot tab of the Section editor.

SynLoadCust3

double

Total number of customers for phase C for the section.

This is equivalent to setting the Customers value for
phase C on the Load - Spot tab of the Section editor.

LOA_132 Editing the description for a sections spot

load
Use the LOA_132 Model Forge command to edit the description for a specified sections spot load. The
inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the load you want to

edit. If the specified section does not exist, then no edits
will be made.

SynDesc

string

Description for the sections spot load.

LOA_133 Enabling/disabling a sections spot load

Use the LOA_133 Model Forge command to enable or disable the spot load for a specified section. The
inputs for this command are described in the following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the load you want to

edit. If the specified section does not exist, then no edits
will be made.

SynerGEE Electric 5.0

Model Forge Commands

Field
2

1025

Name

Type

Description

SynIsSpot

Boolean

Boolean value indicating whether the sections spot

load will be enabled or disabled.

0 Disabled

1 Enabled

This field corresponds to the Is On check box for on

the Load - Spot tab of the Section editor.

LOA_140 Editing KW values for a sections spot load

Use the LOA_140 Model Forge command to edit the KW values for phases A, B, and C for the spot load on a
section that is identified by its associated spot load description. This command will apply the edits to all years
in the model. If the model is not currently displaying the base year, it will be updated first to display the base
year before the edits are applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynDesc

string

Spot load description that identifies the section you

want to edit.
If the specified description does not exist for a spot load
description in the model, then no edits will be made. If
multiple sections exist with the same spot load
description, then only one of those sections will be
updated.

SynLoadkW1

double

Total metered kW for phase A for the sections spot

load. This is equivalent to editing the KW value for
phase A on the Load - Spot tab of the Section editor.

SynLoadkW2

double

Total metered kW for phase B for the sections spot

load. This is equivalent to editing the KW value for
phase B on the Load - Spot tab of the Section editor.

SynLoadkW3

double

Total metered kW for phase B for the sections spot

load. This is equivalent to editing the KW value for
phase B on the Load - Spot tab of the Section editor.

LOA_141 Editing kvar values for a sections spot load

Use the LOA_141 Model Forge command to edit the kvar values for phases A, B, and C for the spot load on
a section that is identified by its associated spot load description. This command will apply the edits to all
years in the model. If the model is not currently displaying the base year, it will be updated first to display the
base year before the edits are applied.

SynerGEE Electric 5.0

User Guide

1026

Model Forge Commands

The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynDesc

string

Spot load description that identifies the section you

want to edit.
If the specified description does not exist for a spot load
description in the model, then no edits will be made. If
multiple sections exist with the same spot load
description, then only one of those sections will be
updated.

SynLoadkvar1

double

Total kvar for phase A for the sections spot load. This is
equivalent to editing the kvar value for phase A on the
Load - Spot tab of the Section editor.

SynLoadkvar2

double

Total kvar for phase B for the sections spot load. This is
equivalent to editing the kvar value for phase B on the
Load - Spot tab of the Section editor.

SynLoadkvar3

double

Total kvar for phase B for the sections spot load. This is
equivalent to editing the kvar value for phase B on the
Load - Spot tab of the Section editor.

LOA_142 Editing the capacity factor for a sections

spot load
Use the LOA_142 Model Forge command to edit the capacity factor for the spot load on a section that is
identified by its associated spot load description. This command will apply the edits to all years in the model.
If the model is not currently displaying the base year, it will be updated first to display the base year before the
edits are applied.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynDesc

string

Spot load description that identifies the section you

want to edit.
If the specified description does not exist for a spot load
description in the model, then no edits will be made. If
multiple sections exist with the same spot load
description, then only one of those sections will be
updated.

User Guide

SynCapacityFactor

double

Capacity factor value that will be applied to the sections

spot load.

SynerGEE Electric 5.0

Model Forge Commands

1027

METERS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit meters.

MET_104 Editing a meter on page 1027

MET_105 Creating/editing a meter on page 1027

MET_106 Specifying the location of a meter on page 1028

MET_107 Specifying whether to use demands on a meter on page 1028

MET_108 Editing continuous and emergency current ratings for a meter on page 1029

MET_109 Editing kW values for a meter on page 1029

MET_110 Editing kvar values for a meter on page 1030

MET_111 Editing amp values for a meter on page 1031

MET_112 Editing % pf values for a meter on page 1032

MET_113 Enabling or disabling the Use with Color By Meter feature on page 1033

MET_114 Enabling or disabling the Use with Color By Meter feature and selecting the feature
color on page 1033

MET_115 Editing the note text for a meter on page 1034

MET_116 Opening or closing a meter on page 1035

MET_104 Editing a meter

The MET_104 Model Forge command has been superseded by other, more recent Model Forge commands.
See Meters on page 1027 for a complete list of meter Model Forge commands.

MET_105 Creating/editing a meter

Use the MET_105 Model Forge command to create a meter on a section where a meter does not exist, or
rename the meter if the meter does exist. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a meter or

edit an existing meter name.

SynerGEE Electric 5.0

If a meter already exists on the section, then

the meter name will be updated with the
specified name.

If a meter does not already exist on the

section, then a new meter will be created and
assigned the specified name.

User Guide

1028

Model Forge Commands

Field
2

Name

Type

Description

SynName

string

Name that will be applied to the meter on the

designated section.

MET_106 Specifying the location of a meter

Use the MET_106 Model Forge command to specify whether a meter is located near the from-node or the tonode of a specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the meter you want to

edit. If a meter does not exist on the specified section,
then no edits will be made.

SynFromNode

Boolean

Boolean value indicating whether the meter will be

located near the from-node or the to-node for the
section.

0 To-node end

1 From-node end

This will perform the same task as using SynerGEEs

move device feature to position the meter at either end
of the section. Only one meter can exist on a section.

MET_107 Specifying whether to use demands on a

meter
Use the MET_107 Model Forge command to specify whether or not a meter on a specified section will use
demands. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the meter you want to

edit. If a meter does not exist on the specified section,
then no edits will be made.

SynIsOn

Boolean

Boolean value indicating whether demands will be used

on the specified meter.

0 Demands will be used on the meter

1 Demands will not be used on the meter

This field corresponds to the Do not use demands

check box on the Demands tab of the Meter editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1029

MET_108 Editing continuous and emergency current

ratings for a meter
Use the MET_108 Model Forge command to edit the continuous and emergency current ratings for a meter
on a specified section. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want

to edit. The AMS link is specified on the Meter
tab of the Meter editor.
If a meter does not exist with the specified
AMS link name, then no edits will be made. If
multiple meters exist with the same AMS link
name, then only one of those meters will be
updated.

SynYearNumber

long

Year number that the edit will be applied to.

Use 0 for the base year for your model, or 1
through 10 for each subsequent year.

SynContCurrentRating

double

Continuous current rating that will be applied

to the meter for the designated year. Note that
the edit will be made to the specified year only.
Previous and subsequent years will not be
modified.

SynEmergCurrentRating

double

Emergency current rating that will be applied

to the meter for the designated year. Note that
the edit will be made to the specified year only.
Previous and subsequent years will not be
modified.

MET_109 Editing kW values for a meter

Use the MET_109 Model Forge command to edit the kW values for phases A, B, and C for a meter that is
identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want to edit.

The AMS link is specified on the Meter tab of the Meter
editor.
If a meter does not exist with the specified AMS link
name, then no edits will be made. If multiple meters
exist with the same AMS link name, then only one of
those meters will be updated.

SynerGEE Electric 5.0

User Guide

1030

Model Forge Commands

Field
2

Name

Type

Description

SynYearNumber

long

Year number that the edit will be applied to. Use 0 for
the base year for your model, or 1 through 10 for
each subsequent year.
Only the specified year will be updated. Previous and
subsequent years will retain their original values.

SynMeterPhAkW

double

Phase A kW value that will be applied to the meter for

the designated year. Note that the edit will be made to
the specified year only. Previous and subsequent years
will not be modified.

SynMeterPhBkW

double

Phase B kW value that will be applied to the meter for

the designated year. Note that the edit will be made to
the specified year only. Previous and subsequent years
will not be modified.

SynMeterPhCkW

double

Phase C kW value that will be applied to the meter for

the designated year. Note that the edit will be made to
the specified year only. Previous and subsequent years
will not be modified.

MET_110 Editing kvar values for a meter

Use the MET_110 Model Forge command to edit the kvar values for phases A, B, and C for a meter that is
identified by an AMS link. The inputs for this command described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want to

edit. The AMS link is specified on the Meter tab of
the Meter editor.
If a meter does not exist with the specified AMS link
name, then no edits will be made. If multiple meters
exist with the same AMS link name, then only one
of those meters will be updated.

SynYearNumber

long

Year number that the edit will be applied to. Use 0

for the base year for your model, or 1 through 10
for each subsequent year.
Only the specified year will be updated. Previous
and subsequent years will retain their original
values.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

Field

1031

Name

Type

Description

SynMeterPhAkvar

double

Phase A kvar value that will be applied to the meter

for the designated year. Note that the edit will be
made to the specified year only. Previous and
subsequent years will not be modified.

SynMeterPhBkvar

double

Phase B kvar value that will be applied to the meter

for the designated year. Note that the edit will be
made to the specified year only. Previous and
subsequent years will not be modified.

SynMeterPhCkvar

double

Phase C kvar value that will be applied to the meter

for the designated year. Note that the edit will be
made to the specified year only. Previous and
subsequent years will not be modified.

MET_111 Editing amp values for a meter

Use the MET_111 Model Forge command to edit the amp values for phases A, B, and C for a meter that is
identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want to

edit. The AMS link is specified on the Meter tab of
the Meter editor.
If a meter does not exist with the specified AMS link
name, then no edits will be made. If multiple meters
exist with the same AMS link name, then only one
of those meters will be updated.

SynYearNumber

long

Year number that the edit will be applied to. Use 0

for the base year for your model, or 1 through 10
for each subsequent year.
Only the specified year will be updated. Previous
and subsequent years will retain their original
values.

SynMeterPhAAmps

double

Phase A amp value that will be applied to the meter

for the designated year. Note that the edit will be
made to the specified year only. Previous and
subsequent years will not be modified.

SynMeterPhBAmps

double

Phase B amp value that will be applied to the meter

for the designated year. Note that the edit will be
made to the specified year only. Previous and
subsequent years will not be modified.

SynerGEE Electric 5.0

User Guide

1032

Model Forge Commands

Field
5

Name

Type

Description

SynMeterPhCAmps

double

Phase C amp value that will be applied to the meter

for the designated year. Note that the edit will be
made to the specified year only. Previous and
subsequent years will not be modified.

MET_112 Editing % pf values for a meter

Use the MET_112 Model Forge command to edit the % pf values for phases A, B, and C for a meter that is
identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want to edit.

The AMS link is specified on the Meter tab of the Meter
editor.
If a meter does not exist with the specified AMS link
name, then no edits will be made. If multiple meters
exist with the same AMS link name, then only one of
those meters will be updated.

SynYearNumber

long

Year number that the edit will be applied to. Use 0 for
the base year for your model, or 1 through 10 for
each subsequent year.
Only the specified year will be updated. Previous and
subsequent years will retain their original values.

SynMeterPhAPf

double

Phase A % pf value that will be applied to the meter for

the designated year. Note that the edit will be made to
the specified year only. Previous and subsequent years
will not be modified.

SynMeterPhBPf

double

Phase B % pf value that will be applied to the meter for

the designated year. Note that the edit will be made to
the specified year only. Previous and subsequent years
will not be modified.

SynMeterPhCPf

double

Phase C % pf value that will be applied to the meter for

the designated year.
Note that the edit will be made to the specified year
only. Previous and subsequent years will not be
modified.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1033

MET_113 Enabling or disabling the Use with Color By

Meter feature
Use the MET_113 Model Forge command to enable or disable the Use with Color By Meter feature for a
meter on a specified section. When this option has been selected and the map display's Color By option is
set to Meters, SynerGEE will color all downstream sections with the specified color until another meter is
encountered with this same option enabled, at which point the section coloring will change to the new meter's
designated color.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the meter you want to

edit. If a meter does not exist on the specified section,
then no edits will be made.

SynUseColorBy

Boolean

Boolean value indicating whether the Use with Color

By Meter option will be enabled or disabled on the
specified meter.

0 The Use with Color By Meter option will

be disabled

1 The Use with Color By Meter option will

be enabled

This value corresponds to the Use with Color By Meter

check box on the Meter tab of the Meter editor.

MET_114 Enabling or disabling the Use with Color By

Meter feature and selecting the feature color
Use the MET_114 Model Forge command to enable or disable the Use with Color By Meter feature for a
meter on a specified section, and also to select the color that is used with this feature. When this option has
been selected and the map display's Color By option is set to Meters, SynerGEE will color all downstream
sections with the specified color until another meter is encountered with this same option enabled, at which
point the section coloring will change to the new meter's designated color.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section that contains the meter you want to

edit. If a meter does not exist on the specified section,
then no edits will be made.

SynerGEE Electric 5.0

User Guide

1034

Model Forge Commands

Field
2

Name

Type

Description

SynUseColorBy

Boolean

Boolean value indicating whether the Use with Color

By Meter option will be enabled or disabled on the
specified meter.

0 The Use with Color By Meter option will

be disabled

1 The Use with Color By Meter option will

be enabled

This value corresponds to the Use with Color By Meter

check box on the Meter tab of the Meter editor.
3

SynRGB

string

Color to be applied to the Use with Color By Meter

feature, specified as RGB values. Use a comma to
separate each numerical value, which can have a value
of 0 to 255. For example, the following RGB value will
set the Use with Color By Meter color to yellow:
255,255,0

MET_115 Editing the note text for a meter

Use the MET_115 Model Forge command to edit the note text for a meter that is identified by an AMS link.
The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which meter you want to edit.

The AMS link is specified on the Meter tab of the Meter
editor.
If a meter does not exist with the specified AMS link
name, then no edits will be made. If multiple meters
exist with the same AMS link name, then only one of
those meters will be updated.

User Guide

SynNote

string

Text to be assigned to the Note field for the meter.

SynerGEE Electric 5.0

Model Forge Commands

1035

MET_116 Opening or closing a meter

Use the MET_116 Model Forge command to open or close a meter on a specified section. The inputs for this
command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the meter you want to

edit. If a meter does not exist on the specified section,
then no edits will be made.

SynStatus

Boolean

Boolean value indicating whether the meter status will

be set to Open or Closed.

0 Closed

1 Open

This field corresponds to the Status option on the

Meter tab of the Meter editor.

NODES
Refer to the topics listed below for information on the Model Forge commands that are used to edit nodes.

NOD_101 Editing the X,Y coordinates for a node on page 1035

NOD_102 Editing the description for a node on page 1036

NOD_101 Editing the X,Y coordinates for a node

Use the NOD_101 Model Forge command to edit the X,Y coordinates for a specified node. The inputs for this
command are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the node that you want to edit. If a node does

not exist with the specified name, then no edits will be
made.

SynX

double

X coordinate value for the node.

SynY

double

Y coordinate value for the node.

SynerGEE Electric 5.0

User Guide

1036

Model Forge Commands

NOD_102 Editing the description for a node

Use the NOD_102 Model Forge command to edit the description text for a node. The inputs for this command
are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the node that you want to edit. If a node does

not exist with the specified name, then no edits will be
made.

SynDescription

string

Description text to be assigned to the node. This is

equivalent to editing the Description field on the Node
tab of the Node editor.

PROJECTS
Refer to the topics listed below for information on the Model Forge commands that are used to edit projects.

PRO_101 Editing a project on page 1036

PRO_102 Editing the energize and retire years for a project on page 1037

PRO_103 Editing the total KW and kvar for a project on page 1038

PRO_101 Editing a project

Use the PRO_101 Model Forge command to edit basic settings for a specified project on a specified section.
The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the project you want

to edit.

SynProjName

string

Name of the project you want to edit. If the specified

project does not exist on the specified section, then no
edits will be made.

SynDescription

string

Description for the project.

SynConPhases

string

Connection phases for the project. Specify this value as

a text string that includes the characters A, B, and C.
Acceptable values include A, B, C, AB, BC,
AC, and ABC.

SynerGEE Electric 5.0

Model Forge Commands

Field

1037

Name

Type

Description

SynCode

string

Code for the project. The code value is a secondary

field for organizational use. The code is intended for
smaller, categorical identifiers that may be particularly
useful for sorting and organizing projects in the Project
View window. The code is not used by SynerGEE.

SynEnabled

Boolean

Boolean value indicating whether the project will be

enabled or disabled.

SynLoadMult

double

0 Disabled

1 Enabled

Load multiplier value for the project.

PRO_102 Editing the energize and retire years for a

project
Use the PRO_102 Model Forge command to edit the energize and retire years for a specified project on a
specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the project you want

to edit. If the specified section does not exist, then no
edits will be made.

SynProjName

string

Name of the project you want to edit. If the specified

project does not exist on the specified section, then no
edits will be made.

SynEnergizeYr

long

Number that represents the energize year for the

project. Use 0 for the base year for your model, or 1
through 10 for each subsequent year.

SynRetireYr

long

Number that represents the retire year for the project.

Use 1 through 10 to represent years 1 through 10 for
your model, or use 0 to represent the setting of
Never.

SynerGEE Electric 5.0

User Guide

1038

Model Forge Commands

PRO_103 Editing the total KW and kvar for a project

Use the PRO_103 Model Forge command to edit the total KW and kvar values for a specified project on a
specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the project you want

to edit. If the specified section does not exist, then no
edits will be made.

SynProjName

string

Name of the project you want to edit.

If the specified section does not exist, or the specified
project does not exist on the specified section, then no
edits will be made.

SynTotalkW

double

Total KW value that will be applied to the project for the

designated year. Note that the edit will be made to the
specified year only. Previous and subsequent years will
not be modified.

SynTotalKvar

double

Total kvar value that will be applied to the project for the
designated year. Note that the edit will be made to the
specified year only. Previous and subsequent years will
not be modified.

SynYearNum

long

Year number that the edit will be applied to. Use 0 for
the base year for your model, or 1 through 10 for
each subsequent year.
Only the specified year will be updated; previous and
subsequent years will retain their original values.

RECLOSERS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit reclosers.

REC_101 Editing a recloser on page 1040

REC_102 Creating/editing a recloser on page 1040

REC_103 Specifying the manufacturer name and model name for a recloser on page 1041

REC_104 Editing the amp rating and interrupt rating for a recloser on page 1041

REC_105 Editing the mechanical response type for a recloser on page 1042

REC_106 Editing the single phase operation status for a recloser on page 1042

REC_107 Editing fast phase settings for a recloser on page 1043

REC_108 Editing slow phase settings for a recloser on page 1044

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1039

REC_109 Editing the fast phase pickup amps for a recloser on page 1045

REC_110 Editing the fast phase minimum response value for a recloser on page 1045

REC_111 Editing the phase source side fuse K factor and phase load side fuse K factor for a
recloser on page 1046

REC_112 Editing the disable ground status for a recloser on page 1046

REC_113 Editing fast ground settings for a recloser on page 1047

REC_114 Editing slow ground settings for a recloser on page 1048

REC_115 Editing the fast ground pickup amps for a recloser on page 1049

REC_116 Editing the fast ground minimum response for a recloser on page 1049

REC_117 Editing the ground source side fuse K factor and load side fuse K factor for a recloser
on page 1050

REC_118 Specifying the location of a recloser on page 1050

REC_119 Specifying a manufacturer name, model name, and mechanical response type for a
recloser on page 1051

REC_120 Editing the interrupt rating for a recloser on page 1052

REC_121 Editing the fast phase cutoff and fast ground cutoff for a recloser on page 1052

REC_122 Editing the slow phase cutoff and slow ground cutoff for a recloser on page 1053

REC_123 Editing the slow phase and slow ground pickup amps for a recloser on page 1053

REC_124 Editing fast phase values for a recloser on page 1054

REC_125 Editing slow phase values a recloser on page 1055

REC_126 Editing the fast phase and slow phase pickup amps for a recloser on page 1055

REC_127 Editing fast ground values for a recloser on page 1056

REC_128 Editing slow ground values for a recloser on page 1057

REC_129 Editing the fast ground and slow ground pickup amps for a recloser on page 1057

REC_130 Editing the phasing for a recloser on page 1058

REC_131 Editing the bypass status for a recloser on page 1058

REC_132 Editing the fast phase pickup amps, minimum response, and def time for a recloser on
page 1059

REC_133 Editing fast phase options for a recloser on page 1060

REC_134 Editing the slow phase pickup amps, minimum response, and def time for a recloser
on page 1061

REC_135 Editing slow phase options for a recloser on page 1062

REC_136 Editing the fast ground pickup amps, minimum response, and def time for a recloser
on page 1063

SynerGEE Electric 5.0

User Guide

1040

Model Forge Commands

REC_137 Editing fast ground options for a recloser on page 1064

REC_138 Editing the slow ground pickup amps, minimum response, and def time for a recloser
on page 1065

REC_139 Editing slow ground options for a recloser on page 1066

REC_140 Setting the transfer scheme and operating mode for a recloser on page 1067

REC_141 Editing the disabled ground option for a recloser on page 1068

REC_142 Editing the fast phase cutoff and fast ground cutoff for a recloser on page 1068

REC_143 Editing the slow phase cutoff and slow ground cutoff for a recloser on page 1069

REC_144 Editing the transfer scheme type, transfer scheme delay, and operating mode for a
recloser on page 1069

REC_145 Editing the amp rating for a recloser on page 1070

REC_101 Editing a recloser

The REC_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Reclosers on page 1038 for a complete list of recloser Model Forge commands.

REC_102 Creating/editing a recloser

Use the REC_102 Model Forge command to create a new recloser on a specified section, and also to edit the
name and status for an existing recloser on a specified section. The inputs for this command are described in
the following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section where you want to add a new

recloser or edit an existing recloser.

SynName

string

If a recloser already exists on the section, then

the existing recloser will be updated with the
settings specified in this command.

If a recloser does not already exist on the

section, then a new recloser will be created
and given the settings specified in this
command.

Name that will be applied to the recloser on the

designated section.

SynerGEE Electric 5.0

Model Forge Commands

Field
3

1041

Name

Type

Description

SynStatus

Boolean

Boolean value indicating whether the recloser status will

be set to Open or Closed.

0 Closed

1 Open

This field corresponds to the Status option on the

Recloser tab of the Recloser editor.

REC_103 Specifying the manufacturer name and

model name for a recloser
Use the REC_103 Model Forge command to specify the manufacturer and model for a recloser on a section
that is identified by its associated section name. The inputs for this command are described in the following
table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser you want

to edit. If a recloser does not exist on the specified
section, then no edits will be made.

SynManufacturer

string

Manufacturer name for the recloser.

SynModel

string

Model name for the recloser.

REC_104 Editing the amp rating and interrupt rating

for a recloser
Use the REC_104 Model Forge command edit specify the amp rating and interrupt rating for a recloser on a
section that is identified by its associated section name. The inputs for this command are described in the
following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser you want

to edit. If a recloser does not exist on the specified
section, then no edits will be made.

SynRating

double

Amp rating for the recloser. This is equivalent to setting

the Amp Rating option on the Recloser tab of the
Recloser editor.

SynInterrupt

double

Interrupt rating for the recloser. This is equivalent to

setting the Interrupt Rating option on the Recloser tab
of the Recloser editor.

SynerGEE Electric 5.0

User Guide

1042

Model Forge Commands

REC_105 Editing the mechanical response type for a

recloser
Use the REC_105 Model Forge command to edit the mechanical response type for a recloser that is
identified by its associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser you

want to edit. If a recloser does not exist on the
specified section, then no edits will be made.

SynMechResponse

string

Mechanical response type for the recloser. You

must specify an exact match to one of the available
options on the Recloser tab of the Recloser editor.
Otherwise, the mechanical response type will be
set to Unknown.

REC_106 Editing the single phase operation status for

a recloser
Use the REC_106 Model Forge command to enable or disable the single phase operation status on a
recloser that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you want to edit.

The AMS link is specified on the Rates tab of the
Recloser editor.
If a recloser does not exist with the specified AMS link
name, then no edits will be made. If multiple reclosers
exist with the same AMS link name, then only one of
those reclosers will be updated.

Syn1PhaseOp

Boolean

Boolean value indicating whether the single phase

operation status will be enabled or disabled.

0 Disabled

1 Enabled

This field corresponds to the Single Phase Operation

check box on the Recloser tab of the Recloser editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1043

REC_107 Editing fast phase settings for a recloser

Use the REC_107 Model Forge command to edit fast phase values for a recloser that is identified by an AMS
link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynFastPhaseCurve

string

Curve type for the reclosers fast phase

settings. This is equivalent to editing the
Curve option for the fast phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastPhaseCount

long

Count value for the reclosers fast phase

settings. This is equivalent to editing the
Count option for the fast phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastPhaseMultiplier

double

Multiplier value for the reclosers fast phase

settings. This is equivalent to editing the
Multiplier option for the fast phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastPhaseAdder

double

Adder value for the reclosers fast phase

settings. This is equivalent to editing the
Adder. option for the fast phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynerGEE Electric 5.0

User Guide

1044

Model Forge Commands

REC_108 Editing slow phase settings for a recloser

Use the REC_108 Model Forge command to edit slow phase values for a recloser that is identified by an
AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

User Guide

SynSlowPhaseCurve

string

Curve type for the reclosers slow phase

settings. This is equivalent to editing the
Curve option for the slow phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynSlowPhaseCount

long

Count value for the reclosers slow phase

settings. This is equivalent to editing the
Count option for the slow phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynSlowPhaseMultiplier

double

Multiplier value for the reclosers slow phase

settings. This is equivalent to editing the
Multiplier option for the slow phase settings
on both the Primary tab and Alternate tab of
the Recloser editor.

SynSlowPhaseAdder

double

Adder value for the reclosers slow phase

settings. This is equivalent to editing the
Adder. option for the slow phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1045

REC_109 Editing the fast phase pickup amps for a

recloser
Use the REC_109 Model Forge command to edit the fast phase pickup amps for a recloser that is identified
by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynPhasePickupAmps

double

Pickup amps value for the reclosers fast

phase settings. This is equivalent to editing the
Pickup option for the fast phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

REC_110 Editing the fast phase minimum response

value for a recloser
Use the REC_110 Model Forge command to edit the fast phase minimum response value for a recloser that
is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynPhaseMinResponse

SynerGEE Electric 5.0

double

Minimum response value for the reclosers fast

phase settings. This is equivalent to editing the
Min. resp. option for the fast phase settings
on both the Primary tab and Alternate tab of
the Recloser editor.

User Guide

1046

Model Forge Commands

REC_111 Editing the phase source side fuse K factor

and phase load side fuse K factor for a recloser
Use the REC_111 Model Forge command to edit the phase source side fuse K factor and phase load side
fuse K factor for a recloser that is identified by an AMS link. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynPhaseSourceKFactor

double

Source side fuse K factor for the reclosers

phase settings. This is equivalent to editing the
Phase: Source Side Fuse option on the
Setup tab of the Recloser editor.

SynPhaseLoadKFactor

double

Load side fuse K factor for the reclosers

phase settings. This is equivalent to editing the
Phase: Load Side Fuse option on the Setup
tab of the Recloser editor.

REC_112 Editing the disable ground status for a

recloser
Use the REC_112 Model Forge command to enable or disable the ground settings of a recloser that is
identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you want to

edit. The AMS link is specified on the Rates tab of
the Recloser editor.
If a recloser does not exist with the specified AMS
link name, then no edits will be made. If multiple
reclosers exist with the same AMS link name, then
only one of those reclosers will be updated.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

Field
2

1047

Name

Type

Description

SynGroundDisabled

Boolean

Boolean value indicating whether the reclosers

disable ground status will be selected, thus
preventing the display of ground curves in the TCC
view and curve legend. Setting the disable ground
status will also disable the Ground settings on the
Primary and Alternate tabs of the Recloser editor.

0 Disabled

1 Enabled

This field corresponds to the Disable Ground

check box on the Recloser tab of the Recloser
editor.

REC_113 Editing fast ground settings for a recloser

Use the REC_113 Model Forge command to edit fast ground values for a recloser that is identified by an
AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynFastGroundCurve

string

Curve type for the reclosers fast ground

settings. This is equivalent to editing the
Curve option for the fast ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastGroundCount

long

Count value for the reclosers fast ground

settings. This is equivalent to editing the
Count option for the fast ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastGroundMultiplier

double

Multiplier value for the reclosers fast ground

settings. This is equivalent to editing the
Multiplier option for the fast ground settings
on both the Primary tab and Alternate tab of
the Recloser editor.

SynerGEE Electric 5.0

User Guide

1048

Model Forge Commands

Field
5

Name

Type

Description

SynFastGroundAdder

double

Adder value for the reclosers fast ground

settings. This is equivalent to editing the
Adder. option for the fast ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

REC_114 Editing slow ground settings for a recloser

Use the REC_114 Model Forge command to edit slow ground values for a recloser that is identified by an
AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

User Guide

SynSlowGroundCurve

string

Curve type for the reclosers slow ground

settings. This is equivalent to editing the
Curve option for the slow ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynSlowGroundCount

long

Count value for the reclosers slow ground

settings. This is equivalent to editing the
Count option for the slow ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynSlowGroundMultiplier

double

Multiplier value for the reclosers slow ground

settings. This is equivalent to editing the
Multiplier option for the slow ground settings
on both the Primary tab and Alternate tab of
the Recloser editor.

SynSlowGroundAdder

double

Adder value for the reclosers slow ground

settings. This is equivalent to editing the
Adder. option for the slow ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1049

REC_115 Editing the fast ground pickup amps for a

recloser
Use the REC_115 Model Forge command to edit the fast ground pickup amps for a recloser that is identified
by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynGroundPickupAmps

double

Pickup amps value for the reclosers fast

ground settings. This is equivalent to editing
the Pickup option for the fast ground settings
on both the Primary tab and Alternate tab of
the Recloser editor.

REC_116 Editing the fast ground minimum response

for a recloser
Use the REC_116 Model Forge command to edit the fast ground minimum response value for a recloser that
is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynGroundMinResponse

SynerGEE Electric 5.0

double

Minimum response value for the reclosers fast

ground settings. This is equivalent to editing
the Min. resp. option for the fast ground
settings on both the Primary tab and Alternate
tab of the Recloser editor.

User Guide

1050

Model Forge Commands

REC_117 Editing the ground source side fuse K factor

and load side fuse K factor for a recloser
Use the REC_117 Model Forge command to edit the ground source side fuse K factor and ground load side
fuse K factor for a recloser that is identified by an AMS link. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynGroundSourceKFactor

double

Source side fuse K factor for the reclosers

ground settings. This is equivalent to editing
the Ground: Source Side Fuse option on the
Setup tab of the Recloser editor.

SynGroundLoadKFactor

double

Load side fuse K factor for the reclosers

ground settings. This is equivalent to editing
the Ground: Load Side Fuse option on the
Setup tab of the Recloser editor.

REC_118 Specifying the location of a recloser

Use the REC_118 Model Forge command to specify whether a recloser is located near the from-node or the
to-node of a specified section. The inputs for this command are described in the following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the recloser you want

to edit. If a recloser does not exist on the specified
section, then no edits will be made.

SynerGEE Electric 5.0

Model Forge Commands

Field
2

1051

Name

Type

Description

SynFromNode

Boolean

Boolean value indicating whether the recloser will be

located near the from-node or the to-node of the
section.

0 To-node end

1 From-node end

This will perform the same task as using SynerGEEs

move device feature to position the recloser at either
end of the section. Only one recloser can exist on a
section.

REC_119 Specifying a manufacturer name, model

name, and mechanical response type for a recloser
Use the REC_119 Model Forge command to specify the manufacturer and model for a recloser on a section
that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you want to

edit. The AMS link is specified on the Rates tab of
the Recloser editor.
If a recloser does not exist with the specified AMS
link name, then no edits will be made. If multiple
reclosers exist with the same AMS link name, then
only one of those reclosers will be updated.

SynManufacturer

string

Manufacturer name for the recloser.

SynModel

string

Model name for the recloser.

SynMechResponse

string

Mechanical response type for the recloser. You

must specify an exact match to one of the available
options on the Recloser tab of the Recloser editor.
Otherwise, the mechanical response type will be
set to Unknown.

SynerGEE Electric 5.0

User Guide

1052

Model Forge Commands

REC_120 Editing the interrupt rating for a recloser

Use the REC_120 Model Forge command to edit the interrupt rating for a recloser that is identified by an
AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you want to edit.

The AMS link is specified on the Rates tab of the
Recloser editor.
If a recloser does not exist with the specified AMS link
name, then no edits will be made. If multiple reclosers
exist with the same AMS link name, then only one of
those reclosers will be updated.

SynInterrupt

double

Interrupt rating for the recloser. This is equivalent to

setting the Interrupt Rating value on the Recloser tab
of the Recloser editor.

REC_121 Editing the fast phase cutoff and fast ground

cutoff for a recloser
Use the REC_121 Model Forge command to edit the fast phase cutoff and fast ground cutoff values for a
recloser that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you want to edit.

The AMS link is specified on the Rates tab of the
Recloser editor.
If a recloser does not exist with the specified AMS link
name, then no edits will be made. If multiple reclosers
exist with the same AMS link name, then only one of
those reclosers will be updated.

User Guide

SynFastPhCutOff

double

Cutoff amps value for the reclosers fast phase setting.

This is equivalent to editing the Cutoff option for the
fast phase setting on both the Primary tab and the
Alternate tab of the Recloser editor.

SynFastGrCutOff

double

Cutoff amps value for the reclosers fast ground setting.

This is equivalent to editing the Cutoff option for the
fast ground setting on both the Primary tab and the
Alternate tab of the Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1053

REC_122 Editing the slow phase cutoff and slow

ground cutoff for a recloser
Use the REC_122 Model Forge command to edit the slow phase cutoff and fast slow cutoff values for a
recloser that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you want to edit.

The AMS link is specified on the Rates tab of the
Recloser editor.
If a recloser does not exist with the specified AMS link
name, then no edits will be made. If multiple reclosers
exist with the same AMS link name, then only one of
those reclosers will be updated.

SynSlowPhCutOff

double

Cutoff amps value for the reclosers slow phase setting.

This is equivalent to editing the Cutoff option for the
slow phase setting on both the Primary tab and the
Alternate tab of the Recloser editor.

SynSlowGrCutOff

double

Cutoff amps value for the reclosers slow ground

setting. This is equivalent to editing the Cutoff option
for the slow ground setting on both the Primary tab and
the Alternate tab of the Recloser editor.

REC_123 Editing the slow phase and slow ground

pickup amps for a recloser
Use the REC_123 Model Forge command to edit the slow phase and slow ground pickup amps for a recloser
that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynerGEE Electric 5.0

User Guide

1054

Model Forge Commands

Field

Name

Type

Description

SynSlowPhPickupAmps

double

Pickup amps value for the reclosers slow

phase setting. This is equivalent to editing the
Pickup option for the slow phase ground
setting on both the Primary tab and Alternate
tab of the Recloser editor.

SynSlowGrPickupAmps

double

Pickup amps value for the reclosers slow

ground setting. This is equivalent to editing the
Pickup option for the slow ground setting on
both the Primary tab and Alternate tab of the
Recloser editor.

REC_124 Editing fast phase values for a recloser

Use the REC_124 Model Forge command to edit fast phase values for a recloser that is identified by its
associated section name. The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the recloser

you want to edit. If a recloser does not exist on
the specified section, then no edits will be
made.

SynFastPhaseCurve

string

Curve type for the reclosers fast phase

settings. This is equivalent to editing the
Curve option for the fast phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastPhaseCount

long

Count value for the reclosers fast phase

settings. This is equivalent to editing the
Count option for the fast phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastPhaseMultiplier

double

Multiplier value for the reclosers fast phase

settings. This is equivalent to editing the
Multiplier option for the fast phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastPhaseAdder

double

Adder value for the reclosers fast phase

settings. This is equivalent to editing the
Adder. option for the fast phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1055

REC_125 Editing slow phase values a recloser

Use the REC_125 Model Forge command to edit slow phase values for a recloser that is identified by its
associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser

you want to edit. If a recloser does not exist on
the specified section, then no edits will be
made.

SynSlowPhaseCurve

string

Curve type for the reclosers slow phase

settings. This is equivalent to editing the
Curve option for the slow phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynSlowPhaseCount

long

Count value for the reclosers slow phase

settings. This is equivalent to editing the
Count option for the slow phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynSlowPhaseMultiplier

double

Multiplier value for the reclosers slow phase

settings. This is equivalent to editing the
Multiplier option for the slow phase settings
on both the Primary tab and Alternate tab of
the Recloser editor.

SynSlowPhaseAdder

double

Adder value for the reclosers slow phase

settings. This is equivalent to editing the
Adder. option for the slow phase settings on
both the Primary tab and Alternate tab of the
Recloser editor.

REC_126 Editing the fast phase and slow phase

pickup amps for a recloser
Use the REC_126 Model Forge command to edit the fast phase and slow phase pickup amps for a recloser
that is identified by its associated section name. The inputs for this command are described in the following
table.
Field
1

Name

Type

Description

SynSect

string

Name of the section that contains the recloser

you want to edit. If a recloser does not exist on
the specified section, then no edits will be
made.

SynerGEE Electric 5.0

User Guide

1056

Model Forge Commands

Field
2

Name

Type

Description

SynPhasePickupAmps

double

Pickup amps value for the reclosers fast and

slow phase settings. This is equivalent to
editing the Pickup option for both the fast and
slow phase settings on the Primary tab of the
Recloser editor.

REC_127 Editing fast ground values for a recloser

Use the REC_127 Model Forge command to edit fast ground values for a recloser that is identified by its
associated section name. The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the recloser

you want to edit. If a recloser does not exist on
the specified section, then no edits will be
made.

SynFastGroundCurve

string

Curve type for the reclosers fast ground

settings. This is equivalent to editing the
Curve option for the fast ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastGroundCount

long

Count value for the reclosers fast ground

settings. This is equivalent to editing the
Count option for the fast ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynFastGroundMultiplier

double

Multiplier value for the reclosers fast ground

settings. This is equivalent to editing the
Multiplier option for the fast ground settings
on both the Primary tab and Alternate tab of
the Recloser editor.

SynFastGroundAdder

double

Adder value for the reclosers fast ground

settings. This is equivalent to editing the
Adder. option for the fast ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1057

REC_128 Editing slow ground values for a recloser

Use the REC_128 Model Forge command to edit slow ground values for a recloser that is identified by its
associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser

you want to edit. If a recloser does not exist on
the specified section, then no edits will be
made.

SynSlowGroundCurve

string

Curve type for the reclosers slow ground

settings. This is equivalent to editing the
Curve option for the slow ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynSlowGroundCount

long

Count value for the reclosers slow ground

settings. This is equivalent to editing the
Count option for the slow ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

SynSlowGroundMultiplier

double

Multiplier value for the reclosers slow ground

settings. This is equivalent to editing the
Multiplier option for the slow ground settings
on both the Primary tab and Alternate tab of
the Recloser editor.

SynSlowGroundAdder

double

Adder value for the reclosers slow ground

settings. This is equivalent to editing the
Adder. option for the slow ground settings on
both the Primary tab and Alternate tab of the
Recloser editor.

REC_129 Editing the fast ground and slow ground

pickup amps for a recloser
Use the REC_129 Model Forge command to edit the fast ground and slow ground pickup amps for a recloser
that is identified by its associated section name. The inputs for this command are described in the following
table.
Field
1

Name

Type

Description

SynSect

string

Name of the section that contains the recloser

you want to edit. If a recloser does not exist on
the specified section, then no edits will be
made.

SynerGEE Electric 5.0

User Guide

1058

Model Forge Commands

Field
2

Name

Type

Description

SynGroundPickupAmps

double

Pickup amps value for the reclosers fast and

slow ground settings. This is equivalent to
editing the Pickup option for both the fast and
slow ground settings on the Primary tab of the
Recloser editor.

REC_130 Editing the phasing for a recloser

Use the REC_130 Model Forge command to edit the phasing for a recloser that is identified by its associated
section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser you want

to edit. If a recloser does not exist on the specified
section, then no edits will be made.

SynPhasing

string

Connection phase that will be applied to the recloser.

Specify this value as a text string that includes the
characters A, B, and C. Acceptable values include A,
B, C, AB, BC, AC, and ABC.

REC_131 Editing the bypass status for a recloser

Use the REC_131 Model Forge command to enable or disable the bypass status for a recloser that is
identified by its associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser you want

to edit. If a recloser does not exist on the specified
section, then no edits will be made.

SynIsBypassed

Boolean

Boolean value indicating whether the recloser will be

bypassed. When a recloser is bypassed SynerGEE will
ignore the operational capability of the recloser during
check coordination analysis, reliability analysis, and
other applications.

0 Not bypassed

1 Bypassed

This field corresponds to the Bypass check box on the

Recloser tab of the Recloser editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1059

REC_132 Editing the fast phase pickup amps,

minimum response, and def time for a recloser
Use the REC_132 Model Forge command to edit the fast phase pickup amps, minimum response value, and
def time value for a recloser that is identified by an AMS link. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on
the Rates tab of the Recloser editor.
If a recloser does not exist with the
specified AMS link name, then no edits
will be made. If multiple reclosers exist
with the same AMS link name, then only
one of those reclosers will be updated.

SynFastPhasePickupAmps

double

Pickup amps value for the reclosers fast

phase setting. This is equivalent to editing
the Pickup option for the fast phase
setting on the Primary tab of the Recloser
editor.

SynFastPhaseMinResponse

double

Minimum response value for the

reclosers fast phase settings. This is
equivalent to editing the Min. resp.
option for the fast phase settings on the
Primary tab of the Recloser editor.

SynFastPhaseDefTime

double

Def Time value for the reclosers fast

phase settings. This is equivalent to
editing the Def. Time option for the fast
phase settings on the Primary tab of the
Recloser editor.

SynerGEE Electric 5.0

User Guide

1060

Model Forge Commands

REC_133 Editing fast phase options for a recloser

Use the REC_133 Model Forge command to edit fast phase options for a recloser that is identified by an
AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on
the Rates tab of the Recloser editor.
If a recloser does not exist with the
specified AMS link name, then no edits
will be made. If multiple reclosers exist
with the same AMS link name, then only
one of those reclosers will be updated.

SynFastPhaseActiveInst

Boolean

Boolean value indicating whether the fast

phase instantaneous options will be made
active.

0 Inactive

1 Active

This field corresponds to the Active Inst

check box for the fast phase settings on
the Primary tab of the Recloser editor.

User Guide

SynFastPhaseInst

double

Fast phase instantaneous delay time for

the recloser. This is equivalent to editing
the Inst (s) value for the fast phase
settings on the Primary tab of the
Recloser editor.

SynFastPhaseInstAmps

double

Fast phase instantaneous pickup amps

for the recloser. This is equivalent to
editing the Inst (A) value for the fast
phase settings on the Primary tab of the
Recloser editor.

SynFastPhaseMinResponse

double

Minimum response value for the

reclosers fast phase settings. This is
equivalent to editing the Min. resp.
option for the fast phase settings on the
Primary tab of the Recloser editor.

SynFastPhaseDefTime

double

Def Time value for the reclosers fast

phase settings. This is equivalent to
editing the Def. Time option for the fast
phase settings on the Primary tab of the
Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1061

REC_134 Editing the slow phase pickup amps,

minimum response, and def time for a recloser
Use the REC_134 Model Forge command to edit the slow phase pickup amps, minimum response value, and
def time value for a recloser that is identified by an AMS link. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on
the Rates tab of the Recloser editor.
If a recloser does not exist with the
specified AMS link name, then no edits
will be made. If multiple reclosers exist
with the same AMS link name, then only
one of those reclosers will be updated.

SynSlowPhasePickupAmps

double

Pickup amps value for the reclosers slow

phase setting. This is equivalent to editing
the Pickup option for the slow phase
setting on the Primary tab of the Recloser
editor.

SynSlowPhaseMinResponse

double

Minimum response value for the

reclosers slow phase settings. This is
equivalent to editing the Min. resp.
option for the slow phase settings on the
Primary tab of the Recloser editor.

SynSlowPhaseDefTime

double

Def Time value for the reclosers slow

phase settings. This is equivalent to
editing the Def. Time option for the slow
phase settings on the Primary tab of the
Recloser editor.

SynerGEE Electric 5.0

User Guide

1062

Model Forge Commands

REC_135 Editing slow phase options for a recloser

Use the REC_135 Model Forge command to edit slow phase options for a recloser that is identified by an
AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on
the Rates tab of the Recloser editor.
If a recloser does not exist with the
specified AMS link name, then no edits
will be made. If multiple reclosers exist
with the same AMS link name, then only
one of those reclosers will be updated.

SynSlowPhaseActiveInst

Boolean

Boolean value indicating whether the slow

phase instantaneous options will be made
active.

0 Active

1 Inactive

This field corresponds to the Active Inst

check box for the slow phase settings on
the Primary tab of the Recloser editor.

User Guide

SynSlowPhaseInst

double

Slow phase instantaneous delay time for

the recloser. This is equivalent to editing
the Inst (s) value for the slow phase
settings on the Primary tab of the
Recloser editor.

SynSlowPhaseInstAmps

double

Slow phase instantaneous pickup amps

for the recloser. This is equivalent to
editing the Inst (A) value for the slow
phase settings on the Primary tab of the
Recloser editor.

SynSlowPhaseMinResponse

double

Minimum response value for the

reclosers slow phase settings. This is
equivalent to editing the Min. resp.
option for the slow phase settings on the
Primary tab of the Recloser editor.

SynSlowPhaseDefTime

double

Def Time value for the reclosers sow

phase settings. This is equivalent to
editing the Def. Time option for the slow
phase settings on the Primary tab of the
Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1063

REC_136 Editing the fast ground pickup amps,

minimum response, and def time for a recloser
Use the REC_136 Model Forge command to edit the fast ground pickup amps, minimum response value, and
def time value for a recloser that is identified by an AMS link. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on
the Rates tab of the Recloser editor.
If a recloser does not exist with the
specified AMS link name, then no edits
will be made. If multiple reclosers exist
with the same AMS link name, then only
one of those reclosers will be updated.

SynFastGroundPickupAmps

double

Pickup amps value for the reclosers fast

ground setting. This is equivalent to
editing the Pickup option for the fast
ground setting on the Primary tab of the
Recloser editor.

SynFastGroundMinResponse

double

Minimum response value for the

reclosers fast ground settings. This is
equivalent to editing the Min. resp.
option for the fast ground settings on the
Primary tab of the Recloser editor.

SynFastGroundDefTime

double

Def Time value for the reclosers fast

ground settings. This is equivalent to
editing the Def. Time option for the fast
ground settings on the Primary tab of the
Recloser editor.

SynerGEE Electric 5.0

User Guide

1064

Model Forge Commands

REC_137 Editing fast ground options for a recloser

Use the REC_137 Model Forge command to edit fast ground options for a recloser that is identified by an
AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on
the Rates tab of the Recloser editor.
If a recloser does not exist with the
specified AMS link name, then no edits
will be made. If multiple reclosers exist
with the same AMS link name, then only
one of those reclosers will be updated.

SynFastGroundActiveInst

Boolean

Boolean value indicating whether the fast

ground instantaneous options will be
made active.

0 Active

1 Inactive

This field corresponds to the Active Inst

check box for the fast ground settings on
the Primary tab of the Recloser editor.

User Guide

SynFastGroundInst

double

Fast ground instantaneous delay time for

the recloser. This is equivalent to editing
the Inst (s) value for the fast ground
settings on the Primary tab of the
Recloser editor.

SynFastGroundInstAmps

double

Fast phase instantaneous pickup amps

for the recloser. This is equivalent to
editing the Inst (A) value for the fast
ground settings on the Primary tab of the
Recloser editor.

SynFastGroundMinResponse

double

Minimum response value for the

reclosers fast ground settings. This is
equivalent to editing the Min. resp.
option for the fast ground settings on the
Primary tab of the Recloser editor.

SynFastGroundDefTime

double

Def Time value for the reclosers fast

ground settings. This is equivalent to
editing the Def. Time option for the fast
ground settings on the Primary tab of the
Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1065

REC_138 Editing the slow ground pickup amps,

minimum response, and def time for a recloser
Use the REC_138 Model Forge command to edit the slow ground pickup amps, minimum response value,
and def time value for a recloser that is identified by an AMS link. The inputs for this command are described
in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on
the Rates tab of the Recloser editor.
If a recloser does not exist with the
specified AMS link name, then no edits
will be made. If multiple reclosers exist
with the same AMS link name, then only
one of those reclosers will be updated.

SynSlowGroundPickupAmps

double

Pickup amps value for the reclosers slow

ground setting. This is equivalent to
editing the Pickup option for the slow
ground setting on the Primary tab of the
Recloser editor.

SynSlowGroundMinResponse

double

Minimum response value for the

reclosers slow ground settings. This is
equivalent to editing the Min. resp.
option for the slow ground settings on the
Primary tab of the Recloser editor.

SynSlowGroundDefTime

double

Def Time value for the reclosers slow

ground settings. This is equivalent to
editing the Def. Time option for the slow
ground settings on the Primary tab of the
Recloser editor.

SynerGEE Electric 5.0

User Guide

1066

Model Forge Commands

REC_139 Editing slow ground options for a recloser

Use the REC_139 Model Forge command to edit slow ground options for a recloser that is identified by an
AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on
the Rates tab of the Recloser editor.
If a recloser does not exist with the
specified AMS link name, then no edits
will be made. If multiple reclosers exist
with the same AMS link name, then only
one of those reclosers will be updated.

SynSlowGroundActiveInst

Boolean

Boolean value indicating whether the slow

ground instantaneous options will be
made active.

0 Active

1 Inactive

This field corresponds to the Active Inst

check box for the slow ground settings on
the Primary tab of the Recloser editor.

User Guide

SynSlowGroundInst

double

Slow ground instantaneous delay time for

the recloser. This is equivalent to editing
the Inst (s) value for the fast phase
settings on the Primary tab of the
Recloser editor.

SynSlowGroundInstAmps

double

Slow ground instantaneous pickup amps

for the recloser. This is equivalent to
editing the Inst (A) value for the fast
phase settings on the Primary tab of the
Recloser editor.

SynSlowGroundMinResponse

double

Minimum response value for the

reclosers slow ground settings. This is
equivalent to editing the Min. resp.
option for the slow ground settings on the
Primary tab of the Recloser editor.

SynSlowGroundDefTime

double

Def Time value for the reclosers slow

ground settings. This is equivalent to
editing the Def. Time option for the slow
ground settings on the Primary tab of the
Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1067

REC_140 Setting the transfer scheme and operating

mode for a recloser
Use the REC_140 Model Forge command to set the transfer scheme, transfer scheme delay, and operating
mode for a recloser that is identified by an AMS link. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you

want to edit. The AMS link is specified on the
Rates tab of the Recloser editor.
If a recloser does not exist with the specified
AMS link name, then no edits will be made. If
multiple reclosers exist with the same AMS link
name, then only one of those reclosers will be
updated.

SynTranSchemeType

string

Text string that identifies the transfer scheme

for the recloser. Specify one of the following
values:

NON Non-transfer

SCZ Sectionalizing

MID Mid-Point

TIE Tie

SynTranSchemeDelaySec

double

Transfer scheme delay for the recloser.

SynOperMode

string

Operating mode for the recloser. Specify one

of the following values:

SynerGEE Electric 5.0

Pri Primary

Alt Alternate

F2T Auto (From - To)

T2F Auto (To - From)

Saf Safety / Hot work

User Guide

1068

Model Forge Commands

REC_141 Editing the disabled ground option for a

recloser
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser you

want to edit. If a recloser does not exist on the
specified section, then no edits will be made.

SynGroundDisabled

Boolean

Boolean value indicating whether the reclosers

disable ground status will be selected, thus
preventing the display of ground curves in the TCC
view and curve legend. Setting the disable ground
status will also disable the Ground settings on the
Primary and Alternate tabs of the Recloser editor.

0 Disable ground status is not selected

1 Disable ground status is selected

This field corresponds to the Disable Ground

check box on the Recloser tab of the Recloser
editor.

REC_142 Editing the fast phase cutoff and fast ground

cutoff for a recloser
Use the REC_142 Model Forge command to edit the fast phase cutoff and fast ground cutoff values for a
recloser that is identified by its associated section name. The inputs for this command are described in the
following table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the recloser you want

to edit. If a recloser does not exist on the specified
section, then no edits will be made.

SynFastPhCutOff

double

Cutoff amps value for the reclosers fast phase setting.

This is equivalent to editing the Cutoff option for the
fast phase setting on both the Primary tab and the
Alternate tab of the Recloser editor.

SynFastGrCutOff

double

Cutoff amps value for the reclosers fast ground setting.

This is equivalent to editing the Cutoff option for the
fast ground setting on both the Primary tab and the
Alternate tab of the Recloser editor.

SynerGEE Electric 5.0

Model Forge Commands

1069

REC_143 Editing the slow phase cutoff and slow

ground cutoff for a recloser
Use the REC_143 Model Forge command to edit the slow phase cutoff and slow ground cutoff values for a
recloser that is identified by its associated section name. The inputs for this command are described in the
following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser you want

to edit. If a recloser does not exist on the specified
section, then no edits will be made.

SynSlowPhCutOff

double

Cutoff amps value for the reclosers slow phase setting.

This is equivalent to editing the Cutoff option for the
slow phase setting on both the Primary tab and the
Alternate tab of the Recloser editor.

SynSlowGrCutOff

double

Cutoff amps value for the reclosers slow ground

setting. This is equivalent to editing the Cutoff option
for the slow ground setting on both the Primary tab and
the Alternate tab of the Recloser editor.

REC_144 Editing the transfer scheme type, transfer

scheme delay, and operating mode for a recloser
Use the REC_144 Model Forge command to set the transfer scheme, transfer scheme delay, and operating
mode for a recloser that is identified by its associated section name. The inputs for this command are
described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the recloser

you want to edit. If a recloser does not exist on
the specified section, then no edits will be
made.

SynTranSchemeType

string

Text string that identifies the transfer scheme

for the recloser. Specify one of the following
values:

SynTranSchemeDelaySec

SynerGEE Electric 5.0

double

NON Non-transfer

SCZ Sectionalizing

MID Mid-Point

TIE Tie

Transfer scheme delay for the recloser.

User Guide

1070

Model Forge Commands

Field
4

Name

Type

Description

SynOperMode

string

Operating mode for the recloser. Specify one

of the following values:

Pri Primary

Alt Alternate

F2T Auto (From - To)

T2F Auto (To - From)

Saf Safety / Hot work

REC_145 Editing the amp rating for a recloser

Use the REC_145 Model Forge command to edit the amp rating for a recloser that is identified by an AMS
link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which recloser you want to edit.

The AMS link is specified on the Rates tab of the
Recloser editor.
If a recloser does not exist with the specified AMS link
name, then no edits will be made. If multiple reclosers
exist with the same AMS link name, then only one of
those reclosers will be updated.

SynAmpRating

string

Amp rating for the recloser. This is equivalent to setting

the Amp Rating option on the Recloser tab of the
Recloser editor.

REGULATORS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit regulators.

REG_101 Editing a regulator on page 1071

REG_102 Editing a regulator on page 1071

REG_103 Creating/editing a regulator on page 1071

REG_104 Editing the reverse mode and reverse threshold for a regulator on page 1073

REG_105 Editing the connection type, gang operated status, and gang metering phase for a
regulator on page 1074

REG_106 Editing forward mode values for a regulator on page 1075

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1071

REG_107 Editing the reverse mode and reverse threshold for a regulator on page 1076

REG_108 Editing reverse mode values for a regulator on page 1077

REG_109 Editing first house values for a regulator on page 1078

REG_110 Editing tap limit values for a regulator on page 1078

REG_111 Editing the tap direction and tap operation for a regulator on page 1079

REG_112 Specifying the location of a regulator on page 1079

REG_113 Turning a regulator on or off on page 1080

REG_114 Editing the gang metering phase for a regulator on page 1080

REG_115 Editing forward mode values for a regulator on page 1081

REG_116 Setting the energize year and retire year for a regulator on page 1082

REG_101 Editing a regulator

The REG_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Regulators on page 1070 for a complete list of regulator Model Forge commands.

REG_102 Editing a regulator

The REG_102 Model Forge command has been superseded by other, more recent Model Forge commands.
See Regulators on page 1070 for a complete list of regulator Model Forge commands.

REG_103 Creating/editing a regulator

Use the REG_103 Model Forge command to create a new regulator on a specified section, and also to edit
basic settings for an existing regulator on a specified section. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a new

regulator or edit an existing regulator.

SynName

SynerGEE Electric 5.0

string

If a regulator already exists on the section,

then the existing regulator will be updated with
the specified edits.

If a regulator does not already exist on the

section, then a new regulator will be created
and then updated with the specified edits.

Name that will be applied to the regulator on the

designated section.

User Guide

1072

Model Forge Commands

Field
3

Name

Type

Description

SynType

string

Name of a regulator type from your equipment

warehouse that will be applied to the regulator. This is
equivalent to selecting the Type option on the
Regulator tab of the Regulator editor.
If the regulator type name does not exist in the current
warehouse, then the regulator type will be set to
Unknown.

SynConnection

string

Connection type for single-phase units that will be

applied to the regulator. (Connection types for threephase units are defined as a part of the regulator type.)
This is equivalent to selecting the Connection option
on the Regulator tab of the Regulator editor.
Specify one of the following values:

SynPhase

string

Y Wye

YG Wye-Gnd

D Delta

OD12 Open-Delta AB

OD23 Open-Delta BC

OD34 Open-Delta CA

OY1 Open-Wye A

OY2 Open-Wye B

OY3 Open-Wye C

Connection phases for the regulator. This is equivalent

to selecting the Tap Position check boxes on the
Regulator tab of the Regulator editor.
Specify this value as a text string that includes the
characters A, B, and C. Acceptable values include A,
B, C, AB, BC, AC, and ABC.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1073

REG_104 Editing the reverse mode and reverse

threshold for a regulator
Use the REG_104 Model Forge command to edit the reverse mode and also the reverse threshold for a
regulator that is identified by its associated section name. The inputs for this command are described in the
following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the regulator you

want to edit. If a regulator does not exist on the
specified section, then no edits will be made.

SynReverseMode

string

Text value that specifies whether the Reverse mode

option will be enabled. Specify one of the following
values:

NR No Reverse Mode

LF Locked Forward

LR Locked Reverse

RI Reverse Idle

BD Bi-Directional

NI Neutral Idle

CG Co-Generation

This value corresponds to the Reverse Mode option

on the Settings tab of the Regulator editor.
3

SynThresholdPct

SynerGEE Electric 5.0

double

Threshold percentage value that will be assigned to the

regulator. This value corresponds to the Threshold
Percent option on the Settings tab of the Regulator
editor.

User Guide

1074

Model Forge Commands

REG_105 Editing the connection type, gang operated

status, and gang metering phase for a regulator
Use the REG_105 Model Forge command to edit the connection type, gang operated status, and gang
metering phase for a regulator that is identified by an AMS link. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which regulator you want to edit.

The AMS link is specified on the Rates tab of the
Regulator editor.
If a regulator does not exist with the specified AMS link
name, then no edits will be made. If multiple regulators
exist with the same AMS link name, then only one of
those regulators will be updated.

SynConfiguration

string

Connection type for single-phase units that will be

applied to the regulator. (Connection types for threephase units are defined as a part of the regulator type.)
This is equivalent to selecting the Connection option
on the Regulator tab of the Regulator editor.
Specify one of the following values:

SynGangOp

Boolean

Y Wye

YG Wye-Gnd

D Delta

OD12 Open-Delta AB

OD23 Open-Delta BC

OD34 Open-Delta CA

OY1 Open-Wye A

OY2 Open-Wye B

OY3 Open-Wye C

Boolean value indicating whether the Gang Operated

option will be enabled or disabled.

0 Disabled

1 Enabled

This field corresponds to the Gang Operated check

box on the Regulator tab of the Regulator editor.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

Field
4

1075

Name

Type

Description

SynGangPhase

string

Text value indicating whether the gang metering phase

for the regulator will be set to Phase A, Phase B, or
Phase C. Specify one of the following values:

A Phase A

B Phase B

C Phase C

This field corresponds to the Gang Metering Phase

option on the Settings tab of the Regulator editor.

REG_106 Editing forward mode values for a regulator

Use the REG_106 Model Forge command to edit the voltage, R Dial, X Dial, and B.W. Dial values for the
forward mode of a regulator that is identified by an AMS link. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which regulator you

want to edit. The AMS link is specified on the
Rates tab of the Regulator editor.
If a regulator does not exist with the specified
AMS link name, then no edits will be made. If
multiple regulators exist with the same AMS
link name, then only one of those regulators
will be updated.

SynForwardVoltSet

double

Forward mode voltage value for the regulator.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the Voltage values in the Forward
section on the LDC tab of the Regulator editor.

SynForwardRDialSet

double

Forward mode R dial value for the regulator.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the R Dial values in the Forward
section on the LDC tab of the Regulator editor.

SynForwardXDialSet

double

Forward mode X dial value for the regulator.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the X Dial values in the Forward
section on the LDC tab of the Regulator editor.

SynerGEE Electric 5.0

User Guide

1076

Model Forge Commands

Field
5

Name

Type

Description

SynForwardBWDialSet

double

Forward mode B.W. dial value for the

regulator. The same value will be applied to all
three phases (A, B, and C). This is equivalent
to setting the B.W. Dial values in the Forward
section on the LDC tab of the Regulator editor.

REG_107 Editing the reverse mode and reverse

threshold for a regulator
Use the REG_107 Model Forge command to edit the reverse mode and also the reverse threshold for a
regulator that is identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which regulator you want to

edit. The AMS link is specified on the Rates tab of
the Regulator editor.
If a regulator does not exist with the specified AMS
link name, then no edits will be made. If multiple
regulators exist with the same AMS link name, then
only one of those regulators will be updated.

SynReverseMode

string

Text value that specifies which reverse mode

option will be enabled. This value corresponds to
the Reverse Mode option on the Settings tab of
the Regulator editor.
Specify one of the following abbreviations to
represent the Reverse Mode option that you want
to set:

User Guide

SynReverseThreshold

double

NR No Reverse Mode

LF Locked Forward

LR Locked Reverse

RI Reverse Idle

BD Bi-Directional

NI Neutral Idle

CG Co-Generation

Threshold percentage value that will be assigned to

the regulator. This value corresponds to the
Threshold Percent option on the Settings tab of
the Regulator editor.

SynerGEE Electric 5.0

Model Forge Commands

1077

REG_108 Editing reverse mode values for a regulator

Use the REG_108 Model Forge command to edit the voltage, R Dial, X Dial, and B.W. Dial values for the
reverse mode of a regulator that is identified by an AMS link. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which regulator you

want to edit. The AMS link is specified on the
Rates tab of the Regulator editor.
If a regulator does not exist with the specified
AMS link name, then no edits will be made. If
multiple regulators exist with the same AMS
link name, then only one of those regulators
will be updated.

SynReverseVoltSet

double

Reverse mode voltage value for the regulator.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the Voltage values in the Reverse
section on the LDC tab of the Regulator editor.

SynReverseRDialSet

double

Reverse mode R dial value for the regulator.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the R Dial values in the Reverse
section on the LDC tab of the Regulator editor.

SynReverseXDialSet

double

Reverse mode X dial value for the regulator.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the X Dial values in the Reverse
section on the LDC tab of the Regulator editor.

SynReverseBWDialSet

double

Reverse mode B.W. dial value for the

regulator. The same value will be applied to all
three phases (A, B, and C). This is equivalent
to setting the B.W. Dial values in the Reverse
section on the LDC tab of the Regulator editor.

SynerGEE Electric 5.0

User Guide

1078

Model Forge Commands

REG_109 Editing first house values for a regulator

Use the REG_109 Model Forge command to enable or disable the First House option for a regulator that is
identified by an AMS link, and also to set the high and low voltage values for the First House option. The
inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which regulator you want to

edit. The AMS link is specified on the Rates tab of
the Regulator editor.
If a regulator does not exist with the specified AMS
link name, then no edits will be made. If multiple
regulators exist with the same AMS link name, then
only one of those regulators will be updated.

SynFirstHouseActive

Boolean

Boolean value indicating whether the First House

option will be enabled or disabled.

0 Disabled

1 Enabled

SynFirstHouseHighV

double

High voltage value for the First House option.

SynFirstHouseLowV

double

Low voltage value for the First House option.

REG_110 Editing tap limit values for a regulator

Use the REG_110 Model Forge command to enable or disable the Tap Limits option for a regulator that is
identified by an AMS link, and also to set the high and low values for the Tap Limits option. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

double

AMS link that identifies which regulator you want to

edit. The AMS link is specified on the Rates tab of
the Regulator editor.
If a regulator does not exist with the specified AMS
link name, then no edits will be made. If multiple
regulators exist with the same AMS link name, then
only one of those regulators will be updated.

User Guide

SynTapLimActive

SynTapLimHighSet

Boolean

long

Boolean value indicating whether the Tap Limits

option will be enabled or disabled.

0 Disabled

1 Enabled

High value for the Tap Limits option.

SynerGEE Electric 5.0

Model Forge Commands

Field
4

1079

Name

Type

Description

SynTapLimLowSet

long

Low value for the Tap Limits option.

REG_111 Editing the tap direction and tap operation

for a regulator
Use the REG_111 Model Forge command to edit the tap direction and tap operation for a regulator that is
identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which regulator you want to edit.

The AMS link is specified on the Rates tab of the
Regulator editor.
If a regulator does not exist with the specified AMS link
name, then no edits will be made. If multiple regulators
exist with the same AMS link name, then only one of
those regulators will be updated.

SynTapDirection

SynTapOperation

Boolean

Boolean

Boolean value indicating whether the tap direction is

near the source or near the load.

0 Near the source

1 Near the load

Boolean value indicating whether the tap operation is

automatic or manual.

0 Automatic

1 Manual

REG_112 Specifying the location of a regulator

Use the REG_112 Model Forge command to specify whether a regulator is located near the from-node or the
to-node of a specified section. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section that contains the regulator you

want to edit. If a regulator does not exist on the
specified section, then no edits will be made.

SynerGEE Electric 5.0

User Guide

1080

Model Forge Commands

Field
2

Name

Type

Description

SynFromNode

Boolean

Boolean value indicating whether the regulator will be

located near the from-node or the to-node of the
section.

0 To-node end

1 From-node end

This will perform the same task as using SynerGEEs

move device feature to position the regulator at either
end of the section. Only one regulator can exist on a
section.

REG_113 Turning a regulator on or off

Use the REG_113 Model Forge command to turn a regulator on a specified section On or Off. The inputs for
this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the regulator you

want to edit. If a regulator does not exist on the
specified section, then no edits will be made.

SynStatus

Boolean

Boolean value indicating whether the regulator will be

status will be set to On or Off.

0 Off

1 On

This will perform the same task as right-clicking on the

regulator in SynerGEE and selecting the Turn On or
Turn Off option, as appropriate.

REG_114 Editing the gang metering phase for a

regulator
Use the REG_114 Model Forge command to edit the gang metering phase for a regulator on a specified
section. The inputs for this command are described in the following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the regulator you

want to edit. If a regulator does not exist on the
specified section, then no edits will be made.

SynerGEE Electric 5.0

Model Forge Commands

Field
2

1081

Name

Type

Description

SynGangPhase

string

Text value indicating whether the gang metering phase

for the regulator will be set to Phase A, Phase B, or
Phase C. Specify one of the following values:

A Phase A

B Phase B

C Phase C

REG_115 Editing forward mode values for a regulator

Use the REG_115 Model Forge command to edit the voltage, R Dial, X Dial, and B.W. Dial values for the
forward mode of a regulator on a specified section. The inputs for this command are described in the
following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the regulator

you want to edit. If a regulator does not exist
on the specified section, then no edits will be
made.

SynForwardVoltSet

double

Forward mode voltage value for the regulator.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the Voltage values in the Forward
section on the LDC tab of the Regulator editor.

SynForwardRDialSet

double

Forward mode R dial value for the regulator.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the R Dial values in the Forward
section on the LDC tab of the Regulator editor.

SynForwardXDialSet

double

Forward mode X dial value for the regulator.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the X Dial values in the Forward
section on the LDC tab of the Regulator editor.

SynForwardBWDialSet

double

Forward mode B.W. dial value for the

regulator. The same value will be applied to all
three phases (A, B, and C). This is equivalent
to setting the B.W. Dial values in the Forward
section on the LDC tab of the Regulator editor.

SynerGEE Electric 5.0

User Guide

1082

Model Forge Commands

REG_116 Setting the energize year and retire year for

a regulator
Use the REG_116 Model Forge command to edit the energize and retire years for a regulator on a specified
section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the regulator you

want to edit. If a regulator does not exist on the
specified section, then no edits will be made.

SynEnergizeYr

long

Number that represents the energize year for the

regulator. Use 0 for the base year for your model, or
1 through 10 for each subsequent year.

SynRetireYr

long

Number that represents the retire year for the regulator.

Use 1 through 10 to represent years 1 through 10 for
your model, or use 0 to represent the setting of
Never.

REM
Refer to the topics listed below for more information.

REM_201 on page 1082

REM_201
Field

Name

Type

EventId

string

SectionID

string

DevType

string

Category

string

Subcategory

string

OutHours

double

OutDate

date

User Guide

Description

SynerGEE Electric 5.0

Model Forge Commands

1083

SECTIONALIZERS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit sectionalizers.

SZR_101 Editing a sectionalizer on page 1083

SZR_102 Creating/editing a sectionalizer on page 1083

SZR_103 Editing the actuating current, number of counts, and location for a sectionalizer on
page 1084

SZR_104 Specifying the location of a sectionalizer on page 1085

SZR_105 Editing the amp rating, actuating current, and number of counts for a sectionalizer on
page 1085

SZR_106 Editing the connection phase for a sectionalizer on page 1086

SZR_101 Editing a sectionalizer

The SZR_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Sectionalizers on page 1083 for a complete list of sectionalizer Model Forge commands.

SZR_102 Creating/editing a sectionalizer

Use the SZR_102 Model Forge command to create a new sectionalizer on a specified section, and also to
edit basic settings for an existing sectionalizer on a specified section. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a new

sectionalizer or edit an existing sectionalizer.

SynName

SynerGEE Electric 5.0

string

If a sectionalizer already exists on the section,

then the sectionalizer will be updated with the
specified settings.

If a sectionalizer does not already exist on the

section, then a new sectionalizer will be
created and assigned the specified settings.

Name that will be applied to the sectionalizer on the

designated section.

User Guide

1084

Model Forge Commands

Field
3

Name

Type

Description

SynStatus

Boolean

Boolean value indicating whether the sectionalizer

status will be set to Open or Closed.

0 Closed

1 Open

This field corresponds to the Status option on the

Sectionalizer tab of the Sectionalizer editor.
4

SynRating

double

Amp rating for the sectionalizer. This is equivalent to

setting the Amp Rating option on the Sectionalizer tab
of the Sectionalizer editor.

SZR_103 Editing the actuating current, number of

counts, and location for a sectionalizer
Use the SZR_103 Model Forge command to edit the actuating current, number of counts, and location for a
sectionalizer on a specified section. The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the sectionalizer you

want to edit. If a sectionalizer does not exist on the
specified section, then no edits will be made.

SynActuating

double

Actuating current value for the sectionalizer. This is

equivalent to setting the Actuating Current option on
the Sectionalizer tab of the Sectionalizer editor.

SynCounts

long

Number of counts value for the sectionalizer. This is

equivalent to setting the Number Counts option on the
Sectionalizer tab of the Sectionalizer editor.

SynFromNode

Boolean

Boolean value indicating whether the sectionalizer will

be located near the from-node or the to-node of the
section.

0 To-node end

1 From-node end

SynerGEE Electric 5.0

Model Forge Commands

1085

SZR_104 Specifying the location of a sectionalizer

Use the SZR_104 Model Forge command to specify whether a sectionalizer is located near the from-node or
the to-node of a specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the sectionalizer you

want to edit. If a sectionalizer does not exist on the
specified section, then no edits will be made.

SynFromNode

Boolean

Boolean value indicating whether the sectionalizer will

be located near the from-node or the to-node of the
section.

0 To-node end

1 From-node end

This will perform the same task as using SynerGEEs

move device feature to position the sectionalizer at
either end of the section. Only one sectionalizer can
exist on a section.

SZR_105 Editing the amp rating, actuating current,

and number of counts for a sectionalizer
Use the SZR_105 Model Forge command to edit the amp rating, actuating current, and number of counts
values for a sectionalizer that is identified by an AMS link. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which sectionalizer you want to

edit. The AMS link is specified on the Rates tab of the
Sectionalizer editor.
If a sectionalizer does not exist with the specified AMS
link name, then no edits will be made. If multiple
sectionalizers exist with the same AMS link name, then
only one of those sectionalizers will be updated.

SynRating

double

Amp rating for the sectionalizer. This is equivalent to

setting the Amp Rating option on the Sectionalizer tab
of the Sectionalizer editor.

SynActuating

double

Actuating current value for the sectionalizer. This is

equivalent to setting the Actuating Current option on
the Sectionalizer tab of the Sectionalizer editor.

SynerGEE Electric 5.0

User Guide

1086

Model Forge Commands

Field
4

Name

Type

Description

SynCounts

long

Number of counts value for the sectionalizer. This is

equivalent to setting the Number Counts option on the
Sectionalizer tab of the Sectionalizer editor.

SZR_106 Editing the connection phase for a

sectionalizer
Use the SZR_106 Model Forge command to edit the connection phase for a sectionalizer that is identified by
its associated section name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the sectionalizer you

want to edit. If a sectionalizer does not exist on the
specified section, then no edits will be made.

SynPhasing

string

Connection phase that will be applied to the

sectionalizer. Specify this value as a text string that
includes the characters A, B, and C. Acceptable values
include A, B, C, AB, BC, AC, and ABC.

SECTIONS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit sections.

SEC_101 Adding a section on page 1087

SEC_104 Editing the phasing, connection type, and length (in feet) for a section on page 1087

SEC_105 Adding a graphic point to a section on page 1088

SEC_108 Editing the conductor types for a section on page 1088

SEC_109 Editing the description for a section on page 1089

SEC_110 Editing the conductor types for a section on page 1089

SEC_111 Editing the constant current (%I) and constant impedance (%Z) for a sections
distributed load on page 1090

SEC_112 Editing the constant current (%I) and constant impedance (%Z) for a sections spot
load on page 1090

SEC_114 Editing the construction model for a section on page 1091

SEC_115 Editing equivalent spacing and height values for a section on page 1091

SEC_116 Editing the detailed spacing configuration type for a section on page 1092

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1087

SEC_117 Setting the transposition phasing order for a section on page 1092

SEC_118 Configuring elbows on a section on page 1093

SEC_119 Editing the phasing, connection type, and length (in meters) for a section on
page 1094

SEC_120 Setting the mitigation zone for a section on page 1094

SEC_121 Setting a section as a contingency section on page 1095

SEC_122 Setting the exposure zone for a section on page 1095

SEC_123 Editing the constant current (%I) and constant impedance (%Z) for a sections
distributed load on page 1096

SEC_124 Editing the constant current (%I) and constant impedance (%Z) for a sections spot
load on page 1096

SEC_101 Adding a section

Use the SEC_101 Model Forge command to add a new section to your model. The new section will be added
between a specified from-node and to-node. If a section already exists between the two nodes, then no edits
will be made.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to create.

SynFromNode

string

From-node for the new section.

SynToNode

string

To-node for the new section.

SEC_104 Editing the phasing, connection type, and

length (in feet) for a section
Use the SEC_104 Model Forge command to edit the phasing, connection type, and length (in feet) on a
specified section. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynerGEE Electric 5.0

User Guide

1088

Model Forge Commands

Field
2

Name

Type

Description

SynPhasing

string

Connection phase that will be applied to the section.

Specify this value as a text string that includes the
characters A, B, C, and N. These values correspond to
the Phasing check boxes on the Section tab of the
Section editor.
This input will also set the Connection type on the
Properties tab of the Section editor. If you input a
connection phase that includes a neutral (N), the
Connection type will be set to phase-ground. If you
input a connection phase that does not include a
neutral, the Connection type will be set to phasephase.

SynLength_Ft

double

Section length, specified in feet. This field corresponds

to the Length option on the Section tab of the Section
editor.

SEC_105 Adding a graphic point to a section

Use the SEC_105 Model Forge command to add a graphic point to a specified section. The graphic point will
be added to the end of any other graphic points that already exist on the section. There is no mechanism to
specify the order of graphic points using this command.
The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynX

double

X coordinate for the new graphic point.

SynY

double

Y coordinate for the new graphic point.

SEC_108 Editing the conductor types for a section

Use the SEC_108 Model Forge command to edit the conductor types for a specified section. You can set one
conductor type for phases A, B, and C, and another conductor type for the neutral phase. The inputs for this
command are described in the following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynerGEE Electric 5.0

Model Forge Commands

Field

1089

Name

Type

Description

SynPhsCond

string

Conductor type for phases A, B, and C for the section.

You must specify an exact match to one of the available
options on the Construction tab of the Section editor.
Otherwise, the conductor type will be set to Unknown.

SynNeuCond

string

Conductor type for the neutral phase for the section.

You must specify an exact match to one of the available
options on the Construction tab of the Section editor.
Otherwise, the conductor type will be set to Unknown.

SEC_109 Editing the description for a section

Use the SEC_109 Model Forge command to edit the description for a specified section. The inputs for this
command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynDescription

string

Description for the section.

SEC_110 Editing the conductor types for a section

Use the SEC_110 Model Forge command to edit the conductor type for specified connection phases on a
specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynCondType

string

Conductor type that will be applied to the specified

connection phases for the section. You must specify an
exact match to one of the available options on the
Construction tab of the Section editor. Otherwise, the
conductor type will be set to Unknown.

SynCondPhase

string

Connection phase(s) that you want to set to use the

specified conductor type. Specify this value as a text
string that includes the characters A, B, C, and N.

SynerGEE Electric 5.0

User Guide

1090

Model Forge Commands

SEC_111 Editing the constant current (%I) and

constant impedance (%Z) for a sections distributed
load
Use the SEC_111 Model Forge command to edit the constant current (%I) and constant impedance (%Z)
values for the distributed load of a section that is identified by an AMS link. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which section you want to edit.

The AMS link is specified on the Section tab of the
Section editor.
If a section does not exist with the specified AMS link
name, then no edits will be made. If multiple sections
exist with the same AMS link name, then only one of
those sections will be updated.

SynDistI

double

Constant current (%I) value for the sections distributed

load. This field corresponds to the %I option on the
Load - Dist tab of the Section editor.

SynDistZ

double

Constant impedance (%Z) value for the sections

distributed load. This field corresponds to the %Z
option on the Load - Dist tab of the Section editor.

SEC_112 Editing the constant current (%I) and

constant impedance (%Z) for a sections spot load
Use the SEC_112 Model Forge command to edit the constant current (%I) and constant impedance (%Z)
values for the spot load on a section that is identified by an AMS link. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which section you want to edit.

The AMS link is specified on the Section tab of the
Section editor.
If a section does not exist with the specified AMS link
name, then no edits will be made. If multiple sections
exist with the same AMS link name, then only one of
those sections will be updated.

User Guide

SynSpotI

double

Constant current (%I) value for the sections spot load.

This field corresponds to the %I option on the Load Spot tab of the Section editor.

SynerGEE Electric 5.0

Model Forge Commands

Field
3

1091

Name

Type

Description

SynSpotZ

double

Constant impedance (%Z) value for the sections spot

load. This field corresponds to the %Z option on the
Load - Spot tab of the Section editor.

SEC_114 Editing the construction model for a section

Use the SEC_114 Model Forge command to edit the construction model for a specified section. The inputs
for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynConstruct

long

Numerical value that represents the construction model

that you want to set for the section. Specify one of the
following values:

0 Equivalent Spacing

1 Detailed Spacing - Identical Phase

Conductors

2 Detailed Spacing - Different Phase

Conductors

3 Duct Bank

This field corresponds to the Construction Model

option on the Construction tab of the Section editor.

SEC_115 Editing equivalent spacing and height values

for a section
Use the SEC_115 Model Forge command to edit the equivalent spacing and height values for a specified
section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynPhtoPh

double

Phase-to-phase value for the section. This field

corresponds to the Phase to Phase option on the
Construction tab of the Section editor.

SynerGEE Electric 5.0

User Guide

1092

Model Forge Commands

Field

Name

Type

Description

SynPhtoNe

double

Phase-to-neutral value for the section. This field

corresponds to the Phase to Neutral option on the
Construction tab of the Section editor.

SynHeight

double

Height value for the section. This field corresponds to

the Height to ref. option on the Construction tab of the
Section editor.

SEC_116 Editing the detailed spacing configuration

type for a section
Use the SEC_116 Model Forge command to edit the detailed spacing configuration type for a specified
section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynConfig

string

Configuration type for the section. You must specify an

exact match to one of the available options on the
Construction tab of the Section editor. Otherwise, the
configuration type will be set to Unknown.

SEC_117 Setting the transposition phasing order for a

section
Use the SEC_117 Model Forge command to set the transposition phasing order for a specified section. The
inputs for this command are described in the following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynerGEE Electric 5.0

Model Forge Commands

Field
2

1093

Name

Type

Description

SynTransp

long

Numerical value that corresponds to one of the

transposition phasing order options on the Construction
tab of the Section editor. Specify one of the following
values:

0 ABC

1 ACB

2 BAC

3 CAB

4 BCA

5 CBA

SEC_118 Configuring elbows on a section

Use the SEC_118 Model Forge command to configure elbows at the from-node end and to-node end of a
specified section, and to set the amp rating for the elbows. The inputs for this command are described in the
following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynElbStatFrom

string

Status of an elbow at the from-node end of the section.

Specify one of the following values:

O Open

C Closed

N No Elbow

Any value that does not match an exact value above

(for example, specifying Open instead of O) will
result in a setting of No Elbow.
3

SynElbStatTo

string

Status of an elbow at the to-node end of the section.

Specify one of the following values:

O Open

C Closed

N No Elbow

Any value that does not match an exact value above

(for example, specifying Open instead of O) will
result in a setting of No Elbow.

SynerGEE Electric 5.0

User Guide

1094

Model Forge Commands

Field
4

Name

Type

Description

SynElbRating

double

Amp rating for the sections elbow. This is equivalent to

setting the Amp Rating value on the Properties tab of
the Section editor.

SEC_119 Editing the phasing, connection type, and

length (in meters) for a section
Use the SEC_119 Model Forge command to edit the phasing, connection type, and length (in meters) on a
specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynPhasing

string

Connection phase that will be applied to the section.

Specify this value as a text string that includes the
characters A, B, C, and N. These values correspond to
the Phasing check boxes on the Section tab of the
Section editor.
This input will also set the Connection type on the
Properties tab of the Section editor. If you input a
connection phase that includes a neutral (N), the
Connection type will be set to phase-ground. If you
input a connection phase that does not include a
neutral, the Connection type will be set to phasephase.

SynLength_Mt

long

Section length, specified in meters. This field

corresponds to the Length option on the Section tab of
the Section editor.

SEC_120 Setting the mitigation zone for a section

Use the SEC_120 Model Forge command to set the mitigation zone for a specified section. The inputs for this
command are described in the following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynerGEE Electric 5.0

Model Forge Commands

Field
2

1095

Name

Type

Description

SynMitZone

string

Name of the mitigation zone that you want to assign to

the section. You must specify an exact match to one of
the available Mitigation Zone options on the Zones tab
of the Section editor. Otherwise, the mitigation zone will
be set to Unknown.

SEC_121 Setting a section as a contingency section

Use the SEC_121 Model Forge command to specify whether a section is a contingency section. The inputs
for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynIsContingency

Boolean

Boolean value indicating whether the section will be set

as a contingency section. This is equivalent to selecting
(or clearing) the Contingency Section check box on
the Properties tab of the Section editor.

0 Not a contingency section

1 Is a contingency section

SEC_122 Setting the exposure zone for a section

Use the SEC_122 Model Forge command to set the exposure zone for a specified section. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which section you want to edit.

The AMS link is specified on the Section tab of the
Section editor.
If a section does not exist with the specified AMS link
name, then no edits will be made. If multiple sections
exist with the same AMS link name, then only one of
those sections will be updated.

SynExpZone

SynerGEE Electric 5.0

string

Name of the exposure zone that you want to assign to

the section. You must specify an exact match to one of
the available Exposure Zone options on the Zones tab
of the Section editor. Otherwise, the exposure zone will
be set to Unknown.

User Guide

1096

Model Forge Commands

SEC_123 Editing the constant current (%I) and

constant impedance (%Z) for a sections distributed
load
Use the SEC_123 Model Forge command to edit the constant current (%I) and constant impedance (%Z)
values for the distributed load of a specified section. The inputs for this command are described in the
following table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynDistI

double

Constant current (%I) value for the sections distributed

load. This field corresponds to the %I option on the
Load - Dist tab of the Section editor.

SynDistZ

double

Constant impedance (%Z) value for the sections

distributed load. This field corresponds to the %Z
option on the Load - Dist tab of the Section editor.

SEC_124 Editing the constant current (%I) and

constant impedance (%Z) for a sections spot load
Use the SEC_124 Model Forge command to edit the constant current (%I) and constant impedance (%Z)
values for the spot load on a specified section. The inputs for this command are described in the following
table.
Field

Name

Type

Description

SynSect

string

Name of the section you want to edit. If the specified

section does not exist, then no edits will be made.

SynSpotI

double

Constant current (%I) value for the sections spot load.

This field corresponds to the %I option on the Load Spot tab of the Section editor.

SynSpotZ

double

Constant impedance (%Z) value for the sections spot

load. This field corresponds to the %Z option on the
Load - Spot tab of the Section editor.

SOURCES
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit sources.

User Guide

SRC_101 Editing source impedance values for a source on page 1097

SynerGEE Electric 5.0

Model Forge Commands

1097

SRC_102 Editing the location link and note text for a source on page 1097

SRC_101 Editing source impedance values for a source

Use the SRC_101 Model Forge command to edit the source impedance values for a source that is identified
by its node name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SourceId

string

Name of the source that you want to edit.

PosSeqROhms

double

Positive sequence R value for the source.

PosSeqXOhms

double

Positive sequence X value for the source.

ZeroSeqROhms

double

Zero sequence R value for the source.

ZeroSeqXOhms

double

Zero sequence X value for the source.

SRC_102 Editing the location link and note text for a

source
Use the SRC_102 Model Forge command to edit the location link and note text for a source. The inputs for
this command are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the source that you want to edit. If a source

does not exist with the specified name, then no edits will
be made.

SynLocLink

string

Location link to be assigned to the source.

SynNote

string

Text to be assigned to the Note field for the source.

SWITCHES
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit switches.

SWT_101 Editing a switch on page 1098

SWT_102 Creating/editing a switch on page 1098

SWT_103 Specifying the location of a switch on page 1099

SWT_104 Setting the operation from analysis status for a switch on page 1099

SWT_105 Setting the energize year and retire year for a switch on page 1100

SynerGEE Electric 5.0

User Guide

1098

Model Forge Commands

SWT_101 Editing a switch

The SWT_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Switches on page 1097 for a complete list of switch Model Forge commands.

SWT_102 Creating/editing a switch

Use the SWT_102 Model Forge command to create a new switch on a specified section, and also to edit
basic settings for an existing switch on a specified section. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a new

switch or edit an existing switch.

If a switch already exists on the section, then

the switch will be updated with the specified
settings.

If a switch does not already exist on the

section, then a new switch will be created and
assigned the specified settings.

SynName

string

Name that will be applied to the switch on the

designated section.

SynStatus

Boolean

Boolean value indicating whether the switch status will

be set to Open or Closed. This is equivalent to setting
the Status option on the Switch tab of the Switch
editor.

SynType

string

0 Closed

1 Open

Name of a switch type from your equipment warehouse

that will be applied to the switch. This is equivalent to
selecting the Type option on the Switch tab of the
Switch editor.
If the switch type name does not exist in the current
warehouse, then the switch type will be set to
Unknown.

User Guide

SynModel

string

Switching model for the switch. Specify one of the

following values:

Manual

Automatic

Auto-transfer

SynerGEE Electric 5.0

Model Forge Commands

1099

SWT_103 Specifying the location of a switch

Use the SWT_103 Model Forge command to specify whether a switch is located near the from-node or the
to-node of a specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the switch you want

to edit. If a switch does not exist on the specified
section, then no edits will be made.

SynFromNode

Boolean

Boolean value indicating whether the switch will be

located near the from-node or the to-node of the
section.

0 To-node end

1 From-node end

This will perform the same task as using SynerGEEs

move device feature to position the switch at either
end of the section. Only one switch can exist on a
section.

SWT_104 Setting the operation from analysis status

for a switch
Certain types of analyses, such as optimal switching, contingency, and reliability, simulate the operation of
switches and protective devices to accomplish the analysis objective. Use the SWT_104 Model Forge
command to select or clear an option that specifies whether a switch identified by an AMS link can be
controlled in this manner. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which switch you want to edit.

The AMS link is specified on the Rates tab of the Switch
editor.
If a switch does not exist with the specified AMS link
name, then no edits will be made. If multiple switches
exist with the same AMS link name, then only one of
those switches will be updated.

SynerGEE Electric 5.0

User Guide

1100

Model Forge Commands

Field
2

Name

Type

Description

SynOperAnalysis

Boolean

Boolean value indicating whether the Dont allow

operation from analysis option will be selected or
cleared on the Switch tab of the Switch editor.

Specify 0 to select the option, meaning that the

switch cannot be controlled automatically by
certain analysis types, including optimal
switching, contingency, and reliability.

Specify 1 to clear the option, meaning that the

switch can be controlled automatically by
certain analysis types, including optimal
switching, contingency, and reliability.

SWT_105 Setting the energize year and retire year for

a switch
Use the SWT_105 Model Forge command to edit the energize and retire years for a switch on a specified
section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the switch you want

to edit. If a switch does not exist on the specified
section, then no edits will be made.

SynEnergizeYr

long

Number that represents the energize year for the

switch. Use 0 for the base year for your model, or 1
through 10 for each subsequent year.

SynRetireYr

long

Number that represents the retire year for the switch.

Use 1 through 10 to represent years 1 through 10 for
your model, or use 0 to represent the setting of
Never.

SUBSTATIONS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit substations.

STN_101 Converting a node to a substation on page 1101

STN_102 Editing minimum and maximum source impedance values for a substation on
page 1101

STN_103 Editing source impedance values for a substation on page 1102

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1101

STN_104 Editing the note text for a substation on page 1102

STN_105 Editing the AMS link for a substation on page 1103

STN_106 Setting the region ID for a substation on page 1103

STN_107 Editing maximum source impedance values for a substation on page 1103

STN_101 Converting a node to a substation

Use the STN_101 Model Forge command to convert a specified node into a substation and then to edit the
nominal kV value, connection type, and substation ID for the new substation. The inputs for this command
are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the substation that you want to edit.

SynNomKv

double

Nominal kV value for the substation.

SynConnection

string

Connection type for the substation. Specify one of the

following values:

SynSubId

string

Wye

Wye-Gnd

Delta

Substation ID for the substation.

STN_102 Editing minimum and maximum source

impedance values for a substation
Use the STN_102 Model Forge command to edit the both the minimum and maximum source impedance
values for a substation that is identified by its node name. The inputs for this command are described in the
following table.
Field

Name

Type

Description

SynNode

string

Name of the substation that you want to edit.

SynPosSeqR

double

Minimum and maximum Positive Sequence R value

for the substation. This is equivalent to setting both the
minimum and maximum Positive Sequence > R
values on the Volts/Ohms tab of the Subtran editor.

SynPosSeqX

double

Minimum and maximum Positive Sequence X value

for the substation. This is equivalent to setting both the
minimum and maximum Positive Sequence > X option
on the Volts/Ohms tab of the Subtran editor.

SynerGEE Electric 5.0

User Guide

1102

Model Forge Commands

Field

Name

Type

Description

SynZeroSeqR

double

Minimum and maximum Zero Sequence R value for

the substation. This is equivalent to setting both the
minimum and maximum Zero Sequence > R option on
the Volts/Ohms tab of the Subtran editor.

SynZeroSeqX

double

Minimum and maximum Zero Sequence X value for

the substation. This is equivalent to setting both the
minimum and maximum Zero Sequence > X option on
the Volts/Ohms tab of the Subtran editor.

STN_103 Editing source impedance values for a

substation
Use the STN_103 Model Forge command to edit the source impedance values for a substation that is
identified by an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which substation you want to

edit. The AMS link is specified on the Source tab of the
Subtran editor.
If a substation does not exist with the specified AMS link
name, then no edits will be made. If multiple substations
exist with the same AMS link name, then only one of
those substations will be updated.

SynPosSeqR

double

Positive sequence R value for the substation.

SynPosSeqX

double

Positive sequence X value for the substation.

SynZeroSeqR

double

Zero sequence R value for the substation.

SynZeroSeqX

double

Zero sequence X value for the substation.

STN_104 Editing the note text for a substation

Use the STN_104 Model Forge command to edit the note text for a substation that is identified by its node
name. The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

SynNode

string

Name of the substation that you want to edit.

SynNote

string

Text to be assigned to the Note field for the substation.

SynerGEE Electric 5.0

Model Forge Commands

1103

STN_105 Editing the AMS link for a substation

Use the STN_105 Model Forge command to edit the AMS link for a substation that is identified by its node
name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the substation that you want to edit.

SynAMSLink

string

AMS link to be assigned to the subtran. AMS links are

used to identify a specific facility in both your model and
your external data source.

STN_106 Setting the region ID for a substation

Use the STN_106 Model Forge command to set the region ID for a substation. The inputs for this command
are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the substation that you want to edit. If a

substation does not exist with the specified name,
then no edits will be made.

SynRegionID

string

Name of the region that you want to assign to the

substation. This is equivalent to editing the
Region field on the Feeder tab of the Feeder
editor.

STN_107 Editing maximum source impedance values

for a substation
Use the STN_107 Model Forge command to edit the maximum source impedance values for a substation
that is identified by its node name. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynNode

string

Name of the substation that you want to edit.

SynPosSeqRMax

double

Maximum Positive Sequence R value for the

substation. This is equivalent to setting the maximum
Positive Sequence > R values on the Volts/Ohms tab
of the Subtran editor.

SynPosSeqXMax

double

Maximum Positive Sequence X value for the

substation. This is equivalent to setting the maximum
Positive Sequence > X option on the Volts/Ohms tab
of the Subtran editor.

SynerGEE Electric 5.0

User Guide

1104

Model Forge Commands

Field

Name

Type

Description

SynZeroSeqRMax

double

Maximum Zero Sequence R value for the substation.

This is equivalent to setting the maximum Zero
Sequence > R option on the Volts/Ohms tab of the
Subtran editor.

SynZeroSeqXMax

double

Maximum Zero Sequence X value for the substation.

This is equivalent to setting the maximum Zero
Sequence > X option on the Volts/Ohms tab of the
Subtran editor.

TRANSFORMERS
Refer to the topics listed below for information on the Model Forge commands that are used to create and
edit transformers.

TRN_101 Editing a transformer on page 1104

TRN_102 Creating/editing a transformer on page 1105

TRN_103 Editing the high-side and low-side connection types for a transformer on page 1105

TRN_104 Creating/editing a transformer on page 1107

TRN_105 Specifying the location of a transformer on page 1108

TRN_106 Editing the gang operated status, gang metering phase, and tap control for a
transformer on page 1109

TRN_107 Editing forward mode values for a transformer on page 1110

TRN_108 Editing first house values for a transformer on page 1111

TRN_109 Editing tap limit values for a transformer on page 1111

TRN_110 Editing the tap setting for a transformer on page 1112

TRN_111 Editing high-side and low-side connection types for a transformer on page 1112

TRN_112 Editing the low-side ground reactance for a transformer on page 1114

TRN_113 Overriding impedance and reactance values for a transformer on page 1115

TRN_101 Editing a transformer

The TRN_101 Model Forge command has been superseded by other, more recent Model Forge commands.
See Transformers on page 1104 for a complete list of transformer Model Forge commands.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1105

TRN_102 Creating/editing a transformer

Use the TRN_102 Model Forge command to create a new transformer on a specified section, and also to edit
the name and transformer type for an existing transformer on a specified section. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a new

transformer or edit an existing transformer.

If a transformer already exists on the section,

then the transformer will be updated with the
specified settings.

If a transformer does not already exist on the

section, then a new transformer will be created
and assigned the specified settings.

SynName

string

Name that will be applied to the transformer on the

designated section.

SynType

string

Name of a transformer type from your equipment

warehouse that will be applied to the transformer. This
is equivalent to selecting the Type option on the
Transformer tab of the Transformer editor.
If the transformer type name does not exist in the
current warehouse, then the transformer type will be set
to Unknown.

TRN_103 Editing the high-side and low-side

connection types for a transformer
Use the TRN_103 Model Forge command to edit the high-side connection type and the low-side connection
type for a transformer that is identified by its associated section name. The inputs for this command are
described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section that contains the transformer you

want to edit. If a transformer does not exist on the
specified section, then no edits will be made.

SynerGEE Electric 5.0

User Guide

1106

Model Forge Commands

Field
2

Name

Type

Description

SynTranHigh

string

High-side connection type for the transformer. This field

sets the Connection option in the High-Side Settings
area on the Transformer tab of the Transformer editor.
Acceptable values are as follows, where the letters A,
B, and C represent the phase designations in use in
your model (as defined in the Units tab of the
Preferences editor). If the phase designations specified
in your model are different (for example, X, Y, and Z),
then the acceptable values for this command will
change accordingly (for example, ODXY, ODYZ, ODZX,
and so on).

User Guide

Y Wye

YG Wye-Gnd

D Delta

ODAB Open-Delta AB

ODBC Open-Delta BC

ODCA Open-Delta CA

YGA Open-Wye A

YGB Open-Wye B

YGC Open-Wye C

SynerGEE Electric 5.0

Model Forge Commands

Field
3

1107

Name

Type

Description

SynTranLow

string

Low-side connection type for the transformer. This field

sets the Connection option in the Low-Side Settings
area on the Transformer tab of the Transformer editor.
Acceptable values are as follows, where the letters A,
B, and C represent the phase designations in use in
your model (as defined in the Units tab of the
Preferences editor). If the phase designations specified
in your model are different (for example, X, Y, and Z),
then the acceptable values for this command will
change accordingly (for example, ODXY, ODYZ, ODZX,
and so on).

Y Wye

YG Wye-Gnd

D Delta

ODAB Open-Delta AB

ODBC Open-Delta BC

ODCA Open-Delta CA

YGA Open-Wye A

YGB Open-Wye B

YGC Open-Wye C

TRN_104 Creating/editing a transformer

Use the TRN_104 Model Forge command to create a new transformer on a specified section, and also to edit
the name and transformer type for an existing transformer on a specified section. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

SynSect

string

Name of the section where you want to add a new

transformer or edit an existing transformer.

SynName

SynerGEE Electric 5.0

string

If a transformer already exists on the section,

then the transformer will be updated with the
specified settings.

If a transformer does not already exist on the

section, then a new transformer will be created
and assigned the specified settings.

Name that will be applied to the transformer on the

designated section.

User Guide

1108

Model Forge Commands

Field
3

Name

Type

Description

SynType

string

Name of a transformer type from your equipment

warehouse that will be applied to the transformer. This
is equivalent to selecting the Type option on the
Transformer tab of the Transformer editor.
If the transformer type name does not exist in the
current warehouse, then the transformer type will be set
to Unknown.

TRN_105 Specifying the location of a transformer

Use the TRN_105 Model Forge command to specify whether a transformer is located near the from-node or
the to-node of a specified section. The inputs for this command are described in the following table.
Field

Name

Type

Description

SynSect

string

Name of the section that contains the transformer you

want to edit. If a transformer does not exist on the
specified section, then no edits will be made.

SynFromNode

Boolean

Boolean value indicating whether the transformer will be

located near the from-node or the to-node of the
section.

0 To-node end

1 From-node end

This will perform the same task as using SynerGEEs

move device feature to position the transformer at
either end of the section. Only one transformer can exist
on a section.

User Guide

SynerGEE Electric 5.0

Model Forge Commands

1109

TRN_106 Editing the gang operated status, gang

metering phase, and tap control for a transformer
Use the TRN_106 Model Forge command to edit the gang operated status, gang metering phase, and tap
control for a transformer that is identified by an AMS link. The inputs for this command are described in the
following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which transformer you want

to edit. The AMS link is specified on the Rates tab
of the Transformer editor.
If a transformer does not exist with the specified
AMS link name, then no edits will be made. If
multiple transformers exist with the same AMS link
name, then only one of those transformers will be
updated.

SynGangOp

Boolean

Boolean value indicating whether the Gang

Operated option will be enabled or disabled.

0 Disabled

1 Enabled

This will perform the same task as selecting or

clearing the Gang Operated check box on the
LTC tab of the Transformer editor.
3

SynGangPh

string

Text value indicating whether the gang metering

phase for the transformer will be set to Phase A,
Phase B, or Phase C. Specify one of the following
values:

A Phase A

B Phase B

C Phase C

This will perform the same task as setting the

Gang Metering Phase option on the LTC tab of
the Transformer editor.
4

SynManualTapControl

Boolean

Boolean value indicating whether the tap control is

automatic or manual.

0 Automatic

1 Manual

This will perform the same task as setting the Tap

Control option on the LTC tab of the Transformer
editor.

SynerGEE Electric 5.0

User Guide

1110

Model Forge Commands

TRN_107 Editing forward mode values for a

transformer
Use the TRN_107 Model Forge command to edit the voltage, R Dial, X Dial, and B.W. Dial values for the
forward mode of a transformer that is identified by an AMS link. The inputs for this command are described in
the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which transformer you

want to edit. The AMS link is specified on the
Rates tab of the Transformer editor.
If a transformer does not exist with the
specified AMS link name, then no edits will be
made. If multiple transformers exist with the
same AMS link name, then only one of those
transformers will be updated.

User Guide

SynForwardVoltSet

double

Forward mode voltage value for the

transformer. The same value will be applied to
all three phases (A, B, and C). This is
equivalent to setting the Voltage values in the
Forward section on the LTC tab of the
Transformer editor.

SynForwardRDialSet

double

Forward mode R dial value for the transformer.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the R Dial values in the Forward
section on the LTC tab of the Transformer
editor.

SynForwardXDialSet

double

Forward mode X dial value for the transformer.

The same value will be applied to all three
phases (A, B, and C). This is equivalent to
setting the X Dial values in the Forward
section on the LTC tab of the Transformer
editor.

SynForwardBWDialSet

double

Forward mode B.W. dial value for the

transformer. The same value will be applied to
all three phases (A, B, and C). This is
equivalent to setting the B.W. Dial values in
the Forward section on the LTC tab of the
Transformer editor.

SynerGEE Electric 5.0

Model Forge Commands

1111

TRN_108 Editing first house values for a transformer

Use the TRN_108 Model Forge command to enable or disable the First House option for a transformer that is
identified by an AMS link, and also to set the high and low voltage values for the First House option. The
inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which transformer you want

to edit. The AMS link is specified on the Rates tab
of the Transformer editor.
If a transformer does not exist with the specified
AMS link name, then no edits will be made. If
multiple transformers exist with the same AMS link
name, then only one of those transformers will be
updated.

SynFirstHouseActive

Boolean

Boolean value indicating whether the First House

option will be enabled or disabled.

0 Disabled

1 Enabled

This will perform the same task as selecting or

clearing the First House Active check box on the
LTC tab of the Transformer editor.
3

SynFirstHouseHighV

double

High voltage value for the First House option.

SynFirstHouseLowV

double

Low voltage value for the First House option.

TRN_109 Editing tap limit values for a transformer

Use the TRN_109 Model Forge command to enable or disable the Tap Limits option for a transformer that is
identified by an AMS link, and also to set the high and low values for the Tap Limits option. The inputs for this
command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which transformer you want to

edit. The AMS link is specified on the Rates tab of the
Transformer editor.
If a transformer does not exist with the specified AMS
link name, then no edits will be made. If multiple
transformers exist with the same AMS link name, then
only one of those transformers will be updated.

SynerGEE Electric 5.0

User Guide

1112

Model Forge Commands

Field
2

Name

Type

Description

SynTapLimActive

Boolean

Boolean value indicating whether the Tap Limits option

will be enabled or disabled.

0 Disabled

1 Enabled

This will perform the same task as selecting or clearing

the Tap Limits Active check box on the LTC tab of the
Transformer editor.
3

SynTapLimHigh

long

High value for the Tap Limits option.

SynTapLimLow

long

Low value for the Tap Limits option.

TRN_110 Editing the tap setting for a transformer

Use the TRN_110 Model Forge command to edit the tap setting option for a transformer that is identified by
an AMS link. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which transformer you want to

edit. The AMS link is specified on the Rates tab of the
Transformer editor.
If a transformer does not exist with the specified AMS
link name, then no edits will be made. If multiple
transformers exist with the same AMS link name, then
only one of those transformers will be updated.

SynTapSetting

double

Tap setting value for the transformer.

TRN_111 Editing high-side and low-side connection

types for a transformer
Use the TRN_111 Model Forge command to edit the high-side and low-side connection types for a
transformer that is identified by its associated section name. The inputs for this command are described in
the following table.
Field
1

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the transformer you

want to edit. If a transformer does not exist on the
specified section, then no edits will be made.

SynerGEE Electric 5.0

Model Forge Commands

Field
2

1113

Name

Type

Description

SynHighConn

string

High-side connection type for single-phase units that

will be applied to the transformer. (Connection types for
three-phase units are defined as a part of the
transformer type.) This is equivalent to selecting the
Connection option on the Transformer tab of the
Transformer editor.
Acceptable values are as follows, where the letters A,
B, and C represent the phase designations in use in
your model (as defined in the Units tab of the
Preferences editor). If the phase designations specified
in your model are different (for example, X, Y, and Z),
then the acceptable values for this command will
change accordingly (for example, ODXY, ODYZ, ODZX,
and so on).

SynerGEE Electric 5.0

Y Wye

YG Wye-Gnd

D Delta

ODAB Open-Delta AB

ODBC Open-Delta BC

ODCA Open-Delta CA

YGA Open-Wye A

YGB Open-Wye B

YGC Open-Wye C

User Guide

1114

Model Forge Commands

Field
3

Name

Type

Description

SynLowConn

string

Low-side connection type for single-phase units that will

be applied to the transformer. (Connection types for
three-phase units are defined as a part of the
transformer type.) This is equivalent to selecting the
Connection option on the Transformer tab of the
Transformer editor.
Acceptable values are as follows, where the letters A,
B, and C represent the phase designations in use in
your model (as defined in the Units tab of the
Preferences editor). If the phase designations specified
in your model are different (for example, X, Y, and Z),
then the acceptable values for this command will
change accordingly (for example, ODXY, ODYZ, ODZX,
and so on).

Y Wye

YG Wye-Gnd

D Delta

ODAB Open-Delta AB

ODBC Open-Delta BC

ODCA Open-Delta CA

YGA Open-Wye A

YGB Open-Wye B

YGC Open-Wye C

TRN_112 Editing the low-side ground reactance for a

transformer
Use the TRN_112 Model Forge command to edit the low-side ground reactance for a transformer that is
identified by its associated section name. The inputs for this command are described in the following table.
Field

User Guide

Name

Type

Description

SynSect

string

Name of the section that contains the transformer

you want to edit. If a transformer does not exist on
the specified section, then no edits will be made.

SynLowGndReact

double

Low-side ground reactance for the transformer.

This field corresponds to the low-side settings X
option on the Transformer tab of the Transformer
editor.

SynerGEE Electric 5.0

Model Forge Commands

1115

TRN_113 Overriding impedance and reactance values

for a transformer
Use the TRN_113 Model Forge command to enable or disable the override option for the impedance and
resistance values for a transformer that is identified by its associated section name, and also to edit the
impedance and resistance values. The inputs for this command are described in the following table.
Field
1

Name

Type

Description

SynAMSLink

string

AMS link that identifies which transformer you want

to edit. The AMS link is specified on the Rates tab
of the Transformer editor.
If a transformer does not exist with the specified
AMS link name, then no edits will be made. If
multiple transformers exist with the same AMS link
name, then only one of those transformers will be
updated.

OverrideImpedance

Boolean

Boolean value indicating whether the override

option will be enabled or disabled for the
impedance and resistance values for the
transformer.

0 Disabled (Impedance and Resistance

values from the transformer's warehouse
type will be used)

1 Enabled (override Impedance and

Resistance values, as specified the
Transformer editor, will be used)

This will perform the same task as selecting or

clearing the Impedance check box on the
Transformer tab of the Transformer editor.
3

Impedance

double

Impedance value for the transformer. This field

corresponds to the Impedance option on the
Transformer tab of the Transformer editor.

Resistance

double

Resistance value for the transformer. This field

corresponds to the Resistance option on the
Transformer tab of the Transformer editor.

SynerGEE Electric 5.0

User Guide

1116

User Guide

Model Forge Commands

SynerGEE Electric 5.0

APPENDIX

D
Model Cleanup
Commands
The topics listed below describe the commands that are supported in model cleanup scripts. Additional
information on the model cleanup scripts is provided Model Cleanup Scripts on page 718.

4001 Deleting duplicate nodes on page 1119

4002 Replacing phase conductors on page 1119

4003 Replacing neutral conductors on page 1121

4004 Setting the load connection to line-line for any section without a neutral on page 1122

4005 Adjusting the phasing of a section to match the adjacent sections on page 1122

4006 Setting phase-to-phase and phase-to-neutral spacing on sections on page 1122

4007 Deleting all loop tie switches on page 1123

4008 Deleting all wandering lateral tie switches on page 1124

4009 Deleting all classic protective devices on page 1124

4010 Copying switch statuses from one year to another on page 1124

4011 Growing meter demands using the feeder multiplier on page 1125

4012 Fixing phasing in force unfed areas on page 1126

4013 Copying the switchable device status from one year to other years on page 1127

4014 Copying meter device demands from one year to other years on page 1128

4015 Resetting feeder colors on page 1129

4016 Moving load from unfed phases to fed phases on page 1129

4017 Replacing invalid conductors on page 1130

4018 Growing a meters demands using a percent growth rate on page 1131

4019 Resetting meter colors on page 1132

4020 Converting classic fuses on page 1132

4021 Converting classic reclosers on page 1133

4022 Converting classic breakers on page 1133

SynerGEE Electric 5.0

User Guide

1118

Model Cleanup Commands

4023 Converting classic sectionalizers on page 1134

4024 Converting existing fuses on page 1134

4025 Converting existing reclosers on page 1135

4026 Converting existing relays on page 1136

4030 Combining close nodes on page 1137

4031 Eliminating close vertices on page 1137

4032 Eliminating duplicate open switchable devices on page 1138

4033 Eliminating zero-length sections that do not have open devices on page 1138

4034 Eliminating exposure zones with no failures on page 1139

4035 Rephasing one-phase laterals on page 1139

4036 Eliminating duplicate closed switchable devices on page 1140

4037 Using wandering laterals to feed forced unfed areas on page 1140

4038 Breaking up forced-unfed sections into one-phase lines on page 1141

4039 Picking up lost neutrals on page 1141

4040 Opening switches to clear loops on page 1142

4050 Setting the value of a field on page 1142

4051 Setting the value of a field if its current value matches a specified value on page 1143

4052 Setting the value of a field if its current value is less than a specified amount on page 1143

4053 Setting the value of a field if its current value is greater than a specified amount on
page 1144

4054 Setting the value of a field if its current value is missing or zero on page 1145

4055 Setting the value of a warehouse ID field if its current value is not in the warehouse on
page 1146

4056 Setting the value of a zone ID field if its current value is not in the warehouse on page 1147

4057 Setting the value of a protection database field if the current value is not in the protection
database on page 1148

4058 Setting the value of a field if its current value matches another field on page 1149

4059 Setting the value of a field if its current value includes a specified value on page 1150

4060 Settings the value of a field if its current value matches a specified value, and a second field
matches a second specified value on page 1150

4061 Setting the neutral conductor to same as phase on page 1151

4062 Replacing invalid conductors with the next valid upstream conductor on page 1153

4070 Growing loads across multiple years using a specified growth rate on page 1153

4071 Growing loads across multiple years using the section growth rates on page 1155

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1119

4072 Growing loads across multiple years using the section growth curves on page 1156

4073 Growing loads across multiple years using the feeder multiplier on page 1157

4074 Copying loads across multiple years on page 1159

4075 Deleting loads for unenergized years on page 1160

4076 Multiplying loads in multiple years on page 1160

4077 Growing meter demands across multiple years on page 1161

4078 Copying phasing and conductor settings across multiple years on page 1162

4081 Deleting kVA for distributed loads for the current year on page 1163

4082 Deleting kWh for distributed loads for the current year on page 1164

4083 Deleting the customer count for distributed loads for the current year on page 1164

4084 Deleting kW and kVAR for spot loads for the current year on page 1165

4099 Special code on page 1165

4101 Suppressing the model cleanup report on page 1165

4104 Suppressing the confirmation message to apply fixes on page 1165

4105 Confirming whether to run the script on page 1165

4106 Applying the script to the query set only on page 1166

4110 Correcting the orientation of regulators and transformers on page 1166

4001 DELETING DUPLICATE NODES

Use the 4001 model cleanup command to delete duplicate nodes that share the same ID. SynerGEE will
maintain the first node that it finds and then delete any subsequent nodes. The inputs for this command are
described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4002 REPLACING PHASE CONDUCTORS

Use the 4002 model cleanup command to search for a specified conductor type in all phases of all sections
and then replace those conductors with a different conductor type.

SynerGEE Electric 5.0

User Guide

1120

Model Cleanup Commands

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Find conductor

Name of the existing conductor type that you want to replace.

Replace conductor

Name of the new conductor type that will be used as the

replacement.

Note that the model cleanup scripts provide numerous other commands that can be used to replace
conductor types. For example:

Use the 4003 model cleanup command to search and replace neutral conductors. For more
information, see 4003 Replacing neutral conductors on page 1121.

Use the 4017 model cleanup command to replace invalid conductors (conductors that do not exist in
the current warehouse) with valid conductors that are found on other phases on the same section.
For more information, see 4017 Replacing invalid conductors on page 1130.

Use the 4055 model cleanup command to replace the value for the specified equipment type field, if
the existing value is not found in the current equipment data. For more information, see 4055
Setting the value of a warehouse ID field if its current value is not in the warehouse on page 1146.

Use the 4061 model cleanup command to set the neutral conductor for sections in the model to the
same as phase option. For more information, see 4061 Setting the neutral conductor to same as
phase on page 1151.

Use the 4062 model cleanup command to replace unknown conductor types in your model with the
next available upstream valid conductor type. For more information, see 4062 Replacing invalid
conductors with the next valid upstream conductor on page 1153.

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1121

4003 REPLACING NEUTRAL CONDUCTORS

Use the 4003 model cleanup command to search for a specified conductor type in all neutrals of all sections
and then replace those conductors with a different conductor type. The inputs for this command are
described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Find conductor

Name of the existing conductor type that you want to replace.

Replace conductor

Name of the new conductor type that will be used as the

replacement.

Note that the model cleanup scripts provide numerous other commands that can be used to replace
conductor types. For example:

Use the 4002 model cleanup command to search for a specified conductor type in all phases of all
sections and then replace those conductors with a different conductor type. For more information,
see 4002 Replacing phase conductors on page 1119.

Use the 4017 model cleanup command to replace invalid conductors (conductors that do not exist in
the current warehouse) with valid conductors that are found on other phases on the same section.
For more information, see 4017 Replacing invalid conductors on page 1130.

Use the 4055 model cleanup command to replace the value for the specified equipment type field, if
the existing value is not found in the current equipment data. For more information, see 4055
Setting the value of a warehouse ID field if its current value is not in the warehouse on page 1146.

Use the 4061 model cleanup command to set the neutral conductor for sections in the model to the
same as phase option. For more information, see 4061 Setting the neutral conductor to same as
phase on page 1151.

Use the 4062 model cleanup command to replace unknown conductor types in your model with the
next available upstream valid conductor type. For more information, see 4062 Replacing invalid
conductors with the next valid upstream conductor on page 1153.

SynerGEE Electric 5.0

User Guide

1122

Model Cleanup Commands

4004 SETTING THE LOAD CONNECTION TO LINE-LINE

FOR ANY SECTION WITHOUT A NEUTRAL
Use the 4004 model cleanup command to fix models that have line-ground load connections on sections
without a neutral wire by setting those sections to line-line connections. The inputs for this command are
described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4005 ADJUSTING THE PHASING OF A SECTION TO

MATCH THE ADJACENT SECTIONS
Use the 4005 model cleanup command to find sections that have different phasing than the two adjacent
sections (such as a two-phase section between two three-phase sections) and then adjust the phasing of the
middle section to match the adjacent sections. The inputs for this command are described in the following
table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4006 SETTING PHASE-TO-PHASE AND PHASE-TONEUTRAL SPACING ON SECTIONS

Use the 4006 model cleanup command to find sections with a specified number of phase conductors and with
a current phase-to-phase spacing that is less than a specified amount (in feet). For any section where these
conditions are met, this command will change the existing phase-to-phase and phase-to-neutral spacing
values to new specified values (in feet).
Notes: The phase-to-phase and phase-to-neutral values are specified on the Construction tab of the
Section editor.

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1123

This command replaces the functionality of the section spacing lookup table in standalone
MiddleLink 3.4 and earlier versions of SynerGEE that used the validator. For more information, see
Importing GIS Data Using MiddleLink on page 100.
Pay attention to the units of measurement when using this command. The spacing values in your
Section editors may not be displayed in the same units of measurement that are used by this
command (feet).
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

# Ph Wires

Number of phase conductors that must be present on a section

in order for this command to apply. Specify a value of 1, 2, or 3.

If PP (FEET).LT.

Maximum value, in feet, of the current phase-to-phase spacing in

order for this command to apply. Any section with a current
phase-to-phase spacing that is greater than this value will not be
affected by this command.

New PP (FEET)

New phase-to-phase spacing value, in feet, that will be applied to

the section if the initial conditions are met.

New PN (FEET)

New phase-to-neutral spacing value, in feet, that will be applied

to the section if the initial conditions are met.

4007 DELETING ALL LOOP TIE SWITCHES

Use the 4007 model cleanup command to delete all loop tie switches from the model. The inputs for this
command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

For more information on loops, see Loops and Wandering Laterals on page 253.

SynerGEE Electric 5.0

User Guide

1124

Model Cleanup Commands

4008 DELETING ALL WANDERING LATERAL TIE

SWITCHES
Use the 4008 model cleanup command to delete all wandering lateral tie switches from the model. The inputs
for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

For more information on wandering laterals, see Loops and Wandering Laterals on page 253.

4009 DELETING ALL CLASSIC PROTECTIVE DEVICES

Use the 4009 model cleanup command to delete all classic protective devices from the model, without
converting them to anything else. The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

For more information on classic devices, see Classic protective devices on page 600.

4010 COPYING SWITCH STATUSES FROM ONE YEAR

TO ANOTHER
Use the 4010 model cleanup command to copy the switch status for all switches in memory from one
specified year to another specified year. This command is only applicable if you use multi-year modeling.
Also note that this command affects all switches in memory; feeder selection is not considered.

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1125

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

From year

Model year that the switch statuses will be copied from.

Acceptable values are 0 through 9, where year 0 represents the
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

To year

Model year that the switch statuses will be copied to. Acceptable
values are 1 through 10. Do not use the custom year labels that
you have configured in your preferences (for example, 2012,
2013, etc.).
Note that any years in between the From year and To year will
not be updated. For example, if you copy switch statuses from
year 0 to year 4, the statuses for years 1 through 3 will not be
edited.

4011 GROWING METER DEMANDS USING THE

FEEDER MULTIPLIER
Use the 4011 model cleanup command to grow meter demands using the respective feeder multiplier over a
specified range of years. This command is only applicable if you use multi-year modeling.
In the 4011 command, you specify a base year, which is the year that demand values will be copied from.
Those base year demands will be multiplied by the feeder multiplier, and the resulting values will be applied
to the following year. (Note that the existing values on that following year will be discarded and replaced with
the new, calculated values.) This process will repeat itself, continuing to grow the demands by the feeder
multiplier each year, until the grow to year is updated. Any years after the grow to year will retain their
original values. The base year, as well as any years before the base year, will also retain their original values.
Note the following before using the 4011 model cleanup command:

The feeder multiplier is specified on the Feeder tab of the Feeder editor. For more information, see
Editing general data for a feeder or subtran node on page 248.

Demands are stored in meter devices. Feeder demands are considered to be those held by meters
directly downstream from feeder sources.

The 4011 model cleanup command affects subtran demands as well, using the same criteria.

SynerGEE Electric 5.0

User Guide

1126

Model Cleanup Commands

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Base year

0 No (not included in Details report)

1 Yes (included in Details report)

Start year for the growth of the meter demands. The demands for
this year will be multiplied by the feeder multiplier, and the result
will be applied to the following year. That years updated
demands will again be multiplied by the feeder multiplier, with the
result applied to the next year. This process will repeat until the
Grow to year has been updated.
Acceptable values are 0 through 9, where 0 represents the actual
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

Grow to year

Final model year that growth of the base year demands will be
applied to. Acceptable values are 1 through 10. Do not use the
custom year labels that you have configured in your preferences
(for example, 2012, 2013, etc.).

4012 FIXING PHASING IN FORCE UNFED AREAS

Force-unfed areas result from sections that are topologically fed but are missing one or more feeding phases.
In these cases, SynerGEE assumes that they are completely unfed and ignores them during analysis.
Use the 4012 model cleanup command to search an entire model for force-unfed sections. When found,
SynerGEE attempts to drop any unfed phases on the force-unfed sections, in an effort to restore the sections
to fully fed, as recognized by SynerGEE. If restoration cannot be completed by dropping phases alone, a
rephase option can be applied for more extensive phase alterations.
Note the following before using the 4012 model cleanup command:

The 4012 model cleanup command operates on all force-unfed areas in memory.

The 4012 command causes phase changes only. It does not cause the elimination of sections.

All phase changes affect the section and any applicable equipment, such as protective devices.

If an eliminated phase contains load, that load is effectively eliminated as well. However, the original
load values remain a part of the section record and can be restored by re-energizing the affected
phase.

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1127

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Allow rephase

0 No (not included in Details report)

1 Yes (included in Details report)

Boolean value that, if set to 1, enables model cleanup to perform

more detailed phase changes if dropping phases alone cannot fix
the problem. For example, if a phase AN section feeds a phase
CN section, model cleanup cannot restore the phase CN section
by dropping phases alone. However, if the Allow rephase
parameter is enabled, model cleanup can rephase it to AN.
Acceptable values are as follows:

By Ph Cond (optional)

0 No (do not allow rephasing)

1 Yes (allow rephasing)

Optional conductor type that the phasing changes will be

restricted to. If this parameter is left blank, then all conductor
types will be considered.

For more information on force-unfed sections, see About force-unfed sections on page 263.

4013 COPYING THE SWITCHABLE DEVICE STATUS

FROM ONE YEAR TO OTHER YEARS
Use the 4013 model cleanup command to copy the status for all switchable devices in memory from one
specified year to another specified year. This command is only applicable if you use multi-year modeling.
Also note that this command affects all devices in memory; feeder selection is not considered.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

SynerGEE Electric 5.0

0 No (not included in Details report)

1 Yes (included in Details report)

User Guide

1128

Model Cleanup Commands

Field

Name

Description

Base year

Model year that the device statuses will be copied from.

Acceptable values are 0 through 9, where year 0 represents the
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

Final year

Final model year that the device statuses will be copied to.
Acceptable values are 1 through 10. Do not use the custom year
labels that you have configured in your preferences (for example,
2012, 2013, etc.).
Note that any years between the Base year and Final year will be
updated as well. For example, if you copy switch statuses from
year 0 to year 4, the statuses for years 1 through 3 will also be
updated.

Only in query

Boolean value specifying whether this command will be applied

to devices in the query set only, or to the entire model.

0 Entire model

1 Query set only

4014 COPYING METER DEVICE DEMANDS FROM ONE

YEAR TO OTHER YEARS
Use the 4014 model cleanup command to copy demands for all metered devices in memory from one
specified year to another specified year. This command is only applicable if you use multi-year modeling.
Also note that this command affects all metered devices in memory; feeder selection is not considered.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

User Guide

Base year

0 No (not included in Details report)

1 Yes (included in Details report)

Model year that the meter demands will be copied from.

Acceptable values are 0 through 9, where year 0 represents the
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

SynerGEE Electric 5.0

Model Cleanup Commands

Field
3

1129

Name

Description

Final year

Final model year that the meter demands will be copied to.
Acceptable values are 1 through 10. Do not use the custom year
labels that you have configured in your preferences (for example,
2012, 2013, etc.).
Note that any years between the Base year and Final year will be
updated as well. For example, if you copy meter demands from
year 0 to year 4, the demands for years 1 through 3 will also be
edited.

Only in query

Boolean value specifying whether this command will be applied

to devices in the query set only, or to the entire model.

0 Entire model

1 Query set only

4015 RESETTING FEEDER COLORS

Use the 4015 model cleanup command to reset feeder and subtran colors using a random selection of colors.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4016 MOVING LOAD FROM UNFED PHASES TO FED

PHASES
Use the 4016 model cleanup command to spread load from unfed phases evenly across fed phases for each
section. The load on the unfed phases is eliminated, as it is replaced by the evenly distributed loads on the
fed phases.
Note the following before using the 4016 model cleanup command:

Fed phases are determined through propagation, and not necessarily by the phasing specified in
the respective Section editor.

Both spot loads and distributed loads are considered by this command.

All load-related values are considered, including kW, kvar, kVA, kWh, and customers.

SynerGEE Electric 5.0

User Guide

1130

Model Cleanup Commands

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4017 REPLACING INVALID CONDUCTORS

Use the 4017 model cleanup command to replace invalid conductors (conductors that do not exist in the
current warehouse) on a section with valid conductors that are found on other phases on the same section. If
no valid conductors are found, an optional default conductor from the 4017 command can be used. If
SynerGEE cannot find a valid conductor on the section and if the default conductor in the 4017 record is
either not specified or also invalid, then no changes will be made to that section.
This command is useful after a section rephase that has set conductors by phase as the configuration option.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Default conductor
(optional)

0 No (not included in Details report)

1 Yes (included in Details report)

Optional conductor that can be used as a replacement, if no valid

conductors are found on the section.

Note that the model cleanup scripts provide numerous other commands that can be used to replace
conductor types. For example:

Use the 4002 model cleanup command to search for a specified conductor type in all phases of all
sections and then replace those conductors with a different conductor type. For more information,
see 4002 Replacing phase conductors on page 1119.

Use the 4003 model cleanup command to search and replace neutral conductors. For more
information, see 4003 Replacing neutral conductors on page 1121.

Use the 4055 model cleanup command to replace the value for the specified equipment type field, if
the existing value is not found in the current equipment data. For more information, see 4055
Setting the value of a warehouse ID field if its current value is not in the warehouse on page 1146.

Use the 4061 model cleanup command to set the neutral conductor for sections in the model to the
same as phase option. For more information, see 4061 Setting the neutral conductor to same as

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1131

phase on page 1151.

Use the 4062 model cleanup command to replace unknown conductor types in your model with the
next available upstream valid conductor type. For more information, see 4062 Replacing invalid
conductors with the next valid upstream conductor on page 1153.

4018 GROWING A METERS DEMANDS USING A

PERCENT GROWTH RATE
Use the 4018 model cleanup command to grow meter demands using a specified growth rate percentage
over a specified range of years. This command is only applicable if you use multi-year modeling.
In the 4018 command, you specify a base year, which is the year that demand values will be copied from.
Those base year demands will be multiplied by the specified growth rate percentage, and the resulting values
will be applied to the following year. (Note that the existing values on that following year will be discarded and
replaced with the new, calculated values.) This process will repeat itself, continuing to grow the demands by
the specified growth rate each year, until the grow to year is updated. Any years after the grow to year will
retain their original values. The base year, as well as any years before the base year, will also retain their
original values.
Note the following before using the 4018 model cleanup command:

Demands are stored in meter devices. Feeder demands are considered to be those held by meters
directly downstream from feeder sources.

The 4018 model cleanup command affects subtran demands as well, using the same criteria.

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Base year

0 No (not included in Details report)

1 Yes (included in Details report)

Start year for the growth of the meter demands. The demands for
this year will be multiplied by the percentage growth rate, and the
result will be applied to the following year. That years updated
demands will again be multiplied by the growth rate, with the
result applied to the next year. This process will repeat until the
Grow to year has been updated.
Acceptable values are 0 through 9, where 0 represents the actual
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

SynerGEE Electric 5.0

User Guide

1132

Model Cleanup Commands

Field

Name

Description

Grow to year

Final model year that growth of the base year demands will be
applied to. Acceptable values are 1 through 10. Do not use the
custom year labels that you have configured in your preferences
(for example, 2012, 2013, etc.).

Pct growth rate

Percentage-based growth rate that will be used to increase

demands between the base year and the grow to year.

4019 RESETTING METER COLORS

Use the 4019 model cleanup command to reset meter colors using a selection of random colors. The inputs
for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4020 CONVERTING CLASSIC FUSES

Use the 4020 model cleanup command to replace classic fuses of a specified type with a new fuse type. The
old classic fuses are completely eliminated.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Old type

0 No (not included in Details report)

1 Yes (included in Details report)

Name of the classic fuse type that you want to find and replace.
Classic fuses by any other type are not affected.
Use an asterisk ( * ) to find and replace all classic fuse types.

User Guide

New manuf

New manufacturer type that will be used by the replacement

fuse.

SynerGEE Electric 5.0

Model Cleanup Commands

Field

1133

Name

Description

New model

New model type that will be used by the replacement fuse.

New amp rat

New amp rating that will be used by the replacement fuse.

New volt rat

New volt rating that will be used by the replacement fuse.

4021 CONVERTING CLASSIC RECLOSERS

Use the 4021 model cleanup command to replace classic reclosers of a specified type with a new recloser
type. The old classic reclosers are completely eliminated.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Old type

0 No (not included in Details report)

1 Yes (included in Details report)

Name of the classic recloser type that you want to find and
replace. Classic reclosers by any other type are not affected.
Use an asterisk ( * ) to find and replace all classic recloser types.

New manuf

New manufacturer type that will be used by the replacement

recloser.

New model

New model type that will be used by the replacement recloser.

New amp rat

New amp rating that will be used by the replacement recloser.

4022 CONVERTING CLASSIC BREAKERS

Use the 4022 model cleanup command to replace classic breakers of a specified type with a new breaker
type. The old classic breakers are completely eliminated.

SynerGEE Electric 5.0

User Guide

1134

Model Cleanup Commands

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Old type

0 No (not included in Details report)

1 Yes (included in Details report)

Name of the classic breaker type that you want to find and
replace. Classic breakers by any other type are not affected.
Use an asterisk ( * ) to find and replace all classic breaker types.

New manuf

New manufacturer type that will be used by the replacement

breaker.

New model

New model type that will be used by the replacement breaker.

New ph curve

New phase curve to that will be used by the replacement

breaker.

New tap

New tap to be applied that will be used by the replacement

breaker.

4023 CONVERTING CLASSIC SECTIONALIZERS

Use the 4023 model cleanup command to replace specified classic sectionalizers with new sectionalizer
types. All data parameters for the new device are retrieved from the classic equipment data record.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4024 CONVERTING EXISTING FUSES

Use the 4024 model cleanup command to complete the conversion of classic fuses following a MiddleLink
3.4 import. This command configures fuses based on the Manufacturer field, which is set with the classic
device type during a MiddleLink 3.4 import. For more information on the entire conversion process, see
Model cleanup and classic protective device conversion on page 719.

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1135

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Old manuf

0 No (not included in Details report)

1 Yes (included in Details report)

Manufacturer name for the fuses that you want to replace. Fuses
by any other manufacturer name are not affected.
Use an asterisk ( * ) to find and replace all fuses in the model.

New manuf

New manufacturer type to be applied to the fuses that are being

replaced.

New model

New model type to be applied to the fuses that are being

replaced.

New amp rat

New amp rating to be applied to the fuses that are being

replaced.

New volt rat

New volt rating to be applied to the fuses that are being replaced.

The 4024 model cleanup command applies to the completion of a MiddleLink 3.4-initiated conversion only. To
convert an original classic fuse from scratch, use the 4020 command. For more information, see 4020
Converting classic fuses on page 1132.

4025 CONVERTING EXISTING RECLOSERS

Use the 4025 model cleanup command to complete the conversion of classic reclosers following a
MiddleLink 3.4 import. This command configures reclosers based on the Manufacturer field, which is set with
the classic device type during a MiddleLink 3.4 import. For more information on the entire conversion
process, see Model cleanup and classic protective device conversion on page 719.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

SynerGEE Electric 5.0

0 No (not included in Details report)

1 Yes (included in Details report)

User Guide

1136

Model Cleanup Commands

Field
2

Name

Description

Old manuf

Manufacturer name for the reclosers that you want to replace.

Reclosers by any other manufacturer name are not affected.
Use an asterisk ( * ) to find and replace all reclosers in the model.

New manuf

New manufacturer type to be applied to the reclosers that are

being replaced.

New model

New model type to be applied to the reclosers that are being

replaced.

New amp rat

New amp rating to be applied to the reclosers that are being

replaced.

The 4025 model cleanup command applies to the completion of a MiddleLink 3.4-initiated conversion only. To
convert an original classic recloser from scratch, use the 4021 command. For more information, see 4021
Converting classic reclosers on page 1133.

4026 CONVERTING EXISTING RELAYS

Use the 4026 model cleanup command to complete the conversion of classic breakers following a MiddleLink
3.4 import. This command configures breakers based on the Manufacturer field, which is set with the classic
device type during a MiddleLink 3.4 import. For more information on the entire conversion process, see
Model cleanup and classic protective device conversion on page 719.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Old type

0 No (not included in Details report)

1 Yes (included in Details report)

Manufacturer name for the breakers that you want to replace.

Breakers by any other manufacturer name are not affected.
Use an asterisk ( * ) to find and replace all breakers in the model.

User Guide

New manuf

New manufacturer type to be applied to the breakers that are

being replaced.

New model

New model type to be applied to the breakers that are being

replaced.

New family

New family to be applied to the breakers that are being replaced.

New pickup

New pickup to be applied to the breakers that are being replaced.

SynerGEE Electric 5.0

Model Cleanup Commands

1137

The 4026 model cleanup command applies to the completion of a MiddleLink 3.4-initiated conversion only. To
convert an original classic breaker from scratch, use the 4022 command. For more information, see 4022
Converting classic breakers on page 1133.

4030 COMBINING CLOSE NODES

Use the 4030 model cleanup command to combine nodes within a specified distance (in feet) from each
other, so that the incident sections are connected through the combined node. The inputs for this command
are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Max distance (ft)

Maximum distance between nodes (in feet) in order for the nodes
to be combined through this command.

Allow loops

Boolean value specifying whether loops will be allowed when

nodes are combined.

0 No (loops are not allowed)

1 Yes (loops are allowed)

If no value is specified for this parameter, then loops will be

allowed.

4031 ELIMINATING CLOSE VERTICES

Use the 4031 model cleanup command to eliminate vertices within a specified distance (in feet) from each
other or from the sections nodes. The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Max distance (ft)

SynerGEE Electric 5.0

0 No (not included in Details report)

1 Yes (included in Details report)

Maximum distance (in feet) between two vertices, or between a

vertex and a node, in order for the vertices to be combined
through this command.

User Guide

1138

Model Cleanup Commands

4032 ELIMINATING DUPLICATE OPEN SWITCHABLE

DEVICES
Use the 4032 model cleanup command to eliminate duplicate (redundant) open switchable devices when the
following conditions are true:

Both switchable devices are the same type (that is, a breaker and a breaker, or a switch and a
switch).

Both switchable devices share the same near node.

Both switchable devices are open.

The common node for both switchable devices has an incidence of exactly two.

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4033 ELIMINATING ZERO-LENGTH SECTIONS THAT

DO NOT HAVE OPEN DEVICES
Use the 4033 model cleanup command to eliminate zero-length sections that do not have any open devices.
A zero-length section is a section that has nodes at the same coordinate and no path through vertices.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

User Guide

0 No (not included in Details report)

1 Yes (included in Details report)

SynerGEE Electric 5.0

Model Cleanup Commands

1139

4034 ELIMINATING EXPOSURE ZONES WITH NO

FAILURES
Use the 4034 model cleanup command to eliminate exposure zones that have no failures. If an exposure
zone does not see an outage in its historical data, then it does not play a role in a Reliability analysis and may
be considered as clutter that can be removed from the model.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4035 REPHASING ONE-PHASE LATERALS

Use the 4035 model cleanup command to rephase one-phase laterals. The 4035 command is designed for
cases when the phasing of single-phase lines is not known when the model is built for SynerGEE. In these
situations, the phasing is often defaulted to phase A. This results in a model with no three-phase line, or with
single-phase lines that are all phased A. The 4035 command will evaluate a model and rephase all singlephase laterals in the order of A, B, and C. In other words, SynerGEE will rephase the first single phase lateral
that it finds to phase A, and the next single-phase lateral to B, and the next one to C. SynerGEE will then
return to phase A and continue the process until the evaluation is complete. This process results in a model
that has a better distribution of phasing in its laterals, even though the SynerGEE phasing will still not reflect
the actual phasing in the field.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

SynerGEE Electric 5.0

0 No (not included in Details report)

1 Yes (included in Details report)

User Guide

1140

Model Cleanup Commands

4036 ELIMINATING DUPLICATE CLOSED SWITCHABLE

DEVICES
Use the 4036 model cleanup command to eliminate duplicate (redundant) closed switchable devices when
the following conditions are true:

Both switchable devices are the same type (that is, a breaker and a breaker, or a switch and a
switch).

Both switchable devices share the same near node.

Both switchable devices are closed.

The common node for both switchable devices has an incidence of exactly two.

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4037 USING WANDERING LATERALS TO FEED

FORCED UNFED AREAS
Use the 4037 model cleanup command to review forced unfed areas to determine if a wandering lateral
exists somewhere upstream that could supply the needed phases. This command includes an optional
parameter that can restrict changes to sections with a specified phase conductor.
Consider the following example: Suppose sections with phasing AB feed a node and sections along another
path feed the same node with phase C. Additional sections then extend out from that node with phase A.
Those sections will be fed. Farther downstream, the phase A sections feed a section with phase A,B,C. The
three-phase section will be forced unfed because it is fed from phase A. The 4037 command would look at
the unfed three-phase section and then search the connectivity of the model. It would see that phases B and
C could be run from the wandering lateral point to the three-phase section to get things connected.

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1141

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

By Ph Cond (optional)

0 No (not included in Details report)

1 Yes (included in Details report)

Optional conductor type that the model cleanup command will be

restricted to. If this parameter is left blank, then all conductor
types will be considered.

4038 BREAKING UP FORCED-UNFED SECTIONS INTO

ONE-PHASE LINES
Use the 4038 model cleanup command to separate phases in forced-unfed areas where individual phases in
a section are fed from different directions. This will allow SynerGEE to perform analyses on areas where the
power is flowing in different directions on the sections.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4039 PICKING UP LOST NEUTRALS

Use the 4039 model cleanup command to pick up lost neutrals. The inputs for this command are described in
the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

SynerGEE Electric 5.0

0 No (not included in Details report)

1 Yes (included in Details report)

User Guide

1142

Model Cleanup Commands

4040 OPENING SWITCHES TO CLEAR LOOPS

Use the 4040 model cleanup command to open switches to clear loops. The inputs for this command are
described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4050 SETTING THE VALUE OF A FIELD

The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4050 model cleanup command to set the value of a specified field in a specified table. No
consideration is given to the existing value of the field; it will automatically be replaced by this command.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Table

Name of the table in the Access schema where you want to

replace the value of a specified field.

Field

Name of the field in the specified table where you want to replace
the value.

Set value

New value to be assigned to the specified field.

Note that the 4050 model cleanup command is the only 4050-series command that is valid for Boolean data
types.

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1143

4051 SETTING THE VALUE OF A FIELD IF ITS

CURRENT VALUE MATCHES A SPECIFIED VALUE
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4051 model cleanup command to set the value for a specified field in a specified table value when
the current value matches a specified match value. The inputs for this command are described in the
following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Table

Name of the table in the Access schema where you want to

replace the value of a specified field.

Field

Name of the field in the specified table where you want to replace
the value.

Set value

New value to be assigned to the specified field, if the current

value matches the match value.

Match value

Value to compare against the current field value. If the current

field value matches the match value, then the current value is
replaced with the set value.

4052 SETTING THE VALUE OF A FIELD IF ITS

CURRENT VALUE IS LESS THAN A SPECIFIED AMOUNT
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4052 model cleanup command to set the value for a specified field in a specified table if the current
value is less than a specified compare value. Although this command can perform alphabetic comparisons
of string values, it is generally intended for numeric values only.

SynerGEE Electric 5.0

User Guide

1144

Model Cleanup Commands

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Table

Name of the table in the Access schema where you want to

replace the value of a specified field.

Field

Name of the field in the specified table where you want to replace
the value.

Set value

New value to be assigned to the specified field, if the current

value is less than the compare value.

Compare value

Value to compare against the current field value. If the current

field value is less than the compare value, then the current
value is replaced with the set value.

4053 SETTING THE VALUE OF A FIELD IF ITS

CURRENT VALUE IS GREATER THAN A SPECIFIED
AMOUNT
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4053 model cleanup command to set the value for a specified field in a specified table if the current
value is greater than a specified compare value. Although this command can perform alphabetic
comparisons of string values, it is generally intended for numeric values only.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

User Guide

Table

0 No (not included in Details report)

1 Yes (included in Details report)

Name of the table in the Access schema where you want to

replace the value of a specified field.

SynerGEE Electric 5.0

Model Cleanup Commands

1145

Field

Name

Description

Field

Name of the field in the specified table where you want to replace
the value.

Set value

New value to be assigned to the specified field, if the current

value is greater than the compare value.

Compare value

Value to compare against the current field value. If the current

field value is greater than the compare value, then the current
value is replaced with the set value.

4054 SETTING THE VALUE OF A FIELD IF ITS

CURRENT VALUE IS MISSING OR ZERO
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4054 model cleanup command to set the value for a specified field in a specified table if the existing
value is either missing or equal to zero. The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Table

Name of the table in the Access schema where you want to

replace the value of a specified field.

Field

Name of the field in the specified table where you want to replace
the value.

Set value

New value to be assigned to the specified field, if the current

value is missing or equal to zero.

SynerGEE Electric 5.0

User Guide

1146

Model Cleanup Commands

4055 SETTING THE VALUE OF A WAREHOUSE ID

FIELD IF ITS CURRENT VALUE IS NOT IN THE
WAREHOUSE
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4055 model cleanup command to replace the value for the specified equipment type field, if the
existing value is not found in the current equipment data. Note the following before using the 4055 command:

This command is only applicable to fields that reference an equipment type in your equipment data.
These fields show up in various places where a reference to equipment data is made, such as the
UniqueDeviceId for devices such as regulators and generators, or the PhaseConductorId and
ConfigurationId fields for sections.
If you specify a non-equipment type field, the command will still function, but will likely never find a
match in the equipment types, and likewise always replace the data. For example, if you specify the
Description field of the InstSection table, all section descriptions will likely be replaced, unless by
some chance they match equipment types in the equipment data. Therefore, you should be careful
to specify only fields that reference equipment types.

Although usually considered equipment data, this command does not work for zones. To validate
zone IDs, use model cleanup command 4056, as described in 4056 Setting the value of a zone ID
field if its current value is not in the warehouse on page 1147.

This command is only applicable to string data fields.

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Table

Name of the table in the Access schema where you want to

replace the value of a specified field.

Field

Name of the field in the specified table where you want to replace
the value.

Set value

New value to be assigned to the specified field, if the current

value is not valid.

Note that the model cleanup scripts provide numerous other commands that can be used to replace
conductor types. For example:

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1147

Use the 4002 model cleanup command to search for a specified conductor type in all phases of all
sections and then replace those conductors with a different conductor type. For more information,
see 4002 Replacing phase conductors on page 1119.

Use the 4003 model cleanup command to search and replace neutral conductors. For more
information, see 4003 Replacing neutral conductors on page 1121.

Use the 4017 model cleanup command to replace invalid conductors (conductors that do not exist in
the current warehouse) with valid conductors that are found on other phases on the same section.
For more information, see 4017 Replacing invalid conductors on page 1130.

Use the 4061 model cleanup command to set the neutral conductor for sections in the model to the
same as phase option. For more information, see 4061 Setting the neutral conductor to same as
phase on page 1151.

Use the 4062 model cleanup command to replace unknown conductor types in your model with the
next available upstream valid conductor type. For more information, see 4062 Replacing invalid
conductors with the next valid upstream conductor on page 1153.

4056 SETTING THE VALUE OF A ZONE ID FIELD IF ITS

CURRENT VALUE IS NOT IN THE WAREHOUSE
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4056 model cleanup command to replace the value for the specified zone ID field, if the existing
value is not found in the current equipment data. Note the following before using the 4056 command:

This command is only applicable to fields that reference a zone type in your equipment data, such
as the SpotLoadCustZone and DistLoadCustZone fields contained in the InstSection table in
Access. If you specify any other field, the command will still function, but will probably always
replace the data, because it is not likely to find a match in the zone types. For example, if you
specify the Description field of the InstSection table, all section descriptions will likely be replaced,
unless by some chance they match zone types in the equipment data. Therefore, you should be
careful to specify only fields that reference zone types.

This command is only applicable to string data fields.

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

SynerGEE Electric 5.0

0 No (not included in Details report)

1 Yes (included in Details report)

User Guide

1148

Model Cleanup Commands

Field

Name

Description

Table

Name of the table in the Access schema where you want to

replace the value of a specified field.

Field

Name of the field in the specified table where you want to replace
the value.

Set value

New value to be assigned to the specified field, if the current

value is not valid.

4057 SETTING THE VALUE OF A PROTECTION

DATABASE FIELD IF THE CURRENT VALUE IS NOT IN THE
PROTECTION DATABASE
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4057 model cleanup command to replace the value for the specified protection database-related
field, if the existing value is not found in the current protection data. Note the following before using the 4056
command:

This command is only applicable to fields that reference a protective device manufacturer or model.
For example, you can use it on the Manufacturer and Model fields of the InstFuses and
InstReclosers tables. Any other usage may produce unpredictable results.

This command may be part of a protective device conversion process, perhaps following a
MiddleLink 3.4 model data import. Often, though, the 4024, 4025, and 4026 commands are more
appropriate for this purpose. For more information, see Model cleanup and classic protective
device conversion on page 719.

This command is only applicable to string data fields.

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

User Guide

Table

0 No (not included in Details report)

1 Yes (included in Details report)

Name of the table in the Access schema where you want to

replace the value of a specified field.

SynerGEE Electric 5.0

Model Cleanup Commands

1149

Field

Name

Description

Field

Name of the field in the specified table where you want to replace
the value.

Set value

New value to be assigned to the specified field, if the current

value is not valid.

4058 SETTING THE VALUE OF A FIELD IF ITS

CURRENT VALUE MATCHES ANOTHER FIELD
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4058 model cleanup command to set a value for a specified data field, but only if another field
matches a specified value. In other words, it sets a field based on an evaluation of another field, on a recordby-record basis.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Table

Name of the table in the Access schema where you want to

replace the value of a specified field.

Field

Name of the field in the specified table where you want to replace
the value.

Match Value

Value to compare against the current field value. If the current

field value matches the match value on the specified second
field, then the current value is replaced with the set value.

Field

Second field in the specified table, whose value you want to

compare to the first field in order to replace its value.

Set Value

New value to be assigned to the specified field, if the match

condition is met.

SynerGEE Electric 5.0

User Guide

1150

Model Cleanup Commands

4059 SETTING THE VALUE OF A FIELD IF ITS

CURRENT VALUE INCLUDES A SPECIFIED VALUE
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4059 model cleanup command to set a value for a specified data field, but only if its current value
includes a specified value. In other words, it sets a field based on an evaluation of its current value, on a
record-by-record basis.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Table

Name of the table in the Access schema where you want to

replace the value of a specified field.

Field

Name of the field in the specified table where you want to replace
the value. The field will be replaced if the current value matches
the value specified in parameter 5 (Contains value).

Set value

New value to be assigned to the specified field, if its current value

includes the value specified in parameter 5 (Contains value).

Contains value

Value to compare against the current field value. If the current

field value includes this value, then the current value is replaced
with the set value.

4060 SETTINGS THE VALUE OF A FIELD IF ITS

CURRENT VALUE MATCHES A SPECIFIED VALUE, AND A
SECOND FIELD MATCHES A SECOND SPECIFIED VALUE
The 4050-series model cleanup commands make model changes and corrections from the perspective of
SynerGEE tables and fields. These records can modify any specified field in the model, with the exception of
record key fields such as FeederID and SectionID.
Use the 4060 model cleanup command to set a value for a specified data field based on two matching
conditions: (1) that its current value matches a specified value, and (2) that a second field matches a second

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1151

specified value. In other words, this command sets a field based on an evaluation of both its current value
and the value of a second field, on a record-by-record basis.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Table

Name of the table in the Access schema where you want to

replace the value of a specified field.

Field A

Name of the field in the specified table where you want to replace
the value. The value will be replaced if two conditions are met:
that this field (Field A) matches the value specified in parameter
4 (Match Value A), and that Field B matches the value
specified in parameter 6 (Match Value B).

Match Value A

Value to compare against the current field value (Field A).

Field B

Name of a second field in the specified table, whose value you

also want to use for comparison purposes.

Match Value B

Value to compare against the second field value (Field B).

Set Value

New value to be assigned to the Field A, if the conditions

described above are met.

4061 SETTING THE NEUTRAL CONDUCTOR TO SAME

AS PHASE
Use the 4061 model cleanup command to set the neutral conductor for sections in the model to the same as
phase option. This command includes a Boolean parameter that you can use to apply this command to
underground conductors only, and another parameter that you can use to apply this command to invalid
neutral conductors only (conductors that do not exist in the current warehouse).

SynerGEE Electric 5.0

User Guide

1152

Model Cleanup Commands

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Is underground

Replace only if invalid

neutral conductor
(optional)

0 No (not included in Details report)

1 Yes (included in Details report)

Boolean value specifying whether neutral conductors will be set

to same as phase for above ground conductors only, or
underground conductors only.

0 Above ground only

1 Underground only

Boolean value specifying whether neutral conductors will be set

to same as phase only when the current neutral conductor type
is invalid (that is, it does not exist in the current warehouse).

0 Replace both valid and invalid conductors

1 Replace invalid conductors only

Note that the model cleanup scripts provide numerous other commands that can be used to replace
conductor types. For example:

Use the 4002 model cleanup command to search for a specified conductor type in all phases of all
sections and then replace those conductors with a different conductor type. For more information,
see 4002 Replacing phase conductors on page 1119.

Use the 4003 model cleanup command to search and replace neutral conductors. For more
information, see 4003 Replacing neutral conductors on page 1121.

Use the 4017 model cleanup command to replace invalid conductors (conductors that do not exist in
the current warehouse) with valid conductors that are found on other phases on the same section.
For more information, see 4017 Replacing invalid conductors on page 1130.

Use the 4055 model cleanup command to replace the value for the specified equipment type field, if
the existing value is not found in the current equipment data. For more information, see 4055
Setting the value of a warehouse ID field if its current value is not in the warehouse on page 1146.

Use the 4062 model cleanup command to replace unknown conductor types in your model with the
next available upstream valid conductor type. For more information, see 4062 Replacing invalid
conductors with the next valid upstream conductor on page 1153.

User Guide

SynerGEE Electric 5.0

Model Cleanup Commands

1153

4062 REPLACING INVALID CONDUCTORS WITH THE

NEXT VALID UPSTREAM CONDUCTOR
Use the 4062 model cleanup command to replace unknown conductor types in your model with the next
available upstream valid conductor type. The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Note that the model cleanup scripts provide numerous other commands that can be used to replace
conductor types. For example:

Use the 4002 model cleanup command to search for a specified conductor type in all phases of all
sections and then replace those conductors with a different conductor type. For more information,
see 4002 Replacing phase conductors on page 1119.

Use the 4003 model cleanup command to search and replace neutral conductors. For more
information, see 4003 Replacing neutral conductors on page 1121.

Use the 4017 model cleanup command to replace invalid conductors (conductors that do not exist in
the current warehouse) with valid conductors that are found on other phases on the same section.
For more information, see 4017 Replacing invalid conductors on page 1130.

Use the 4055 model cleanup command to replace the value for the specified equipment type field, if
the existing value is not found in the current equipment data. For more information, see 4055
Setting the value of a warehouse ID field if its current value is not in the warehouse on page 1146.

Use the 4061 model cleanup command to set the neutral conductor for sections in the model to the
same as phase option. For more information, see 4061 Setting the neutral conductor to same as
phase on page 1151.

4070 GROWING LOADS ACROSS MULTIPLE YEARS

USING A SPECIFIED GROWTH RATE
Use the 4070 model cleanup command to grow section loads using a specified growth rate percentage over
a specified range of years. This command is only applicable if you use multi-year modeling.
In the 4070 command, you specify a base year, which is the year that load values will be copied from.
Those base year loads will be multiplied by the specified growth rate percentage, and the resulting values will
be applied to the following year. (Note that the existing values on that following year will be discarded and
replaced with the new, calculated values.) This process will repeat itself, continuing to grow the loads by the
specified growth rate each year, until the grow to year is updated. Any years after the grow to year will

SynerGEE Electric 5.0

User Guide

1154

Model Cleanup Commands

retain their original values. The base year, as well as any years before the base year, will also retain their
original values.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Base year

0 No (not included in Details report)

1 Yes (included in Details report)

Start year for the growth of the section loads. The loads for this
year will be multiplied by the percentage growth rate, and the
result will be applied to the following year. That years updated
loads will again be multiplied by the growth rate, with the result
applied to the next year. This process will repeat until the Grow
to year has been updated.
Acceptable values are 0 through 9, where 0 represents the actual
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

Grow to year

Final model year that growth of the base year demands will be
applied to. Acceptable values are 1 through 10. Do not use the
custom year labels that you have configured in your preferences
(for example, 2012, 2013, etc.).

Load type

Text value that represents the type of load that will be copied.
Acceptable values are as follows:

User Guide

Pct growth rate

D Distributed load

S Spot load

L Large customer load

G Large customer distributed generator

P Project load

A Speculative load

Percentage-based growth rate that will be used to increase loads

between the base year and the grow to year.

SynerGEE Electric 5.0

Model Cleanup Commands

1155

4071 GROWING LOADS ACROSS MULTIPLE YEARS

USING THE SECTION GROWTH RATES
Use the 4071 model cleanup command to grow section loads using the section growth rate over a specified
range of years. This command is only applicable if you use multi-year modeling.
In the 4071 command, you specify a base year, which is the year that load values will be copied from.
Those base year loads will be multiplied by the section growth rate, and the resulting values will be applied to
the following year. (Note that the existing values on that following year will be discarded and replaced with the
new, calculated values.) This process will repeat itself, continuing to grow the loads by the section growth rate
each year, until the grow to year is updated. Any years after the grow to year will retain their original
values. The base year, as well as any years before the base year, will also retain their original values.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Base year

0 No (not included in Details report)

1 Yes (included in Details report)

Start year for the growth of the section loads. The loads for this
year will be multiplied by the section growth rate, and the result
will be applied to the following year. That years updated loads
will again be multiplied by the growth rate, with the result applied
to the next year. This process will repeat until the Grow to year
has been updated.
Acceptable values are 0 through 9, where 0 represents the actual
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

Grow to year

SynerGEE Electric 5.0

Final model year that growth of the base year demands will be
applied to. Acceptable values are 1 through 10. Do not use the
custom year labels that you have configured in your preferences
(for example, 2012, 2013, etc.).

User Guide

1156

Model Cleanup Commands

Field
4

Name

Description

Load type

Text value that represents the type of load that will be copied.
Acceptable values are as follows:

D Distributed load

S Spot load

L Large customer load

G Large customer distributed generator

P Project load

A Speculative load

4072 GROWING LOADS ACROSS MULTIPLE YEARS

USING THE SECTION GROWTH CURVES
Use the 4072 model cleanup command to grow section loads using the section growth curve over a specified
range of years. This command is only applicable if you use multi-year modeling.
In the 4072 command, you specify a base year, which is the year that load values will be copied from.
Those base year loads will be multiplied by the corresponding growth rate from the section growth curve, and
the resulting values will be applied to the following year. (Note that the existing values on that following year
will be discarded and replaced with the new, calculated values.) This process will repeat itself, continuing to
grow the loads by the rates specified in the section growth rate each year, until the grow to year is updated.
Any years after the grow to year will retain their original values. The base year, as well as any years before
the base year, will also retain their original values.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

User Guide

0 No (not included in Details report)

1 Yes (included in Details report)

SynerGEE Electric 5.0

Model Cleanup Commands

Field
2

1157

Name

Description

Base year

Start year for the growth of the section loads. The loads for this
year will be multiplied by the corresponding growth rate specified
in the section growth curve, and the result will be applied to the
following year. That years updated loads will again be multiplied
by the corresponding growth rate from the section growth curve,
with the result applied to the next year. This process will repeat
until the Grow to year has been updated.
Acceptable values are 0 through 9, where 0 represents the actual
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

Grow to year

Final model year that growth of the base year demands will be
applied to. Acceptable values are 1 through 10. Do not use the
custom year labels that you have configured in your preferences
(for example, 2012, 2013, etc.).

Load type

Text value that represents the type of load that will be copied.
Acceptable values are as follows:

D Distributed load

S Spot load

L Large customer load

G Large customer distributed generator

P Project load

A Speculative load

4073 GROWING LOADS ACROSS MULTIPLE YEARS

USING THE FEEDER MULTIPLIER
Use the 4073 model cleanup command to grow section loads using the feeder multiplier over a specified
range of years. This command is only applicable if you use multi-year modeling.
In the 4073 command, you specify a base year, which is the year that load values will be copied from.
Those base year loads will be multiplied by the feeder multiplier associated with the section, and the resulting
values will be applied to the following year. (Note that the existing values on that following year will be
discarded and replaced with the new, calculated values.) This process will repeat itself, continuing to grow
the loads by the feeder multiplier each year, until the grow to year is updated. Any years after the grow to
year will retain their original values. The base year, as well as any years before the base year, will also retain
their original values.

SynerGEE Electric 5.0

User Guide

1158

Model Cleanup Commands

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Base year

0 No (not included in Details report)

1 Yes (included in Details report)

Start year for the growth of the section loads. The loads for this
year will be multiplied by the feeder multiplier, and the result will
be applied to the following year. That years updated loads will
again be multiplied by the feeder multiplier, with the result applied
to the next year. This process will repeat until the Grow to year
has been updated.
Acceptable values are 0 through 9, where 0 represents the actual
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

User Guide

Grow to year

Final model year that growth of the base year demands will be
applied to. Acceptable values are 1 through 10. Do not use the
custom year labels that you have configured in your preferences
(for example, 2012, 2013, etc.).

Load type

Text value that represents the type of load that will be copied.
Acceptable values are as follows:

D Distributed load

S Spot load

L Large customer load

G Large customer distributed generator

P Project load

A Speculative load

SynerGEE Electric 5.0

Model Cleanup Commands

1159

4074 COPYING LOADS ACROSS MULTIPLE YEARS

Use the 4074 model cleanup command to copy all loads (distributed, spot, project, and large customer) from
a specified start year and applying it through a specified finish year. The inputs for this command are
described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

Base year

Model year that the loads will be copied from. Acceptable values
are 0 through 9, where year 0 represents the base year of your
model and 1 through 9 represent subsequent model years. Do
not use the custom year labels that you have configured in your
preferences (for example, 2012, 2013, etc.).

Grow to year

Final model year that growth of the original loads will be applied
to. Acceptable values are 1 through 10. Do not use the custom
year labels that you have configured in your preferences (for
example, 2012, 2013, etc.).
Note that any years between the Base year and Grow to year will
be updated as well. For example, if you copy meter demands
from year 0 to year 4, the demands for years 1 through 3 will also
be edited.

Only in query

SynerGEE Electric 5.0

Boolean value specifying whether this command will be applied

to sections in the query set only, or to the entire model.

0 Entire model

1 Query set only

User Guide

1160

Model Cleanup Commands

4075 DELETING LOADS FOR UNENERGIZED YEARS

Use the 4075 model cleanup command to delete loads of a specified load type (distributed, spot, project, or
large customers) for unenergized years. The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Load type

0 No (not included in Details report)

1 Yes (included in Details report)

Text value that represents the type of load that will be copied.
Acceptable values are as follows:

D Distributed load

S Spot load

L Large customer load

P Project load

4076 MULTIPLYING LOADS IN MULTIPLE YEARS

Use the 4076 model cleanup command to multiply loads of a specified type by a specified multiplier value for
each year across a specified span of years. For each year, the existing load will be multiplied by the specified
multiplier value. Loads will not be copied from one year to the next.
The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

User Guide

First year

0 No (not included in Details report)

1 Yes (included in Details report)

Model year that the loads will first be edited. Acceptable values
are 0 through 9, where year 0 represents the base year of your
model and 1 through 9 represent subsequent model years. Do
not use the custom year labels that you have configured in your
preferences (for example, 2012, 2013, etc.).

SynerGEE Electric 5.0

Model Cleanup Commands

Field
3

1161

Name

Description

Grow to year

Final model year that loads will be edited. Acceptable values are
1 through 10. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).
Note that any years between the First year and Grow to year will
be updated as well. For example, if you copy meter demands
from year 0 to year 4, the demands for years 1 through 3 will also
be edited.

Load type

Multiplier

Letter that represents the type of load. Acceptable values are as

follows:

D Distributed load

S Spot load

L Large customer load

G Large customer distributed generator

P Project load

A Speculative load

Multiplier value to be applied to the specified load type in each

year.

4077 GROWING METER DEMANDS ACROSS

MULTIPLE YEARS
Use the 4077 model cleanup command to grow meter demands using a specified growth rate percentage
over a specified range of years. This command is only applicable if you use multi-year modeling.
In the 4077 command, you specify a base year, which is the year that demand values will be copied from.
Those base year demands will be multiplied by the specified growth rate percentage, and the resulting values
will be applied to the following year. (Note that the existing values on that following year will be deleted and
replaced with the new, calculated values.) This process will repeat itself, continuing to grow the demands by
the specified percentage each year, until the grow to year is updated. Any years after the grow to year will
retain their original values. The base year, as well as any years before the base year, will also retain their
original values.
Note the following before using the 4077 model cleanup command:

Demands are stored in meter devices. Feeder demands are considered to be those held by meters
directly downstream from feeder sources.

The 4077 model cleanup command affects subtran demands as well, using the same criteria.

SynerGEE Electric 5.0

User Guide

1162

Model Cleanup Commands

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

Base year

0 No (not included in Details report)

1 Yes (included in Details report)

Start year for the growth of the meter demands. The demands for
this year will be multiplied by the feeder multiplier, and the result
will be applied to the following year. That years updated
demands will again be multiplied by the feeder multiplier, with the
result applied to the next year. This process will repeat until the
Grow to year has been updated.
Acceptable values are 0 through 9, where 0 represents the actual
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

Grow to year

Final model year that growth of the base year demands will be
applied to. Acceptable values are 1 through 10. Do not use the
custom year labels that you have configured in your preferences
(for example, 2012, 2013, etc.).

Pct growth rate

Percentage-based growth rate that will be used to increase

demands between the base year and the grow to year.

4078 COPYING PHASING AND CONDUCTOR

SETTINGS ACROSS MULTIPLE YEARS
Use the 4078 model cleanup command to copy phasing and conductor settings from a specified start year
and applying to each year through a specified end year. The inputs for this command are described in the
following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

User Guide

0 No (not included in Details report)

1 Yes (included in Details report)

SynerGEE Electric 5.0

Model Cleanup Commands

Field

1163

Name

Description

Base year

Model year that the phasing and conductors will be copied from.
Acceptable values are 0 through 9, where year 0 represents the
base year of your model and 1 through 9 represent subsequent
model years. Do not use the custom year labels that you have
configured in your preferences (for example, 2012, 2013, etc.).

Final year

Final model year that the phasing and conductors will be copied
to. Acceptable values are 1 through 10. Do not use the custom
year labels that you have configured in your preferences (for
example, 2012, 2013, etc.).
Note that any years between the Base year and Final year will be
updated as well. For example, if you copy phasing and
conductors from year 0 to year 4, the statuses for years 1
through 3 will also be updated.

Only in query

Boolean value specifying whether this command will be applied

to sections in the query set only, or to the entire model.

0 Entire model

1 Query set only

4081 DELETING KVA FOR DISTRIBUTED LOADS FOR

THE CURRENT YEAR
Use the 4081 model cleanup command to delete kVA values for distributed loads for the current year. The
inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

SynerGEE Electric 5.0

0 No (not included in Details report)

1 Yes (included in Details report)

User Guide

1164

Model Cleanup Commands

4082 DELETING KWH FOR DISTRIBUTED LOADS FOR

THE CURRENT YEAR
Use the 4082 model cleanup command to delete kWh values for distributed loads for the current year. The
inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4083 DELETING THE CUSTOMER COUNT FOR

DISTRIBUTED LOADS FOR THE CURRENT YEAR
Use the 4083 model cleanup command to delete the customer count values for distributed loads for the
current year. The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

User Guide

0 No (not included in Details report)

1 Yes (included in Details report)

SynerGEE Electric 5.0

Model Cleanup Commands

1165

4084 DELETING KW AND KVAR FOR SPOT LOADS

FOR THE CURRENT YEAR
Use the 4084 model cleanup command to delete kW and kVAR values for spot loads for the current year. The
inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

0 No (not included in Details report)

1 Yes (included in Details report)

4099 SPECIAL CODE

The 4099 model cleanup command is for internal use only.

4101 SUPPRESSING THE MODEL CLEANUP REPORT

Use the 4101 model cleanup command to prevent the Model Cleanup report from generating after a model
cleanup script is run. This command does not require any inputs.

4104 SUPPRESSING THE CONFIRMATION MESSAGE

TO APPLY FIXES
If the model cleanup script finds fixes that need to be made, it will produce a message box that allows you to
either make the changes to the model or view a report of the fixes that were found. If desired, you can use the
4104 model cleanup command to suppress this confirmation box. SynerGEE will automatically apply fixes to
the model, and then generate a report describing the changes that were made.
This command does not require any inputs.

4105 CONFIRMING WHETHER TO RUN THE SCRIPT

Use the 4105 model cleanup command to provide a confirmation box to the user before the model cleanup
script begins. The confirmation box will provide the name of the script and an optional message, if one is
specified as a parameter for this command.

SynerGEE Electric 5.0

User Guide

1166

Model Cleanup Commands

The inputs for this command are described in the following table.
Field
1

Name

Description

Message (optional)

Optional message to be displayed in the confirmation box.

4106 APPLYING THE SCRIPT TO THE QUERY SET

ONLY
Use the 4106 model cleanup command to apply the script only to sections and devices that are included in
the current query set. This command does not require any inputs.
Note that this command will restrict all script actions to the sections and devices that are in the query set.
However, many model cleanup commands include individual parameters to restrict that command only to the
query set. The 4106 command, if used, will override the settings for these individual parameters.

4110 CORRECTING THE ORIENTATION OF

REGULATORS AND TRANSFORMERS
Use the 4110 model cleanup command to correct the orientation of regulators and transformers so that the
following conditions are true:

Regulator taps are pointed downstream.

Transformer high side is upstream.

The inputs for this command are described in the following table.
Field

Name

Description

Report

Boolean value specifying whether any actions that are performed

by this command will be included in the Details section of the
Model Cleanup report.

User Guide

0 No (not included in Details report)

1 Yes (included in Details report)

SynerGEE Electric 5.0

APPENDIX

E
SynerGEE File
Summary
SynerGEE uses a wide variety of files for a host of different purposes. Some files store data and settings,
while others are used to import data. The following table lists several SynerGEE-related files and their
descriptions. If a file you are looking for does not appear on this list, it may be an application file that should
not be moved or otherwise altered.
Common name

Ext.

File name

Description

Access database

MDB

(varies)

Can contain a variety of

SynerGEE data, including model,
equipment, results, subset,
customer, and version data. You
should create a DSA to access
data from a database. For more
information, see Data Source
Aliases (DSAs) on page 75.

or
ACCDB

Extensible markup
language file

XML

(varies)

File format that can be used for

the import and export of model
and equipment data. For more
information, see SynerGEE
XML data format on page 75.

SynerGEE binary
file

EDM

(varies)

Proprietary binary format file

used to import and export data,
as well as save backups and
models for the gallery. For more
information on binary files, see
Binary data format (EDM) on
page 72.

SynerGEE main
application file

EXE

SynerGEE.exe

Main file that runs SynerGEE.

SynerGEE Electric 5.0

User Guide

1168

SynerGEE File Summary

Common name

Ext.

File name

Description

Outage cause data

file

TXT

ReliCauseMeta.txt

Contains customizable root

cause data used by SynerGEE
Reliability. For more information,
see Defining root causes for a
reliability simulation on
page 677.

Defaults file

XML

SynDefaults.xml

Contains defaults values for

SynerGEE devices, including
facilities, sections, and feeders.
These default values are used
during external data imports and,
in some cases, for newly
modeled sections and devices.
For more information, see
Editing Default Values for
SynerGEE Devices on
page 136.

Backup file

EDM

SynBackup.edm

Backup model and equipment

data file, from the most recent
backup. For more information,
see Backing Up SynerGEE
Data on page 131.

Help file

CHM

Syne.chm

SynerGEE Online Help file.

User Guide

PDF

SynEUserGuide.pdf

SynerGEE User Guide.

Technical
Reference

PDF

SynETechRef.pdf

The SynerGEE Electric

Technical Reference. Describes
the theory and processes behind
many SynerGEE analyses and
functions.

Release Notes

PDF

SynEReleaseNotes.pdf

Documents the latest updates

and fixes to your current version
of SynerGEE.

License file

DAT

License.dat

Contains all your SynerGEE

licensing information. This file
should never be moved or
altered.

Recipe

SRF

(varies)

Recipe file. For more

information, see Recipe Scripts
on page 700.

User Guide

SynerGEE Electric 5.0

SynerGEE File Summary

1169

Common name

Ext.

File name

Description

Startup recipe

SRF

Startup.srf

Recipe run when SynerGEE

starts up. If the recipe does not
exist, SynerGEE creates it. For
more information, see Startup
Scripts on page 715.

Log file

SLF

{pref}SynLog.slf

A general log of SynerGEE

activity for the current session.
You can access the log from
within SynerGEE by selecting
the VIEWS tab in the SynerGEE
ribbon bar and, in the General
group, clicking Log.

TCC file

SPV

(varies)

A saved TCC view. For more

information, see Saving and
loading TCC views as external
files on page 613.

Sample radial
model, in Access

MDB

SampleModel.mdb

A multi-feeder sample database

with which you can experiment to
learn about SynerGEE. This
database includes equipment
data.

Sample radial
model, in XML

XML

SampleDb.xml

A multi-feeder sample model

with which you can experiment to
learn about SynerGEE. This
XML file includes equipment
data, and contains data identical
to SampleDb.mdb.

Sample network
model

MDB

NetworkDb.mdb

A multi-feeder sample network

database with which you can
experiment to learn about
SynerGEE. This database
includes equipment data.

Data source library

MDB

SynDataSources.mdb

Stores all information related to

DSAs. For more information, see
Data Source Aliases (DSAs) on
page 75.

PowerCalc script

SPC

(varies)

Stored PowerCalc script. For

more information, see
PowerCalc on page 761.

Model cleanup
script

MODCLEAN

(varies)

Stored model cleanup script. For

more information, see Model
Cleanup Scripts on page 718.

SynerGEE Electric 5.0

User Guide

1170

SynerGEE File Summary

Common name

Ext.

File name

Description

Report template

XML

(varies)

Data templates for grid-style

reports. Most of these files
represent individual chapter
templates. For more information,
see Grid-style reports on
page 467.

Application settings
group file

APPSET

(varies)

Data for an applications settings

file. For more information, see
Settings Groups and Settings
Files on page 189.

Map settings group

file

DISPSET

(varies)

Data for a map settings file. For

more information, see Settings
Groups and Settings Files on
page 189.

Background image
settings group file

GBTILESET

(varies)

Data for a background image

settings file. For more
information, see Settings
Groups and Settings Files on
page 189.

Interface settings
file

INTERSET

(varies)

Data for a SynerGEE interface

settings file.

Model explorer
settings file

EXPSET

(varies)

Data for a model explorer

settings file.

State settings file

STATE

SynerGEE.state.xml

Data for a SynerGEE state file.

General SynerGEE
settings file

SYNSET

(varies)

Data for a general settings file.

Feature lock
settings file

FEATURELOC
K

(varies)

Data for a feature lock settings

file. For more information, see
Feeder locks and lock IDs on
page 121.

CMM data in
MiddleLink format

CMM

(varies)

CMM data in SynerGEEs

MiddleLink format. For more
information, see The CMM
Process on page 838.

PI Server
messaging script

MESS

(varies)

Script file for communications

with PI server. For more
information, see PI Server on
page 74.

User Guide

SynerGEE Electric 5.0

SynerGEE File Summary

1171

Common name

Ext.

File name

Description

SQL dashboard
script

SYNSQL

(varies)

SQL dashboard script file. For

more information, see SQL
Dashboard on page 772.

SynerGEE Electric 5.0

User Guide

1172

User Guide

SynerGEE File Summary

SynerGEE Electric 5.0

APPENDIX

F
Background Image
Support
SynerGEE supports a variety of image types as background images.

SYNERGEE-SUPPORTED IMAGE TYPES

SynerGEE supports the following types:
AutoCAD DXF (DXF)

AutoCAD 2000 and earlier supported.

AutoCAD DWG (DWG)

AutoCAD 2000 and earlier supported.

Esri Shape (SHP)

MapInfo Vector (MIF)

MicroStation DGN (DGN)

Tagged Image File Format

(TIFF)

TIF Specification 5.0 files supported. Compression types supported: no

compression, packbits, Modified Huffman encoding, CCITT Group 3 1D,
CCITT Group 3 2D, and CCITT Group 4. Color formats supported:
monochrome, 256 color, grayscale, and 24-bit

Windows Bitmap (BMP, DIB)

1-, 4-, 8-, and 24-bit images in Windows or OS/2 format supported. Run
length encoded files not supported.

Joint Photographics
Experts Group (JPG)

JFIF-compliant files supported.

WORLD FILES FOR RASTER IMAGES

A raster image, including BMP, TIFF, and JPG format, requires an accompanying world file for display in
SynerGEE. A world file is a simple text file that contains coordinate and scaling information so SynerGEE
knows how and where to display the image. Vector formats, such as DXF, already contain this information
and do not need world files.

SynerGEE Electric 5.0

User Guide

1174

Background Image Support

A world file uses the same name as its associated image file, with a different extension as follows:
Image File

World File

JPG

JGW

TIF

TFW

BMP

WLD

For example, the world file for the image MyPicture.jpg would be MyPicture.jgw.
A world file contains six numbers in a specific order, as follows:
x-scale

The width of a single pixel in map units. For example, if your map units are in
feet, and the x-scale is 1.5, each pixel of the image will horizontally occupy 1.5
feet. In other words, this number controls the width of the displayed image.

rotation term 1

Not supported by SynerGEE. This number should always be zero (0).

rotation term 2

Not supported by SynerGEE. This number should always be zero (0).

y-scale

The height of a single pixel in map units. For example, if your map units are in
feet, and the y-scale is -1.5, each pixel of the image will vertically occupy 1.5
feet. In other words, this number controls the width of the displayed image.
The y-scale is always negative, because map coordinates are projected
upwards from a 0,0 point. The functionality is identical to the x-scale,
however. Normally, the y-scale is the negative value of the x-scale, unless
stretching of the image is desired.

X coordinate

The X coordinate for the upper left pixel of the image, in map units.
Tip:

Y coordinate

When you move the mouse pointer across the map, you can see the
current coordinates displayed in the status bar.

The Y coordinate for the upper left pixel of the image, in map units.

The following is an example of the actual world file ortho1.jgw, found in the Sample Data\Backgrounds folder
in your SynerGEE install area:
1.34718265515579
0.00000000000000
0.00000000000000
-1.34718265515579
439130.54764475720000
89805.63249184121000

The precise numbers allow the image to align and scale perfectly with the New - Springfield feeder in the
sample model database.

User Guide

SynerGEE Electric 5.0

Background Image Support

1175

VECTOR IMAGES AND SUPPLEMENTAL FILES

Vector images may require supplemental files, as follows:

A SHP file requires a corresponding SHX supplemental file.

An MIF file requires an accompanying MID file.

SynerGEE looks for the supplemental file in the same folder as the image file. These files are normally
generated by the originating application, such as a GIS product.
For AutoCAD files, you may need to perform the following steps to ensure that all text is preserved during the
import.
1

Before importing the file into SynerGEE, open it in AutoCAD.

From the AutoCAD main menu, select Express > Block > Explode Attribute to Text.

Select the object(s) that will be a part of the import.

Save the file in AutoCAD and proceed with the import to SynerGEE.

SynerGEE Electric 5.0

User Guide

1176

User Guide

Background Image Support

SynerGEE Electric 5.0

Index

1177

Index
Numerics
3010 recipe command 856
3013 recipe command 856
3014 recipe command 856
3030 recipe command 857
3031 recipe command 858
3032 recipe command 858
3034 recipe command 858
3035 recipe command 858
3050 recipe command 859
3051 recipe command 861
3052 recipe command 862
3053 recipe command 862
3054 recipe command 862
3055 recipe command 863
3056 recipe command 864
3057 recipe command 865
3058 recipe command 866
3059 recipe command 866
3060 recipe command 866
3061 recipe command 867
3062 recipe command 868
3063 recipe command 869
3064 recipe command 869
3065 recipe command 869
3066 recipe command 870
3071 recipe command 870
3072 recipe command 870
3073 recipe command 870
3080 recipe command 871
3081 recipe command 871
3090 recipe command 871
3091 recipe command 872
3100 recipe command 874
3101 recipe command 874
3102 recipe command 874

SynerGEE Electric 5.0

3103 recipe command 875

3104 recipe command 875
3105 recipe command 876
3106 recipe command 876
3107 recipe command 877
3108 recipe command 878
3109 recipe command 878
3110 recipe command 879
3111 recipe command 879
3112 recipe command 879
3113 recipe command 880
3114 recipe command 880
3200 recipe command 882
3201 recipe command 882
3203 recipe command 883
3204 recipe command 883
3205 recipe command 884
3206 recipe command 884
3207 recipe command 884
3208 recipe command 885
3210 recipe command 886
3211 recipe command 886
3212 recipe command 886
3230 recipe command 887
3231 recipe command 887
3232 recipe command 888
3233 recipe command 888
3250 recipe command 889
3251 recipe command 889
3300 recipe command 890
3301 recipe command 891
3302 recipe command 891
3303 recipe command 892
3400 recipe command 893
3500 recipe command 894
3501 recipe command 894
3502 recipe command 894

User Guide

1178
3503 recipe command 895
3504 recipe command 895
3505 recipe command 895
3506 recipe command 895
3507 recipe command 896
3508 recipe command 896
3509 recipe command 896
3510 recipe command 896
3511 recipe command 896
3512 recipe command 898
3550 recipe command 899
3551 recipe command 899
3552 recipe command 899
3553 recipe command 899
3554 recipe command 900
3555 recipe command 900
3600 recipe command 901
3601 recipe command 902
3650 recipe command 902
3651 recipe command 903
4001 model cleanup command 1119
4002 model cleanup command 1119
4003 model cleanup command 1121
4004 model cleanup command 1122
4005 model cleanup command 1122
4006 model cleanup command 1122
4007 model cleanup command 1123
4008 model cleanup command 1124
4009 model cleanup command 1124
4010 model cleanup command 1124
4011 model cleanup command 1125
4012 model cleanup command 1126
4013 model cleanup command 1127
4014 model cleanup command 1128
4015 model cleanup command 1129
4016 model cleanup command 1129
4017 model cleanup command 1130
4018 model cleanup command 1131
4019 model cleanup command 1132
4020 model cleanup command 1132

User Guide

Index
4021 model cleanup command 1133
4022 model cleanup command 1133
4023 model cleanup command 1134
4024 model cleanup command 1134
4025 model cleanup command 1135
4026 model cleanup command 1136
4030 model cleanup command 1137
4031 model cleanup command 1137
4032 model cleanup command 1138
4033 model cleanup command 1138
4034 model cleanup command 1139
4035 model cleanup command 1139
4036 model cleanup command 1140
4037 model cleanup command 1140
4038 model cleanup command 1141
4039 model cleanup command 1141
4040 model cleanup command 1142
4050 model cleanup command 1142
4051 model cleanup command 1143
4052 model cleanup command 1143
4053 model cleanup command 1144
4054 model cleanup command 1145
4055 model cleanup command 1146
4056 model cleanup command 1147
4057 model cleanup command 1148
4058 model cleanup command 1149
4059 model cleanup command 1150
4060 model cleanup command 1150
4061 model cleanup command 1151
4062 model cleanup command 1153
4070 model cleanup command 1153
4071 model cleanup command 1155
4072 model cleanup command 1156
4073 model cleanup command 1157
4074 model cleanup command 1159
4075 model cleanup command 1160
4076 model cleanup command 1160
4077 model cleanup command 1161
4078 model cleanup command 1162
4081 model cleanup command 1163

SynerGEE Electric 5.0

Index
4082 model cleanup command 1164
4083 model cleanup command 1164
4084 model cleanup command 1165
4099 model cleanup command 1165
4101 model cleanup command 1165
4104 model cleanup command 1165
4105 model cleanup command 1165
4106 model cleanup command 1166
4110 model cleanup command 1166
8760 Analysis 588
A
Access (personal)
about 71
data truncation during saving 71
Access (server) data format 72
AFS analysis 534
amp multiplier, fuses 346
analyses
automatic feeder switching (AFS) analysis 534
R&D analysis 489
substation bus transformer analysis 534
analysis 433
adding notes to reports 460
analysis results 449
analysis year, selecting 434
auto-transfer switch analysis 533
balance improvement 565
Capacitor Flicker Report power tool 753
capacitor placement 562
charts 479
check coordination 622
configuring report options 459
contingency 535
cost files 447
cost settings 446
customer load curves/time-of-day 808
customizing device colors and sizes based on
analysis results 211
customizing section colors and sizes based on

SynerGEE Electric 5.0

1179
analysis results 210
design evaluation 572
economic 597, 851
fault 648
forecasting 556
global costs 449
harmonic 689
I,Z,PQ Calibration power tool 748
Insert Tie Switches power tool 756
load allocation 549
load balancing improvement 569
load-flow 512
locked rotor analysis 375
model and analysis options 436
motor analysis 375
motor start analysis 377
multi-model analysis 576
multi-year modeling 579, 586
network 522, 524
Node Overlap Report power tool 757
node reduction 267
optimal switching 529
output options 444
performing 449
phase balancing improvement 566
power tools 744
Regulator Setting power tool 745
reliability 661
reports 456
re-running 449
results 449
results annotation, adding 208
setting a section for analysis 434
setting up 433
System Status analysis 489
Ten-Year Growth Report power tool 755
throw-over analysis 533
time of day, selecting 434
uncertainty analysis 487
Unfused Tap analysis 696

User Guide

1180
Voltage Optimization 594
what-ifs 484
analysis results 449
Broadcaster 451
enterprise databases and results import/export 456
exporting 455
getting started with results import/export 453
import/export DSAs 454
importing 455
importing and exporting 452
reporting 456
results handling 453
Results Viewer 451
Results Viewer, selecting attributes 445
selecting attributes for the Results tab 445
selecting whether to generate 457
suggestions for viewing 450
Analysis.CheckData recipe command 909
Analysis.CloseAllReports recipe command 908
Analysis.RunCleanupScript recipe command 908
Analysis.Topology recipe command 909
annotation
adding to the map display 207
results annotation, adding 208
AOI_101 model forge command 948
AOI_102 model forge command 949
AOI_103 model forge command 950
AOI_104 model forge command 951
AOI_105 model forge command 952
AOI_106 model forge command 953
application setting codes 149
Arc Flashover
Analysis Settings 645
Disclaimer 644
Exceptions 645
Overview 644
rap sheet 181
Settings tab 645
Working Distance tab 646
areas of interest 217

User Guide

Index
associating with a section 223
creating 218
deleting 223
editing 220
Model Forge commands 948
moving 219
redrawing 219
reshaping 219
ASAI 668
AutoCAD DXF files
Publishing export 739
automatic feeder switching (AFS) analysis 534
automation scripts 720
auto-transfer switch analysis 533
auto-transfer switches 407
toggling 408
B
background images 232, 1173
backups 131
balance improvement analysis 565
load balancing 569
phase balancing 566
basemap layer
basemap layer files 239
changing 242
binary (EDM) data format 72
BKR_101 model forge command 954
BKR_102 model forge command 954
BKR_103 model forge command 955
BKR_104 model forge command 955
BKR_105 model forge command 956
BKR_106 model forge command 957
BKR_107 model forge command 957
BKR_108 model forge command 958
BKR_109 model forge command 959
BKR_110 model forge command 959
BKR_111 model forge command 960
BKR_112 model forge command 961
BKR_113 model forge command 962

SynerGEE Electric 5.0

Index
BKR_114 model forge command 962
BKR_115 model forge command 963
BKR_116 model forge command 964
BKR_117 model forge command 964
BKR_118 model forge command 965
BKR_119 model forge command 965
BKR_120 model forge command 966
Breaker Zone 1 report 477
breakers 321
Breaker editor 321
Breaker tab 322
Relays tab 323
Results tab 325
breaker flexibility 327
breaker model 326
curves 327
deleting 326
editing 321
Model Forge commands 953
modeling 321
relay groups 327
relays 326
stages 327
transitioning from older breaker models 328
Broadcaster 451
Bulk Editor 192
C
cable ampacity
about 785
general steps 785
cable conductors
overview 786
cable study scripts 721
cables
cable conductors 787
applying to sections 789
concentric neutral model 787
separate neutral model 787
simple impedance model 787

SynerGEE Electric 5.0

1181
tape shield model 788
three-core cable model 789
Cable Duct Bank view 793
direct buried cables 796
display properties 796
opening 794
report 797
troubleshooting 797
using 795
zooming 796
duct bank, creating 790
duct banks
applying to sections 797
Duct Bank editor 790
Duct Bank evaluation 798
editing 790
modeling overview 786
study scripts 800
CAIDI 668
CAIFI 668
calculators 739
CAP_101 model forge command 967
CAP_102 model forge command 967
CAP_103 model forge command 967
CAP_104 model forge command 968
CAP_105 model forge command 969
CAP_106 model forge command 970
CAP_107 model forge command 971
CAP_108 model forge command 971
CAP_109 model forge command 972
CAP_110 model forge command 973
CAP_111 model forge command 973
CAP_112 model forge command 974
CAP_113 model forge command 974
CAP_114 model forge command 975
CAP_115 model forge command 975
CAP_116 model forge command 976
CAP_117 model forge command 976
CAP_118 model forge command 977
CAP_119 model forge command 978

User Guide

1182
CAP_120 model forge command 978
CAP_121 model forge command 979
CAP_122 model forge command 979
CAP_123 model forge command 980
Capacitor Flicker Report power tool 753
running 754
settings 754
Capacitor Manager toolbox tool 765
capacitor placement analysis 562
running 563
setting up 562
capacitors 328
adding 335
Capacitor editor 335
Capacitor tab 336
Results tab 341
Settings tab 339
Capacitor Flicker Report power tool 753
Capacitor Manager toolbox tool 765
controlling switched modules 331
deleting 342
editing 335
editing loads using the Bulk Editor 192
fixed and switched units 329
kV rating 331
line-drop compensator 333
managing 334
manually turning on a capacitor switched module
334
metering phase 333
Model Forge commands 966
motor analysis 342
placement analysis 342
positioning 330
SynerGEE capacitor model 329
tripping and closing rules 332
voltage override 334
capacity 529
capacity factors 502
chapter report template

User Guide

Index
editing 469
restoring 470
chapters
printing selected chapters of a report 179
charts 479
chart window, closing 484
chart window, opening 480
closing 484
custom 480
creating 480
deleting 482
loading 482
saving 482
exporting 483
modifying 483
printing 483
check coordination analysis
about 622
cases not checked 642
coordination range 641
default margins 627
general operation 623
protection pairs 639
rule-base 627
running 641
selecting rules 627
setting margins 626
setting options 623
check data report 137
classic protective device types 601
classic protective devices
about 600
converting 719
clearing the SynerGEE registry 193
CMM 837
automating the CMM process 842
CMM wizard 839
data sets 846
creating and destroying 847
merging 848

SynerGEE Electric 5.0

Index
reporting 846
using the model in memory to update
connectivity 848
DSAs 838
importing MiddleLink files into a CMM data set 839
Model Forge commands 981
overview 838
processing CMM data set bills and loads 840
running a script using the CMM wizard 842
schema, viewing 843
script examples 845
security and support via a Lock ID 850
SQL Dashboard 849
controls 849
queries 850
updating a model with customer data 839
updating model loads with a CMM data set 841
writing scripts 843
CMM_110 model forge command 981
CMM_113 model forge command 982
CMM_114 model forge command 982
CMM_120 model forge command 982
CMM_121 model forge command 983
CMM_123 model forge command 983
CMM_124 model forge command 983
CMM_127 model forge command 984
CMM_128 model forge command 984
CMM_130 model forge command 984
CMM_131 model forge command 985
CMM_132 model forge command 985
CMM_140 model forge command 985
CMM_162 model forge command 986
CMM_164 model forge command 986
CMM_211 model forge command 986
CMM_212 model forge command 987
CMM_214 model forge command 987
Cmm.RunScript recipe command 910
codes
application setting codes 149
model characteristic codes 148

SynerGEE Electric 5.0

1183
Color By
defining colors 212
sections 216
columns
editing data in columns 150
command line
opening SynerGEE from the command line 184
concentric neutral cable conductor model 787
Concepts view 490
Harmonics view 491
Impedance view 490
opening 490
conductor damage curves
on the TCC 612
conductor spacing
setting spacing preferences 169
conductors 304
cable 786
cable conductors 787
applying to sections 789
changing on a section 262
conductor types, creating 305
conductor types, deleting 308
conductor types, editing 305
conductor types, sorting 308
configurations 311
damage curves 316
equivalent spacing 311
how conductor data is used in calculations 309
optimal conductor selection analysis 572
seasonal ratings 832
simple impedance method 310
spacing and configuration options 310
spacing options 310
configuration types
about 311
creating 311
determining coordinates 312
editing 312
examples 314

User Guide

1184
usage 314
constant current load model 498
constant impedance load model 499
constant power load model 498
context menus 150
contingency
automatic feeder switching (AFS) analysis 534
substation bus transformer analysis 534
contingency analysis
about 535
Contingency Analysis Options editor 537
examples of outage types 546
fast pickup method 536
setting up 538
isolating sections 546
load transfer method 537
setting up 540
method, selecting 537
methods 535
optimized pickup method 536
setting up 542
running 546
Contingency.Run recipe command 910
contour points
see graphic points
controls script 821
creating 821, 822
cost files 447
creating 448
editing 448
format 447
selecting for analysis 448
cost zones 851
assigning to a section 853
creating 851
deleting 853
editing 852
costs
cost settings for analysis 446
model costs, setting 443

User Guide

Index
creating 822
curves
growth 804
load 808
plotting on TCC 605
transformer 643
custom charts 480
creating 480
deleting 482
loading 482
saving 482
custom keyboard shortcuts 149
customer classes 810
class information, editing 812
coincidence settings, editing 813
creating 810
deleting 815
economic data, editing 814
editing 811
load curves, editing 811
customer load curves/time-of-day analysis 808
Customer Management Module
see CMM
customer zones 815
applying to sections 817
creating 816
deleting 818
editing 816
customers
see CMM
D
data 57
comparing 63
data source aliases 75
editing data in columns 150
loading models 156
network intelligence 58
overview 58
repairing schemas 134

SynerGEE Electric 5.0

Index
data formats
about 70
Access (personal) 71
Access (server) 72
binary (EDM) 72
MiddleLink 72
Oracle 74
SQL Server 74
XML 75
Data Hammer 767
data mining
setting preferences 169
data source alias
see DSA
data types
about 59
equipment data 64
gallery 129
model 61
partials 89
protection 67
subsets 82
versions 86
database
setting preferences 167
DataHammer.SigedMidway recipe command 918
DataPrep
see MiddleLink-GIS model builds
defaults file 136
Demo Manager 769
design evaluation analysis 572
optimal conductor selection 572
processing 572
running 574
setting up 573
optimal regulator position 574
processing 574
running 575
setting up 575
viewing results 575

SynerGEE Electric 5.0

1185
tips 573
details
toggling in the map display 199
Details rap sheet 179
Device Risk Ranking 696
devices 317
adding to a model 317
annotation, adding 207
breakers 321
capacitors 328
coloring based on analysis results 211
copying 318
creating 317
deleting 319
editing 317, 318
failure rates 685
fuses 342
generators 347
meters 356
motors 364
moving 318
protective devices 599
reclosers 377
regulators 383
sectionalizers 393
switches 397
transformers 415
Digest report 478
display settings 200
adding annotation based on analysis results 208,
210
adding section and device annotation 207
coloring by path type 216
configuring map display symbols 213
configuring the map display style 201
configuring visibility levels for map display symbols
214
customizing device colors and sizes based on
analysis results 211
customizing section colors and sizes abased on
analysis results 210

User Guide

1186
defining Color By colors 212
selecting a coloring scheme for sections 216
showing the map display grid 215
distances, measuring in the map 198
distributed generation
see large customers
distribution transformers
editing using the DTran worksheet 297
editing using the Section editor 296
Model Forge commands 987
dockable reports 462
docking 463
enabling 462
hiding 466
documentation 52
documents
Library 770
DSA
creating 76, 79
creating with custom content 80
editing 77
purpose 76
saving 81
sharing with other users 81
validating 80
DSA.Create recipe command 919
DSA.Delete recipe command 921
DSA.DeleteFeeder recipe command 922
DSA.DeleteFeederList recipe command 922
DSA.DropModel recipe command 921
DSA.DropSubstation recipe command 922
DSA.ExecStoredProc recipe command 923
DSA.ExportLastReport recipe command 927
DSA.ExportLastReport2 recipe command 928
DSA.LoadFeeders recipe command 924
DSA.LoadModelBySub recipe command 925
DSA.LoadProtectionDb recipe command 929
DSA.LoadSubBySection recipe command 925
DSA.LoadWarehouse recipe command 926
DSA.ResultsSetSave recipe command 926

User Guide

Index
DSA.SaveFeeders recipe command 926
DSA.SaveWarehouse recipe command 929
DSA.TestConnection recipe command 927
DSAs
about 75
analysis results importing and exporting 454
deleting 81
DTR_101 model forge command 988
DTR_102 model forge command 988
DTR_103 model forge command 989
DTR_104 model forge command 989
DTR_105 model forge command 990
DTR_106 model forge command 990
DTR_107 model forge command 991
duct banks
applying to sections 797
Cable Duct Bank view 793
direct buried cables 796
display properties 796
opening 794
report 797
troubleshooting 797
using 795
zooming 796
creating 790
Duct Bank editor 790
Circuits tab 792
Duct Bank tab 791
Duct Bank evaluation 798
running 799
section derating 800
setting up 798
editing 790
DXF export
layer creation 742
running 742
settings 740
DXF files
Publishing export 739
E

SynerGEE Electric 5.0

Index
economic analysis 597, 851
cost zones 851
editor
opening 155
using 151
viewing results 156
editors
multi-year modeling 583
elbows 408
energize years
multi-year modeling 583
enterprise databases
about 114
advantages 115
analysis results import/export 456
connecting to the server 116
creating a new model 119
deleting models and feeders 121
getting started 115
loading feeders 120
locks 121
model locks 122
saving feeders 120
schema 123
using 116
with analysis 123
environment 142
model explorer 143
ribbon bar 146
status bar 148
SynerGEE editor 151
equipment
see devices
equipment data
about 64
clearing from memory 66
loading 65
merging 66
sample database 67
saving 65

SynerGEE Electric 5.0

1187
zones and curves 66
equipment types
about 319
copying 320
creating 319
deleting 320
editing 320
equipment warehouse
generator types 348
motor curve types 368
motor types 365
regulator types 384
switch types 400
transformer types 422
equivalent spacing, conductors 311
ESRI
Geography view 239
Excel
exporting data from a grid-style report 474
exception load limits 437
explorer
TCC 605
exposure zones 679
assigning to sections 682
creating 681
deleting 682
editing 681
setup methods 680
F
FAC_110 model forge command 992
FAC_111 model forge command 992
FAC_112 model forge command 993
FAC_113 model forge command 993
facilities
Model Forge commands 991
see devices
tagging 172
Facilities tab (model explorer) 144
failure rates for devices 685

User Guide

1188
fast pickup method (contingency analysis) 536
setting up 538
fault analysis 648
about 648
fault flow analysis 649
fault voltage analysis 649
generators 650
running 652
setting up 650
types 648
wandering laterals 652
fault events
adding 655
deleting 656
editing 655
fault location analysis 655
fault location analysis 654
fault events 655
running 658
setting up 656
Fault rap sheet 182
FaultLoc.FaultsToConsider recipe command 911
FaultLoc.Run recipe command 911
FaultLoc.SetFaultAmps recipe command 912
FDR_101 model forge command 994
FDR_102 model forge command 994
FDR_103 model forge command 995
FDR_104 model forge command 996
FDR_105 model forge command 996
FDR_106 model forge command 997
FDR_107 model forge command 997
FDR_108 model forge command 998
FDR_109 model forge command 998
FDR_110 model forge command 998
FDR_111 model forge command 999
FDR_112 model forge command 999
feature locks
setting preferences 171
SQL Dashboard 779
Feeder Overview toolbox tool 764

User Guide

Index
feeder sets 161
creating 161, 162
deleting 162
selecting 162
Feeder Tie Path report 478
feeders
converting nodes into feeders 246
demands 252
de-selecting a single feeder 160
editing 247
Feeder editor 247
Feeder tab 248
Node tab 250
Rates tab 251
Results tab 251
Volts/Ohms tab 249
Feeder Overview toolbox tool 764
Model Forge commands 993
modeling 245
repeating the last feeder selection 160
selecting 157
selecting a single feeder 160
selecting automatically when you load a model 161
selecting multiple feeders 157, 159
Feeders tab (model explorer) 145
file paths
setting preferences 167
file types 1167
File.WriteLine recipe command 913
files
cost files 447
filtering data columns 151
find model data 171
force unfed sections 263
forecasting analysis 556
performing 561
selecting a forecasting agent 560
setting up 557
Full-Year Analysis 588
function keys 149

SynerGEE Electric 5.0

Index
FUS_101 model forge command 1000
FUS_102 model forge command 1001
FUS_103 model forge command 1001
FUS_104 model forge command 1002
fuses 342
amp multiplier factor 347
amp multipliers 346
defaults and uprating 347
deleting 346
editing 343
Fuse editor 343
Fuse tab 343
Rates tab 345
Results tab 346
Model Forge commands 1000
modeling 342
time multiplier factor 346
time multipliers 346
G
gallery
about 129
deleting a model 131
loading a model 130
renaming a model 131
saving a model 130
Garage
see Organizer
GEN_101 model forge command 1002
GEN_102 model forge command 1003
GEN_103 model forge command 1003
GEN_104 model forge command 1004
GEN_105 model forge command 1004
generator types 348
creating 348
deleting 351
editing 349
generators 347
adding 352
deleting 356

SynerGEE Electric 5.0

1189
Delta-connected 356
distributed generation 503
editing 352
fault analysis 356, 650
Generator editor 352
Generator tab 352
Machine tab 355
Results tab 355
generator types 348
managing 351
Model Forge commands 1002
multiple generators 356
scheduled, distributed generation 356
Geography view 239
changing the basemap layer 242
setting up 239
synchronizing with the Map view 241
using the Geography view window 241
viewing a model 241
GIS extraction
see MiddleLink-GIS model builds
global costs 449
graphic nodes
see graphic points
graphic points
about 278
adding 278
deleting 279
moving 278
removing using node reduction 276
graphs
generating from a grid-style report 473
grid
showing 215
grid-style reports 467
appearance, editing 468
applying color to the map display 472
exporting to a database 475
exporting to Excel 474
generating graphs 473

User Guide

1190
managing content 470
saving 473
shortcuts 476
growth curves 804
applying to a section 806
applying to sections 806
creating 805
deleting 806
editing 805
multi-year modeling 807
single-year environment 808
using 806
H
harmonic analysis 689
designating sections for harmonic monitoring 693
harmonic curves 690
harmonic load-flow report 694
harmonics 689
impedance frequency scan report 695
options 693
running 694
setting up 689
harmonic curves 690
assigning to a large customer 692
creating 690
deleting 692
editing 690
harmonic load-flow report 694
Harmonics concepts view 491
height above ground
setting spacing preferences 169
HTML reports 477
I
I,Z,PQ - see load I,Z,PQ
I,Z,PQ Calibration power tool 748
calculating Delta % kW / Delta %V 750
operation 752
power mathematics 749

User Guide

Index
running 753
settings 753
using 749
using the calculated Delta % kW / Delta %V 751
images
background images 1173
supported image types 1173
vector images 1175
world files for raster images 1173
Impedance concepts view 490
impedance frequency scan report 695
Insert Tie Switches power tool 756
running 757
settings 756
intermediate points
see graphic points
isolating sections 546
K
keyboard shortcuts
custom 149
function keys 149
panning the map using the arrow keys 198
KML files
Publishing export 739
L
labels 225
adding 226
deleting 229
editing 227
moving 229
large customers
about 503
adding 503
analysis results, viewing 510
assigning harmonic curves 692
editing 504
editing loads using the Bulk Editor 192
load curves 821

SynerGEE Electric 5.0

Index
Model Forge commands 1004
scheduling 511
with load curves 511
layers
creation during Publishing export 742
legend 231
Legend tab (model explorer) 145
LGC_101 model forge command 1005
LGC_102 model forge command 1006
LGC_103 model forge command 1006
LGC_104 model forge command 1007
LGC_105 model forge command 1007
LGC_106 model forge command 1008
LGC_107 model forge command 1008
LGC_108 model forge command 1009
LGC_109 model forge command 1010
LGC_110 model forge command 1011
LGC_111 model forge command 1011
LGC_112 model forge command 1011
LGC_113 model forge command 1012
LGC_114 model forge command 1012
LGC_115 model forge command 1013
LGC_116 model forge command 1014
LGC_117 model forge command 1015
LGC_118 model forge command 1015
LGC_119 model forge command 1015
LGC_120 model forge command 1016
Library 770
adding documents 770
deleting documents 772
updating documents 771
viewing documents 771
licensing 54
line construction report 479
line-drop compensator
capacitors 333
lines
see section
links
see location links

SynerGEE Electric 5.0

1191
LOA_120 model forge command 1020
LOA_121 model forge command 1020
LOA_122 model forge command 1021
LOA_123 model forge command 1022
LOA_124 model forge command 1022
LOA_130 model forge command 1023
LOA_131 model forge command 1023
LOA_132 model forge command 1024
LOA_133 model forge command 1024
LOA_140 model forge command 1025
LOA_141 model forge command 1025
LOA_142 model forge command 1026
load allocation 552
about 549
calculations with customer load curves 552
capacitor options 551
choosing time to allocate load 819
demands and meters 550
handling the model afterward 820
load I,Z,PQ 552
loops 552
metering points 364
preparing the model for 819
regulator options 551
running 555
setting options 552
substation transformers 552
suggested approaches 551
understanding results 820
use of demands 551
when to run 550
with customer load curves 819
load balancing improvement analysis 569
running 570
setting up 569
load categories
setting preferences 170
Load Center Manager toolbox tool 765
creating and editing load centers 766
load centers

User Guide

1192
creating 766
editing 766
load curves 808
benefits 809
customer classes 810
customer zones 815
enabling 818
getting started 809
interaction with multi-year modeling 581
large customers 821
summary 821
with load allocation 819
load growth 552, 801
enabling 802
growth curves 804
interaction with multi-year modeling 581
rates, specifying 804
load I,Z,PQ
about 496
assigning percentages to loads 496
model details 497
sample values 502
load modeling, getting started 494
load transfer method (contingency analysis) 537
setting up 540
LoadAlloc.Run recipe command 915
load-flow analysis 512
advantages of 515
benefits of 515
by-phase versus balanced 516
invalid tie switches and load flow 520
network analysis 522, 524
overview 513
radial 516
radial load-flow engine 514
radial load-flow with loops 517
radial load-flow with loops example 517
radial load-flow with loops, about 517
radial load-flow with wandering laterals 520
radial low-flow foundation 513

User Guide

Index
running 516
sample wandering lateral calculations 521
wandering laterals and tie switches 520
LoadFlow.Run recipe command 915
loading
model data 61
TCC files 613
loading models 156
loads
adjusting for weather 828
constant current 498
constant impedance 499
constant power 498
editing using the Bulk Editor 192
exception load limits, defining 437
I,Z,PQ - see load I,Z,PQ
Load Center Manager toolbox tool 765
Model Forge commands 1016
modeling 253
network 496
radial 495
setting up 493
types 494
location links 223
creating 224
launching 225
locked rotor analysis (LRA) 375
motor model details 376
running 376
locks
enterprise databases 121
LOD_101 model forge command 1017
LOD_103 model forge command 1017
LOD_104 model forge command 1018
LOD_105 model forge command 1019
LOD_106 model forge command 1019
long units of length 188
loop tie switch
about 253
modeling 255

SynerGEE Electric 5.0

Index
loop tie switches 255
loops
about 253
analysis considerations 256
modeling 254
modeling with a loop tie switch 255
modeling with a wandering lateral tie switch 256
LUL (units) 188
LYR files 239
M
MAIFI 669
Maintenance Wizard 193
manholes
see large customers
map 195
annotation based on analysis results 208
background images 232, 1173
changing the zoom direction of the map scroll wheel
200
Color By colors, defining 212
coloring by path type 216
coloring sections 216
customizing device colors and sizes based on
analysis results 211
customizing section colors and sizes based on
analysis results 210
display settings 200
display style, configuring 201
Geography view 239
grid, showing 215
labels 225
legend 231
measuring distances 198
nodes, viewing 264
panning 197
refreshing 199
rotating 198
section and device annotation, adding 207
Show Manager 242
symbol visibility levels, configuring 214

SynerGEE Electric 5.0

1193
symbols, configuring 213
synchronizing with the Geography view 241
toggling details 199
using 196
views 231
zooming 196
map centering mode 198
map settings editor 200
margins, in check coordination analysis 627
master report template, editing 469
master report template, restoring 470
measuring distances in the map display 198
measuring the TCC 611
Media Viewer 770
medium units of length 188
menus
context (right-click) menus 150
messaging scripts 720
MET_104 model forge command 1027
MET_105 model forge command 1027
MET_106 model forge command 1028
MET_107 model forge command 1028
MET_108 model forge command 1029
MET_109 model forge command 1029
MET_110 model forge command 1030
MET_111 model forge command 1031
MET_112 model forge command 1032
MET_113 model forge command 1033
MET_114 model forge command 1033
MET_115 model forge command 1034
MET_116 model forge command 1035
meters 356
adding 357
deleting 364
editing 357
managing 357
Meter editor 357
Demands tab 359
Meter tab 358
Reliability tab 362

User Guide

1194
Results tab 363
Zones tab 363
metering points and load application 364
Model Forge commands 1027
reliability studies 364
MiddleLink
importing MiddleLink files into a CMM data set 839
MiddleLink data format
about 72
architecture 73
MiddleLink data type
automating model builds 112
import options 106
node identification 107
protective device conversion 109
source details (3.4) 103
source details (new ML) 104
MiddleLink-GIS model builds 100
benefits 101
general steps 102
note to ML 3.4 users 101
running 103
mining
setting data mining preferences 169
SQL Dashboard 779
mitigation zones 683
assigning to a section 684
creating 683
deleting 685
editing 684
mobile items
adding to the map display 230
deleting 230
editing 230
model
building a model 245
setting as the Startup script 717
model and analysis options 436
automatic fixes 442
exception load limits 437

User Guide

Index
general analysis options 441
general model options 438
model costs 443
multi-year analysis options 442
report warnings 460
model characteristic codes 148
model cleanup
commands 1117
model cleanup scripts 718
example 718
protective device conversion 719
supplementing spacing data 719
model costs
setting 443
model data
about 61
comparing 63
in Access 63
loading 61
merging 62
sample database 64
saving 61
model explorer 143
Facilities tab 144
Feeders tab 145
Legend tab 145, 231
Model tab 143
Query tab 145
toolbox 763
Toolbox tab 145
Warehouse tab 144
model forge 702
Model Forge schema, viewing 703
Model Forge script example 703
Model Forge wizard, running 703
Model Forge commands 947
areas of interest 948
breakers 953
capacitors 966
CMM 981

SynerGEE Electric 5.0

Index
distribution transformers 987
facilities 991
feeders 993
fuses 1000
generators 1002
large customers 1004
loads 1016
meters 1027
nodes 1035
projects 1036
reclosers 1038
regulators 1070
REM 1082
sectionalizers 1083
sections 1086
sources 1096
substations 1100
switches 1097
transformers 1104
model reduction 267
Model Rollover wizard 585
Model tab (model explorer) 143
Model Viewer files
Publishing export 739
Model.AnalysisSection recipe command 933
Model.AnalysisYear recipe command 933
Model.DeselectAllFeeders recipe command 932
Model.DropAllFeeders recipe command 930
Model.Dtran_PlaceWithXY recipe command 933
Model.SelectFeeder recipe command 932
Model.SetAnalysisSection recipe command 930
Model.SetAnalysisSectionByFirstBreaker recipe
command 931
Model.SetMeterAmps recipe command 931
Model.SetMeterDataType recipe command 933
Model.SetRegulatorsManualMode recipe command 932
Model.SetSwitchableDeviceStatusUsingSubstring recipe
command 931
Model.ZoomToSelectedFeeders recipe command 930
ModelForge.RunProcess recipe command 918

SynerGEE Electric 5.0

1195
modeling
breakers 321
fuses 342
reclosers 378
sectionalizers 393
model-in-memory
SQL Dashboard 778
Modelpedia
see Organizer
models
loading 156
model and analysis options 436
multi-model analysis 576
node reduction 267
performance comparison 589
regression 759
setting preferences 163
motor curve types 368
creating 368
deleting 369
editing 368
motor start analysis 377
running 377
motor types 365
creating 365
deleting 367
editing 366
motors 364
adding 369
deleting 375
editing 370
locked rotor analysis 375
managing 369
motor analysis types 375
motor curve types 368
Motor editor 370
Load tab 374
Motor tab 370
Results tab 374
Service tab 371

User Guide

1196
Starter tab 373
motor start analysis 377
motor types 365
mouse
changing the zoom direction of the scroll wheel 200
panning the map display 197
moving 147
moving data columns 151
MUL (units) 188
multi-model analysis 576
identifying data sources 577
performing 579
selecting analysis types and years 577
selecting post-processing options 578
selecting pre-processing options 578
setting up 576
MultiModel.AddDataSource recipe command 934
MultiModel.CheckCoordination recipe command 934
MultiModel.CheckData recipe command 935
MultiModel.Contingency recipe command 935
MultiModel.CreateZonesAndProcessEvents recipe
command 936
MultiModel.Fault recipe command 936
MultiModel.LoadAllocation recipe command 936
MultiModel.LoadFlow recipe command 937
MultiModel.Reliability recipe command 937
MultiModel.RemoveAllDataSources recipe command
938
MultiModel.Run recipe command 938
MultiModel.ThrowOver recipe command 938
MultiModel.Years1 recipe command 938
MultiModel.Years2 recipe command 939
multiple editor 177
applying customer zones to sections 817
multiple sessions 55
multi-year analysis
options 442
multi-year modeling 579
applicable data 580
challenges 582

User Guide

Index
changing years 581
copying data 584
data characteristics 587
differences with versions 581
enabling 582
energize and retire year 583
general information 580
getting started 580
growth curves 807
interaction with customer load curves and load
growth 581
Model Rollover wizard 585
modeling information 582
multi-year analysis 586
running 587
setting up 586
SynerGEE editors 583
time spans 584
year names 584
year specific data 583
N
network analysis 522, 524
analysis 522, 525
network fault analysis 523, 526
network load-flow analysis 522, 525
network outage analysis 523, 526
running 524, 527
setting up 523, 526
network installation
multiple sessions 55
network model loads 496
network protectors 420
sample model 421
tripping and closing 421
NOD_101 model forge command 1035
NOD_102 model forge command 1036
Node Overlap Report power tool 757
running 759
settings 758

SynerGEE Electric 5.0

Index
node reduction 267, 276
breaking loops with elbows 277
detailed operation 273
eliminating a node completely 272
example 275
load handling 277
methodology 271
node elimination rules 273
performing 270
removing nodes 271
replacing a node with a vertex 272
settings 267
nodes
about 264
converting into feeders and subtrans 246
converting to other device types 266
converting to pad-mounted switch gear 409
creating 261, 265
deleting 266
disabling node editing 199
editing 265
Model Forge commands 1035
moving 266
Node Overlap Report power tool 757
renaming 265
viewing in the map display 264
Notepad
opening scripts from the script editor 727
notes
adding to reports 460
numerical recipes
analysis commands 881
commands 855
data I/O commands 858
graphical user interface commands 855
licensing commands 900
list commands 898
map coloring commands 873
messaging script commands 902
model modification commands 890

SynerGEE Electric 5.0

1197
parameter reference 903
analysis types 905
colors 903
results 904
program operation commands 856
results handing commands 892
selection commands 893
selection commands example 898
O
opening
models 156
optimal switching analysis 529
application operation 529
application speed 530
running 532
setting options 530
optimized pickup method (contingency analysis) 536
setting up 542
Oracle data format 74
Organizer 183
output options 444
adding notes to reports 460
configuring report options 459
editing 444
generating reports 457
P
pad-mounted switch gear 408
converting from node 409
editing 410
page setup options 178
panning 197
using map centering mode 198
using the arrow keys 198
using the mouse 197
using the scroll wheel 197
partials
about 89
cautionary note 90

User Guide

1198
how they work 90
loading 89
paths
coloring the map by path type 216
setting file path preferences 167
performance comparison 589
add phase/change phase factors 592
calculating model costs 592
running 594
secondary losses 593
selecting models 590
setting analysis options 591
setting costs 590
settings 589
phase balancing improvement analysis 566
running 567
setting up 566
PhaseBalancing.Run recipe command 940
phases
adding to a section 262
changing on a section 262
planning 549
Full-Year (8760) Analysis 588
power tools 744
Capacitor Flicker Report power tool 753
I,Z,PQ Calibration power tool 748
Insert Tie Switches power tool 756
Node Overlap Report power tool 757
Regulator Setting power tool 745
Ten-Year Growth Report power tool 755
PowerCalc 761
available functions 763
scripts 763
starting 761
understanding 761
preferences 162
changing the zoom direction of the mouse scroll
wheel 200
data mining 169
database 167

User Guide

Index
feature locks 171
file paths 167
load categories 170
model 163
spacing options 169
units of measurement 165
printing 178
charts 483
page setup options 178
printing report chapters 179
reports 460
PRJ files 239
PRO_101 model forge command 1036
PRO_102 model forge command 1037
PRO_103 model forge command 1038
profiles
weather 825
projection files 239
projects
editing using the Projects Manager 293
editing using the Projects worksheet 292
editing using the Section editor 290
Model Forge commands 1036
protection 599
protection coordination analysis
see check coordination analysis
protection data
about 67
general information 67
interaction with TCC 69
mechanical response times 70
Protection Lab 615
protection pairs, in check coordination analysis 639
protective device types 601
creating 601
deleting 602
editing 601
protective devices 599
adding 602
analysis results, viewing 603

SynerGEE Electric 5.0

Index
breakers 321
classic 600
data management 599
deleting 604
fuses 342
general data, editing 603
reclosers 377
sectionalizers 393
switchable devices 600
Publishing export 739
layer creation 742
running 742
SVG output information 744
Python scripts 705
creating 706, 708, 709
editing 706
examples 710
performing a fault analysis 712
reporting model data 710
Startup script 711
updating neutrals 714
running 709
running at startup 715
writing 707
Q
queries
CMM SQL Dashboard 850
running a SQL query in the SQL Dashboard 777
sample SQL queries in the SQL Dashboard 782
writing a SQL query in the SQL Dashboard 775
Query Path tool 175
query sets
adding sections 174
adding sections using spatial query mode 174
clearing 176
creating 173
creating from the map display 174
creating using the Query Wizard 176
modifying sections using the Query Path tool 175

SynerGEE Electric 5.0

1199
removing sections 176
Query tab (model explorer) 145
Query Wizard 176
quick access toolbar 146, 147
editing 147
R
R&D analysis 489
radial model loads 495
rap sheets 179
Arc Flashover rap sheet 181
Details rap sheet 179
Fault rap sheet 182
Voltage Plot rap sheet 180
raster images 1173
ratings, seasonal 831
REC_101 model forge command 1040
REC_102 model forge command 1040
REC_103 model forge command 1041
REC_104 model forge command 1041
REC_105 model forge command 1042
REC_106 model forge command 1042
REC_107 model forge command 1043
REC_108 model forge command 1044
REC_109 model forge command 1045
REC_110 model forge command 1045
REC_111 model forge command 1046
REC_112 model forge command 1046
REC_113 model forge command 1047
REC_114 model forge command 1048
REC_115 model forge command 1049
REC_116 model forge command 1049
REC_117 model forge command 1050
REC_118 model forge command 1050
REC_119 model forge command 1051
REC_120 model forge command 1052
REC_121 model forge command 1052
REC_122 model forge command 1053
REC_123 model forge command 1053
REC_124 model forge command 1054

User Guide

1200
REC_125 model forge command 1055
REC_126 model forge command 1055
REC_127 model forge command 1056
REC_128 model forge command 1057
REC_129 model forge command 1057
REC_130 model forge command 1058
REC_131 model forge command 1058
REC_132 model forge command 1059
REC_133 model forge command 1060
REC_134 model forge command 1061
REC_135 model forge command 1062
REC_136 model forge command 1063
REC_137 model forge command 1064
REC_138 model forge command 1065
REC_139 model forge command 1066
REC_140 model forge command 1067
REC_141 model forge command 1068
REC_142 model forge command 1068
REC_143 model forge command 1069
REC_144 model forge command 1069
REC_145 model forge command 1070
recipe scripts
running at startup 715
Startup recipe script 716
Recipe.End recipe command 914
Recipe.Start recipe command 914
Recipe.StartAutomated recipe command 914
recipes 700
analysis commands (numerical) 881
analysis commands (text-based) 908
CMM commands (text-based) 909
contingency commands (text-based) 910
data I/O commands (numerical) 858
deleting 725
fault location commands (text-based) 910
file commands (text-based) 912
graphical user interface commands (numerical) 855
licensing commands (numerical) 900
list commands (numerical) 898
list commands (text-based) 915

User Guide

Index
load allocation commands (text-based) 914
load flow commands (text-based) 915
map coloring commands (numerical) 873
map commands (text-based) 917
messaging script commands (numerical) 902
model forge commands (text-based) 918
model I/O commands (text-based) 918
model management commands (text-based) 930
model modification commands (numerical) 890
multi-model commands (text-based) 934
numerical recipe commands 855
parameter reference (numerical) 903
analysis types 905
colors 903
results 904
phase balancing commands (text-based) 940
program operation commands (numerical) 856
QA commands (text-based) 941
recipe control commands (text-based) 913
reliability commands (text-based) 941
renaming 724
repeating the most recent script 732
results handling commands (numerical) 892
running automatically 731
script example 701
selection commands (numerical) 893
selection commands example (numerical) 898
settings commands (text-based) 943
SQL commands (text-based) 943
startup 715
Startup script wizard 716
Startup script, setting 717
syntax 700
text-based recipe commands 907
throw-over commands (text-based) 944
warehouse commands (text-based) 945
reclosers 377
deleting 383
editing 378
mechanical response times 383

SynerGEE Electric 5.0

Index
Model Forge commands 1038
modeling 378
Recloser editor 378
Alternate tab 381
Primary tab 381
Rates tab 381
Recloser tab 378
Results tab 382
Setup tab 380
redo 172
refreshing the map display 199
REG_101 model forge command 1071
REG_102 model forge command 1071
REG_103 model forge command 1071
REG_104 model forge command 1073
REG_105 model forge command 1074
REG_106 model forge command 1075
REG_107 model forge command 1076
REG_108 model forge command 1077
REG_109 model forge command 1078
REG_110 model forge command 1078
REG_111 model forge command 1079
REG_112 model forge command 1079
REG_113 model forge command 1080
REG_114 model forge command 1080
REG_115 model forge command 1081
REG_116 model forge command 1082
Register
see Organizer
registry
clearing 193
regression 759
general steps 759
regression files, comparing 760
regression files, creating 760
regression files, deleting 760
Regulator Setting power tool 745
examples 747
running 746
settings 745

SynerGEE Electric 5.0

1201
regulator Setting power tool
examples 747
regulator types 384
creating 384
deleting 386
editing 384
regulators 383, 384
adding 387
deleting 393
editing 387
managing 386
Model Forge commands 1070
optimal regulator position evaluation 574
Regulator editor 387
LDC tab 388
Rates tab 392
Regulator tab 387
Results tab 392
Settings tab 390
seasonal ratings 832
reliability 661
reliability analysis 661
about 661
additional options, setting 665
analytical model calibration 675
aspects of 667
assumptions 688
basic options, setting 663
capacity considerations 670
challenges 662
data calibration 674
data management 674
device failure rates 685
exposure factors 673
exposure zones 679
failures 676
historical outage data management 674
importance of 662
interruptions 676
isolating/switching/pickup example 688

User Guide

1202
meters 671
metric variance 670
mitigation zones 683
performing 667
process 686
processing examples 686
publishable results 669
Reliability Event Management wizard 697
ReliCauseMeta.txt file 677
results 687
results presentation 687
root causes 670
root causes, defining 677
scalars, settings up 666
setting up 662
spatial mitigation 671
supported indices 667
supporting applications 673
switching plan models 669
SynerGEE approach 662
trial and study 687
variation analysis 675
version comparison 669
Reliability Event Management wizard 697
Reliability.CreateDataSet recipe command 942
Reliability.CreateZonesAndProcessEvents recipe
command 942
Reliability.DeleteDataSet recipe command 943
ReliCauseMeta.txt 677
editing 679
file format 678
REM
Model Forge commands 1082
REM_201 model forge command 1082
repeating the last feeder selection 160
reports 456
Breaker Zone 1 report 477
Capacitor Flicker Report power tool 753
chapter report template, editing 469
chapter report template, restoring 470

User Guide

Index
check data 137
configuring output options 459
Digest 478
dockable 462
errors 460
Feeder Tie Path report 478
generating after an analysis 457
grid-style 467
harmonic load-flow report 694
HTML reports 477
impedance frequency scan report 695
including notes 460
line construction 479
master report template, editing 469
master report template, restoring 470
Node Overlap Report power tool 757
non-analysis reports 477
options affecting analysis 460
printing 460
printing selected report chapters 179
Ten-Year Growth Report power tool 755
Version 55
Voltage Optimization analysis report 595
warnings 460
warnings, suppressing 460
zones 479
resizing data columns 151
results
Broadcaster 451
viewing in the SynerGEE editor 156
Results tab
selecting attributes 445
Results Viewer 451
selecting attributes for 445
retire year
multi-year modeling 583
ribbon bar 146
right-click menus 150
rotating the map 198
rule-base, check coordination 627

SynerGEE Electric 5.0

Index
S
SAIDI 668
SAIFI 668
sample equipment database 67
sample model database 64
saving
model data 61
TCC as JPEG 613
TCC files 613
scalars
reliability analysis 666
scatter-plot graphs
generating from a grid-style report 473
scenario
see versions
schemas
CMM
viewing 843
model cleanup 1117
Model Forge 947
numerical recipes 855
script 733
text-based recipes 907
schemas, repairing 134
schematics 233
creating 237
editing device and section data 238
grid properties 239
opening 238
templates 234
deleting 236
templates, copying 236
templates, creating 234
templates, editing 235
templates, renaming 236
working in 238
Script editor 725
creating scripts 726
deleting scripts 729
editing scripts 727

SynerGEE Electric 5.0

1203
opening scripts 726
opening scripts in Notepad 727
ScriptList.AddItem recipe command 917
ScriptList.Create recipe command 916
ScriptList.Destroy recipe command 916
ScriptList.Empty recipe command 916
ScriptList.LoadFromFile recipe command 917
ScriptList.RemoveItem recipe command 917
scripts 699
automation 720
cable study scripts 721
CMM
examples 845
running using the CMM wizard 842
schema, viewing 843
writing 843
controls script 821, 822
creating 821
copying 723
creating 722
creating from the Script editor 726
deleting 724
deleting from the Script editor 729
editing 723
editing from the Script editor 727
messaging 720
model cleanup commands 1117
model cleanup script 718
model cleanup script example 718
model forge 702
Model Forge commands 947
numerical recipe commands 855
opening from the Script editor 726
opening in Notepad from the Script editor 727
PowerCalc 763
Python 705
recipes 700
renaming 724
repeating the most recent recipe 732
running 730

User Guide

1204
automatically 731
from Script wizard 731
from the ribbon bar 731
schema 733
Script editor 725
Script Wizard 729
setting the current model as the Startup script 717
startup recipe 715
Startup script wizard 716
text-based recipe commands 907
what-if analysis 484
writing 722
scripts, example 487
scripts, managing 485
scroll wheel
changing the zoom direction 200
panning the map display 197
searching 171
seasonal ratings 831
conductors 832
regulators 832
selecting 831
Summer/Winter analysis 833
transformers 833
SEC_101 model forge command 1087
SEC_104 model forge command 1087
SEC_105 model forge command 1088
SEC_108 model forge command 1088
SEC_109 model forge command 1089
SEC_110 model forge command 1089
SEC_111 model forge command 1090
SEC_112 model forge command 1090
SEC_114 model forge command 1091
SEC_115 model forge command 1091
SEC_116 model forge command 1092
SEC_117 model forge command 1092
SEC_118 model forge command 1093
SEC_119 model forge command 1094
SEC_120 model forge command 1094
SEC_121 model forge command 1095

User Guide

Index
SEC_122 model forge command 1095
SEC_123 model forge command 1096
SEC_124 model forge command 1096
sectionalizers 393
deleting 397
editing 394
Model Forge commands 1083
modeling 393
Sectionalizer editor 394
Rates tab 395
Results tab 396
Sectionalizer tab 394
sections 257
adding 259, 279
analysis results, viewing 304
annotation, adding 207
applying customer zones 817
applying growth curves 806
associating with an area of interest 223
cable conductors, applying 789
coloring based on analysis results 210
coloring by path type 216
conductors, changing 262
connecting 260
cost zones, assigning 853
customer zones, applying 817
deleting 263
designating for harmonic monitoring 693
diagram 258
disconnecting 260
distribution transformers, editing using the DTran
worksheet 297
distribution transformers, editing using the Section
editor 296
duct banks, applying 797
editing 279
exposure zones, assigning 682
force unfed 263
isolating 546
mitigation zones, assigning 684

SynerGEE Electric 5.0

Index
Model Forge commands 1086
modeling 258
moving 260
phase, adding 262
phase, changing 262
projects, editing using the Projects Manager 293
projects, editing using the Projects worksheet 292
projects, editing using the Section editor 290
reconductoring 261
renaming 262
rephasing 261
Section editor
Construction tab 281
Coordinates tab 303
Gen - Dist tab 298
Load - Dist tab 284
Load - DTrans tab 295
Load - Proj tab 289
Load - Spot tab 287
Properties tab 283
Section tab 280
Zones tab 301
setting coloring scheme 216
setting for analysis 434
splitting 261
tagging 172
weather zones, assigning 835
selecting
feeders 157
feeders automatically when you load a model 161
multiple feeders 157, 159
single feeder 160
substations 157
separate neutral cable conductor model 787
set points for weather modeling 825
settings
restoring defaults 191
settings file 189
details 191
settings groups 189

SynerGEE Electric 5.0

1205
creating 190
managing 190
Settings.LoadXML recipe command 943
short units of length 188
shortcuts
custom keyboard shortcuts 149
function keys 149
panning the map using the arrow keys 198
Show Manager 242
simple impedance cable conductor model 787
simple impedance method, conductors 310
Software Version 55
Solver
running from within SynerGEE 783
sorting data columns 151
sources
editing 247
Model Forge commands 1096
spacing
setting spacing preferences 169
spatial query mode 174
SPV files 613
SQL Dashboard 772
CMM 849
controls 849
queries 850
deleting a SQL query 776
feature locks 779
mining 779
model-in-memory feature 778
opening 773
running a SQL query 777
sample SQL queries 782
saving a SQL query 776
selecting a data type and data source 774
showing tables and fields 776
SQL commands 780
SQL queries 775
using 773
writing a SQL query 775

User Guide

1206
SQL Server data format 74
SQL.RunFromFile recipe command 944
SRC_101 model forge command 1097
SRC_102 model forge command 1097
startup defaults
restoring to factory settings 191
Startup script 715
setting the current model as the Startup script 717
specifying script type to run 715
Startup recipe script 716
wizard 716
State Master 768
status bar 148, 149
STN_101 model forge command 1101
STN_102 model forge command 1101
STN_103 model forge command 1102
STN_104 model forge command 1102
STN_105 model forge command 1103
STN_106 model forge command 1103
STN_107 model forge command 1103
subsets
about 82
getting started 82
manual creation/editing 85
types 83
with multi-year modeling 85
substation bus transformer analysis 534
substations
Model Forge commands 1100
selecting 157
subtrans 157
configuration 252
converting nodes into subtrans 246
demands 252
editing 247
modeling 245
selecting 157
Subtran editor 247
Node tab 250
Rates tab 251

User Guide

Index
Results tab 251
Subtran tab 248
Volts/Ohms tab 249
SUL (units) 188
summer ratings 831
conductors 832
enabling 831
regulators 832
Summer/Winter analysis 833
transformers 833
Summer/Winter analysis 833
SVG files
Publishing export 739
Publishing export information 744
Switch Manager toolbox tool 763
switch plans 411
creating 411
deleting 413
editing 411
Switch Plan Manager 413
switch types 400
creating 401
deleting 402
editing 401
switchable protective devices 600
switched capacitor modules, controlling 331
switches 397
adding 402
auto-transfer switch analysis 533
auto-transfer switches 407
connectivity rules 398
contingency and optimal switching analysis 415
converting a node to pad-mounted switch gear 409
deleting 407
editing 402
elbows 408
invalid tie switches and load flow 520
loop tie 253
managing 402
Model Forge commands 1097

SynerGEE Electric 5.0

Index
pad-mounted switch gear 408
pad-mounted switch gear, editing 410
special types 400
Switch editor 402
Rates tab 406
Results tab 407
Switch tab 403
Switch Manager toolbox tool 763
switch plans 411
switch types 400
wandering lateral tie 253
SWT_101 model forge command 1098
SWT_102 model forge command 1098
SWT_103 model forge command 1099
SWT_104 model forge command 1099
SWT_105 model forge command 1100
symbols
configuring 213
configuring map display symbols 213
configuring visibility levels 214
synchronizing the Geography view and the Map view 241
SynerGEE
environment 142
launching from the command line 184
using SynerGEE 141
windows 142
SynerGEE documentation 52
SynerGEE editor 151
multi-year modeling 583
opening 155
selecting attributes for the Results tab 445
viewing results 156
SynerGEE-MiddleLink, detailed processing 106
SynQA.GenRemDataFile recipe command 941
System Status analysis 489
SZR_101 model forge command 1083
SZR_102 model forge command 1083
SZR_103 model forge command 1084
SZR_104 model forge command 1085
SZR_105 model forge command 1085

SynerGEE Electric 5.0

1207
SZR_106 model forge command 1086
T
tagging sections and facilities 172
tape shield cable conductor model 788
TCC
about 604
conductor damage curves 612
copy 614
creating a new view 604
delete whole graph 615
display properties 606
explorer 605
grid properties 610
labels 610
legend display 609
lines, amp and time 610
loading files 613
measuring tools 611
moving 606
notes display 609
plotting curves 605
refreshing 615
remove curve from graph 615
saving as JPEG 613
saving files 613
setting curve visibility 606
TCC sets 612
title on printouts 615
transformer curves 606, 643
zooming 606
TCC sets 612
Technical Support 56
templates
chapter report template, editing 469
chapter report template, restoring 470
master report template, editing 469
master report template, restoring 470
schematics 234
Ten-Year Growth Report power tool 755

User Guide

1208
running 756
settings 755
terminology 53
tertiary windings 416
basic steps for modeling 416
secondary versus tertiary connections 416
setting up for a transformer 429
text-based recipes
CMM commands 909
commands 907
contingency commands 910
fault location commands 910
file commands 912
list commands 915
load allocation commands 914
load flow commands 915
map commands 917
model forge commands 918
model I/O commands 918
model management commands 930
multi-model commands 934
phase balancing commands 940
QA commands 941
recipe control commands 913
reliability commands 941
selection commands 908
settings commands 943
SQL commands 943
throw-over commands 944
warehouse commands 945
three-core cable conductor model 789
throw-over analysis 533
ThrowOver.Run recipe command 945
tie switches
Insert Tie Switches power tool 756
invalid tie switches and load flow 520
with wandering laterals 520
time
controls script 821
creating 821, 822

User Guide

Index
customer load curves/time-of-day analysis 808
features and tools 801
multi-year modeling 579
time spans in multi-year modeling 584
time multiplier, fuses 346
time of day, selecting 434
time versus current coordination
see TCC
toggling details in the map display 199
toolbars
quick access toolbar 146
toolbox 763
Capacitor Manager 765
Feeder Overview 764
Load Center Manager 765
Switch Manager 763
Toolbox tab (model explorer) 145
tools 739
transformer types 422
creating 422
deleting 424
editing 422
transformers 415
adding 425
connection models 418
curve shifting in the TCC 609
deleting 431
editing 425
managing 425
Model Forge commands 1104
network protectors 420
seasonal ratings 833
simulating underutilized 502
tertiary windings 416, 429
Transformer editor 425
LTC tab 427
Net Protector tab 429
Rates tab 430
Results tab 431
Transformer tab 426

SynerGEE Electric 5.0

Index
transformer model 415
transformer types 422
TRN_101 model forge command 1104
TRN_102 model forge command 1105
TRN_103 model forge command 1105
TRN_104 model forge command 1107
TRN_105 model forge command 1108
TRN_106 model forge command 1109
TRN_107 model forge command 1110
TRN_108 model forge command 1111
TRN_109 model forge command 1111
TRN_110 model forge command 1112
TRN_111 model forge command 1112
TRN_112 model forge command 1114
TRN_113 model forge command 1115
U
uncertainty analysis 487
performing 488
setting up 488
undo 172
Unfused Tap analysis 696
Unit test 99
units 185
automatic conversion 186
concepts 186
control tables 187
conversion 187
conversion rules when saving 188
generic names for length increments 188
internal units 186
setting preferences 165
tips 189
using SynerGEE 141
using the SynerGEE editor 151
V
vaults
see large customers
vector images 1175

SynerGEE Electric 5.0

1209
Version 55
Device Risk Ranking 696
versions
about 86
deleting 86
differences with multi-year modeling 581
loading 86
managing 86
processing details 87
sample workflow 87
saving 86
vertex reduction 267
vertices
see graphic points
views 231
Concepts view 490
creating 231
deleting 232
replacing 232
viewing 231
visibility
configuring visibility levels for map display symbols
214
Voltage Optimization analysis 594
example 596
reporting 595
running 595
setting up 595
Voltage Plot rap sheet 180
W
wandering laterals
about 253
analysis considerations 256
modeling 256
sample wandering lateral calculations 521
with fault analysis 652
with radial load-flow 520
with tie switches 520
warehouse

User Guide

1210
see equipment types
Warehouse tab (model explorer) 144
Warehouse.Drop recipe command 917, 945
warnings
report warnings, suppressing 460
weather
adjusting loads 828
weather modeling 823
defining weather conditions 824
overview 823
profiles 825
selecting seasonal rating 831
set points 825
weather profiles 825
applying to a model 827
creating 826
deleting 828
editing 826
weather zones 834
assigning to a section 835
creating 834
deleting 835
editing 834
what-if analysis 484, 485, 487
windows 142
winter ratings 831
conductors 832
enabling 831
regulators 832
Summer/Winter analysis 833
transformers 833
worksheets 739
world files for raster images 1173

Index
changing for multi-year modeling 581
year names in multi-year modeling 584
Z
zones
customer 815
exposure 679
mitigation 683
weather 834
zones report 479
zooming 196
TCC 606

X
XML data format 75
Y
year, selecting for analysis 434
years

User Guide

SynerGEE Electric 5.0

Index

SynerGEE Electric 5.0

1211

User Guide

1212

User Guide

Index

SynerGEE Electric 5.0

www.gl-group.com/electric