E Terrasource Ug

e-terrasource User’s Guide
This document provides information about the use of the e-terrasource

software.
Software Version: e-terrasource 2.0
Document Date: May 8, 2012

Copyright and Proprietary Information
Copyright © 2008, 2012 ALSTOM Grid Inc. or Affiliate. All Rights Reserved.
NOTE: CONTAINS PROPRIETARY INFORMATION OWNED BY ALSTOM GRID INC.

AND/OR ITS AFFILIATES. DO NOT COPY, STORE IN A RETRIEVAL SYSTEM,
TRANSMIT OR DISCLOSE TO ANY THIRD PARTY WITHOUT PRIOR WRITTEN
PERMISSION FROM ALSTOM GRID INC.
__________________________________________________________________
Trademarks
“ESCA” and “HABITAT” are registered trademarks of ALSTOM Grid Inc. “eterra” is a
registered trademark and/or service mark of E-Terra, LLC, licensed for use by
ALSTOM Grid Inc. in connection with its e-terra family of products and services.
Other product and company names in these materials may be trademarks or registered
trademarks of other companies, and are the property of their respective owners. They are
used only for explanation and to the respective owners’ benefit, without intent to infringe.
Contents
About This Document............................................................................. xv

Purpose of This Document ..........................................................................................xv
Who Should Use This Document.................................................................................xv
Structure of This Document .........................................................................................xv
For More Information ...................................................................................................xv
Conventions ................................................................................................................ xvi
Change Summary ...................................................................................................... xvii
1. Overview................................................................................................ 1
1.1 About e-terrasource ................................................................................................ 1
1.1.1 Metadata-Based Model...................................................................................... 1
1.1.2 Models and Model Authority Sets ...................................................................... 2
1.1.3 Projects.............................................................................................................. 2
1.1.4 Independent Workspaces .................................................................................. 4
1.1.5 Model Validation ................................................................................................ 4
1.1.6 Import/Export ..................................................................................................... 5
1.1.7 Data Security ..................................................................................................... 5
1.1.8 Authorization ...................................................................................................... 5
1.1.9 User Interface .................................................................................................... 6
1.1.10 Web Service Interface ..................................................................................... 7
1.2 A Useful Analogy .................................................................................................... 8
2. User Interface Basics ......................................................................... 10

2.1 Logging In ............................................................................................................. 10
2.2 e-terrasource User Interface ................................................................................. 12
2.2.1 Home Page ...................................................................................................... 13
2.2.1.1 Timeline ...................................................................................................... 14
2.2.1.1.1 Options .................................................................................................. 15
2.2.1.1.2 Add Calendar Entry ............................................................................... 17
2.2.1.2 Loaded Models/Model Authority Sets ......................................................... 17
2.2.1.3 Loaded Projects.......................................................................................... 18
2.2.1.4 User Notes.................................................................................................. 19
2.2.1.5 System Messages ...................................................................................... 19
2.2.1.6 Recent System Activity ............................................................................... 20
2.2.1.7 Recent Project Activity................................................................................ 20
2.2.1.8 Recent Deployments .................................................................................. 20
2.2.2 Menus .............................................................................................................. 21
2.2.3 Toolbar............................................................................................................. 24
2.2.4 Context Menus................................................................................................. 25
Proprietary – See Copyright Page iii

2.2.5 Context-Sensitive Help .................................................................................... 25
2.3 Customizing the e-terrasource Layout .................................................................. 28
2.3.1 Working with Panes ......................................................................................... 30
2.3.2 Interacting with Multiple Open Panes .............................................................. 31
2.4 Opening Multiple Viewports .................................................................................. 32
2.5 Status Bar Information .......................................................................................... 32
2.6 Data Entry Validation ............................................................................................ 32
2.7 User Preferences .................................................................................................. 33
2.8 Alstom Presentation Framework ........................................................................... 35
2.8.1 Rooms ............................................................................................................. 35
2.8.2 CLS Viewer ...................................................................................................... 36
3. Using e-terrasource ............................................................................ 38

3.1 Workspaces .......................................................................................................... 38
3.1.1 About the Workspace Explorer ........................................................................ 38
3.1.2 Opening/Changing Workspaces ...................................................................... 39
3.1.3 Viewing/Modifying Workspace Properties........................................................ 39
3.1.4 Changing a Workspace Password................................................................... 41
3.1.5 Viewing Loaded Models................................................................................... 41
3.1.6 Viewing Loaded Model Authority Sets ............................................................. 42
3.1.7 Viewing Loaded Projects ................................................................................. 43
3.1.8 Viewing Workspace Users ............................................................................... 44
3.1.9 Viewing Workspace Activity ............................................................................. 45
3.1.10 Resetting a Workspace.................................................................................. 45
3.1.11 Locking a Workspace .................................................................................... 45
3.1.12 Unlocking a Workspace ................................................................................. 46
3.1.13 Viewing the Tables Explorer .......................................................................... 46
3.1.14 Comparing Workspaces ................................................................................ 47
3.2 Models .................................................................................................................. 47
3.2.1 Viewing Models with the Model Explorer ......................................................... 48
3.2.2 Viewing/Modifying Model Properties ................................................................ 49
3.2.3 Loading a Model .............................................................................................. 50
3.2.4 Unloading a Model ........................................................................................... 51
3.2.5 Creating a Model.............................................................................................. 52
3.2.6 Deleting a Model .............................................................................................. 54
3.3 Model Authority Sets ............................................................................................. 55
3.3.1 Viewing Model Authority Sets with the Model Explorer .................................... 55
3.3.2 Viewing/Modifying Model Authority Set Properties .......................................... 56
3.3.3 Viewing Model Authority Set Audit Log ............................................................ 57
3.3.4 Viewing Model Authority Set Ancestry ............................................................. 58
3.3.5 Viewing Model Authority Set Activity................................................................ 59
3.3.6 Loading a Model Authority Set......................................................................... 59
3.3.7 Unloading a Model Authority Set ..................................................................... 60
3.3.8 Creating a Model Authority Set ........................................................................ 61
3.3.9 Deleting a Model Authority Set ........................................................................ 63
Proprietary – See Copyright Page iv

3.4 Projects ................................................................................................................. 63
3.4.1 About Active Projects....................................................................................... 64
3.4.2 About the Project View..................................................................................... 65
3.4.3 Viewing/Modifying Project Properties............................................................... 66
3.4.4 Viewing Unapplied Change Items.................................................................... 67
3.4.5 Viewing Overlapping Change Items................................................................. 68
3.4.6 Viewing/Modifying Project Details .................................................................... 69
3.4.7 Viewing the Project Audit Log .......................................................................... 71
3.4.8 Viewing Project Activity .................................................................................... 72
3.4.9 Updating Change Item Path Names ................................................................ 72
3.4.10 Loading Projects ............................................................................................ 73
3.4.11 Unloading Projects......................................................................................... 75
3.4.12 Creating a Project .......................................................................................... 76
3.4.13 Deleting a Project........................................................................................... 77
3.4.14 Copying a Project........................................................................................... 78
3.5 Snapshots ............................................................................................................. 78
3.5.1 Creating a Snapshot ........................................................................................ 79
3.5.2 Viewing/Restoring Snapshots .......................................................................... 80
3.5.3 Removing a Snapshot...................................................................................... 81
3.6 Viewing and Modifying Models.............................................................................. 81
3.6.1 Tree Views ....................................................................................................... 81
3.6.1.1 Navigation................................................................................................... 82
3.6.1.2 Show in New Tab........................................................................................ 82
3.6.1.3 Show in New Tree ...................................................................................... 83
3.6.1.4 Show References ....................................................................................... 83
3.6.1.5 Insert........................................................................................................... 84
3.6.1.6 Delete ......................................................................................................... 84
3.6.1.7 Copy/Paste ................................................................................................. 84
3.6.1.8 Clone .......................................................................................................... 85
3.6.1.9 Deep Copy.................................................................................................. 85
3.6.1.10 Moving Records ........................................................................................ 87
3.6.1.11 Graphic Modeler ....................................................................................... 88
3.6.1.12 Export to Excel.......................................................................................... 90
3.6.2 Property Sheets ............................................................................................... 90
3.6.2.1 Header Information ..................................................................................... 91
3.6.2.2 Property Groups ......................................................................................... 93
3.6.2.3 Properties ................................................................................................... 94
3.6.3 Grid Views........................................................................................................ 97
3.6.3.1 Tables Explorer......................................................................................... 101
3.6.3.2 Nested Grids............................................................................................. 101
3.6.3.3 Editing....................................................................................................... 102
3.6.3.3.1 Inserting Records ................................................................................ 102
3.6.3.3.2 Deleting Records ................................................................................. 102
3.6.3.3.3 Modifying Records ............................................................................... 103
3.6.3.3.4 Copying Records ................................................................................. 103
3.6.3.3.5 Moving Records................................................................................... 103
Proprietary – See Copyright Page v

3.6.3.4 Range Value ............................................................................................. 104
3.6.3.5 Show References ..................................................................................... 105
3.6.3.6 Show Children .......................................................................................... 106
3.6.3.7 Properties ................................................................................................. 107
3.6.3.8 Sorting ...................................................................................................... 108
3.6.3.9 Show/Hide/Re-Order Columns ................................................................. 109
3.6.3.10 Export to Excel........................................................................................ 109
3.6.3.11 Printing.................................................................................................... 110
3.6.3.12 Required Only Properties........................................................................ 110
3.6.4 Graphic Modeler ............................................................................................ 110
3.6.4.1 Graphic Modeler Toolbar .......................................................................... 110
3.6.4.2 Graphic Modeler Context Menus .............................................................. 111
3.6.4.2.1 Canvas Context Menu ......................................................................... 111
3.6.4.2.2 Symbol Context Menu ......................................................................... 112
3.6.4.2.3 Node Context Menu............................................................................. 113
3.6.4.2.4 Region Context Menu .......................................................................... 113
3.6.4.3 Viewing the Substation Overview ............................................................. 115
3.6.4.4 Viewing the DC Line Overview ................................................................. 118
3.6.4.5 Viewing the Substation Detail and/or Voltage Level Detail Displays......... 120
3.6.4.6 Viewing SCADA Topology ........................................................................ 122
3.6.4.7 Instantiating Templates............................................................................. 123
3.6.4.8 Node Connections .................................................................................... 123
3.6.4.9 Connecting Items...................................................................................... 124
3.6.4.10 Connecting to Another Substation .......................................................... 125
3.6.4.11 Navigating Substations ........................................................................... 125
3.6.4.12 Disconnecting Items ............................................................................... 126
3.6.4.13 Inflection Points ...................................................................................... 126
3.6.4.14 Saving Changes vs. Accepting Layout Changes .................................... 127
3.6.4.15 Selecting Regions................................................................................... 128
3.6.4.16 Region Subselections ............................................................................. 129
3.6.4.17 Clipboard Scratchpad ............................................................................. 130
3.6.4.17.1 Clipboard Scratchpad – Tree View Panel.......................................... 131
3.6.4.17.2 Clipboard Scratchpad – Graphic Modeler Panel ............................... 131
3.6.4.17.3 Clipboard Scratchpad – Property Sheet Panel .................................. 131
3.6.4.18 Copying Items......................................................................................... 132
3.6.4.19 Deep Copying Items ............................................................................... 132
3.6.4.20 Deleting Items......................................................................................... 132
3.6.4.21 Creating Templates ................................................................................ 133
3.6.4.22 Property Sheets ...................................................................................... 133
3.6.4.23 Tool Tips ................................................................................................. 133
3.6.4.24 Changing the Symbol Type of an Object ................................................ 133
3.6.4.25 Moving Items .......................................................................................... 134
3.6.4.26 Renaming Items...................................................................................... 134
3.6.4.27 Changing Label Information.................................................................... 134
3.6.4.28 Changing the Axis Style.......................................................................... 135
3.6.4.29 Changing a Node's Resize Mode ........................................................... 135
Proprietary – See Copyright Page vi

3.6.4.30 Undoing and Redoing Operations .......................................................... 136
3.6.4.31 Panning................................................................................................... 137
3.6.4.32 Zooming.................................................................................................. 137
3.6.4.33 Aligning Items in a Region ...................................................................... 137
3.6.4.34 Orienting a Region.................................................................................. 137
3.6.4.35 Editing a Region ..................................................................................... 138
3.6.5 Special-Purpose Modeling Displays............................................................... 139
3.6.5.1 Linkage Displays....................................................................................... 139
3.6.5.2 Curve Displays.......................................................................................... 140
3.6.6 Search Dialog Box ......................................................................................... 141
3.6.6.1 Range Expressions................................................................................... 142
3.6.6.2 Regular Expressions................................................................................. 143
3.6.7 Templates ...................................................................................................... 145
3.6.7.1 About the Template Explorer .................................................................... 146
3.6.7.2 Creating Template Groups ....................................................................... 147
3.6.7.3 Viewing/Modifying Template Group Properties......................................... 147
3.6.7.4 Deleting Template Groups........................................................................ 148
3.6.7.5 Creating Templates Using Deep Copy ..................................................... 148
3.6.7.6 Creating Templates Using Graphic Modeler............................................. 150
3.6.7.7 Creating Templates Manually ................................................................... 151
3.6.7.8 Viewing/Modifying Template Properties.................................................... 153
3.6.7.8.1 Template Properties ............................................................................ 153
3.6.7.8.2 Template Parameters .......................................................................... 154
3.6.7.8.3 Template Parameter Rules.................................................................. 156
3.6.7.8.4 Template Change Items ...................................................................... 157
3.6.7.9 Template Editor ........................................................................................ 158
3.6.7.9.1 Template Editor – Tree View Panel..................................................... 160
3.6.7.9.2 Template Editor – Property Sheet Panel ............................................. 160
3.6.7.9.3 Template Editor – Graphic Modeler Panel........................................... 166
3.6.7.10 Copying/Cloning Templates.................................................................... 167
3.6.7.11 Deleting Templates................................................................................. 168
3.6.7.12 Instantiating Templates on Tree Views................................................... 169
3.6.7.13 Instantiating Templates on Graphic Modeler .......................................... 170
3.6.8 Modeling in Excel........................................................................................... 171
3.6.8.1 Exporting from Tree Views ....................................................................... 172
3.6.8.1.1 Exporting an Entire Hierarchy.............................................................. 172
3.6.8.1.2 Exporting Chosen Tables .................................................................... 172
3.6.8.2 Exporting from Grid Views ........................................................................ 173
3.6.8.3 Modifying Data in Excel ............................................................................ 174
3.6.8.4 Importing Changes from Excel ................................................................. 175
3.6.8.5 Importing All Data from Excel ................................................................... 176
3.7 Importing/Exporting Data .................................................................................... 177
3.7.1 Local File vs. Server File................................................................................ 180
3.7.2 CIM/XML Import/Export ................................................................................. 180
3.7.2.1 Overview................................................................................................... 180
3.7.2.2 Warnings and Errors................................................................................. 183
Proprietary – See Copyright Page vii

3.7.2.3 CIM MRID vs. CSM MRID ........................................................................ 184
3.7.3 Model Authority Set Dump/Load .................................................................... 185
3.7.4 Project Dump/Load ........................................................................................ 185
3.7.5 Export Workspace ......................................................................................... 186
3.7.6 Export Project ................................................................................................ 189
3.7.7 Import into Workspace................................................................................... 192
3.7.8 Import into Project.......................................................................................... 195
3.7.9 Import/Export Progress Dialog Box................................................................ 198
3.7.10 Import/Export History View........................................................................... 200
3.7.11 e-terraplatform Exports and Imports ............................................................ 201
3.7.11.1 Exports.................................................................................................... 201
3.7.11.2 Imports.................................................................................................... 203
3.8 Validation ............................................................................................................ 203
3.8.1 Starting a Validation Sequence...................................................................... 205
3.8.2 Validation Progress Dialog Box...................................................................... 206
3.8.3 Validation History View .................................................................................. 207
3.9 Activity Log.......................................................................................................... 208
3.10 Constraint Violations ......................................................................................... 209
3.11 Viewing Unsaved Changes ............................................................................... 210
4. Administrative Tasks........................................................................ 212

4.1 About the Administration Explorer....................................................................... 212
4.2 Managing Workspaces ....................................................................................... 215
4.2.1 Creating a Workspace ................................................................................... 215
4.2.2 Viewing/Modifying Workspace Information .................................................... 217
4.2.3 Viewing Workspace Activity ........................................................................... 219
4.2.4 Removing a Workspace................................................................................. 219
4.3 Managing Users .................................................................................................. 220
4.3.1 Creating a User.............................................................................................. 220
4.3.2 Viewing/Modifying User Information............................................................... 222
4.3.3 Viewing User Activity...................................................................................... 225
4.3.4 Removing a User ........................................................................................... 225
4.4 Managing Roles and Privileges........................................................................... 225
4.4.1 Creating Roles ............................................................................................... 226
4.4.2 Viewing/Modifying Roles ................................................................................ 227
4.4.3 Viewing Roles for a User ............................................................................... 229
4.4.4 Assigning or De-Assigning Roles................................................................... 230
4.4.5 Removing Roles............................................................................................. 231
4.4.6 Creating a Privilege........................................................................................ 232
4.4.7 Viewing/Modifying Privileges.......................................................................... 232
4.4.8 Removing Privileges ...................................................................................... 233
4.4.9 Available Roles and Privileges....................................................................... 233
4.5 Managing Model Types and Model Authority Set Types..................................... 241
4.5.1 Creating a Model Type................................................................................... 241
4.5.2 Viewing/Modifying a Model Type ................................................................... 242
Proprietary – See Copyright Page viii

4.5.3 Removing a Model Type ................................................................................ 244
4.5.4 Creating a Model Authority Set Type ............................................................. 245
4.5.5 Viewing/Modifying Model Authority Set Types ............................................... 246
4.5.6 Removing a Model Authority Set Type........................................................... 247
4.6 Managing Import/Export Metadata...................................................................... 247
4.6.1 Creating an Import/Export Sequence............................................................. 248
4.6.1.1 Creating a Sequence Step........................................................................ 249
4.6.1.2 Creating a Sequence Step Prerequisite.................................................... 250
4.6.2 Viewing/Modifying Sequences ....................................................................... 251
4.6.3 Removing a Sequence................................................................................... 254
4.6.4 Creating an Import/Export Type..................................................................... 254
4.6.4.1 Creating a Target...................................................................................... 256
4.6.4.2 Creating Target Parameters ..................................................................... 257
4.6.4.3 Defining Exportable States ....................................................................... 260
4.6.5 Viewing/Modifying a Type .............................................................................. 261
4.6.6 Removing a Type........................................................................................... 266
4.6.7 Proxies ........................................................................................................... 266
4.7 Managing Model Authorities................................................................................ 268
4.7.1 Creating a Model Authority ............................................................................ 268
4.7.2 Viewing/Modifying a Model Authority ............................................................. 268
4.7.3 Removing a Model Authority.......................................................................... 269
4.8 Managing Application Parameters ...................................................................... 270
4.8.1 Creating an Application Parameter ................................................................ 270
4.8.2 Viewing/Modifying an Application Parameter................................................. 271
4.8.3 Removing an Application Parameter ............................................................. 272
4.9 Managing States ................................................................................................. 272
4.9.1 Creating States and Transitions..................................................................... 274
4.9.2 Viewing/Modifying States and Transitions ..................................................... 276
4.9.3 Removing States and Transitions .................................................................. 278
4.10 Managing Custom Attributes............................................................................. 278
4.10.1 Creating Custom Attributes.......................................................................... 279
4.10.2 Viewing/Modifying Custom Attributes........................................................... 283
4.10.3 Removing Custom Attributes ....................................................................... 284
5. Data Security..................................................................................... 285

5.1 Row-Level vs. Table-Level Security .................................................................... 285
5.2 Access Type "Full" .............................................................................................. 286
5.3 Row-Level Security ............................................................................................. 287
5.4 Table-Level Security ........................................................................................... 288
5.5 Public Access...................................................................................................... 289
5.6 Effect on the User Interface ................................................................................ 290
5.7 Effect on Exports................................................................................................. 291
5.8 Changing Data Security Settings ........................................................................ 292
Proprietary – See Copyright Page ix

6. Configuration Information................................................................ 293
6.1 Graphic Modeler Configuration Editor................................................................. 293
6.1.1 Modifying Node, Line, and Background Color................................................ 295
6.1.2 Modifying a Symbol's Visual Image ............................................................... 296
6.1.3 Advanced Configuration................................................................................. 298
6.1.4 Selection of Themes ...................................................................................... 300
6.1.5 Configuration Files ......................................................................................... 303
Appendix A. Terminology..................................................................... 305
Figures
Figure 1: Model Authority Sets ........................................................................................ 2
Figure 2: Projects and New Model Authority Sets ........................................................... 4
Figure 3: Viewport with Workspace Explorer Pane ....................................................... 12
Figure 4: e-terrasource Home Page.............................................................................. 13
Figure 5: Home Page – Timeline .................................................................................. 14
Figure 6: Timeline – Date Options Dialog Box .............................................................. 15
Figure 7: Timeline – Filter Options Dialog Box.............................................................. 16
Figure 8: Timeline – Add Calendar Entry Dialog Box.................................................... 17
Figure 9: Home Page – Loaded Models/Model Authority Sets ..................................... 17
Figure 10: Home Page – Loaded Projects with Context Menu...................................... 18
Figure 11: Home Page – User Notes ............................................................................ 19
Figure 12: Home Page – System Messages with Context Menu .................................. 19
Figure 13: Home Page – Recent System Activity.......................................................... 20
Figure 14: Home Page – Recent Project Activity .......................................................... 20
Figure 15: Home Page – Recent Deployments............................................................. 20
Figure 16: Home Page – Deployment History............................................................... 21
Figure 17: Menus .......................................................................................................... 21
Figure 18: e-terrasource Layout with Project Details Dialog Box .................................. 29
Figure 19: Pane Context Menu ..................................................................................... 30
Figure 20: Pane with Multiple Tabs ............................................................................... 31
Figure 21: Status Bar .................................................................................................... 32
Figure 22: Validation Error ............................................................................................ 32
Figure 23: Validation Error Dialog Box .......................................................................... 33
Figure 24: User Preferences Dialog Box....................................................................... 33
Figure 25: APF Console – Rooms Tab ......................................................................... 36
Figure 26: APF Console – CLS Viewer Tab.................................................................. 37
Figure 27: Workspace Explorer..................................................................................... 38
Figure 28: Toolbar – Workspace Selector..................................................................... 39
Figure 29: Toolbar – Locked Workspace ...................................................................... 39
Figure 30: Workspace Properties.................................................................................. 40
Figure 31: Change Workspace Password Dialog Box .................................................. 41
Proprietary – See Copyright Page x

Figure 32: Tables Explorer ............................................................................................ 46
Figure 33: Model Authority Set Type Assignment ......................................................... 48
Figure 34: Model Authority Set Type Selector............................................................... 48
Figure 35: Model in Model Explorer .............................................................................. 49
Figure 36: Model Property Sheet .................................................................................. 50
Figure 37: Load Model Dialog Box ................................................................................ 51
Figure 38: Unload Model............................................................................................... 52
Figure 39: Model Authority Set in Model Explorer ......................................................... 55
Figure 40: Model Authority Set Property Sheet............................................................. 57
Figure 41: Model Authority Set Audit Log...................................................................... 57
Figure 42: Unload Model Authority Set ......................................................................... 61
Figure 43: Toolbar – Project Selector............................................................................ 64
Figure 44: Project Explorer with Filtering Section and Context Menu ........................... 65
Figure 45: Project Property Sheet ................................................................................. 67
Figure 46: Unapplied Change Items Warning ............................................................... 68
Figure 47: Unapplied Change Items View..................................................................... 68
Figure 48: Overlapping Change Items Warning ............................................................ 69
Figure 49: Overlapping Change Items View.................................................................. 69
Figure 50: Project Details View (Ungrouped) ................................................................ 70
Figure 51: Project Details View (Grouped)................................................................... 70
Figure 52: Edit Change Item Dialog Box ....................................................................... 71
Figure 53: Project Audit Log.......................................................................................... 72
Figure 54: Load Project Dialog Box............................................................................... 74
Figure 55: Projects Filter Dialog Box............................................................................. 75
Figure 56: Unload Project Dialog Box ........................................................................... 76
Figure 57: New Project Dialog Box ............................................................................... 77
Figure 58: New Snapshot Dialog Box ........................................................................... 80
Figure 59: Snapshots View ........................................................................................... 80
Figure 60: Tree View with Context Menu ...................................................................... 82
Figure 61: Show in New Tree Used to Create a New Substation Tree View ................ 83
Figure 62: Show References......................................................................................... 83
Figure 63: Deep Copy ................................................................................................... 86
Figure 64: Template Creation Using Deep Copy .......................................................... 87
Figure 65: Property Sheet ............................................................................................. 91
Figure 66: Property Sheet Header ................................................................................ 93
Figure 67: Nesting of Property Groups.......................................................................... 93
Figure 68: Property Tool Tip ......................................................................................... 94
Figure 69: Grid View with Context Menu ....................................................................... 98
Figure 70: Tables Explorer .......................................................................................... 101
Figure 71: Expansion of a Nested Grid ....................................................................... 101
Figure 72: Range Value on Search Results ................................................................ 105
Figure 73: Show Children............................................................................................ 106
Figure 74: Grid View with Properties in Auxiliary Pane ............................................... 107
Figure 75: Grid Sorting Dialog Box.............................................................................. 108
Figure 76: Show/Hide Columns Dialog Box ................................................................ 109
Figure 77: Graphic Modeler Toolbar ........................................................................... 110
Proprietary – See Copyright Page xi

Figure 78: Launching the Substation Overview........................................................... 115
Figure 79: Substation Overview with Aerial Map......................................................... 116
Figure 80: Substation Overview – Additional Toolbar Controls ................................... 116
Figure 81: Excel Export of Substation Coordinates..................................................... 117
Figure 82: Launching the DC Line Overview............................................................... 118
Figure 83: DC Line Overview ...................................................................................... 119
Figure 84: Launching the Substation Detail Display.................................................... 120
Figure 85: Substation Detail Display ........................................................................... 121
Figure 86: BusBarSection Example ............................................................................ 121
Figure 87: Launching the SCADA Topology View....................................................... 122
Figure 88: SCADA Topology View .............................................................................. 123
Figure 89: Inflection Points.......................................................................................... 126
Figure 90: Clipboard Scratchpad................................................................................. 130
Figure 91: Linkage Display.......................................................................................... 139
Figure 92: Curve Display............................................................................................. 140
Figure 93: Search Dialog Box ..................................................................................... 141
Figure 94: Search Dialog Box with Results Grid ......................................................... 142
Figure 95: Template Explorer...................................................................................... 146
Figure 96: New Template Group Dialog Box............................................................... 147
Figure 97: Template Group Property Sheet ................................................................ 148
Figure 98: Delete Template Group Error..................................................................... 148
Figure 99: New Template Dialog Box.......................................................................... 152
Figure 100: Template Property Sheet ......................................................................... 153
Figure 101: New Template Parameter Dialog Box...................................................... 155
Figure 102: Template Parameter Property Sheet ....................................................... 155
Figure 103: Add Template Parameter Validation Rule Dialog Box ............................. 156
Figure 104: Template Parameter Validation Rule Property Sheet .............................. 157
Figure 105: Template Change Items........................................................................... 158
Figure 106: Template Editor........................................................................................ 159
Figure 107: Template Record ID and Create QueryId ................................................ 161
Figure 108: Conditional Creation Query...................................................................... 161
Figure 109: Template Editor – Property Value Sources.............................................. 162
Figure 110: Template Editor – Relationship Sources.................................................. 164
Figure 111: Copy/Paste Template – New Template Dialog Box ................................. 167
Figure 112: Clone Template – New Template Dialog Box .......................................... 168
Figure 113: Choose Tables to Export to Excel............................................................ 173
Figure 114: Excel Export of Hierarchy......................................................................... 174
Figure 115: CIM/XML Import/Export............................................................................ 182
Figure 116: Import/Export Progress Dialog Box .......................................................... 198
Figure 117: Import/Export History View....................................................................... 200
Figure 118: Toolbar Validation Button......................................................................... 205
Figure 119: Validation Sequence Dialog Box.............................................................. 206
Figure 120: Validation Progress Dialog Box................................................................ 206
Figure 121: Validation History View ............................................................................ 207
Figure 122: Activity Log View ...................................................................................... 209
Figure 123: Constraint Violations View ....................................................................... 210
Proprietary – See Copyright Page xii

Figure 124: Unsaved Change Items View................................................................... 210
Figure 125: Administration Explorer ............................................................................ 214
Figure 126: Workspace Property Sheet ...................................................................... 217
Figure 127: Change Workspace Password Dialog Box .............................................. 218
Figure 128: Workspaces Grid View............................................................................. 219
Figure 129: New User Dialog Box ............................................................................... 221
Figure 130: User Property Sheet................................................................................. 223
Figure 131: Users Grid View ....................................................................................... 224
Figure 132: Add Role Dialog Box ................................................................................ 227
Figure 133: Role Property Sheet................................................................................. 228
Figure 134: Modify Privileges Dialog Box.................................................................... 228
Figure 135: Viewing User Roles.................................................................................. 229
Figure 136: Assign a Role to a User ........................................................................... 230
Figure 137: Deassign a Role from a User ................................................................... 231
Figure 138: Error Removing Role................................................................................ 232
Figure 139: New Model Type Dialog Box.................................................................... 242
Figure 140: Model Type Property Sheet ..................................................................... 243
Figure 141: Add/Remove Model Authority Set Types Dialog Box ............................... 244
Figure 142: New Model Authority Set Type Dialog Box .............................................. 245
Figure 143: Model Authority Set Type Property Sheet ................................................ 246
Figure 144: New Import/Export Sequence Dialog Box ................................................ 248
Figure 145: New Import/Export Sequence Step Dialog Box........................................ 250
Figure 146: Prerequisite Example ............................................................................... 250
Figure 147: New Step Prerequisite Dialog Box ........................................................... 251
Figure 148: Import/Export Sequence Property Sheet ................................................. 252
Figure 149: Import/Export Sequence Step Property Sheet ......................................... 253
Figure 150: Import/Export Prerequisite Property Sheet............................................... 254
Figure 151: New Import/Export Type Dialog Box ........................................................ 255
Figure 152: New Import/Export Target Dialog Box...................................................... 257
Figure 153: New Import/Export Parameter Dialog Box ............................................... 258
Figure 154: New State Dialog Box .............................................................................. 260
Figure 155: Import/Export Type Property Sheet.......................................................... 261
Figure 156: Import/Export Target Property Sheet ....................................................... 263
Figure 157: Import/Export Parameter Property Sheet................................................. 264
Figure 158: Import/Export State Property Sheet ......................................................... 266
Figure 159: New Model Authority Dialog Box.............................................................. 268
Figure 160: Model Authority Property Sheet ............................................................... 269
Figure 161: Application Parameters Grid View ........................................................... 270
Figure 162: Application Parameters Grid View ........................................................... 271
Figure 163: Sample Project Lifecycle.......................................................................... 273
Figure 164: Sample Model and Model Authority Set Lifecycle .................................... 273
Figure 165: Sample Template Lifecycle ...................................................................... 273
Figure 166: New State Dialog Box .............................................................................. 274
Figure 167: New State Transition Dialog Box ............................................................. 276
Figure 168: State Property Sheet................................................................................ 277
Figure 169: State Transition Property Sheet ............................................................... 278
Proprietary – See Copyright Page xiii

Figure 170: New Attribute Type Dialog Box ................................................................ 280
Figure 171: Custom Attribute on a Property Sheet ..................................................... 282
Figure 172: Attribute Type Property Sheet.................................................................. 283
Figure 173: User with Access Type “Full”.................................................................... 286
Figure 174: Row-Level Security Information ............................................................... 287
Figure 175: Adding Access to a Record for a Model Authority.................................... 287
Figure 176: Table-Level Security Information ............................................................. 288
Figure 177: Graphic Modeler – Read-Only Access ..................................................... 291
Figure 178: Graphic Modeler – No Access ................................................................. 291
Figure 179: Launching the Graphic Modeler Configuration Editor .............................. 293
Figure 180: Graphic Modeler Configuration Editor Dialog Box.................................... 294
Figure 181: Color Selector Dialog Box ........................................................................ 295
Figure 182: Color Definitions....................................................................................... 299
Figure 183: Selection of Themes ................................................................................ 300
Figure 184: North American Theme Symbols ............................................................. 301
Figure 185: European Theme Symbols ...................................................................... 302
Figure 186: Configuration File Locations..................................................................... 303
Proprietary – See Copyright Page xiv

About This Document
This document is supplied as a part of Alstom Grid’s e-terrasource
product.
Purpose of This Document

This document has three main purposes:
• To provide a general overview of the features and components of
e-terrasource
• To explain concepts relevant to the e-terrasource software
• To provide basic step-by-step instructions on how to use e-terrasource
Who Should Use This Document

This document is intended for all users of e-terrasource. Users are
expected to have a technical understanding of creating models.
Structure of This Document

This document is structured in the following manner:
• Chapter 1 provides an overview of the product.
• Chapter 2 describes user interface basics.
• Chapter 3 describes how to use e-terrasource.
• Chapter 4 describes the administrative tasks.
• Chapter 5 provides information about data security.
• Chapter 6 provides configuration information.
• Appendix A provides a list of terminology.
For More Information

For more information about e-terrasource, refer to the following:
• e-terrasource Release Notes – Installation information about and
requirements for the current e-terrasource release.
• e-terrasource Software Installation and Maintenance Guide –
Information about installation and maintenance of e-terrasource.
• e-terrasource Metamodel Guide – Information about e-terrasource
metamodel management.
Proprietary – See Copyright Page xv

Conventions
The following conventions are used throughout this document.
Commands that are particular to an operating system are shown with the
corresponding prompt symbol.
Command Prompts
Operating Prompt Description
System
Linux % All commands preceded by a percent sign prompt
(%) are issued from a Linux terminal window.
Note that all Linux commands are case-sensitive.
Windows > All commands preceded by a greater than sign
prompt (>) are issued from the Windows
command-line window.
All Operating The absence of any prompt character before a
Systems command indicates that the command is valid on
all operating systems.
Command Strings
Operating Delimiter Description
System
Linux Italics Text in italics indicates information you must
supply. (*)
Linux [] Text enclosed in square brackets “[ ]” indicates
optional qualifiers, arguments, or data. (*)
All Operating Select When used in command strings, the term “Select”
Systems means placing the pointer over the specified item
and pressing the left (default) mouse button.
(*) Note: All Linux commands are case-sensitive and must be typed exactly as
shown.
Proprietary – See Copyright Page xvi

Change Summary
The following changes have been made to this document for this release:
• Significant updates for e-terrasource 2.0.
• Updated section 3.4.6 Viewing/Modifying Project Details.
• Updated section 3.6.1.9 Deep Copy.
• Added a warning to section 3.6.2.1 Header Information.
• Added section 3.6.3.3.4 Copying Records.
• Updated section 3.6.4.19 Deep Copying Items.
• Minor editorial and formatting corrections.
Proprietary – See Copyright Page xvii

1. Overview
1.1 About e-terrasource
e-terrasource is a revolutionary step forward in the construction and
maintenance of models. It provides a powerful set of features that make
modeling tasks easy to coordinate and implement.
This chapter introduces the major features of e-terrasource and
introduces important terminology used throughout this document.
Although the official product name is “e-terrasource”, you may notice
some scattered use of the abbreviation “CSM” in installation scripts,
executable names, example user names, etc. “CSM” is an abbreviation for
“Common Source Modeler”, which was the internal name of the product
prior to receiving its official name.
1.1.1 Metadata-Based Model

The first thing to know about e-terrasource is that it is highly configurable
through the use of “metadata”. Metadata is “data about data”, and for
e-terrasource, this means that the business model is configured rather
than hard-coded.
As part of the e-terra product suite, e-terrasource comes preconfigured
with a business model oriented toward electrical networks and Energy
Management Systems; however, substitution of the metadata allows
e-terrasource to support essentially any type of modeling problem.
The preconfigured business model supports the International
Electrotechnical Commission (IEC) Common Information Model (CIM) for
the modeling of electrical networks, as well as the following Alstom Grid
products:
• e-terrahabitat – Alarm modeling is supported in this release.
• e-terraplatform – Network, Generation, SCADA, Dispatcher Training
Simulator, Contingency, and Remedial Action Schemes modeling are
supported in this release.
• e-terracomm – All supported e-terracomm protocols can be modeled
with this release.
Detailed information about modeling can be found in the e-terrasource
EMS Modeling Guide.
Proprietary – See Copyright Page 1 Overview

1.1.2 Models and Model Authority Sets
Whether building a model for a control area, a region, or an entire
interconnected grid, e-terrasource supports collaborative model building
by allowing a large model to be broken up into smaller pieces that make
sense.
Model Authority Set

North v1
Model Authority Set Model Authority Set

West v3 East v5
Model Authority Set

South v8
Figure 1: Model Authority Sets

Each organization that performs modeling tasks is referred to as a “model
authority”, because they have the authority to maintain a model, or a
portion of a model. These model portions are called “model authority
sets”, which contain a model representation for a particular point in time.
A model authority set is identified in e-terrasource using a “type” and
“version”. The version is incremented each time a new model authority set
is created.
Referring to Figure 1 as an example, there are four model authority sets
that make up the “model”: North v1, East v5, West v3, and South v8.
1.1.3 Projects
e-terrasource projects contain an ordered list of model changes. Each
individual “change item” in this ordered list represents either the addition
of a record, the deletion of a record, or the update of a single record
property.
A project has an “effective date”, which indicates the point in time that the
changes are intended to take effect. This simple feature efficiently

provides timestamps of all model changes without the encumbrance of
managing timestamps for each individual record.
Projects also have a “current state” property, which indicates where the
project is in its implementation lifecycle. A sample implementation lifecycle
is included, but you can modify it to include steps/states that are relevant
for your organization’s modeling business process or workflow.
You can also easily create additional custom attributes for projects (and
several other e-terrasource constructs) to track other things that you
might be interested in, such as a project category, subcategory, reviewer
notes, links to related documents, etc.
It is highly recommended that each set of model changes that must take
place at the same time be placed in its own project. This way, you can
react quickly to last-minute scheduling changes by simply changing the
project’s effective date, thereby avoiding the tedium of backing out model
changes that have been rescheduled. In other words, it is generally to
your benefit to have several small projects as opposed to a single
monolithic project.
Model changes made by a user are saved to the user’s “active project”.
e-terrasource makes it easy for users to create new projects and choose
which project is “active”.
As implemented projects accumulate over time, they can be “rolled up”, or
combined, with a model authority set to form an updated model authority
set. This updated model authority set generally forms a new baseline for
making future model changes.

Model Authority Set
North v1
=
Project
Add_Station_Kirkland Model Authority Set
Effective: 15 Feb 2010 North v2
Project
Add_Station_Redmond
Effective: 1 Mar 2010
Figure 2: Projects and New Model Authority Sets

Figure 2 shows two projects (Add_Station_Kirkland and
Add_Station_Redmond) that are independently constructed and have
different effective dates. These two projects can be combined with the
North v1 model authority set to form an updated model authority set
named North v2.
1.1.4 Independent Workspaces

Every user views and modifies models within a workspace. A “workspace”
is an environment where model authority sets and projects are retrieved
for the purposes of viewing, modifying, validating, or deploying/exporting
models. Generally, each user has their own workspace, although it is
possible for multiple users to share the same workspace.
1.1.5 Model Validation

e-terrasource provides several mechanisms to ensure that constructed
models are valid. First, the definition of the business model metadata
ensures that basic syntactic and referential rules are enforced. The
business model metadata is used to ensure that the data type and data
length are correct, and, if desired, are restricted to a legal set of values.
Also, references between objects are checked for validity.

Second, validation rules can be defined in the metadata. Each rule
defines the characteristics of a violation in a natural way. For example,
“If X < 50 and Y is not null”, a violation is reported. Many rules are
provided in the standard installation, and additional rules can be added
easily.
Validation of individual projects or the entire content of a workspace can
be performed, with easy navigation provided from validation error
messages to the offending data.
1.1.6 Import/Export
Since the main purpose of e-terrasource is to provide models to other
applications, there are several mechanisms provided for the purpose of
importing and exporting model data.
The International Electrotechnical Commission (IEC) has developed a
Common Information Model (CIM), primarily for the purpose of supporting
the exchange of power system models. e-terrasource supports the
exchange of models using the CIM/XML international standard. A
CIM/XML file can represent a full model or incremental modifications to a
model.
Models are exchanged between e-terrasource and e-terrahabitat–based
applications using an extensible transformation subsystem. e-terrasource
also supports the export of model data to Microsoft Excel, and it allows
changes made in Excel to be imported back into an e-terrasource project.
1.1.7 Data Security

e-terrasource controls user access to model data, which is particularly
important in configurations having multiple model authorities and
privileged data. Through a flexible data security implementation, it is
possible to have fine-grained control over the data that a particular user
sees, depending on the user’s access rights, his/her model authority’s
access rights, and the allowed access for a particular property.
1.1.8 Authorization
The term “authorization” refers to the actions that an authenticated user is
allowed to perform. e-terrasource has a fixed set of privileges, which
correspond to actions that can be performed (e.g., CreateProject
privilege). These privileges are grouped into roles, and a user can have
one or more assigned roles.
Upon installation, e-terrasource creates the following four roles, listed in
order from least privileged to most privileged: Guest, Modeler,
ModelSupervisor, and Superuser. Additional roles can be created as
desired.

1.1.9 User Interface
e-terrasource provides modelers with a rich user interface for working with
models. The bulk of this document is devoted to providing detailed
information about the capabilities of the user interface.
The user interface operates as a plug-in to the Alstom Presentation
Framework (APF). It provides mechanisms to view and modify the model
using a Graphic Modeler, as well as tree views, grid views, and property
sheets. Several useful “explorers” and “views” are also provided.
The explorers are:
• Workspace Explorer
The Workspace Explorer allows users to view information about the
available workspaces, such as which model authority sets and projects
are loaded, and which users are assigned to them.
• Model Explorer
The Model Explorer allows users to view information about the
available models and model authority sets. Each model and model
authority set is listed hierarchically by its parent type, and can be
expanded to display information about their ancestry.
• Administration Explorer
The Administration Explorer provides administrative capabilities with
regards to workspaces, users, roles/privileges, application parameters,
model authority, model, and model authority set types, as well as
import/export configuration, state/lifecycle definition, and custom
attribute definition.
• Template Explorer
The Template Explorer displays the available templates, which are
reusable model patterns that can be instantiated to rapidly build a
model. The Template Explorer allows template details to be viewed
and modified, and new templates can easily be created via drag and
drop from tree views or the Graphic Modeler.
• Tables Explorer
The Tables Explorer is accessible via the toolbar, and it provides a
hierarchical list of all of the tables in the model. Clicking a table name
displays a grid of the data in the table, one page at a time.

The views are:
• Project View – The Project view provides a filtered view of the
available projects in the system. Information about projects as well as
their constituent change items is available.
• Snapshots View – Snapshots provide a mechanism to record
workspace data for later restoration. This view can be used to create
and remove snapshots, and view available snapshots.
• Validation and Import/Export History – These views provide
information related to past requests to validate and import/export data.
• Activity Log – This view provides a log of significant operations
performed by users.
• Unapplied Change Items – This view lists the change items that
cannot be applied as a result of loading projects into the workspace.
For example, a project might attempt to delete a non-existent record.
• Overlapping Change Items – This view lists the change items that can
potentially be conflicting. Change items belonging to different loaded
projects that modify the same property of the same record are listed
here.
• Unsaved Change Items – This view lists the changes you have made
to the model that have not been saved to the active project. The user
has the choice of saving the changes to the active project, or
discarding them (via Undo or Undo All).
• Constraint Violations – This view lists the invalid references between
records, and values that do not match a picklist entry.
• User Preferences – This is a dialog box that is used to view and
modify user preferences.
The Graphic Modeler component of the user interface provides several
schematic views of the electrical network: Substation Overview, DC Line
Overview, Substation Detail, and Voltage Level Detail. It provides powerful
viewing and editing capabilities, which are described in detail in section
3.6.4 Graphic Modeler.
1.1.10 Web Service Interface

e-terrasource provides a Web service interface for the purpose of
allowing integration with external applications and systems. Further details
about Web service support are beyond the scope of this document; for
further information, refer to the e-terrasource Programmer’s Guide.

1.2 A Useful Analogy
An overhead projector provides a useful analogy for illustrating the key
concepts of workspaces, model authority sets, and projects.
A workspace is an environment in which a user performs modeling
activities. It is analogous to an overhead projector on which you place
transparencies. All users have access to a workspace, or overhead
projector, which they can use to view and modify models.
A model authority set can be thought of as the underlying model that is
used as a starting point for modeling activities. It is analogous to the first
(master) transparency you put on the overhead projector, which shows
some sort of picture — such as the “model authority set picture” in Figure
1 titled “North v1”. A user wanting to look at the North v1 model authority
set pulls the transparency out of a filing cabinet and lays it on the
overhead projector for viewing.
Extending this concept, if the complete model includes other regions, the
user can place additional transparencies (a.k.a., model authority sets) for
other regions (South, East, West, Central, etc.) onto the projector (a.k.a.,
the workspace). Assume that these independent model authority sets are
non-overlapping and connect up nicely to form the whole model.
The model authority sets are not “checked out”, so someone else can also
view the North v1 model authority set on a different overhead projector.
A key concept of e-terrasource is to organize edits into independent
projects. This is analogous to taking a blank transparency and putting it on
top of the model authority set transparency (or transparencies), then
taking a red marker and making additions, deletions, and modifications.
The “project” transparency then consists of only the changes that were
made with the red marker.
Extending this concept in turn, the user can take another blank
transparency, place it on top, and make further edits with a purple marker.
Referring back to Figure 2, the transparency in red marker might be the
“Add_Station_Kirkland” project, and the transparency in purple marker
might be the “Add_Station_Redmond” project.
What the users see in their workspace (i.e., what the overhead projector
displays) is the end result of overlaying the North_Region_Jan2010 model
authority set, the Add_Station_Kirkland project, and the
Add_Station_Redmond project.
At the end of the day, when users are happy with their edits (projects),
they return the model authority set transparencies to the filing cabinet, and
they file the project transparencies (the one in red marker and the one in

purple marker) in a filing cabinet of projects. The overhead projector is
now empty and available to load other model authority sets or projects.
Although we mentioned that model authority sets are not “checked out”,
there is a concept of “checking out” a project. If you are actively making
changes to a project, no one else can make changes to it until you release
it.
The analogy breaks down a bit when multiple transparencies that edit the
same object are overlaid on top of each other. What you see projected is
an area of overlapping unreadable values. What is actually seen in a
workspace is the most recently loaded edit. For example, if project A sets
a value to 10, project B sets the same value to 20, and project C sets the
same value to 30, the value the user sees in the workspace depends on
the order in which the projects are loaded. If project A is loaded last, the
user sees a value of 10. If project C is loaded last, the user sees a value
of 30. In these cases, e-terrasource informs users of “overlapping
changes”.
While the thought may be disconcerting at first, it is actually quite useful
and powerful to have a project contain only the changes that are made.
As project implementation dates are shuffled around, the order in which
they are included in a deployed model can change without the user having
to backtrack or undo previous edits. The key is to include in a project only
the changes that are implemented at the same time. Furthermore, it is
typical to load projects in order of their implementation dates, so the
project with the latest date “wins”.
If a new substation is being constructed, the 345 kV level can enter
service before the 500 kV level, so it is appropriate to make those
separate projects with different in-service dates.

2. User Interface Basics
2.1 Logging In
When starting the e-terrasource user interface, you must connect to an
e-terrasource server. Your Microsoft Windows user name is used to
authenticate yourself to the server and determine what actions you are
allowed to perform.
To start e-terrasource and log in:
1. Start the Alstom Presentation Framework using Start > Programs >
Eterra > Presentation Framework > APF 2.1.1
The APF console window appears.
2. The e-terrasource user interface plug-in normally starts automatically
because it is part of the APF default “room”. If it does not, from the
Applications tab, double-click the e-terrasource icon in the right pane
to start e-terrasource.
If you have more than one server you can connect to, the Choose a
Server dialog box appears. This dialog box indicates your Windows
user name, which is used for authentication purposes.
Proprietary – See Copyright Page 10 User Interface Basics

3. In the Connection list, select the appropriate server and click OK.
An e-terrasource viewport opens and displays the home page.

2.2 e-terrasource User Interface
The e-terrasource user interface consists of a viewport window and
panes. The viewport is the main window that contains panes, which can
be docked at the sides of the window or floated independently.
Figure 3: Viewport with Workspace Explorer Pane

2.2.1 Home Page
The home page provides a view of useful information about your
e-terrasource environment. You can get to the home page quickly by
clicking the Home button on the toolbar. The home page contains several
sections.
Figure 4: e-terrasource Home Page

2.2.1.1 Timeline
The purpose of the timeline is to provide a quick, at-a-glance view of
upcoming and recently completed projects and model authority sets in the
system, as well as other calendar entries. The default values for the
timeline are set to display seven days in the past and seven days in the
future, but these values can be changed in your user preferences. On the
timeline section of the home page, icons are shown for projects, model
authority sets, and calendar entries.
Figure 5: Home Page – Timeline

• Projects meeting your filter criteria are shown on the timeline based on
their effective date (for information about filtering projects, refer to
section 3.4.2 About the Project View). You can hover the cursor over
the project icon to obtain more information, and right-click the icon for
more options.
• Model authority sets are shown on the timeline based on the date they
were created. Therefore, you only see model authority sets in the past.
You can hover the cursor over the model authority set icon to obtain
more information, and right-click the icon for more options.
• Calendar entries are user-entered notes that you and others can
create. Private calendar entries appear only on your timeline, whereas
public calendar entries appear on everyone’s timeline display.
The timeline has buttons that can be used to move the timeline forward or
backward in time.
The upper right corner of the timeline has a button that can be clicked to
control timeline options and create new calendar entries.

2.2.1.1.1 Options
If you choose “Options”, a dialog box is shown that displays tabs for date
options and filter options.
Figure 6: Timeline – Date Options Dialog Box

The Date Options tab contains fields that allow you to control the date
range for the timeline. The range can be specified using absolute dates,
or dates relative to today. To specify an absolute date range, select the
Use Absolute Values check box and enter a Start Date and End Date. To
specify relative dates, uncheck the Use Absolute Values check box and
enter values for “Past days from today” and “Future days from today”. By
default, the timeline is configured to show seven past days and seven
future days.

Figure 7: Timeline – Filter Options Dialog Box
The Filter Options tab provides check boxes to control whether model
authority sets, projects, and calendar entries should be displayed on your
timeline.
At the top of the dialog box, you can choose the model schema for which
you want to configure the filter options. The Show Model Authority Sets
check box allows you to control, at a global level, whether model authority
sets are shown on the timeline or not.
Also, in the event that your system is configured with many model
authority set types, you can choose which model authority set types you
are interested in seeing on your timeline. The list box in the center of the
dialog box lists each model authority set type. The contents of the list box
can be filtered by choosing a model using the Filter Model Authority Set
Type List by Model selector. Simply check the box next to the desired
model authority set types. If none are checked, all model authority set
types for the model schema are shown on the timeline.
The Show Projects check box allows you to control whether projects
meeting your filter criteria are shown on the timeline or not. You can
modify the project filter criteria by clicking the Change Projects Filter
button.
The Show Calendar Entries check box allows you to control whether
calendar entries are shown on the timeline.

2.2.1.1.2 Add Calendar Entry
If you choose “Add Calendar Entry”, a dialog box is displayed that lets you
create a new public or private calendar entry.
Figure 8: Timeline – Add Calendar Entry Dialog Box

You can enter an ID, description, and time for the calendar entry, and
choose to make it public or private. Private entries appear only on your
timeline display, whereas public entries appear on everyone’s timeline
display.
2.2.1.2 Loaded Models/Model Authority Sets
This section of the home page lists each of the models and/or model
authority sets that are loaded in your current workspace.
Figure 9: Home Page – Loaded Models/Model Authority Sets

Model authority sets that are shown in bold indicate that there have been
changes made to records that belong to that model authority set type. You
can right-click the model or model authority set name for additional
options.

2.2.1.3 Loaded Projects
This section of the home page lists each of the projects that are loaded in
your current workspace.
Figure 10: Home Page – Loaded Projects with Context Menu

You can right-click the project name for additional options.

2.2.1.4 User Notes
This section of the home page provides an area where you can type in
notes for your own use. No one else sees your notes. The upper right
portion of this section provides a quick link to the property sheet for your
user ID (for more information, refer to section 4.3.1 Creating a User).
Figure 11: Home Page – User Notes
2.2.1.5 System Messages

This section of the home page displays messages from the system
administrator.
Figure 12: Home Page – System Messages with Context Menu

If you have sufficient privilege, you can click the button in the top right
corner to add a new system message. Also, you can right-click an existing
message for options to edit or delete the message.

2.2.1.6 Recent System Activity
This section of the home page displays the five most recent messages
from the Activity Log.
Figure 13: Home Page – Recent System Activity

You can click the More link in the upper right corner to display the Activity
Log view.
2.2.1.7 Recent Project Activity
This section of the home page displays information about the five most
recent change items in your active project.
Figure 14: Home Page – Recent Project Activity

You can click the More link in the upper right corner to display the Project
Details view for the active project.
2.2.1.8 Recent Deployments
This section of the home page displays information about the five most
recent deployments (exports) that have been performed.
Figure 15: Home Page – Recent Deployments

You can click the More link in the upper right corner to display a window of
your complete deployment history.

Figure 16: Home Page – Deployment History
2.2.2 Menus
The e-terrasource interface provides several menus at the top of the
viewport.
Figure 17: Menus

• File menu
− Save – Saves model edits to the currently active project.
− Close – Closes just this viewport.
− Exit – This option closes the entire APF application and all
viewports.
• Edit menu
− Undo – Backs out the most recent unsaved edit operation. Note
that one edit operation may have resulted in several unsaved
change items, so a single undo action can remove several unsaved
change items.
− Undo All – Backs out all unsaved edit operations. All unsaved
change items are discarded.
Once change items have been saved to a project, you can
selectively delete change items from the Project Details view (refer
to section 3.4.6 Viewing/Modifying Project Details).

• View menu
− Workspace Explorer – Opens the Workspace Explorer, or closes it
if it is already open.
− Model Explorer – Opens the Model Explorer, or closes it if it is
already open.
− Template Explorer – Opens the Template Explorer, or closes it if it
is already open.
− Administration Explorer – Opens the Administration Explorer, or
closes it if it is already open.
− Activity Log – Opens a dialog box containing an unfiltered view of
the Activity Log, or closes it if it is already open.
− Import/Export History – Opens a dialog box containing a view of the
import/export history, or closes it if it is already open.
− Validation History – Opens a dialog box containing a view of the
validation history, or closes it if it is already open.
− Unsaved Change Items – Opens a dialog box containing a view of
the unsaved change items, or closes it if it is already open.
Note that Unsaved Change Items are model modifications stored
only on the e-terrasource client. Change items are saved
(committed) to the database and stored within the active project, at
which point they are persistent.
− Unapplied Change Items – Opens a dialog box containing a view of
the unapplied change items, or closes it if it is already open.
When projects are loaded into a workspace, it is possible that
some change items cannot be applied successfully to the model
loaded into the workspace. This is not necessarily an error
condition, so they are not treated as errors.
− Overlapping Change Items – Opens a dialog box containing a view
of the overlapping change items, or closes it if it is already open.
Overlapping change items are modifications that can potentially be
conflicting. Change items belonging to different loaded projects that
modify the same property of the same record are listed here. There
may be cases where the resulting value depends on the order in
which the projects are loaded, and that there are justifiable reasons
for referencing objects in both projects.

− Constraint Violations – Opens a view of the constraint violations, or
closes it if it is already open.
The Constraint Violation view lists the invalid references between
records, and values that do not match a picklist entry.
− Project View – Opens the Project view, or closes it if it is already
open.
− Snapshots View – Opens the Snapshots view, or closes it if it is
already open.
− User Preferences – Opens a dialog box that allows user
preferences to be viewed and modified.
• Help menu
− Help Contents – Opens a help viewport that allows access to all
available online help documents.
− About e-terrasource – Opens a dialog box that displays the version
of the e-terrasource client, server, and database.
− About APF – Displays information about the APF and its plug-in
components. Select “e-terrasource” in the “Installed plug-ins” list to
obtain detailed information about modules in the e-terrasource
interface.

2.2.3 Toolbar
The e-terrasource toolbar is immediately below the menus. It contains
icons for common operations, as well as names of the available tree view
displays for the workspace.
Button Name Description
Home page icon Provides easy access to the
home page
New icon with Supports creation of a new
drop-down list project, model, or model
authority set
Load icon with Supports loading of existing
drop-down list projects, models, and model
authority sets
Save icon Causes unsaved edits to be
saved as change items to
the active project
Refresh icon Forces all data to be
re-queried from the
database and refreshed on
the user interface; the F5
function key can also be
used
Search icon Brings up the Search dialog
box to support ad hoc
searches of model data
Linkages icon Shows available special-
with drop-down purpose linkage displays
list
Validation icon Allows the active project or
with drop-down the entire workspace to be
list validated
Import icon with Allows data to be imported
drop-down list into a project or workspace;
also allows changes to be
imported from Excel
Export icon with Allows workspace data to be
drop-down list exported
Reset Causes the workspace to be
workspace icon reset, or emptied of all data

Button Name Description
Active Project Allows you to choose the
Selector project that changes are
saved into
Workspace Allows you to choose a
Selector workspace to use
Default Model Allows you to specify the
Authority Set model authority set type that
Type Selector new records should be
assigned to; this selection is
overridden by the model
authority set type of the
active project (if specified)
2.2.4 Context Menus

e-terrasource makes extensive use of context menus. To activate a
context menu, right-click on an object in the interface.
2.2.5 Context-Sensitive Help

The e-terrasource user interface provides several types of context-
sensitive help.
• Help on the e-terrasource user interface itself can be obtained by
pressing <F1> with the input focus set to the desired pane or dialog
box.
For example, pressing <F1> on the New Project dialog box opens the
e-terrasource User’s Guide and positions to the section that explains
how to create a new project.
• Help on the business model can be obtained by pressing the
<Ctrl><F1> key combination on a property sheet or grid.
For example, pressing <Ctrl><F1> on a Substation property sheet
opens the e-terrasource EMS Modeling Guide and positions to the
section that explains how to model a substation.
• Information about the mapping between specific business model
records/properties and their corresponding e-terrahabitat
records/fields and CIM fields can be obtained by pressing the
<Alt><F1> key combination.

The e-terrasource interface supports the following display types:
• Tree View – This display type provides an overview of data
relationships in a hierarchical fashion. Tree view displays are
configurable, where administrators define their logical views.
e-terrasource comes with several tree views provided, and additional
views can be created as needed. For details on creating additional tree
views, refer to the e-terrasource Software Installation and
Maintenance Guide.
• Property Sheet – This display type shows the details of any given
record and supports editing the properties of that record. The property
sheets can have scroll bars, and the properties can be grouped
hierarchically into property groups. References to other objects are
created by selecting the target instance from a combo box.

• Grid Display – This display type shows records of the same type in a
tabular format. The grid displays support the bulk presentation of data,
and they support sorting and navigation. Columns can be hidden, and
data can be exported to Microsoft Excel.

• Graphic Modeler Display – This display type shows the business
objects graphically, such as a one-line diagram, a schematic display, a
geographical map, etc. Essentially, the graphic display depicts objects
and connections between objects. With graphic displays, users can
build their model by dragging and dropping business objects on a
canvas and connecting them.
2.3 Customizing the e-terrasource Layout

The e-terrasource user interface layout consists of the following
components:
• Menu – The menus (File, Edit, View, and Help) appear at the top of
the interface.
• Toolbar – The toolbar consists of several buttons, drop-down lists, and
navigation tree names that appear below the menus.
• Left/Navigation pane – The navigation pane is docked at the left side
of the interface by default, and it is used to hold hierarchical navigation
displays. The e-terrasource explorers and model tree views appear in
this pane.
• Center/Main pane – The center/main pane is used to display property
sheets called up from the tree view. It also shows grid displays and
Graphic Modeler displays.
• Right/Auxiliary pane – The auxiliary pane is docked at the right side of
the interface by default, and it is used to display property sheets for
records that are selected in grid and graphic displays in the center
pane.
• Bottom pane – The bottom pane (docked at the bottom of the
interface) is not used by default. However, it is available for you to
dock a display at the bottom.

• Status bar – The status bar is at the bottom of the interface. It displays
the user name, server name, and current time.
By default, explorer panes and navigation tree views are docked at the left
side of the viewport; grids, Graphic Modeler views, and property sheets for
tree view items are shown in the center; property sheets for grid and
graphic records are shown on the right side; and all other logs, messages,
and project details appear in dialog boxes.
Figure 18: e-terrasource Layout with Project Details Dialog Box

The layout of e-terrasource can be changed to meet the needs and
preferences of the user.

2.3.1 Working with Panes
To reposition an entire pane (including its tabs, if any):
1. Drag the title bar of the pane toward the center of the viewport.
The pane-positioning graphic appears, as shown below:
2. Point to the desired location where you want to place the pane in the
graphic above, and release the mouse button.
The pane positions itself in the highlighted location of the viewport.
Dropping the pane on the center icon turns that pane into a tab for the
highlighted section. Alternatively, you can “tear off” the pane by moving
the cursor off the viewport and releasing the mouse button.
The same method can be used to reposition (or tear off) individual tabs
within a pane. However, instead of dragging the title bar, drag the tab
name.
Panes can also be pinned and unpinned by clicking the pin symbol on the
right side of the pane’s title bar. When unpinned, the pane collapses to
the side until you hover the cursor over the pane name to expand it again.
Left of the pin symbol is an arrow symbol that displays a context menu for
the pane, as shown below:
Figure 19: Pane Context Menu

The options on the pane context menu are:
• Close – Choosing this option closes the pane. It is equivalent to
clicking the “X” icon in the title bar.

• Floating – Choosing this option turns the current tab into a floating
window.
• Dockable – The pane is dockable by default.
• Tabbed Document – Choosing this option converts the pane/tab into a
tab in the center pane.
• Auto Hide – Choosing this option causes the pane/tab to collapse to
the side until you hover the cursor over it, similar to unpinning the
pane.
2.3.2 Interacting with Multiple Open Panes

When multiple panes are opened that appear in the same location of the
viewport, they appear as tabs along the bottom of the pane. Figure 20
shows three open panes (Network Model, Tables Explorer, and
Administration Explorer) that are grouped together in a single pane with
tabs.
Figure 20: Pane with Multiple Tabs

The entire pane can be “torn off” by dragging the pane’s title bar off the
viewport. Alternatively, a single tab can be torn off by clicking the tab
name and dragging it off the viewport.

2.4 Opening Multiple Viewports
You can have multiple viewports open simultaneously by following the
steps below:
1. Open the APF console.
2. From the APF Console Application tab, double-click the e-terrasource
icon.
An additional viewport opens.
2.5 Status Bar Information

The status bar at the bottom of the e-terrasource window displays the
user name, the current e-terrasource server endpoint name, and the
current time. Other information can also be shown in the status bar,
depending on the user’s current operation.
Figure 21: Status Bar
2.6 Data Entry Validation

The user interface performs some rudimentary validation at the time of
data entry:
• Entry of text fields is limited to the maximum length of the field.
• Numeric fields can contain only numeric data.
• If a string field has a validation expression associated with it, the
entered value is checked against the validation expression. The
validation expression is in the form of a regular expression.
• If a numeric field has a validation expression associated with it, the
entered value is checked against the validation expression. The
validation expression is in the form of a range expression.
If the entered value fails validation, the text box is enclosed by a red
rectangle and a dialog box is displayed.
Figure 22: Validation Error

Figure 23: Validation Error Dialog Box
2.7 User Preferences

Several user preferences can be configured in the e-terrasource user
interface by clicking View > User Preferences.
Figure 24: User Preferences Dialog Box

Several user preferences are available in the dialog box:
• Client data refresh rate – This value specifies the rate (in seconds) at
which the user interface checks to see if any of its data requires
refreshing. The refresh rate cannot be set lower than 4 seconds.

• Edit projects filter – This button can be used to display the project filter
dialog box. This dialog box controls which projects are shown on the
Timeline section of the home page, as well as the Projects View and
the Load Project dialog box.
• Preserve viewport layout – Selecting this check box saves the current
viewport layout into a default room when the user exits the application.
The default room is loaded on application startup with the same saved
layout.
• Grid views
− Page size – This value specifies the maximum number of records
that is shown on a single grid page. Keep in mind that increasing
this value potentially increases the memory usage of the
e-terrasource user interface.
− Preserve attributes – If checked, the user interface uses any
previously saved columns widths, column ordering, and other
attributes controlling the appearance of grid displays. This
information is retained separately per grid display. If you uncheck
this box, the saved grid attributes are not used.
− Attribute expiration – This value specifies how long saved grid
attributes are retained. To discard all your stored grid attributes, set
this value to 0 and click OK.
• Domain properties
− Enable SCADA properties: If this option is checked, property
groups that contain information related to the SCADA (Supervisory
Control and Data Acquisition) subsystem are shown on property
sheets and grid views. If you are not interested in viewing SCADA
properties, uncheck this box.
− Enable DTS properties: If this option is checked, property groups
that contain information related to the DTS (Dispatcher Training
Simulator) subsystem are shown on property sheets and grid
views. If you are not interested in viewing DTS properties, uncheck
this box.
− Enable Network properties: If this option is checked, property
groups that contain information related to the Network subsystem
are shown on property sheets and grid views. If you are not
interested in viewing Network properties, uncheck this box.
− Enable Generation properties: If this option is checked, property
groups that contain information related to the Generation

subsystem are shown on property sheets and grid views. If you are
not interested in viewing Generation properties, uncheck this box.
• Restore defaults
− Import/export parameters – This button can be clicked to restore all
import/export parameters to their default values. Otherwise, the
user interface uses the parameter values from the most recent
import or export.
− User and application preferences – Clicking this button effectively
deletes the user preference file saved for this user and re-creates a
new one using the application defaults. This may be helpful if the
file becomes corrupt.
2.8 Alstom Presentation Framework

The APF console window provides some useful capabilities, which are
documented in the Alstom Presentation Framework User’s Guide
(available via Help > Help Contents > APF Documentation > APF User’s
Guide).
Two items are worth mentioning in regards to e-terrasource: rooms and
the CLS viewer.
2.8.1 Rooms
A room is a particular configuration of a viewport that can be saved and
recalled in the future. The e-terrasource user interface creates a default
“room” upon installation, and this room is called up automatically when
APF starts. You can see this on the Rooms tab of the APF console; it
displays a room called “e-terrasource DefaultRoom”.
If you choose the Preserve Viewport Layout option in the User
Preferences dialog box, the default room is updated whenever you exit
the e-terrasource user interface. The next time the e-terrasource user
interface starts, the viewport should look similar to its appearance when it
was last opened.

Figure 25: APF Console – Rooms Tab
For information about creating additional rooms and calling them up, refer
to the Alstom Presentation Framework User’s Guide.
2.8.2 CLS Viewer

The APF console window has a Common Logging Service (CLS) viewer
tab, which displays diagnostic messages that can be useful for
troubleshooting purposes. The default settings for the CLS viewer are
such that the e-terrasource client messages are shown. However, server
and database tier messages can also be viewed if your system has been
configured properly.
To determine what value you should use for the “CLS Service URI” in your
CLS settings, contact your system administrator.

Figure 26: APF Console – CLS Viewer Tab

3. Using e-terrasource
3.1 Workspaces
A workspace is an environment where models are viewed and edited. Its
contents are transient; different model authority sets or projects can be
loaded into a workspace over time for the purposes of deploying,
validating, viewing, or editing a model.
Each workspace is an independent repository for working with model
authority sets and projects. A workspace has a single owner. Although it is
allowable to have other (non-owner) users view the same workspace, only
the owner can modify the content of the workspace.
Remember that a workspace is not considered a permanent repository of
data. Models are saved as model authority sets and projects. A
workspace can be populated by loading model authority sets and/or
projects, or by importing data into it. A workspace can be returned to an
empty state by “resetting” it.
Users familiar with e-terrahabitat can think of a workspace as being
similar to a modeling “clone”.
3.1.1 About the Workspace Explorer

To view a display of the available workspaces, click View > Workspace
Explorer. A pane with a hierarchical tree display opens that shows the ID
for all workspaces. The user’s currently open workspace is shown in bold
font. The information in the tree is read-only.
Figure 27: Workspace Explorer

The workspace nodes can be expanded to view Loaded Model Authority
Sets, Loaded Models, Loaded Projects, and Workspace Users. Clicking
Proprietary – See Copyright Page 38 Using e-terrasource

on any of the nodes (workspace, model, model authority set, project, or
user) displays the property sheet for that node. Right-clicking on a node
displays a context menu for the node.
Note that you cannot view or open any metamodel workspaces unless you
have the UseMetaModelWorkspace privilege.
3.1.2 Opening/Changing Workspaces

A user can have a single workspace open at a time. The Workspace
Explorer lists all available workspaces, but the one that is currently open is
listed in bold font. You must have an open workspace in order to view
and modify model data.
To open a workspace or change to another workspace, use the
workspace selector in the toolbar.
Figure 28: Toolbar – Workspace Selector

The icon next to the selector includes a “lock” symbol if the workspace is
currently locked.
Figure 29: Toolbar – Locked Workspace

You can also open a workspace from the Workspace Explorer by right-
clicking the desired workspace, and choosing Open.
When changing workspaces, the project selector in the toolbar is set to
<No Active Project>.
Note that you cannot view or open any metamodel workspaces unless you
have the UseMetaModelWorkspace privilege.
3.1.3 Viewing/Modifying Workspace Properties

Users can view the properties of a workspace using either of the following
methods:
• From the Workspace Explorer, right-click on the workspace ID, and
select Properties from the context menu.
• From the Workspace Explorer, click the workspace ID.
The workspace property sheet is shown with the following information:
• Workspace ID
• Workspace description

• Current owner of the workspace
Only the owner can modify the content of the workspace.
• Workspace database schema name
• Workspace locked flag
Can be changed to “Yes” to prevent modification of the workspace
content. Can only be changed to “No” by the user who locked the
workspace.
• If the workspace is locked, the lock time, locked-by-user ID, and lock
reason are shown
• Business model schema and version that the workspace uses
• Workspace created by, creation date, modified by, modification date
Figure 30: Workspace Properties

Any changes made to the property sheet are saved to the database.

3.1.4 Changing a Workspace Password
The owner of a workspace can change the workspace password by right-
clicking the workspace name on the Workspace Explorer, then choosing
Change Password from the context menu. The Change Workspace
Password dialog box is shown.
Figure 31: Change Workspace Password Dialog Box

Enter the old password, then enter the new password twice and click OK
to change the password.
3.1.5 Viewing Loaded Models

To view information about the models that are currently loaded in a
workspace, use one of the following methods:
• From the home page, right-click on a model in the Loaded
Models/Model Authority Sets section, and choose Properties from the
context menu.
• From the Workspace Explorer, click the Loaded Models node.
A grid display appears that lists the models that are loaded in the
workspace.
• From the Workspace Explorer, expanding the Loaded Models node
displays the loaded models (both name and version number; e.g.,
EMP60: 12 for version 12 of the EMP60 model) as child nodes.
Clicking one of the child nodes brings up the property sheet for that
model.
The property sheet or grid shows:
− The model type and version number
− Model description
− Model state
− Created by, creation date, modified by, and modification date

− Any custom model attributes that are defined
The grid display is read-only, but selected fields on the property sheet are
modifiable if the user has ReplaceModel or ReplaceAnyModel privileges.
3.1.6 Viewing Loaded Model Authority Sets

To view information about the model authority sets that are currently
loaded in a workspace, use one of the following methods:
• From the home page, right-click on a model authority set in the Loaded
Models/Model Authority Sets section, and choose Properties from the
context menu.
• From the Workspace Explorer, click the Loaded Model Authority Sets
node.
A grid display appears that lists the model authority sets that are
loaded in the workspace.
• From the Workspace Explorer, expanding the Loaded Model Authority
Sets node displays the loaded model authority sets (both name and
version number; e.g., East: 7 for version 7 of the East model authority
set) as child nodes. Clicking one of the child nodes brings up the
property sheet for that model authority set.
− The model authority set type and model authority set version
number
− Model authority set description
− Model authority set state
− Business model schema and version
− Modification flag
− Time the model authority set was last loaded
− Any custom model authority set attributes that are defined
modifiable if the user has ReplaceMdlAuthSet or ReplaceAnyMdlAuthSet
privileges.

3.1.7 Viewing Loaded Projects
The home page and Workspace Explorer show the list of projects that are
currently loaded into the workspace. The order in which they are shown
matches the order in which they were loaded. The default setting is to
have the most recently loaded project listed first.
Remember, the order in which projects are loaded can be very important
in the event that there are dependencies or overlaps between projects.
“Dependency” means that Project B may depend on Project A being
loaded first. For example, Project A creates a new object, and Project B
references the new object — making Project B dependent on Project A
being loaded first. “Overlap” means that Project A and Project B can both
modify the same property on the same record, so the project loaded last
“wins”.
Information about the projects that are loaded in a workspace can be
accessed using either of the following methods:
• From the home page, right-click on a project in the Loaded Projects
section, and choose Properties from the context menu.
• From the Workspace Explorer, click the Loaded Projects node.
A grid display appears that lists the projects that are loaded in the
workspace.
• From the Workspace Explorer, expand the Loaded Projects node to
display the loaded project IDs as child nodes. The child nodes are
listed in order of load sequence (by default, they are shown from most-
recently loaded to least-recently loaded). Clicking one of the child
nodes brings up the property sheet for that project.
− Project ID
− Project name
− Project description
− Model authority set type
− State
− Locked flag
− Effective date
− Number of change items

− Business model schema
− Created by, creation date, modified by, modification date
− Impacted model authority set types
− Any custom project attributes that are defined
modifiable if the user has ReplaceProject or ReplaceAnyProject
privileges.
There is an application parameter named “ui_loaded_projects_order”,
viewable on the Administration Explorer, which can be set to “ascending”
or “descending” to control the order in which loaded projects are
displayed. The default is “descending”, meaning that the most-recently
loaded project is shown first.
3.1.8 Viewing Workspace Users

A workspace has a single owner. Although it is allowable to have other
(non-owner) users view the same workspace, only the owner can modify
the content of the workspace.
To view information about the users who are currently assigned to the
workspace, you can use either of the following methods:
• From the Workspace Explorer, click the Workspace Users node.
A table appears that lists the users that are assigned to the
workspace.
• From the Workspace Explorer, expand the Users node to display the
users as child nodes. Click on one of the child nodes to bring up the
property sheet for that user.
− User ID
− First name
− Last name
− Active project
− Access type
− User’s model authority
− User’s model authority set type to assign new records to

− Language
− Current workspace
− Disabled flag
− Time of last action
− Any custom user attributes that are defined
Each child node displays the user ID and the active project that the user is
currently working on.
modifiable if the user has ReplaceUser or ReplaceAnyUser privileges.
3.1.9 Viewing Workspace Activity

The information in the Activity Log can be filtered for a particular
workspace by right-clicking the workspace ID on the Workspace Explorer,
then clicking Activity Log.
An Activity Log dialog box opens that displays only messages related to
the selected workspace.
3.1.10 Resetting a Workspace

Resetting a workspace empties the contents of the workspace and
unloads all model authority sets and projects. Remember that model
changes are saved in model authority sets and projects, so you should
only reset your workspace if you are sure that all desired data has been
saved.
To reset the contents of a workspace:
1. Click the Reset Workspace button on the toolbar.
2. From the Workspace Explorer, right-click on the current workspace,
and select Reset from the context menu.
A confirmation dialog box appears.
3. Click OK to confirm or Cancel to abort.

3.1.11 Locking a Workspace
Locking a workspace restricts the workspace so its contents cannot be
altered until it is unlocked. While a workspace is locked, model authority
sets and projects cannot be loaded, change items cannot be saved, and
the workspace cannot be reset or removed. Workspaces are automatically
locked for the duration of import/export operations.
Since the owner of a workspace is the only user allowed to modify the
content of the workspace, there is usually no need to explicitly lock a
workspace. Nevertheless, if a user’s workspace is currently unlocked, it
can be locked using either of the following methods:
• From the Workspace Property Sheet, change the Locked list to “Yes”.
• From the Workspace Explorer, right-click on the workspace, and select
Lock from the context menu.
The Lock Reason field can optionally be filled. When locking a workspace,
e-terrasource automatically fills in the locked-by-user ID and the time it
was locked.
3.1.12 Unlocking a Workspace

The owner of a locked workspace must have the ReplaceWorkspace
privilege to unlock it. Other users must have the ReplaceAnyWorkspace
privilege to unlock it.
If the workspace is currently locked, use one of the following methods to
unlock it:
• From the Workspace Property Sheet, change the Locked list to “No”.
• From the Workspace Explorer, right-click on the open workspace, and
select Unlock from the context menu.
3.1.13 Viewing the Tables Explorer

The Tables toolbar button opens the Tables Explorer, which is a tree view
display that provides access to every table in the model. Clicking on a
table name displays a grid that shows the data in the table, one page at a
time.

Figure 32: Tables Explorer
The Tables Explorer lists all tables in a hierarchical fashion. If you hover
the cursor over the name of a table, a tool tip is shown that provides a
detailed description of the table.
3.1.14 Comparing Workspaces

Beginning with e-terrasource 2.0.2, e-terrasource provides a mechanism
to compare models in two different workspaces and capture the
differences in a project. This feature is described in the section titled
“Sample Scripts” in the e-terrasource Software Installation and
Maintenance Guide.
A future release of e-terrasource will allow workspace comparisons to be
performed from the user interface and allow management of workspace
comparison “definitions”.
3.2 Models
A “model” is an e-terrasource concept that is completely optional. It is
simply a collection of model authority sets at a given point in time. They
are used only if you want to break up your full model into pieces. In this
case, each piece is a model authority set, and all the pieces form a
complete model. In e-terrasource, a model is identified by a “type” and a
“version”. The version is incremented each time a new model is created.
If you refer back to Figure 1, you can see that the full model is broken into
North, South, East, and West regions. Given this scenario, one can create
a model type called “Full”, and four model authority set types: North,
South, East, and West. Furthermore, you declare that:
Full = North + South + East + West

This tells e-terrasource that:
• When creating a Full model, it actually needs to create four model
authority sets (North, South, East, and West).
• When loading a Full model, it actually needs to load four model
The definition of model and model authority set types is performed in the
Administration Explorer. Models and model authority sets are symbolized
by the Greek letter Sigma (Σ).
Using models does not prevent you from loading individual model
authority sets. For example, you can load only an East model authority set
if that was the only region you were interested in viewing/modifying.
As a side note, you might want to put information referenced by all regions
in a separate “Common” model authority set:
Full = North + South + East + West + Common
Each record in your model must be assigned to exactly one model
authority set type. For example, an object cannot be in both East and
West. The assignment of records to model authority set types can be
viewed and modified at the top of the property sheet.
Figure 33: Model Authority Set Type Assignment

You can control which model authority set type newly created records are
assigned to using the Model Authority Set Type Selector on the toolbar.
Figure 34: Model Authority Set Type Selector

Models are identified by two things: the model type, and a version
number, which starts at 1 and increases each time a new model is
created. For example:
Full v3 = North v3 + South v3 + East v4 + West v5
This indicates that version 3 of the Full model is made up of:
• Version 3 of model authority set North

• Version 3 of model authority set South
• Version 4 of model authority set East
• Version 5 of model authority set West
3.2.1 Viewing Models with the Model Explorer

The Model Explorer provides a hierarchical view of each model, organized
by model type. The ancestry of each model authority set can be viewed to
determine how it was created.
To access the Model Explorer, choose View > Model Explorer.
Figure 35: Model in Model Explorer

A hierarchical tree display opens, which shows model types at the top
level and their models as child nodes. Under each model node, each
model authority set that belongs to the model is listed. The model
authority sets can be further expanded to show the Ancestor Model
Authority Sets and Ancestor Projects that were used to form each model
authority set. The information about the tree is read-only. Clicking on a
node displays its property sheet.
3.2.2 Viewing/Modifying Model Properties

To view the properties of a model, perform any of the following steps:
• From the Loaded Models/Model Authority Sets section of the home
page, right-click a model, and choose Properties.

• From the Model Explorer, click on a model name.
• From the Model Explorer, right-click on a model name, and choose
Properties from the context menu.
• From the Workspace Explorer, click on a model name.
• From the Workspace Explorer, right-click on a model name, and select
The model property sheet displays the following information:
• Model type and version
• Model description
• Model state
• Created by, creation date, modified by, modification date
Figure 36: Model Property Sheet

Changes made on the property sheet are saved to the database.
3.2.3 Loading a Model

Loading a model causes the data in each of the model’s constituent
model authority sets to be loaded into your workspace, and the list of
loaded models is updated.
Physically, what happens at the database level is that the database
referential and check constraints are disabled, and then all of the model

authority set data is inserted into the workspace tables. When this
completes, the database constraints are enabled again.
It is possible that one or more constraints might fail to become enabled
due to incorrect data. If this is the case, a warning is displayed, and you
can obtain further information by clicking Constraint Violations on the View
menu.
To load a model, either:
• Click the drop-down list on the Load button on the toolbar, and select
Model.
• Right-click a model on the Model Explorer, and choose Load.
The following dialog box is displayed:
Figure 37: Load Model Dialog Box

Select the model type from the list. A list of available models appears in
the Version portion of the dialog box. Select the desired model and click
OK.
You can also open a model from the Model Explorer by right-clicking on
the model name and selecting Load.
Note that only one version of a model can be loaded into a workspace at
any point in time. That is, you cannot simultaneously load different
versions of a model into a workspace.
When the model is finished loading, all views are refreshed to show the
newly loaded data.
3.2.4 Unloading a Model

A model can be unloaded from a workspace using one of the following
methods:

page, right-click the desired model, and choose Unload.
• From the Loaded Models node of the Workspace Explorer, right-click
the desired model, and choose Unload.
The Unload dialog box is displayed that lists the model authority sets and
projects that are currently loaded in the workspace. Check boxes are
provided to indicate which of these items should be unloaded, with the
selected model’s constituent model authority sets checked. After
reviewing the check boxes, click OK to proceed with the unload operation.
Figure 38: Unload Model

WARNING: The unload operation simply resets the workspace and
reloads the model authority sets and projects that were not selected to be
unloaded. This implies that, if you have data in your workspace that did
not originate from a model authority set or project, it is not reloaded. For
example, if you have loaded data via an import operation but not yet
created a model authority set containing that data, the imported data is
not reloaded.
3.2.5 Creating a Model

If your system is configured to define models as a group of model
authority sets, then models should be created regularly as a means of
saving a baseline of a complete model at a point in time.
A model is identified by its type and a sequential version number. When a
model is created, all of the data in the workspace is saved into a collection
of model authority sets, along with information about its ancestry — the
model authority sets and projects that were used to create it.

Generally, it is a good idea to create a model under the following
situations:
• A model is first imported from an external source, such as a savecase
or a CIM/XML file.
• A model is being deployed to an external system.
• A set of model changes (represented by a set of projects loaded in the
workspace) needs to be folded into a previous model.
• Any time you want to save a baseline of a model that you can quickly
retrieve.
A model can be saved at any time — even if the model is invalid, has
constraint violations, or is flawed in any other way.

To create a new model:
1. Click the drop-down list on the New button on the toolbar, and select
Model.
2. Select a model type from the model type list.

3. Optionally, enter a description of the new model authority set in the
text region, and select the desired State.
4. Select either the Work with New Model or the Work with Current Model
option.
Choose the Work with New Model option to create the new model, and
then set the Loaded Model, Loaded Model Authority Set, and Loaded
Project information to indicate that the only thing loaded in the
workspace is the new model.
Choose the Work with Current Model option to create a new model
without changing the list of currently loaded models, model authority
sets, and projects (subject to the exception noted below).

5. Click OK to create the new model.
Note: There is a caveat to the Work with Current Model option. When
choosing this option, projects may also be unloaded. The idea is that you
probably do not want to continue to modify a project after its contents
have been rolled into a new model. For example, if you create the model
“Full v7” that contains changes from project “P1”, then P1 is unloaded,
because you probably do not want to make additional changes to P1
afterwards because those changes would not be reflected in Full v7.
In other words, it is probably not a good practice to make changes to a
project after it has been included in the creation of a model or model
authority set. This situation can also be minimized by including only
projects that are no longer in an editable state when creating a model or
model authority set.
3.2.6 Deleting a Model

Deleting a model permanently removes it from e-terrasource. Models
cannot be deleted if any of their constituent model authority sets are
currently loaded in any workspace. Also, users can only delete models
that they have created, unless they have the RemoveAnyModel privilege.
When a model is deleted, its constituent model authority sets are also
deleted, unless they happen to be part of another model as well.
To delete a model, perform the following steps:
1. Right-click on the model from the Model Explorer, and select Delete
from the context menu.
2. In the confirmation dialog box that appears, click OK to delete the
model.
Note: It is not possible to delete a model from the Workspace Explorer,
because it is illegal to delete a model that is currently loaded in any
workspace.
3.3 Model Authority Sets

A model authority set is a complete model (or model portion) at a given
point in time. In e-terrasource, a model authority set is identified by a
“type” and a “version”. The version is incremented each time a new model
authority set is created.
• If your system is configured to break up a model into portions, then a
model authority set represents a portion of the model.
• If your system is not configured to break up the model, then you
probably have a single model authority set type that represents the
whole model.

For more information, refer to section 3.2 Models.
Workspaces are usually initialized by loading in at least one model
authority set (and zero or more projects) as a starting point. Models and
model authority sets are symbolized by the Greek letter Sigma (Σ).
Model authority sets are identified by two things: the model authority set
type, and a version number, which starts at 1 and increases each time a
new model authority set is created (for example, North version 3).
3.3.1 Viewing Model Authority Sets with the Model Explorer

The Model Explorer provides a hierarchical view of each model authority
set, organized by model authority set type. The ancestry of each model
authority set can be viewed to determine how it was created.
To access the Model Explorer, choose View > Model Explorer.
Figure 39: Model Authority Set in Model Explorer

A hierarchical tree display opens, which shows model authority set types
at the top level and their model authority sets as child nodes. Under each
model authority set child node, there are additional nodes for showing
Ancestor Model Authority Sets and Ancestor Projects that were used to
form the model authority set. The information about the tree is read-only.
Clicking on a node displays its property sheet.
3.3.2 Viewing/Modifying Model Authority Set Properties

To view the properties of a model authority set, perform any of the
following:
page, right-click a model authority set, and choose Properties.
• From the Model Authority Set Explorer, click on a model authority set
name.

• From the Model Authority Set Explorer, right-click on a model authority
set name, and select Properties from the context menu.
• From the Workspace Explorer, click on a model authority set name.
• From the Workspace Explorer, right-click on a model authority set
name, and select Properties from the context menu.
The model authority set property sheet displays the following information:
• Model authority set type and version
• Model authority set description
• Business model schema ID and version that the model authority set
was created from
• Modification flag to indicate if any model edits have been made that
impact records in this model authority set type
• Last loaded time, created by, creation date, modified by, modification
date
Figure 40: Model Authority Set Property Sheet


3.3.3 Viewing Model Authority Set Audit Log
e-terrasource keeps an audit log of changes made to model authority set
properties. Each time a model authority set property is modified, an entry
is added to the audit log.
To view the audit log for a model authority set, right-click on the model
authority set name on the home page, Workspace Explorer, or Model
Explorer, and choose Detailed Audit Log from the context menu.
A grid display is shown, which lists all previous modifications made to the
model authority set. By default, the grid display lists the most recent
change at the top, although you can sort the data by clicking on the
desired column header.
Figure 41: Model Authority Set Audit Log

When the data is ordered by modification date, as is the default, the
changes that were made can be determined by comparing the data in
successive rows. In addition to listing each property of the model authority
set, the following columns provide additional auditing information:
• Modified By – User making the change
• Modification Date – Time at which the change was made
• Created By – User who initially created the model authority set
• Creation Date – Time at which the model authority set was created
• Audit System User – Operating system user making the change
• Audit Module – Process making the change. This is normally empty
unless e-terrasource has certain debugging flags enabled.
• Audit Host – Identification of the server from which the change was
made
3.3.4 Viewing Model Authority Set Ancestry

It is often useful to know the origins of a model authority set.
e-terrasource keeps track of the ancestry of each model authority set.
The “ancestry” is the list of model authority sets and projects that were
used to create a model authority set. For example, the model authority set
EMP60 version 12 might have been created from EMP60 version 11 and
projects X, Y, and Z.

The ancestry is important information that you need to familiarize yourself
with a particular model authority set. Although it may be typical to have
version N+1 of a model authority set created from version N, that may not
always be the case.
To view the ancestry of a model authority set, use either of the following
methods:
• From the Workspace Explorer, expand the Ancestor Model Authority
Sets and Ancestor Projects nodes under the model authority set node
for a loaded model authority set.
• From the Model Explorer, expand the Ancestor Model Authority Sets
and Ancestor Projects nodes under the respective model authority set.
Expanding the Ancestor Model Authority Sets node displays the model
authority set type and version for each ancestor of the parent model
authority set (e.g., EMP60: 12 for version 12 of the EMP60 model
authority set type). Expanding the Ancestor Projects node displays the
project ID for each ancestor of the parent model authority set.
Even if the ancestor model authority sets and projects are eventually
deleted, the ancestry information remains. In other words, if model
authority set EMP60 version 11 is deleted, you can still see that EMP60
version 12 had EMP60 version 11 as an ancestor.
3.3.5 Viewing Model Authority Set Activity

The information in the Activity Log can be filtered for a particular model
authority set using one of the following methods:
page, right-click the model authority set, then click Activity Log.
• From the Model Explorer, right-click the model authority set, then click
Activity Log.
• From the Workspace Explorer, right-click the model authority set, then
click Activity Log.
the selected model authority set.
3.3.6 Loading a Model Authority Set

Loading a model authority set causes all of the data that is part of that
model authority set to be loaded into your workspace, and the list of
loaded model authority sets is updated.
Physically, what happens at the database level is that the database
referential and check constraints are disabled, and then all of the model

authority set data is inserted into the workspace tables. When this
completes, the database constraints are enabled again.
It is possible that one or more constraints might fail to become enabled
due to incorrect data. If this is the case, a warning is displayed, and you
can obtain further information by clicking Constraint Violations on the View
menu.
To load a model authority set:
1. Click the drop-down list on the Load button on the toolbar, and select
Model Authority Set.
The Load Model Authority Set dialog box is shown.
2. Right-click a model authority set on the Model Explorer, and choose
Load.
3. Select the model authority set type from the list.

A list of available model authority sets appears in the Version portion
of the dialog box.
4. Select the desired model authority set and click OK.
Note that only one version of a model authority set type can be loaded
into a workspace at any point in time. That is, you cannot simultaneously
load different versions of a model authority set into a workspace.
When the model authority set is finished loading, all views are refreshed
to show the newly loaded data.

3.3.7 Unloading a Model Authority Set
A model authority set can be unloaded from a workspace using one of the
following methods:
page, right-click the desired model authority set, and choose Unload.
• From the Loaded Model Authority Sets node of the Workspace
Explorer, right-click the desired model authority set, and choose
Unload.
selected model authority set checked. After reviewing the check boxes,
click OK to proceed with the unload operation.
Figure 42: Unload Model Authority Set

not reloaded.

3.3.8 Creating a Model Authority Set
Model authority sets should be created regularly, as a means of saving a
snapshot of a model (or model portion) at a point in time.
A model authority set is identified by its type and a sequential version
number. When a model authority set is created, all of the records in the
workspace that belong to the model authority set type are saved, along
with information about its ancestry — the model authority sets and
projects that were used to create it.
Generally, it is a good idea to create a model authority set under the
following situations:
• A model is first imported from an external source, such as a savecase
or a CIM/XML file.
• A model is being deployed to an external system.
• A set of changes (represented by a set of projects loaded in the
workspace) needs to be folded into a previous model authority set.
• Any time you want to save a baseline of a model that you can quickly
retrieve.
A model authority set can be saved at any time — even if the model is
invalid, has constraint violations, or is flawed in any other way.
To create a new model authority set:
1. Click the drop-down list on the New button on the toolbar, and select
Model Authority Set.

2. Select a model authority set type from the Model Authority Set list.
3. Optionally enter a description of the new model authority set in the text
region, and select the desired State.
4. Select either the Work with New Model Authority Set or the Work with
Current Model Authority Set option.
Choose the Work with New Model Authority Set option to create the
new model authority set, and then set the Loaded Model, Loaded
Model Authority Set, and Loaded Project information to indicate that
the only thing loaded in the workspace is the new model authority set.
Choose the Work with Current Model Authority Set option to create a
new model authority set without changing the list of currently loaded
model authority sets and projects (subject to the exception noted
below).
5. Click OK to create the new model authority set.
Note: There is a caveat to the Work with Current Model Authority Set
option. When choosing this option, projects that touch only the model
authority set being created are also unloaded. The idea is that you
probably do not want to continue to modify a project after its contents
have been rolled into a new model authority set. For example, if you
create the model authority set “East v7” that contains changes from
project “P1”, then P1 is unloaded, because you probably do not want to
make additional changes to P1 afterwards because those changes would
not be reflected in East v7. In other words, it is probably not a good
practice to make changes to a project after it has been included in the

creation of a model or model authority set. This situation can also be
minimized by including only projects that are no longer in an editable state
when creating a model or model authority set.
3.3.9 Deleting a Model Authority Set

Deleting a model authority set permanently removes it from e-terrasource.
Model authority sets cannot be deleted if they are currently loaded in any
workspace. Also, users can only delete model authority sets that they
have created, unless they have the RemoveAnyMdlAuthSet privilege.
To delete a model authority set, perform the following steps:
1. Right-click on the model authority set from the Model Explorer, and
select Delete from the context menu.
2. In the confirmation dialog box that appears, click OK to delete the
model authority set.
Note: It is not possible to delete a model authority set from the
Workspace Explorer, because it is illegal to delete a model authority set
that is currently loaded in any workspace.
3.4 Projects
A “project” is the mechanism by which changes to a model are made. A
project is first and foremost a collection of change items (edits) that are to
be performed.
Change items can be of three types:
• Add – Create a new record of type <xxx>.
• Delete – Delete a record of type <xxx>.
• Update – Set property <yyy> to the value <zzz> for a particular record
of type <xxx>.
Since projects represent changes to models, they are represented with
the Greek letter Delta (Δ).
Projects have other properties as well. The most important of these is the
scheduled effective date. This is the date on which the model changes in
the project are scheduled to go into effect. Therefore, it is critical that a
project contains related changes that happen at the same time. If there is
any doubt about this, it is recommended that separate projects be
created. By having separate projects, adjustments can be made to the
scheduled effective date in the event that certain model changes need to
be delayed or accelerated.

Projects also have an implementation lifecycle or workflow, which is
represented by states and transitions between states. This lifecycle is
configurable in the Administration Explorer.
Projects can be optionally associated with a single model authority set
type, although it is perfectly acceptable for a project to contain changes to
records that belong to different model authority set types.
A project also has a short ID, a longer name, and a verbose description.
3.4.1 About Active Projects

In order to edit a model, a user must have an active project. The edits that
are performed are saved as change items in the user’s active project.
The active project:
• Must be loaded into the workspace.
• Must be in a state that allows editing (is not in a “locked” state).
• Is indicated in the Project Selector in the toolbar.
• Cannot be another user’s currently active project.
Figure 43: Toolbar – Project Selector

To set the active project, use the picklist at the top of the Workspace
Explorer to choose one of the projects currently loaded in the workspace.
Alternatively, when a new project is created, it is automatically set as the
active project.
Note that the Project Selector only lists projects that are in a state that
allows editing (is not in a “locked” state).
3.4.2 About the Project View

A grid view of the available projects can be displayed with the Project
view. Since the number of projects can be very large, the Project view has
a filtering capability, which can be used to locate only projects of interest.
The project filter criteria that you supply is used to filter the projects in the
Project view, as well as the Load Projects dialog box and the Timeline
section of the home page.
To display the Project view, use either of the following methods:
• Choose View > Project View.

• On the home page or Workspace Explorer, right-click a project, and
choose Project View from the context menu.
A grid display is shown:
Figure 44: Project Explorer with Filtering Section and Context Menu
The Project view shows all projects meeting the filter criteria. Right-
clicking on a project in the grid displays a context menu of available
options.
To filter the list of projects that are shown, perform the following steps:
1. Click the Filtering expansion icon, if the filtering section is not visible.
2. Enter the desired filter criteria. First choose a Model Schema using the
drop-down list. In the ID, Name, and Description fields, the asterisk (*)
can be used as a wildcard character. In the Status list box, one or
more statuses can be selected.

3. Click Apply Filter to apply the filter to the Project view. Note that the
filter also applies to the Load Project dialog box, as well as the
Timeline section of the home page.
The filter settings are retained as user preferences and remain in effect
until Clear Filter is chosen.
3.4.3 Viewing/Modifying Project Properties

To view properties for a project, use one of the following methods:
• From the Loaded Projects section of the home page, right-click the
project, and choose Properties on the context menu.
• From the Project view, right-click a project, and choose Properties on
the context menu.
• From the Workspace Explorer, click a project ID from the Loaded
Projects node.
• From the Workspace Explorer, right-click a project ID from the Loaded
Projects node, and choose Properties from the context menu.
The project property sheet is shown with the following information:
• Project ID
• Project Name
• Project Description
• Project’s model authority set type
• Current state in the project lifecycle
• Effective date
• Number of change items currently in the project
• Business model schema that the project applies to
• Model authority set types that the project impacts, based on the
records modified by the project
• Any custom project attributes that are defined
All of these fields are enterable to users that are modifying projects they
have created, or to users that have the ReplaceAnyProject privilege.

Figure 45: Project Property Sheet
Any changes made to the property sheet are saved to the database.
3.4.4 Viewing Unapplied Change Items

When projects are loaded into a workspace, it is possible that some
change items are not applied successfully. For example, a change item
can request updating or deleting a record that cannot be found in the
workspace, or the addition of a record that is already in the workspace.
Generally speaking, this is an indication that the project being loaded
should be examined more closely to determine why it has change items
that cannot be applied.
If loading a project results in new unapplied change items, the following
warning is displayed:
Figure 46: Unapplied Change Items Warning

A summary of all of the change items that cannot be applied to the
workspace as a result of loading projects can be called up using either of
the following methods:
• On the View menu, click Unapplied Change Items.
• From the Workspace Explorer, right-click on the current workspace
name, and click Unapplied Change Items.
Because unapplied change items are shown for a particular workspace,
you must have an open workspace; otherwise, the Unapplied Change
Items view is empty.
Figure 47: Unapplied Change Items View

The Unapplied Change Items are displayed in a dialog box. The dialog
box shows the workspace ID, project ID, project name, change item order,
operation, path name, table ID, column ID, old value, new value, and
reason. All of the fields are read-only. Clicking a column header sorts the
data by that column and displays an “ascending sort arrow”. Clicking
again reverses the sort and displays a “descending sort arrow”.
Keep in mind that this view is subject to data security rules, so you may
not see the old/new values if you are not authorized.
3.4.5 Viewing Overlapping Change Items

Overlapping change items occur when multiple projects attempt to change
the same property of the same record. The changes are applied in the
order that the projects are loaded, so that the end result for the property is
the last loaded change. These overlapping changes should be
investigated carefully, because the property’s resulting value can be
different by loading the projects in a different order.
If loading a project results in new overlapping change items, the following
warning is displayed:
Figure 48: Overlapping Change Items Warning

A summary of all of the overlapping change items for the workspace as a
result of loading projects can be called up using the either of the following
methods:
• On the View menu, click Overlapping Change Items.
• On the Workspace Explorer, right-click the workspace, and choose
Overlapping Change Items.
Figure 49: Overlapping Change Items View

The Overlapping Change Items are displayed in a dialog box. The dialog
box shows the project ID, project name, change item order, operation,
path name, table ID, property, old value, new value, reason, created by,
and creation date. All fields are read-only.
Note that the Overlapping Change Items view is not automatically
updated. You can manually refresh the information by clicking the Refresh
button in the top right corner, or you can simply close and re-open the
view.
not see the old/new values if you are not authorized.
3.4.6 Viewing/Modifying Project Details

To view the change items belonging to a project, perform any of the steps
below:
project, and choose Project Details from the context menu.
• From the Project view, right-click on a project, and choose Project
Details from the context menu.
• From the Workspace Explorer, right-click on a project ID, and choose
Project Details from the context menu.
A dialog box appears that displays the change items that belong to the
project. There is header information that identifies which project is being
viewed. By default, the change items are sorted by the change item order.
The dialog box displays the order, operation, table ID, path name,
column ID, old value, new value, created by, and creation date.

There are two views of the project details: ungrouped and grouped.
The ungrouped view shows each individual change item in the project in
the order they were created. Right-clicking shows a context menu of
available options, including the “Group” option.
Figure 50: Project Details View (Ungrouped)

The grouped view organizes the display by record. Each record can be
expanded to show the change item details related to the record. Right-
clicking shows a context menu of available options, including the
“Ungrouped” view.
Figure 51: Project Details View (Grouped)

not see the old/new values if you are not authorized. Also, change items
related to graphic layout are intentionally not shown on this view.
The change items within a project can be modified or deleted, subject to
certain restrictions. If the project is not currently loaded into any
workspace, then you can edit a change item’s value or delete change
items.
To edit a change item’s value, right-click the desired change item, and
choose Edit from the context menu. If the Edit option is disabled, the
project is probably loaded in a workspace; therefore, edits are not
allowed. The following dialog box appears:

Figure 52: Edit Change Item Dialog Box
To delete a change item, right-click the desired change item, and choose
Delete from the context menu. You can also delete multiple change items
by:
• Left-clicking to choose a single change item
• Left-clicking on the first change item, then <Shift> left-clicking on the
last change item to choose a contiguous range of change items
• <Ctrl> left-clicking to choose noncontiguous change items
Then right-click, and choose Delete from the context menu.
Note: Use extreme care when modifying or deleting change items, as the
changes cannot be undone. It is highly advisable that you make a copy of
the project before you attempt to edit its change items.
3.4.7 Viewing the Project Audit Log

e-terrasource keeps an audit log of changes made to project properties.
Each time a project property is modified, an entry is added to the audit
log.
To view the audit log for a project, right-click on the project ID on the
home page, Workspace Explorer, or Project view, and choose Detailed
Audit Log from the context menu.
A grid display is shown, which lists all previous modifications made to the
project. By default, the grid display lists the most recent change at the top,
although you can sort the data by clicking on the desired column header.

Figure 53: Project Audit Log
When the data is ordered by modification date, as is the default, the
changes that were made can be determined by comparing the data in
successive rows. In addition to listing each property of the project, the
following columns provide additional auditing information:
• Modified By – User making the change
• Modification Date – Time at which the change was made
• Created By – User who initially created the project
• Creation Date – Time at which the project was created
• Audit System User – Operating system user making the change
• Audit Module – Process making the change. This is normally empty
unless e-terrasource has certain debugging flags enabled.
• Audit Host – Identification of the server from which the change was
made
3.4.8 Viewing Project Activity

The information in the Activity Log can be filtered for a particular project
using one of the following methods:
project, then click Activity Log.
• From the Project view, right-click the project, then click Activity Log.
• From the Workspace Explorer, right-click the project, then click Activity
Log.
the selected project.
3.4.9 Updating Change Item Path Names

It is important to know that the path name shown for a change item is
initially determined at the time the change item is created. If changes are
made to a record subsequently that affect the path name, the path name
on previously created change items is not changed. If you want to update
the path names on the change items, right-click the project (on the home

page, Project view, or Workspace Explorer), and choose Update Path
Names. A project must be loaded into a workspace in order for the path
names to be updated.
3.4.10 Loading Projects

e-terrasource allows users to load desired projects (model changes) into
their workspace in an order of their choosing. Users can apply filter criteria
to view a list of candidate projects, and then specify the order in which
they should be loaded.
As projects are loaded, the edits specified by its change items are
performed in order against the current contents of the workspace. If a
change item cannot be applied successfully, it is reported on the
Unapplied Change Items view. If a change item happens to overlap with a
change item in another loaded project, it is reported on the Overlapping
Change Items view. If the loading of projects results in additional
overlapping or unapplied change items, a warning message is displayed.
To load a project, use one of the following methods:
• From the Project view, right-click the desired project and click Load.
In this case, the selected project is immediately loaded.
• From the drop-down list on the toolbar’s Load button, choose Project.
In this case, the Load Project dialog box appears, which allows you to
choose multiple projects to load, and also to determine the order in
which they are loaded.

Figure 54: Load Project Dialog Box
The left pane lists the projects that meet the filter criteria. One or more
projects in the left pane can be highlighted and added to the list of
projects to load (in the right pane) by clicking the button. If you change
your mind, a project in the right pane can be removed from the list by
clicking the button. You can add all of the projects on the left side to
the list of projects to load by clicking the button, or remove all of the
projects from the list by clicking the button. The sequence in which the
projects are loaded can be adjusted by clicking the Up/Down
buttons that appear when you hover the cursor over a project. The
projects are loaded from top to bottom when the OK button is clicked.
To filter the list of projects that are shown, perform the following steps:
1. Click the Filter button.
2. Enter the desired filter criteria.
In the ID, Name, and Description fields, the asterisk (*) can be used as
a wildcard character.
3. Click OK to apply the filter to the Load Project dialog box.

Figure 55: Projects Filter Dialog Box
The filter settings are saved as user preferences, and are also used to
filter the projects that are shown in both the Project view as well as the
Timeline section of the home page.
3.4.11 Unloading Projects

A project can be unloaded from a workspace using one of the following
methods:
desired project, and choose Unload.
• From the Loaded Projects node of the Workspace Explorer, right-click
the desired project, and choose Unload.
selected project checked. After reviewing the check boxes, click OK to
proceed with the unload operation.

Figure 56: Unload Project Dialog Box
not reloaded.
3.4.12 Creating a Project

A new project should be created for every related group of model changes
that take effect at the same time.
New projects can be created by clicking the New toolbar button, then
choosing Project from the drop-down list.
A dialog box appears that allows the user to enter the project ID, name,
description, business model schema, associated model authority set type,
state, and effective date. Also, any custom project attributes can be
entered as well, such as the Category attribute in Figure 57.
If you set a model authority set type for the project, then all newly created
records that are saved to the project are assigned to the model authority
set type specified here. If you leave the project’s model authority set type
null, then newly created records are assigned to the default model
authority set type that is specified in the toolbar.

Figure 57: New Project Dialog Box
When the user clicks OK, three operations are performed:
• If you have the CreateProject privilege, the project is created.
• If you have the LoadWorkspace and ReplaceProject privileges, if the
workspace is not locked, and if you own the workspace, the project is
loaded into the workspace.
• The active project is set to the newly created project.
If any of these operations fail, the subsequent steps are not performed.
Note that the project ID and name must be provided and must be unique
among all projects.
3.4.13 Deleting a Project

Projects can be deleted from the Project view by right-clicking the desired
project, and choosing Delete from the context menu.
Note: It is not possible to delete a project from the Workspace Explorer,
because it is illegal to delete a project that is currently loaded in any
workspace.
Confirm that you want to delete the project from the dialog box that
appears.

3.4.14 Copying a Project
It is sometimes useful to copy a project — for example, in the event that
you want to split a project into two or more pieces. You can copy a project
and then delete the desired change items from the source project and the
new copy. This is a task best left to experienced users because there can
be some dependencies between change items that require careful editing.
Projects can be copied from the Project view or Workspace Explorer by
right-clicking the desired source project, and choosing Copy from the
context menu.
Confirm that you want to copy the project from the dialog box that
appears.
When a project is copied, the new project ID and name are prefixed with
“Copy of”. If this is not unique, the new project is prefixed with
“Copy <n> of”, where <n> is a number that makes the ID and name
unique. You can then change the ID and name on the new project’s
property sheet.
Also, note that the newly created project is not loaded into any workspace.
3.5 Snapshots
Note: The Snapshot feature is disabled by default when e-terrasource is
installed. Due to the limitations discussed below, use of snapshots is not
recommended. The feature is retained for backward compatibility with
e-terrasource 1.0, but snapshots are a deprecated feature that will be
removed in a future release. For information about how to enable
snapshots, refer to the e-terrasource Software Installation and
Maintenance Guide.
Snapshots are a mechanism for recording the contents of all workspace
data. A snapshot of a workspace can be taken prior to a potentially risky
or destructive operation, and then restored afterwards to revert to the
workspace’s original state.
When a snapshot is created, the database makes a copy of:
• The contents of all workspace tables
• The list of loaded models, model authority sets, and projects
• The list of unapplied change items
When a snapshot is restored, these items are used to restore the
workspace to its previous state.
Keep in mind that:

• Snapshots are not intended to be used as a mechanism to transfer
model data between different database environments.
• Any changes that are saved to projects after the snapshot is taken are
not restored/undone if the snapshot is restored. Therefore, it is
recommended that a new active project be created after a snapshot is
created so that the “risky” changes are isolated in a separate project.
For each snapshot, a database user/schema is created; therefore,
snapshot creation requires elevated database privileges. For information
about “runtime” versus “administrative” privileges, refer to the
e-terrasource Software Installation and Maintenance Guide. Your
administrator may have disabled the snapshot feature.
Remember that creating model authority sets and projects are the only
recommended ways of saving model changes. Snapshots should not be
viewed as a substitute for using projects and model authority sets.
3.5.1 Creating a Snapshot

Snapshot creation requires elevated database privileges; therefore, it is
possible that your administrator has disabled the snapshot feature.
To create a snapshot:
1. Click View > Snapshots View to display the Snapshots grid display.
2. Right-click the body of the grid, and choose New Snapshot from the
context menu.
The New Snapshot dialog box is displayed.
3. Enter the required fields, as indicated by an asterisk (*), and click OK.
A new snapshot is created with the given ID.

Figure 58: New Snapshot Dialog Box
The following properties are available in the dialog box:
• Name: You must enter a name for the snapshot.
• Workspace: You must specify the workspace that is the source of the
snapshot.
• Description: You can optionally enter a description of the snapshot.
3.5.2 Viewing/Restoring Snapshots

The Snapshots view is used to view information about available
snapshots, and to restore them into workspaces.
To display available snapshots, click View > Snapshots View. The
Snapshots grid display is shown:
Figure 59: Snapshots View

To restore a snapshot into a workspace, right-click the desired snapshot,
and choose Restore Snapshot from the context menu. Click OK in the
confirmation dialog box.
WARNING: Restoring a snapshot causes the workspace to be reset and

then repopulated from the data contained in the snapshot. Be sure that
you will not lose any work before restoring a snapshot.

3.5.3 Removing a Snapshot
When a snapshot is no longer needed, it can be removed using the
Snapshots view.
To display available snapshots, click View > Snapshots View. The
Snapshots grid display is shown.
To remove a snapshot, right-click the desired snapshot, and choose
Remove Snapshot from the context menu. Click OK in the confirmation
dialog box.
WARNING: Removing a snapshot causes the database user/schema

holding the snapshot data to be dropped. Be sure that you will not lose
any work before removing a snapshot.
3.6 Viewing and Modifying Models

There are four basic types of displays that can be used to edit the model
data: tree views, property sheets, grid views, and the Graphic Modeler.
In addition, there are two special-purpose displays for model data:
• Linkage displays – These displays are used to assist the user in
viewing and assigning relationships between records.
• Curve displays – These displays are used to view and modify X-Y
curve data, and they provide a graphic depiction of the modeled curve.
3.6.1 Tree Views

The tree view is primarily a navigation aid for viewing records that have
hierarchical relationships. However, it is also useful for inserting, deleting,
and copying records in a hierarchy. These functions are available on the
context menu, which is shown when you right-click on a node. Note that
not all options are available for every node in the tree view.

Figure 60: Tree View with Context Menu
Because it is a navigation pane, tree views are docked at the left side of
the interface. You can “tear off” the entire pane by clicking the pane’s title
bar and dragging it off the viewport. Alternatively, you can “tear off” a
single tab of the pane, by clicking the tab name on the bottom of the pane
and dragging it off the viewport. For example, to tear off the Alarm pane in
the figure above, click on Alarm, drag the cursor off the viewport, and
release.
The text label for a tree node is usually an enterable text field from the
record (such as the record’s Name field), but it might be labeled with a
calculated field. Keep in mind that calculated fields are only updated when
change items are saved, so the tree node label may not update until you
save your changes.
3.6.1.1 Navigation
Tree nodes can be expanded by clicking the “+” symbol, and closed by
clicking the “-” symbol. Clicking on a folder displays a grid view of the child
records. Clicking on a node displays the property sheet for the record.
3.6.1.2 Show in New Tab
If you click a node in the tree view, the property sheet corresponding to
that record is displayed without opening a new tab. If you want the
property sheet to be opened in a new tab, choose this option from the
context menu.

3.6.1.3 Show in New Tree
If you click this option, a new tree view is created with the selected record
at the top of the tree view. This feature can be useful when navigating
deep within a tree view. Instead of widening the tree view to
accommodate the depth, you can create a new tree view at the desired
depth.
Figure 61: Show in New Tree Used to Create a New Substation Tree View
3.6.1.4 Show References

The Show References option is a useful feature for obtaining a grid view
of all child records that “point to” a parent record. When Show References
is chosen, a submenu is displayed that lists every possible type of child
relationship the record may have. Selecting one of the child relationships
displays a grid view of the child records that point to this parent record.
Figure 62: Show References

3.6.1.5 Insert
The Insert option displays a submenu that lets you choose the type of
child record to insert under a parent record. If you want to insert a new
top-level record, right-click the top node in the tree view (which is a
dummy node that is labeled with the name of the tree view), and choose
Insert. For example, to insert a Geographical Region record on the
Network tree view, right-click the top Network node, and choose Insert >
GeographicalRegion.
The new record is inserted as a child of the parent record, its name is set
to “New Item n”, and any fields with default values specified are filled. The
remaining fields of the child record are left null. In some cases, the field
used to label the record is too small to hold the label “New Item n”, so the
label is shortened to “Nx”. In some rare cases, it is possible that a label
may not be generated at all.
3.6.1.6 Delete
The Delete option deletes the selected record and any other child records
that are contained by it.
WARNING: When a parent record is deleted, all child records “contained

by” the parent are also deleted whether they are displayed on the tree
view or not. The determination of what children are “contained” by a
parent is made in the business model metadata when defining
relationships between parent tables and child tables. A confirmation dialog
box is shown that lists the possible first-level children that are to be
deleted, but keep in mind that all children, grandchildren, etc., of the first-
level children are also deleted.
Also, the change item simply reflects that the parent record is to be
deleted; it does not specifically list the child records that are
consequentially deleted. Therefore, if this project is applied to different
model authority sets, it may actually delete a different total number of
records.
For example, if a project deletes an entire substation, that may result in

deleting 100 records when applied to model authority set version 15 and
105 records when applied to model authority set version 16.
3.6.1.7 Copy/Paste
The Copy option marks the record as the source for a subsequent paste
operation. After choosing Copy, you must next select the parent record
where the Source record should be copied to as a child, then choose
Paste from the parent record’s context menu. The Source record is copied
under the new parent, and its name is changed to “Copy of xxx”. In some
cases, the field used to label the record is too small to hold the label

“Copy of xxx”, so the label is shortened to “Cnxxx”. In some rare cases, it
is possible that a label may not be generated at all.
You cannot use drag and drop to copy a record.
Caution: Copy/paste operations only copy a single record, not a record

hierarchy. Deep Copy must be used to copy a hierarchy of records. Also,
the Paste option is disabled if the Source record cannot be a child of the
paste target. The Paste option is enabled only for records that can be a
parent of the Source record.
3.6.1.8 Clone
The Clone option is a copy-and-paste operation combined into a single
step. The Source record is duplicated (cloned) under the same parent
record, and its name is set to “Copy of xxx”. In some cases, the field used
to label the record is too small to hold the label “Copy of xxx”, so the label
is shortened to “Cnxxx”. In some rare cases, it is possible that a label may
not be generated at all.
Caution: The clone operation only copies a single record, not a record
hierarchy. Deep Copy must be used to copy a hierarchy of records.
3.6.1.9 Deep Copy

Some records in the tree view may have the Deep Copy option available
in the context menu. Deep Copy is a hierarchical copy operation, which
must be followed by a paste operation. The paste operation copies the
source record and its children, grandchildren, etc., to the target location.
When pasting, only the top-level record’s identifier changes; identifiers for
children records are unchanged. In some modeling scenarios, children
identifiers may be dependent on the parent identifier; therefore, you may
need to manually correct the children identifiers after pasting.

Figure 63: Deep Copy
Caution: The depth of the copy is determined by configuration metadata,
as well as the specific properties that should be copied. Also, the Paste
option is disabled if the Source record cannot be a child of the paste
target. The Paste option is enabled only for records that can be a parent
of the Source record.
The Deep Copy operation can also be used to create a new template.
After choosing the Deep Copy option on the Source record, you can then
paste on a template group in the Template Explorer. By doing so, the New
Template dialog box is displayed.

Figure 64: Template Creation Using Deep Copy
After filling in the Template ID and clicking OK, the Source record’s
hierarchy is used to create a new template (for more information, refer to
section 3.6.7 Templates).
3.6.1.10 Moving Records
There are three ways to move a child record from one parent to another.
The first method is to:
1. Click the record to display the property sheet.
2. Find the relationship to the parent record, and use the FK editor to
select the new parent.
The second method is to drag and drop the new parent to the relationship
property in the child. For more information, refer to the Relationship bullet
item in section 3.6.2.3 Properties.
The third method is to click and hold to drag the child record and drop it
on a new parent record in the tree view.

3.6.1.11 Graphic Modeler
The Graphic Modeler option is available on selected records in the
Network tree view to provide the following schematic displays:
• DC Line Overview – This overview of DC components can be
obtained by right-clicking on a Geographical Region, and choosing
Graphic Modeler > DC Line Overview.
• Substation Overview – This overview of substations and their AC line

connections can be obtained by right-clicking on a SubGeographical
Region, and choosing Graphic Modeler > Substation Overview.

• Substation Detail – This detailed view of a substation can be
obtained by right-clicking on a Substation, and choosing Graphic
Modeler > Substation Detail.
• Voltage Level Detail – This detailed view of a voltage level can be

obtained by right-clicking on a Substation or Voltage Level, and
choosing Graphic Modeler > Voltage Level Detail.
For further information, refer to section 3.6.4 Graphic Modeler.

3.6.1.12 Export to Excel
Most tree view records have two options to Export to Excel on the context
menu:
• Choose Tables – When this option is chosen, a dialog box is
presented that allows the user to choose the tables to export. The
choices are retained in your user preferences.
• Entire Hierarchy – When this option is chosen, all tables in the
hierarchy are exported. With large hierarchies, this can be time-
consuming.
A standard Save File dialog box is shown, which allows you to choose the
name and location of the Excel file. Clicking OK in the Save File dialog
box begins the export of the hierarchy to Excel.
The Excel file contains the data for the parent record, as well as data for
each selected child record type in the tree view.
For more information, refer to section 3.6.8 Modeling in Excel.
3.6.2 Property Sheets

Property sheets for model data can be displayed in several ways:
• Clicking a node on a tree view displays the property sheet for the
record in the center pane.
• Right-clicking a grid row on a grid display and choosing Properties
displays the property sheet for the record in the auxiliary pane on the
right.
• Right-clicking a symbol on a Graphic Modeler display and choosing
Show Property Sheet displays the property sheet in the auxiliary pane
on the right.
• Clicking the button on a validation message displays the property

sheet for the record in the auxiliary pane.
• Clicking the button on views such as Project Details, Overlapping

Change Items, and Unapplied Change Items displays the property
sheet for the record in the auxiliary pane.
The tab that displays the property sheet can be repositioned or “torn off”
(for more information, refer to section 2.3.1 Working with Panes).
The name of the property sheet in the tab strip identifies the table and
path name of the record.

Figure 65: Property Sheet
3.6.2.1 Header Information

The top portion of the property sheet contains several notable items:
• The e-terrasource Master Resource Identifier (MRID) of the record is
displayed. This identifier is unique among all records in the model. It is
also referred to as the “CSM MRID”, which is not to be confused with
the “CIM MRID”.
• The model authority set type to which the record is assigned is
displayed. You can use the selector to change the model authority set
type assignment for the record. If you change the assignment, it takes
effect when future model authority sets are created. In other words, if
you reassign a record from model authority set type A to B, the next
time a B model authority set is created, this record is included in it.
However, any model authority sets of type A that were created in the
past still contains the record.

If you set a model authority set type for the active project, all newly
created records that are saved to the project are assigned to the
model authority set type specified there. If you leave the active
project’s model authority set type null, newly created records are
assigned to the default model authority set type that is specified in the
toolbar.
WARNING: The model authority set type assignment for each record
is tracked independently of model data; it is not like model data
properties that are captured in model authority sets and projects. The
model authority set type that is shown represents the current
assignment of the record, and this is a characteristic of the record that
is independent of workspaces. If the model authority set type
assignment is changed by a user, the new assignments takes effect
immediately and is visible across all workspaces and for all users.
• The Show Only Required Properties check box allows you to toggle
between showing all properties or only required properties.
• If you right-click anywhere in the header, a context menu appears that
contains the following options:
− Modify Security – For tables that use row-level security, this option
can be used to view and configure the security settings for the
record (for information regarding data security, see chapter 5 Data
Security). This option is not shown for tables that use table-level
security.
− Show In Tree – Select this option to expand the tree view so that it
is synchronized with the record that is shown on the property sheet.
− Show Children – This option splits the property sheet into top and
bottom portions. The top portion continues to show the original grid
view, whereas the bottom portion shows a tab group, with each tab
containing a grid for a child record type.
− Show References – This option is a useful feature for obtaining a
grid view of all child records that “point to” a particular parent
record. When Show References is chosen, a submenu is displayed
that lists every possible type of child relationship the record has.
Selecting one of the child relationships displays a grid view of the
child records that point to this parent record.

Figure 66: Property Sheet Header
3.6.2.2 Property Groups

The properties of a record are organized into a hierarchy of property
groups, which can be expanded or collapsed using the and
buttons.
The assignment of properties to property groups, as well as the ordering
of properties within property groups, is defined in the metadata. The
metadata can also be configured so that certain properties or property
groups are never displayed.
The metadata also assigns property groups to zero or more modeling
subsystems, or domains: Network, Generation, SCADA (Supervisory
Control and Data Acquisition), or DTS (Dispatcher Training Simulator).
You can choose to show or hide all property groups for a domain in the
User Preferences dialog box. For example, you can hide all property
groups related to the Generation domain (from both property sheets and
grid views) by unchecking a single check box in the User Preferences
dialog box (for details, see section 2.7 User Preferences).
For further information about controlling the appearance of property
groups, refer to the e-terrasource Metamodel Guide.
Figure 67: Nesting of Property Groups

3.6.2.3 Properties
Each property within a property group is listed with a label and a value,
and, if applicable, a unit of measure. Fields that are required for validation
purposes are marked with an asterisk (*) next to the label. Hovering the
cursor over the label displays a tool tip with a detailed description of the
property. Hovering the cursor over the value displays a tool tip with
additional information, such as the property ID, description, data type,
maximum length, and default value.
Figure 68: Property Tool Tip

Note that individual properties can be configured to be hidden from view.
In some cases, user entry of a particular property is conditional on some
other property. For example, a property called “FileName” might be
enterable only if another property called “WriteToFile” is true.
For further information about controlling the appearance of properties,
refer to the e-terrasource Metamodel Guide.
Properties can be of several types:
• Text/Numeric – Simple text and numeric properties are enterable in a
text box. Text boxes are typically single-line, but can be multi-line for
larger text fields. Data entry is limited to the maximum length of the
property.
• Relationship – Properties that define a relationship must point to

another record. Clicking the button displays a combo box, which
allows you to select the desired target record. Clicking the button
displays the property sheet of the target record.
By filling a relationship from a child record to a parent record, you are
effectively “moving” the child record to belong to the parent.
There are two types of relationship combo boxes. The first type is used
to fill a single relationship between a child record and its parent.

The second type of combo box requires the selection of both a parent
type and a parent record. This type of relationship is used when a child
can possibly belong to many types of parents.
In both types of combo boxes, you can filter the list box by typing in the
Filter field. In most cases, the Filter field is initialized with an
asterisk (*), but it is also possible to define an “auto-filter” in the

metadata. For more information, refer to the e-terrasource Metamodel
Guide.
Relationships can also be filled by dragging the desired parent/target
record and dropping it into the child’s relationship property. To do so,
use the following steps:
− Locate the desired parent record in a tree view or grid view.
− In the tree view, click and hold the parent record node. In a grid
view, click and hold the gray Row Selector button in the first column
of the grid.
− Drag the cursor to the desired relationship property on the child
record’s property sheet.
If the drop location is legal, the cursor changes to a shortcut
symbol. If the drop location is not legal, the invalid cursor symbol
is shown.
• Date/DateTime – Date or Date/Time fields can be entered by
modifying the character string, or by clicking the drop-down symbol
and using the calendar control.
• Picklist – Properties that are restricted to a specific set of values have

a drop-down symbol that lists the legal values.
• Calculated – Properties that are calculated are disabled from entry by

the user. If model changes are made that affect a calculated property,
the calculated property’s value is not updated until the model changes
are saved to a project.

WARNING: Since calculated properties are not entered, project
change items are not created for calculated properties. This is
important to remember when viewing project details or exporting a
project, because calculated properties are not shown.
• URL – Properties that are intended to contain URLs are very similar to
simple text fields; however, there is a button to the right of the text box
that supports navigation to the URL (if it is a valid, accessible URL).
Examples of URLs are:

− http://www.grid.alstom.com – Opens a Web site in the default
browser
− file:///d:/temp/MyDocument.doc – Opens a Word document
− mailto:john.doe@acme.com – Creates an e-mail
− ftp://ftp.acme.com – Connects to an FTP site
WARNING: When editing a property, the edit is captured as an unsaved

change item only if you leave the field by using the <Tab> or <Enter>
keys, or click elsewhere in the property sheet. It is important to remember
that clicking on a toolbar or menu item immediately after editing a property
does not capture the edit as an unsaved change item.
3.6.3 Grid Views

Grid views are used for displaying records from the same table. Grid
views can be called up by:
• Using the Tables Explorer to show records for any table.
• Clicking folder nodes on a tree view to display a grid of all children of a
particular type for a parent record.
• Using the Show References option on a context menu to display all
child records of a specific type for a particular parent.
• Using the Show Children option on a context menu to display all child
records of all types for a particular parent. Each child type is shown in
a separate tab.
• Using the Search dialog box to display a grid of search results (for
more information, refer to section 3.6.6 Search Dialog Box).

Figure 69: Grid View with Context Menu
The name of the grid view in the tab strip indicates whether it is displaying
all records, or only the child records for a specific parent.
The data on the grid display is shown in pages, based on the page size
specified in the user’s preferences (see View > User Preferences for the
page size). The top of the grid display has the following information:
Button Description
Click this button to go to the first page. The
button is disabled if you are currently on the
first page.
Click this button to go back one page. The
first page.
This box displays the current page number.
You can enter a number here to jump directly
to a specific page.
Click this button to go forward one page. The
last page.
Click this button to go to the last page. The
last page.

Button Description
This displays the total number of pages and
the total number of records.
Click this button to refresh the information on
the grid display.
Warning: Grid displays must be refreshed
manually by clicking the Refresh button.
The column headers on grid views contain both the label and unit of
measure (if applicable) for the property. You can click on a column header
to sort by that column in either ascending or descending order.
The column ordering in grid views matches the ordering on property
sheets, with the exception that the leftmost property is the record’s path
name and it is locked when scrolling horizontally. However, you can
reorder the columns by dragging the column header to a new location.
If you reorder the columns or change the column widths, this is stored in
your preferences, so the widths and ordering are the same the next time
you call up the grid.
WARNING: If you resize a column width so that it is no longer visible, you

will not be able to see the column again. To recover from this situation,
you must reset the stored grid preferences. This can be done in two ways:
First, you can use View > User Preferences and set the grid attribute
preservation to 0 and click OK — but this erases all preferences for all
grids.
Second, you can go to the C:\Documents and Settings\<user>\Application

Data\Eterra\Presentation Framework\e-terrasource\GridSchemas folder,
and delete the XML file associated with the desired grid.
The first column in the body of the grid is an indicator that can be used to
select a row and view its status.
Indicator Description
The “new record” indicator is shown only on
the first row of the grid. To create a new
record, locate this record at the top of the grid
and begin filling in its cells. When you press
Enter, the new record is created and moves to
the main body of the grid. Refer to section
3.6.3.3.1 Inserting Records for more
information.

Indicator Description
The “editing” indicator appears when you start
typing in a record’s cell. Refer to section
3.6.3.3.3 Modifying Records for more
information.
The “selected record” indicator appears on the
row that currently has focus.
For all other records, the indicator is blank:
• You may click the button to select the
entire (single) record.
• You may select consecutive records by
clicking the button on one record, and then
pressing Shift while clicking the button for
another record. The range of records
between the first and last will be selected.
• You may select non-consecutive records by
clicking the button on the first record, then
pressing Ctrl while clicking the button on
each additional record.
After one or more records have been selected,
you can press the Delete key to delete all of
them. For more information, refer to section
3.6.3.3.2 Deleting Records.
The metadata assigns property groups to zero or more modeling

subsystems or domains: Network, Generation, SCADA (Supervisory
Control and Data Acquisition), or DTS (Dispatcher Training Simulator).
You can choose to show or hide all property groups for a domain in the
User Preferences dialog box. For example, you can hide all property
groups related to the Generation domain (from both property sheets and
grid views) by unchecking a single check box in the User Preferences
dialog box (for details, see section 2.7 User Preferences).

3.6.3.1 Tables Explorer
The Tables Explorer provides a mechanism to access grid displays for all
tables in the model. Simply click the Tables link in the toolbar to display
the Tables Explorer.
Figure 70: Tables Explorer

The Tables Explorer lists all tables in a hierarchical fashion. If you hover
the cursor over the name of a table, a tool tip is shown that provides a
detailed description of the table.
3.6.3.2 Nested Grids
Each record on a grid display has a button on the left side of the grid.
Clicking this button causes one or more nested grids to be queried and
displayed. There is one nested grid shown for each possible type of child
that the parent record may have.
Figure 71: Expansion of a Nested Grid

The figure above shows a parent OperationalLimitSet, with child
OperationalLimit records.
Only one level of nesting is supported. In other words, the records in the
child grid cannot be further expanded.

3.6.3.3 Editing
Grid views allow records to be inserted, deleted, and modified.
3.6.3.3.1 Inserting Records
New records can be created on a grid view by filling in the top row of the
grid, which is marked with an asterisk (*) in the leftmost column.
Keep in mind that cells that are shaded gray represent non-enterable
properties. Text and numeric properties have a simple text box for editing,
and date or date/time properties have a calendar control.
Properties that represent relationships to other records have two buttons
in the cell. Clicking the button brings up a combo box, which allows you
to select the desired target record. Clicking the button displays the
property sheet of the target record.
Once you press the Enter key, the new record moves from the top row
down into the main body of the grid. The Unsaved Change Items view
updates to reflect the addition of the new record. You must click Save to
save the new record to the active project.
If you also are displaying a tree view, keep in mind that a record inserted
on a grid is not properly reflected on a tree view until:
• The record’s relationship to its parent is filled.
• The property used as the tree node label (e.g., Name) is filled.
Caution: If you are viewing a filtered grid (e.g., only children of a specific
parent) and the newly inserted record does not meet the filter criteria, then
when you press Enter, the record disappears from view. However, it is still
created.
3.6.3.3.2 Deleting Records

Records can be deleted from a grid view by simply selecting the desired
row and pressing the Delete key, or right-clicking the row to display the
context menu and choosing Delete.
Multiple records can be deleted by selecting the desired consecutive or
non-consecutive rows and pressing the Delete key. Refer to section
3.6.3 Grid Views for more information about using the indicator column to
select multiple records.
WARNING: When the record to be deleted is a parent of other records, all

child records “contained by” the parent are also deleted, even though they
are not shown on the grid view. The determination of which children are
“contained” by a parent is made in the business model metadata when

defining relationships between parent tables and child tables.
Also, the change item simply reflects that the parent record is to be
deleted; it does not specifically list the child records that are
consequentially deleted. Therefore, if this project is applied to different
model authority sets, it may actually delete a different total number of
records. For example, if a project deletes an entire substation, that may
result in deleting 100 records when applied to model authority set
version 15 and 105 records when applied to model authority set
version 16.
3.6.3.3.3 Modifying Records

Records can be modified on a grid view by simply typing in new values
over existing property values. If you begin typing and then change your
mind, you can press the Escape key to revert to the original value.
Keep in mind that cells that are shaded gray represent non-enterable
properties. Text and numeric properties have a simple text box for editing,
and date or date/time properties have a calendar control.
Properties that reference other records have two buttons in the cell.
Clicking the button brings up a combo box, which allows you to select
the desired target record. Clicking the button displays the property
sheet of the target record.
3.6.3.3.4 Copying Records
Records on grid views can be copied and pasted to create new records
using the following method:
1. Find the desired source record on the grid, click the indicator column,
and press Ctrl + C to copy it.
You must use the keyboard shortcut to perform the copy because the
Copy option on the context menu copies only a single cell, not the
entire record.
2. Create a new empty record using the steps described in section
3.6.3.3.1 Inserting Records.
3. Locate the new record, click the indicator column, and press Ctrl + V to
paste the cell values from the source record to the new record.
3.6.3.3.5 Moving Records
To move a child record from one parent to another:
1. Find the relationship property to the parent record.
2. Use the FK editor to select the new parent.

3.6.3.4 Range Value
The Range Value feature allows you to select a range of cells in a column,
and enter a value that applies to all of the selected cells.
To use the Range Value feature:
1. Use the mouse to click the first cell in the range.
2. Use the mouse to Shift-click the last cell in the range.
3. At the bottom of the grid, enter the desired value for the range, then
click the green arrow button to fill the cells with the value.
The Range Value feature can be particularly powerful when used in

conjunction with the Search dialog box. If you have a particular set of
records for which you want to change a property, you can first use the
Search dialog box to locate the desired records. Then, on the search
results grid, you can select the desired range of cells and use the Range
Value feature to update all the values.

Figure 72: Range Value on Search Results
3.6.3.5 Show References

The Show References option is a useful feature for obtaining a grid view
of all child records that “point to” a particular parent record. When Show
References is chosen for a particular parent row, a submenu is displayed
that lists every possible type of child relationship the record has. Selecting
one of the child relationships displays a grid view of the child records that
point to this parent record.

3.6.3.6 Show Children
The Show Children option splits the center pane into top and bottom
portions. The top portion continues to show the original grid view, whereas
the bottom portion shows a tab group, with each tab containing a grid for a
child record type.
Figure 73: Show Children

3.6.3.7 Properties
The Properties option on the context menu displays the property sheet for
the selected row. The property sheet is opened in the auxiliary pane on
the right side of the viewport.
Figure 74: Grid View with Properties in Auxiliary Pane

3.6.3.8 Sorting
Sorting by a single column can easily be accomplished by clicking the
column header. An arrow appears on the right side of the column header,
which indicates the direction of the sort (ascending vs. descending).
Clicking the column header again reverses the direction of the sort.
More complex sorting, involving ascending or descending sorts of multiple
columns, can be accomplished by choosing the Sorting option in the
context menu. The Grid Sorting dialog box is shown, which allows you to
choose multiple columns for sorting and choose the sort direction for each
column.
Figure 75: Grid Sorting Dialog Box

The sort can be canceled by choosing the Clear Table Sorting option in
the context menu, or by choosing Clear All in the Grid Sorting dialog box.

3.6.3.9 Show/Hide/Re-Order Columns
Columns can be re-ordered on the grid by simply dragging the column
headers to the left or right and dropping them in the desired location.
You can also choose to hide specific columns using the Show/Hide option
on the context menu.
Figure 76: Show/Hide Columns Dialog Box

Simply uncheck the box next to a column to hide it from the grid view, or
check the box to have a hidden column show again.
3.6.3.10 Export to Excel
The current grid page can be exported to Microsoft Excel using the Export
to Excel option. If you have more than one page of data that you want to
export, you can increase your grid page size using View > User
Preferences.
Any columns that are hidden on the grid display are also hidden in the
Excel workbook.
After choosing this option, a standard Save File dialog box is shown,
which allows you to choose the name and location of the Excel file.
Clicking OK in the Save File dialog box begins the export of the grid data
to Excel.
For more information, refer to section 3.6.8 Modeling in Excel.

3.6.3.11 Printing
The context menu contains options for printing the grid data. There are
fairly straightforward options for page setup, print preview, and print.
3.6.3.12 Required Only Properties
This option can be chosen from the context menu to toggle between
showing all columns or only required columns on the grid.
3.6.4 Graphic Modeler

The Graphic Modeler component of the user interface provides several
schematic views of the electrical network:
• Substation Overview – This overview display shows all of the
substations within a SubGeographicalRegion and the
ACLineSegments that connect them. The substations can be overlaid
on a geographical map based on their latitude/longitude.
• DC Line Overview – This overview display shows the DC network
within a GeographicalRegion. Substations, DCConverters, and
DCLineSegments are shown.
• Substation Detail – This schematic display shows the detailed model
of a single substation and its connected equipment regardless of
voltage level.
• Voltage Level Detail – This schematic display is very similar to the
substation detail except that it displays a single voltage level within a
substation.
• SCADA Topology – This schematic display enables the user to
maintain mixed network and SCADA equipment, or SCADA-only
topology information.
In order for the Graphic Modeler to properly generate a schematic display,
the underlying records should be saved to the database. So, for example,
if you create a new substation via a Deep Copy operation, you should
save your changes before attempting to view the Substation Detail or
Voltage Level Detail displays for the new substation.
3.6.4.1 Graphic Modeler Toolbar
When any of the Graphic Modeler schematic displays are viewed, the top
of the pane displays the following toolbar:
Figure 77: Graphic Modeler Toolbar

The toolbar contains the following buttons:
Button Description
Click to navigate back to the previous schematic display that
was called up, if there is one.
Click to navigate forward to the next schematic display that
was called up, if there is one.
Click to refresh the display with fresh data from the database.
Click to center the diagram in the pane.

Click to print the current schematic display.
Click to open the same diagram in another tab.
Click to undo the last changes to the graphic layout.

Click to redo the last changes to the graphic layout.
Click to display the security list for all items on the view. Click
again to hide the security list.
Click to display the Graphic Modeler Configuration Editor (for
more information, refer to section 6.1 Graphic Modeler
Configuration Editor).
Click to display a Clipboard Scratchpad in a new window (for
more information, refer to section 3.6.4.17 Clipboard
Scratchpad).
Click to open a Find dialog box to locate items on the
schematic display based on the item’s label.
3.6.4.2 Graphic Modeler Context Menus

The Graphic Modeler provides context menus on the entire canvas, as
well as with symbols, nodes, and regions.
3.6.4.2.1 Canvas Context Menu
If you right-click on the canvas, a context menu is displayed with the
following choices:
• Find
− Find – Choose this option to open the Find dialog box to locate
items on the schematic display based on the item’s label.
− Find Next – Choose this option to find the next occurrence.

• Edit
− Paste – Choose this option to paste a previously copied selection
onto the schematic display. The copy can have originated on a
schematic display or the Template Editor.
• Deep Copy – For more information, refer to section 3.6.4.19 Deep
Copying Items.
• Select All – Choose this option to create a region in which all items on
the display are selected.
• Zoom to Center – Choose this option to center the diagram in the
pane.
3.6.4.2.2 Symbol Context Menu
If you right-click on a symbol, a context menu is displayed with the
following choices:
• Rename – Choose this option to change the name/label of the symbol.
• Pixel Nudge – Choose this option to move the symbol up, down, left,
or right by one or 10 pixels.
• Zoom to Center – Choose this option to center the symbol in the pane.
• Show Property Sheet – Choose this option to display the property
sheet for the equipment.
• Symbol Type – If there are multiple symbol types for the equipment,
you can choose the desired symbol type from this list.
• Symbol Labeling – Choose this option to change the location of the
label for the symbol, or turn off labeling.
• Symbol Axis Style
− Vertical/Horizontal – Choose Vertical or Horizontal to change the
alignment of the symbol.
− Apply Gravity – Connected equipment can be positioned and
aligned in straight vertical or horizontal lines by applying “gravity” to
the selected symbol. All symbols and nodes that are connected to
the gravity source are drawn toward the source, stacking up in
straight vertical or horizontal lines.
• Symbol Orientation – The symbol orientation menu item provides the
ability to flip and rotate the symbol.

3.6.4.2.3 Node Context Menu
If you right-click on a connection node in the display, a context menu is
displayed with the following choices:
• Rename – Choose this option to change the name/label of the node.
• Pixel Nudge – Choose this option to move the node up, down, left, or
right by one or 10 pixels.
• Zoom to Center – Choose this option to center the node in the pane.
• Show Property Sheet – Choose this option to display the property
sheet for the node.
• Node Resizing – For more information, refer to section
3.6.4.29 Changing a Node's Resize Mode.
• Node Labeling – Choose this option to change the location of the label
for the node, or turn off labeling.
• Node Axis Style
− Central/Vertical/Horizontal – For more information, refer to section
3.6.4.28 Changing the Axis Style.
the selected node. All symbols and nodes that are connected to the
gravity source are drawn toward the source, stacking up in straight
vertical or horizontal lines.
• Node Bar Thickness – Choose Thin or Wide to change the desired
thickness of node bars.
• Cascading Assign Voltage Level – This feature is used to reassign the
voltage level of a group of connected equipment in one operation. You
can think of it as “painting” the equipment with a voltage level. Choose
the desired voltage level and all connected equipment is modified, but
transformer boundaries are not crossed.
3.6.4.2.4 Region Context Menu
If you use the mouse to outline a region, then right-click the region, a
context menu for the region is displayed with the following choices:
• Region Edit
− Copy – Choose this option to copy the region for later pasting.

− Cut – Choose this option to cut (delete) the region for later pasting
elsewhere.
− Delete – Choose this option to delete all items in the region.
− Disconnect – Choose this option to disconnect the region from
anything outside the region.
• Deep Copy – For more information, refer to section 3.6.4.19 Deep
Copying Items.
• Pixel Nudge – Choose this option to move the region up, down, left, or
right by one or 10 pixels.
• Zoom to Center – Choose this option to center the region in the pane.
• Region Alignment
− Vertical/Horizontal – Choose Vertical or Horizontal to change the
alignment of the region.
the selected region. All symbols and nodes that are connected to
the gravity source are drawn toward the source, stacking up in
straight vertical or horizontal lines.
• Region Orientation – The region orientation menu item provides the
ability to flip and rotate the region.
• Region Subselection – For more information, refer to section
3.6.4.16 Region Subselections.
• Region Auto Layout – Choose this option to perform auto-layout of the
equipment in the region. The choices are:
− Vertical Bus Style
− Horizontal Bus Style
− Default – This uses the default style specified in the Graphic
Modeler configuration.
− Tier Expansion Style – The user can create a subselection of
nodes and/or symbols within a region that are used as the root
nodes of an auto-layout operation. After choosing the root nodes,
choose Tier Expansion Style to perform the auto-layout.
Additional menu items from the node and symbol context menus are
also shown. Any selections made here apply to all nodes/symbols in
the region.

3.6.4.3 Viewing the Substation Overview
To display an overview of all substations within a SubGeographicalRegion
and the ACLineSegments that connect them, right-click on a
SubGeographicalRegion name on the Network tree view, point to Graphic
Modeler, and click Substation Overview.
Figure 78: Launching the Substation Overview

The Substation Overview appears in the center pane. Substations and the
AC line connections between them are shown, along with navigation
points to adjacent SubGeographicalRegions. An AC line connection
between substations is shown as a single straight line unless you create
Inflection Points.
The overview display has the following features:
• If you hover the mouse over a substation or AC line, its full
identification is shown.
• Double-clicking the center of a substation box displays its property
sheet in the auxiliary pane.
• Double-clicking the button in the top right corner of a substation box
opens the Substation Detail display in a new tab.
• If you hover the mouse over an AC line and press “J”, the display
jumps to the next station. Alternatively, you can right-click the AC line,
and choose “Jump to Substation <name>” from the context menu.
• Double-clicking the name of an adjacent SubGeographicalRegion
displays the overview for that region.

Figure 79: Substation Overview with Aerial Map
The standard Graphic Modeler toolbar is augmented with additional
controls that are specifically for the overview display.
Figure 80: Substation Overview – Additional Toolbar Controls

The leftmost radio-button controls (labeled “dec” and “gps”) are used to
select whether decimal degrees or Global Positioning System (GPS)
coordinates are displayed.
To the right are buttons that control the detail level of the geographical
map. Buttons are provided to zoom in or out by one level, and a picklist is
provided to jump directly to a desired level. If the Auto radio button is
chosen, the map selection is automatic. If Lock is chosen, the current
detail level on the current map is kept. If you choose a specific detail level
in the picklist, the Lock mode is automatically chosen.
The next set of buttons control the symbol size. By default (when the Auto
radio button is selected), the symbol sizes change as the detail level of

the map changes. However, you can use the zoom in/out buttons or the
picklist to change the symbol size. If you choose the Lock radio button,
the symbol size is kept the same regardless of the detail level of the map.
If you choose a specific symbol size in the picklist, the Lock mode is
automatically chosen.
The next set of buttons control whether or not a map is displayed. If Show
is selected, then either an aerial or a road map is shown, depending on
the zoom level. If Road is selected, a road map is always shown. If Aerial
is selected, an aerial map is always shown. If Hide is selected, no map is
shown in the background.
Aerial and geographical maps are obtained on-demand by accessing the
Microsoft Virtual Earth server via the Internet. As the server responds,
new map tiles are displayed in the overview diagram’s background. There
are 19 zoom levels provided by the Virtual Earth server, although not all
areas have aerial maps at all 19 zoom levels available. Once they are
downloaded, map tiles are cached on your PC, so if you are not
connected to the Internet, the Graphic Modeler can display cached maps
if they were previously downloaded.
The next control is a slider to control the brightness of the background
map.
The two controls at the right side of the toolbar are used for exporting
substation and AC line coordinates to Excel, or importing them from
Excel.
The substation coordinates are on the Substation worksheet, and the
ACLineSegment coordinates are on the ACLineSegment worksheet. The
ACLineSegment worksheet only contains data if line inflection points have
been created. If no inflection points have been created for a line, there is
no latitude/longitude data for the line’s inflection points.

Figure 81: Excel Export of Substation Coordinates
You can also change the latitude/longitude of a substation on its property
sheet. As you do so, the overview display updates to show the new
position of the substation.
3.6.4.4 Viewing the DC Line Overview
To display an overview of the DC network within a GeographicalRegion,
right-click on a GeographicalRegion name on the Network tree view, point
to Graphic Modeler, and click DC Line Overview.
Figure 82: Launching the DC Line Overview

The DC Line Overview appears in the center pane. Substations with DC
converters and the DC line connections between them are shown, as well
as DC connectivity nodes.
Components from the Template Explorer’s DC Components template
group can be dragged and dropped onto the overview diagram.

DCConverter and DCLineSegment terminals can be connected to
ConnectivityNodes using the method described in section 3.6.4.8 Node
Connections.
A DC converter is modeled as a three terminal device. The near and far
terminals connect to DC connectivity nodes, and a tertiary terminal
connects to an AC connectivity node. Because they have both AC and DC
connections, DC converters appear on both the Substation Detail display
(for AC connections) and the DC Line Overview (for DC connections).
In order to create a new DCLineSegment and DCConverter, both the
Substation Detail display and DC Line Overview must be used:
1. First, on the Substation Detail display, add a DCConverter and
connect its AC (tertiary) terminal to an existing or new AC
ConnectivityNode that is associated with the proper Voltage Level.
2. On the DC Line Overview, add a new DCLineSegment and connect
one of its terminals to the ConnectivityNode from step 1.
You must do this using the terminal’s property sheet because the
ConnectivityNode is not shown on the DC Line Overview.
Once this relationship is created, the DCConverter and Substation
Detail display from step 1 appear on the DC Line Overview.
You can navigate to the Substation Detail display by clicking the button in
the top right corner of the substation symbol.
Figure 83: DC Line Overview

3.6.4.5 Viewing the Substation Detail and/or Voltage Level Detail Displays
To view a schematic display of a substation, right-click on a substation
name, point to Graphic Modeler, and click Substation Detail.
To view a schematic display of a particular voltage level within a
substation, right-click on a voltage level name, point to Graphic Modeler,
and click Voltage Level Detail.
Figure 84: Launching the Substation Detail Display

The Substation Detail or Voltage Level Detail display appears. The
features and functions of these two types of displays are virtually identical.
For the purposes of this discussion, the Substation Detail display is used.

Figure 85: Substation Detail Display
The Substation Detail display shows a schematic representation of a
substation structure. Tool tips appear when you point the mouse to any
element of the diagram, and show the equipment name and the name of
the database table. Double-clicking an element causes its property sheet
to be displayed in the auxiliary pane.
Connectivity nodes that have an associated BusBarSection are displayed
with a dark border, and the tool tip identifies both the ConnectivityNode
and BusBarSection names. Double-clicking the node displays the
BusBarSection property sheet.
Figure 86: BusBarSection Example

3.6.4.6 Viewing SCADA Topology
To view the SCADA topology for a substation, right-click on a substation
name, point to Graphic Modeler, and click SCADA Topology.
Figure 87: Launching the SCADA Topology View

The SCADA Topology view appears in the center pane. The diagram
contains both SCADA and network equipment objects. Hovering the
mouse over an object displays a tool tip that identifies the object. The
objects have terminals that can be connected and disconnected, as
described in section 3.6.4.9 Connecting Items. Existing topology is shown
as long as the ConnectivityNode records are marked with the ForScada
flag.
Network equipment or generic SCADA equipment (GenericEquipment)
can be dragged from tree views and dropped on the canvas, as well as
measurements such as Analogs.
The SCADA Topology view is unique in that it only references existing
network and SCADA equipment and does not actually create or delete
them. As topological connections are made on the canvas, the relevant
properties of the existing equipment records are updated. You can check
the Unsaved Change Items view to verify the changes that are being
made by the Graphic Modeler.
One exception is that, as connections are made, ConnectivityNode
records are automatically created.

Figure 88: SCADA Topology View
3.6.4.7 Instantiating Templates

Templates can be used to create new records by simply dragging a
template from the Template Editor into the Substation Detail display and
dropping it in the desired location. If the template requires parameters to
be entered, a dialog box appears where the parameter values can be
supplied.
After the new items have been created, you can modify properties by
double-clicking an item to display its property sheet in the auxiliary pane.
Note: Because not all record types are viewable in the Graphic Modeler, it
is certainly possible to use the method described above to instantiate a
template — but the new records are not shown on the canvas. To confirm
the records that were created by this operation, refer to the Unsaved
Change Items view. You may have to use another display (tree view, grid
view) to locate the records and set their properties.
3.6.4.8 Node Connections
Symbols have terminal lines that connect to nodes. The attachment point
on the node is emphasized by a little bump on the side of vertical and
horizontal nodes.
A typical substation diagram has transmission lines laid out around the
perimeter of the station in a quasi-geographic order. For example, if a
destination substation is to the north, the transmission line symbol is
typically at the top of the substation diagram. Interior vertical and
horizontal oriented nodes are manually stretched to form long buses. A
symbol’s terminal connection may cross one or more of these buses on its
way to its ultimate node connection. At the point where a symbol’s

terminal passes underneath an obstacle bus, there is a little gap
separating the bus from the terminal line that it is passing under.
3.6.4.9 Connecting Items
Connectivity in the Graphic Modeler is restricted to connections between
symbols and nodes. Nodes represent connection points. Symbols have
one or more terminals that are always attached to the symbol. A symbol’s
terminal can be connected to a node or it can be disconnected. When the
terminal is disconnected, it is drawn as a light gray square eyelet attached
to the symbol.
Connections can be formed from any symbol’s disconnected terminals to
a node by performing the following steps:
1. Hover the mouse cursor over a square eyelet.
The cursor changes to a pointer hand, and a tool tip appears that
identifies the terminal type.
2. Click and drag the cursor.
A faint dashed line is drawn between the eyelet and the cursor icon.
3. Continue dragging the cursor to the desired node.
When the cursor is hovering over a valid node, the dashed line
becomes wider, indicating that the connection is allowed.
4. Release the mouse button.

The symbol’s terminal is now connected to the node. The color of the
terminal changes to the color of the target node. Also, any correlated
foreign key reference from the symbol to the node’s voltage level is
assigned.

It is also possible to make direct terminal-to-terminal connections. Click on
one disconnected terminal and then drag the mouse and release on
another disconnected terminal. The Graphic Modeler automatically inserts
a new node between the terminals and makes the proper terminal
connections to the new node.
3.6.4.10 Connecting to Another Substation
Most symbols on a substation diagram connect to local nodes in that
substation. However, in the case of transmission lines, symbols connect
to nodes in different substations.
To connect a transmission line symbol’s disconnected terminal to a node
in a different substation:
1. Bring up two Graphic Modeler windows.
One window is the “from” substation that contains the transmission line
symbol, and the other window shows the “to” substation that contains
the target node.
2. Move the mouse arrow cursor over the disconnected terminal.
The cursor icon changes to a pointer hand, and a tool tip pops up
identifying the terminal type.
3. Press and hold the Shift key while dragging the mouse.
The cursor changes to the drag-and-drop link icon.
4. Continue dragging to the target “to” substation. When the mouse is
over a blank space on the canvas near the target node, release the
mouse button.
The transmission line symbol appears with one terminal attached to an
elongated hexagonal box that contains the name of the “from”
substation. The other terminal of the transmission line is disconnected;
connect the disconnected terminal to the target node, as described in
section 3.6.4.9 Connecting Items.
3.6.4.11 Navigating Substations
Interconnected substations are identified using an elongated hexagonal
box containing the name of the destination substation.
Double-clicking on the name of the destination substation navigates to
that substation (in the same pane).
To call up the destination substation in a new pane, press the Ctrl key or
the Shift key, and double-click the name of the substation.

After navigating to other substations, you can click the Back or Forward
buttons in the toolbar to return to previously viewed substations.
3.6.4.12 Disconnecting Items
A single item or a group of items in the Substation Detail display can be
disconnected by performing the following steps:
1. Draw a region around an existing terminal, and point the cursor at the
selected region.
The cursor changes to a pointer hand and a tool tip pops up identifying
the terminal type.
2. Right-click on the selected region, point to Region Edit, and click
Disconnect.
The terminal connection to the node is broken, and the disconnected

terminal is drawn as a light gray square eyelet attached to the symbol.
3.6.4.13 Inflection Points
Line inflection points are user-defined “bend” points along transmission
lines in the Substation Overview diagram, or along equipment terminals in
the Substation Detail and Voltage Level Detail displays. Inflection points
can be used to explicitly control the routing of lines.
Figure 89: Inflection Points

To create inflection points in a line:
1. Locate the line on the desired diagram.
2. Zoom in to the desired location and expand the length of the line by
moving the connected items apart.
3. Click once on the line.
Two plus signs (+) appear at the ends of the line, to indicate that the
line is in “inflection point edit mode”.
4. Create the inflection point by hovering the mouse cursor over the line
and pressing the keyboard Insert key — or right-click the line, point to
Line Inflection Points on the context menu, and click Create.
A circular inflection point is added to the line.
5. Click anywhere on the canvas to leave inflection point edit mode.
The plus signs and circular inflection point symbols disappear.
Inflection points can be deleted in a similar manner. Place the line in
inflection point edit mode, move the cursor over the inflection point, and
press the keyboard Delete key — or right-click the inflection point, point to
Line Inflection Points on the context menu, and click Delete. You can also
click Delete All to delete all inflection points on the line.
Once inflection points have been created in inflection point edit mode,
they can be moved by dragging them and dropping them in the desired
location, or using the arrow keys to move them via Pixel Nudge.
3.6.4.14 Saving Changes vs. Accepting Layout Changes
To save all unsaved change items to the database, use one of the
following methods:
• Click the Save button on the viewport toolbar, or the Save button on
the Graphic Modeler toolbar.
• Right-click on a blank area of the Graphic Modeler canvas, point to
Recent Changes, and click Save Changes to Database.
Selecting the Accept Changes to the Graphical Layout option creates
unsaved change items for the layout changes. These unsaved change
items will be saved to the database the next time the Save button is
clicked. To save layout changes to the database immediately, select the
Save Changes to Database option.

3.6.4.15 Selecting Regions
A selection region in the Graphic Modeler is shown as an enclosed area
outlined with a dashed line, as shown in the figure below. The region can
be rectangular or it can be drawn freehand. A selection region is a means
of selecting a collection of items as the target of some wholesale change.
To create a rectangular selection region:
1. Move the mouse arrow cursor to a blank space on the work surface.
2. Click and drag the mouse to enclose the items inside the rectangular
selection box.
In addition to the rectangle, there is a faint dashed line that traces out
the cursor’s actual path.
3. Release the mouse button to complete the selection.
The selection region persists until either the mouse clicks in a blank
space on the work surface or a new selection region is created.
To create a freehand selection region:
1. Move the mouse arrow cursor to a blank space on the work surface.
2. Press and hold the Ctrl key while dragging a selection region.

Only the freehand trace of the cursor’s actual path is shown.
3. Release the mouse button to complete the selection.
Once the selection region is drawn, you can make wholesale changes to
the enclosed items. By moving the arrow cursor into the selection region,
the cursor changes to a pointer hand. You can right-click to bring up the
region’s context menu, or you can use keyboard shortcut keys.
The region’s context menu presents the node and symbol context menus
as submenus and is divided into three sections:
• Region – Action applies to all items in the selection region.
• Node – Action applies to all of the nodes in the selection region.
• Symbol – Action applies to all of the symbols in the selection region.
3.6.4.16 Region Subselections
Once a region has been selected, you can then further select (“subselect”)
one or more items in the region, and then use the Region Subselection
menu to perform actions such as:
• Set to Same Kind
• Set to Same Size
• Align Tops
• Align Bottoms
• Align Right Sides
• Align Left Sides
• Align Vertical Centers
• Align Horizontal Centers
To “subselect” one or more items in a region:
1. Select a region, as described in section 3.6.4.15 Selecting Regions.
2. Hover the mouse cursor over an item in the region.
The cursor icon changes from the pointer hand to a crossed line icon.
3. Click the item.
An ellipse is drawn around the item to indicate that it has been
subselected. Clicking again deselects it.

4. After all desired items have been subselected, right-click one of the
items and point to Region Subselect on the context menu, then click
the desired action.
3.6.4.17 Clipboard Scratchpad
The Clipboard Scratchpad is a viewport that allows you to build, view, and
manage a group of records for later pasting into the Graphic Modeler.
Figure 90: Clipboard Scratchpad

The Clipboard Scratchpad has three panels:
• Tree View Panel – The first panel in the scratchpad is a tree view of all
the records in the scratchpad. This panel can be used to add new
records to the scratchpad or delete records from the scratchpad.
• Graphic Modeler Panel – The second panel displays a graphic
representation of the records in the scratchpad. The layout can be
adjusted as desired. You can also paste additional records into the
scratchpad (sourced from Deep Copy or Graphic Modeler) by right-
clicking the canvas, and choosing Edit > Paste.
• Property Sheet Panel – If you select a record in the first or second
panel, its property sheet is shown in the third panel. This panel can be
used to view and modify the properties of any record in the
scratchpad.
In addition to the standard Graphic Modeler toolbar, the Clipboard
Scratchpad has a second toolbar that contains the following buttons:

Button Description
Clear, delete all items – Deletes all records from the
scratchpad.
Copies all items to the clipboard.
Click and drag this icon to drag the scratchpad records and
drop them onto a Graphic Modeler canvas.
3.6.4.17.1 Clipboard Scratchpad – Tree View Panel

The Tree View panel hierarchically displays the records in the scratchpad.
Records can be deleted from the scratchpad by right-clicking the record,
and choosing Delete or Delete Subtree from the context menu. The
Delete option deletes only the target record and causes its children
records to be orphaned, so they can be reassigned to a different parent.
The Delete Subtree option deletes the target record and its children.
Records can be added to the scratchpad, one by one, using either of the
following methods:
• Right-click the desired parent record, and choose Insert from the
context menu, then choose the record type from the Insert submenu.
The new record is inserted as a child.
• Choose the desired record type at the top of the Tree View panel and
then click the button. The new record is inserted as a top-level
record.
Multiple records can be added to the scratchpad (sourced from Deep
Copy or Graphic Modeler) by pasting them onto the scratchpad’s Graphic
Modeler panel.
3.6.4.17.2 Clipboard Scratchpad – Graphic Modeler Panel
The Graphic Modeler panel of the scratchpad provides a visual layout of
the records in the scratchpad — assuming the scratchpad actually has
records that can be viewed in the Graphic Modeler.
You can add additional records to the scratchpad (sourced from Deep
Copy or Graphic Modeler) by right-clicking the canvas and choosing Edit >
Paste. Records can also be added singly in the scratchpad’s Tree View
panel.
3.6.4.17.3 Clipboard Scratchpad – Property Sheet Panel
To view the property sheet for a scratchpad record, simply click on the
desired record in the Tree View panel, or double-click the record in the

Graphic Modeler panel. The property sheet is displayed in the right panel,
and the properties can be viewed and modified as desired.
3.6.4.18 Copying Items
A single item or a group of items can be copied by using the following
method:
1. Create a region containing a single item or a group of items.
2. Right-click on the selected region, point to Region Edit, and click Copy.
3. Choose the desired paste location, right-click on the canvas, point to
Edit, and click Paste.
You can paste multiple times to create multiple copies. The pasted
records remain selected in a region.
3.6.4.19 Deep Copying Items
The Graphic Modeler supports two methods to perform a deep copy of a
collection of items:
• Database metadata-defined deep copy – The e-terrasource metadata
is used to define the nature and extent of the deep copy. For further
information about configuring deep copy metadata, refer to the
e-terrasource Metamodel Guide.
• Client-configured deep copy – This type of deep copy is driven by a
query definition stored in the client’s Graphic Modeler configuration.
Both forms of deep copy allow the user to select a region of connected
equipment, and perform a deep copy using the region’s context menu.
The Graphic Modeler initiates the deep copy and pops up a Clipboard
Scratchpad view with the deep copy results (for more information, refer to
section 3.6.4.17 Clipboard Scratchpad).
When you are satisfied with the collection of objects in the Clipboard
Scratchpad, click the Copy to Clipboard button on the scratchpad
toolbar, then paste onto a Graphic Modeler canvas and save. When
pasting, only the top-level record’s identifier changes; identifiers of
children records are unchanged. In some modeling scenarios, children
identifiers may be dependent on the parent identifier; therefore, you may
need to manually correct the children identifiers after pasting.
3.6.4.20 Deleting Items
A single item or a group of items can be deleted using the following
method:
1. Create a region containing a single item or a group of items.

2. Right-click the region, point to Region Edit on the context menu, and
click Delete.
3.6.4.21 Creating Templates
For more information, refer to section 3.6.7.6 Creating Templates Using
Graphic Modeler.
3.6.4.22 Property Sheets
The property sheet can be accessed by double-clicking objects on the
Graphic Modeler canvas, or pressing the “I” shortcut key while hovering
the cursor over the object. The property sheet is displayed in the auxiliary
pane on the right side.
3.6.4.23 Tool Tips
When the mouse cursor points to an item’s symbol, the cursor changes to
a pointer hand and a tool tip pops up that displays the equipment name,
the name of the database table, and (optionally) the symbol type
depending on whether multiple symbol types have been defined for the
equipment.
Switches have multiple symbol types. Each symbol type is tied to a unique
combination of database column values for “Switch Type” and “Normally
Open”. The choice of database columns and values is defined in the
Graphic Modeler configuration file.
When the mouse cursor hovers over a node, a tool tip shows the node
name, its base voltage, and the database table name.
When the mouse cursor hovers over a symbol’s terminal, a tool tip shows
the terminal type.
3.6.4.24 Changing the Symbol Type of an Object
As discussed in section 3.6.4.23 Tool Tips, switches have multiple symbol
types from which to choose.
To change the symbol type of a switch:
1. Point the mouse cursor to a switch symbol.
The cursor changes to a pointer hand.
2. Right-click on the switch symbol, point to Symbol Type, and click one
of the symbol types.
The symbol changes to the selected type, and the database columns
“Switch Type” and “Normally Open” are set to the appropriate values.

3.6.4.25 Moving Items
Individual items or groups of items can be moved with the mouse or the
keyboard. To move a group of items, use the steps described in section
3.6.4.15 Selecting Regions to select the items to be moved before
following the steps below.
To move items with the mouse:
1. Point the mouse cursor to the symbol, node, or region.
2. Click and drag the item to the new location.
Any connections or links automatically adjust to the new position.
To pixel nudge items with the keyboard:
1. Point the mouse cursor to the symbol, node, or region.
2. Press the arrow keys on the keyboard in the direction you want to
move the item.
The item moves one pixel in the selected direction. You can also right-
click the symbol, node, or region, and choose Pixel Nudge from the
context menu.
3.6.4.26 Renaming Items
To rename items:
1. Point the mouse cursor to the target symbol or node.
2. Right-click on the symbol or node, and click Rename.
A dialog box appears with a text box to change the item’s name.
3. Click OK to accept the new name.
3.6.4.27 Changing Label Information
To change the location of symbol and node labels:
1. Hover the mouse cursor over a symbol or node.
2. Right-click on the object, point to Symbol Labeling or Node Labeling,
and click one of the placement options.

The label is placed at the chosen location.
Choose No Labeling to remove the label entirely.
Choose Default Labeling where the location of the label depends on
the object’s axis style. When a symbol or node is set to use default
labeling, the user can change the symbol axis style from horizontal to
vertical; the label placement automatically switches from Top to
Top Right.
3.6.4.28 Changing the Axis Style
The axis style of a single symbol or node, or a group of symbols and
nodes, can be changed to best fit the substation layout.
To change a node’s axis style to Central Point, Vertical, or Horizontal:
1. Hover the mouse cursor over a node.
2. Right-click on the node, point to Node Axis Style, and select one of the
three options from the Node Axis Style menu — or press C (Central
Point), V (Vertical), or H (Horizontal) on the keyboard as a shortcut.
The node changes its orientation.
To change a symbol’s axis style to Vertical or Horizontal:
1. Hover the mouse cursor over a symbol.
2. Right-click on the symbol, point to Symbol Axis Style, and select one of
the two options from the Symbol Axis Style menu — or press
V (Vertical) or H (Horizontal) on the keyboard as a shortcut.
The symbol changes its orientation.
3.6.4.29 Changing a Node's Resize Mode
Nodes with Auto Resize enabled automatically arrange the placement of
connections around the node according to the relative location of the
connected symbol.
When a user moves either a node or the symbols connected to the node,
the Auto Resize feature re-arranges the placement of connections to
minimize the number of crossed lines.
Nodes with Manual Resize enabled typically have long straight terminal
connections perpendicular to the side of the node. The node must be
manually stretched long enough to be aligned with the connected symbol.
If the node has not been manually stretched long enough, the terminal

connections attach to either end of the node and go off either in a straight
line or in a 45-degree angle line toward the connected symbol depending
on the relative location of the connected symbol.
To manually stretch vertical and horizontal nodes:
1. Point to either end of the node.
The cursor changes to a Resize icon.
2. Drag the end of the node to resize it to the desired length.
The act of resizing a node changes the node’s resizing mode to
Manual.
To change a single node’s (or a group of nodes within a selected region)
resizing mode to Auto or Manual:
1. Point the mouse cursor to a node.
2. Right-click on the node, point to Node Resizing, and click Auto or
Manual — or point to the selected region so the cursor changes to the
pointer hand, and press A (Auto) or M (Manual) on the keyboard as a
shortcut.
Note: Only a node that has a vertical or horizontal axis style changes its
resizing mode.
3.6.4.30 Undoing and Redoing Operations
Nodes and symbols displayed by the Graphic Modeler have certain
graphic properties such as graphic position, symbol rotation, the
placement of labels, horizontal/vertical orientation, etc. As the layouts are
re-arranged, changes in the graphic properties of each individual “step”
are recorded.
A “step” is defined by releasing the mouse button or pressing a key on the
keyboard. A record is maintained as long as the user does not change the
model by adding or removing items, changing the connectivity, accepting
the changes, or saving the changes to the database.
It is important to remember that there is a distinction between changes
made to the model versus changes made to the graphics layout.
To undo changes in consecutive order, click the Undo button on the
toolbar, or press Ctrl + Z on the keyboard.
To redo changes in consecutive order, click the Redo button on the
toolbar, or press Ctrl + Y on the keyboard.

3.6.4.31 Panning
To pan up or down:
• Scroll the mouse wheel up or down, respectively.
To pan left or right:
• Hold down Shift on the keyboard while scrolling the mouse wheel up or
down, respectively.
To pan in any direction:
• Press and hold the scroll wheel and move the mouse in the direction
you want the display to pan.
3.6.4.32 Zooming
To view the entire Substation Detail display:
• Click the Center the Diagram button on the toolbar, or press Z on the
keyboard.
To zoom in on a selected region:
• Right-click on the selected region and click Zoom to Center, or press Z
on the keyboard.
To zoom in at the current location of the mouse pointer:
• Press and hold the Ctrl key while scrolling the scroll wheel on the
mouse.
3.6.4.33 Aligning Items in a Region
To vertically or horizontally align all items within a region:
1. Select the items you want to align using the steps described in section
3.6.4.15 Selecting Regions.
2. Right-click inside the selected region, point to Region Alignment, and
click Align Vertically or Align Horizontally — or point to the selected
region so the cursor changes to the pointer hand, and press V
(Vertical) or H (Horizontal) on the keyboard as a shortcut.
3.6.4.34 Orienting a Region
To vertically or horizontally flip all objects within a region:
1. Select the items you want to flip, creating a selection region.
2. Right-click inside the selected region, point to Region Orientation, and
click Flip Vertically or Flip Horizontally — or point to the selected region

so the cursor changes to the pointer hand, and press F to flip the
object vertically or Shift + F to flip the object horizontally.
To rotate an object 90 degrees counter-clockwise:
1. Select the items you want to rotate, creating a selection region.
2. Right-click inside the selected region, point to Region Orientation, and
click Rotate Region — or point to the selected region so the cursor
changes to a pointer hand, and press R as a keyboard shortcut.
Note that the location of the cursor arrow is the axis point of rotation. To
make the object rotate in place, make sure that the cursor is in the center
of the selected region.
3.6.4.35 Editing a Region
To perform Cut, Copy, Paste, Delete, or Disconnect operations on a
region:
1. Select the items, creating a selection region.
2. Point to the selected region so the cursor changes to the pointer hand,
then perform one of the following operations:
Cut: Right-click within the selected region, point to Region Edit, and
click Cut.
Copy: Right-click within the selected region, point to Region Edit, and
click Copy — or press Ctrl + C.
Paste: Paste objects copied to the clipboard by right-clicking on a
blank area, pointing to Edit, and clicking Paste — or press Ctrl + V.
Delete: Press Delete on the keyboard.
Disconnect: Right-click within the selected region, point to Region
Edit, and click Disconnect.
To duplicate a selected region using drag-and-drop:
1. Select the region you want to duplicate.
2. Point to the selected region so the cursor changes to a pointer hand.
3. Press and hold Ctrl, then drag and drop the region to a blank area of
the canvas.
You can drop the copy into the same substation, into a substation in a
different Graphic Modeler window, or into a template group in the
Template Explorer to create a new template.

When the mouse button is released, a copy of the selected equipment
is created at the location of the drop. Any terminal connections that
crossed the original selection region boundary are open-ended in the
copied objects. All interior connections remain intact.
3.6.5 Special-Purpose Modeling Displays

3.6.5.1 Linkage Displays
The e-terrasource interface may also contain one or more special-
purpose linkage displays. Linkage displays provide a convenient
mechanism for viewing and modifying relationships between records.
Click the drop-down list on the Linkages icon in the toolbar to view
the available linkage displays.
In EMS modeling, the classic example of a linkage display is one that
allows substation measurements to be linked to their corresponding
Remote Telemetry Unit (RTU) inputs/outputs.
Figure 91: Linkage Display

In Figure 91, the left side contains all of the measurements in a particular
substation, whereas the right side contains RTU data items. The drag and
drop feature can be used to fill the relationships between the RTU data
items and substation measurements.
The picklist at the top left is used to select the desired substation. The
picklist at the top right is used to select the desired RTU. The picklist at
the top center is used to select other related linkage displays. The check
boxes in the center are used to filter the type of records that are shown.
Click and hold to drag a row from the left pane and drop it into a Linkage
cell in the right pane. To clear a linkage, click the Clear button.

3.6.5.2 Curve Displays
The e-terrasource interface may also contain one or more special-
purpose displays for viewing data that represents X–Y curves.
Figure 92: Curve Display

Curve displays make use of the center pane, bottom pane, and auxiliary
pane.
• The center pane shows a graphic representation of the curve. The
graph is read-only, but it provides a visual check that the breakpoints
on the curve are correct.
• The bottom pane displays a grid of the breakpoints of the curve. You
can insert, delete, and modify breakpoints in the grid view. As you do
so, the graph in the center pane updates to show the new curve
shape.
• The auxiliary pane on the right displays the property sheet for the
curve record.

3.6.6 Search Dialog Box
The toolbar contains a Search button that can be clicked to call up the
Search dialog box. You can use the Search dialog box to perform an
ad hoc search of any table in the model.
Figure 93: Search Dialog Box

The top of the dialog box contains a drop-down list from which the desired
table can be selected. Once the table is selected, you can enter the
search criteria below it. Each search criterion consists of a property name,
an operator, and a value.
The button can be used to add additional search criteria, which can be
logically ANDed or ORed to the search expression. The button can be
used to remove a search criterion.
The allowable operators depend on the data type of the property.
Data Type Allowable Operators Value
String or =, <> Value is restricted to a legal
numeric with picklist value, or null.
a picklist
String without =, <>, Starts With, If operator is not Matches,
a picklist Contains, Matches value can be null or a string.
URL String can contain “*” as a
Relationship wildcard.
If operator is Matches, value
must be a regular expression.
Date =, <>, <, <=, >, >= Use calendar control to enter
Date/Time desired date/time.
Numeric =, <>, <, <=, >, >=, If operator is not Matches,
Matches value can be null or a number.
If operator is Matches, value
must be a range expression.

You can also click the Case Sensitive check box to perform a case-
sensitive search. By default, searches are not case-sensitive.
Once the search criteria are entered, click OK to perform the search.
When the search is complete, the title bar is updated to indicate the
number of rows returned, and the bottom of the dialog box displays a grid
of the search results.
The search criteria are retained in your user preferences so that, the next
time you perform a search, the dialog box contains your previous search
criteria.
Figure 94: Search Dialog Box with Results Grid
3.6.6.1 Range Expressions

When you use the Matches operator with numeric properties, the value
field must be filled with a numeric range expression. Allowable range
expressions are:
Range Expression Meaning
[0–100] Matches values between 0 and 100 inclusive
(0–100) Matches values between 0 and 100 exclusive
(0–100] Matches values greater than 0 and less than or
equal to 100
[0–100) Matches values greater than or equal to 0 and
less than 100
1, 3, 5 Matches a specific comma-separated list of
values
The expressions support both integer and decimal values. Also, the
different types of range expressions can be combined.

For example, the following is a valid range expression:
1,3.14159,5,(6-11],(15-20],99.9
3.6.6.2 Regular Expressions
When you use the Matches operator with string properties (including URL
or relationship properties), the value must be filled with a regular
expression.
A complete discussion of regular expressions is beyond the scope of this
document. Many resources to describe regular expressions are available
on the Internet. A brief description and some examples are given here.
A regular expression is used for pattern matching of strings. A regular
expression can contain literals and meta-characters.
Meta- Definition Example Pattern Sample Match
Character
^ Start of a string ^abc abc, abc123
$ End of a string abc$ abc, 123abc
. Any character a.c aac, abc, acc
| Alternation ab | cd ab, cd
{…} Explicit ab{4}c abbbbc
quantifier
[…] Explicit a[bB]c abc, aBc
character set
(…) Grouping of part (abc){2} abcabc
of an
expression
* 0 or more of ab*c ac, abc, abbc,
previous abbbc
expression
+ 1 or more of ab+c abc, abbc,
previous abbbc
expression
? 0 or 1 of ab?c ac, abc
previous
expression
\ Preceding one a\+c a+c
of the above,
makes it a literal
instead of a
meta-character

Useful escape characters are listed below.
Escape Character Description
\t Matches a tab
\r Matches a carriage return
\n Matches a new line
\040 Matches octal 040 (space)
Any three octal digits can be specified.
\x20 Matches hex 20 (space)
\u0020 Matches a four digit Unicode character
Examples of character classes are listed below:

Character Class Description
. Matches any single character except \n
[aeiou] Matches any single character included in the
set within the brackets
[^aeiou] Matches any single character not included in
the set within the brackets
[0-9a-zA-Z] A hyphen can be used to specify a contiguous
range of characters
\w Matches any word character
\W Matches an non-word character
\s Matches any white space character
\S Matches any non-white space character
\d Matches any decimal digit
\D Matches any non-digit

3.6.7 Templates
Templates are a very powerful tool for building models. A “template” is a
group of related records that represents a reusable modeling pattern.
Templates can be repeatedly instantiated to quickly build a model. For
example, templates can be used to represent a prototypical substation, an
equipment group or bay, or a single switch.
Templates can also have parameters associated with them. When a
template is used to create an instance, the user is prompted to enter
values for the template’s parameters. These user-entered values can be
used to derive many of the instance’s properties. For example, the user
can enter an “Equipment Name”, which is used to populate many of the
names of the instance records.
Templates can be organized into groups, and can be public or semi-
private. Public templates are available for all e-terrasource users to view
and use. Semi-private templates are available for use by all users
belonging to a specified model authority.
Instances that are created from templates retain information about the
originating template. This information can be viewed at the top of the
property sheets.

3.6.7.1 About the Template Explorer
Information about available templates can be obtained using the Template
Explorer. To display the Template Explorer, choose View > Template
Explorer. The Template Explorer opens in the left pane and displays a
hierarchy of template groups and templates.
Figure 95: Template Explorer
The Template Explorer has a toolbar with three buttons.

Toolbar Button Description
Click this button to add a new template group.
Click this button to manually add a new template.

Click this button to delete the highlighted template or
template group.

3.6.7.2 Creating Template Groups
A template group is simply way of organizing templates into folders. Users
with the CreateTemplateGroup permission can create new template
groups.
To create a new template group, click the button on the toolbar of the
Template Explorer. The New Template Group dialog box is shown:
Figure 96: New Template Group Dialog Box

Specify a name for the template group, and an optional description, and
then click OK.
3.6.7.3 Viewing/Modifying Template Group Properties
To view properties for a template group, use either of the following
methods:
• From the Template Explorer, right-click the desired group, and click
Properties.
• From the Template Explorer, click the desired group.
The template group property sheet is shown with the following
information:
• Template Group ID
• Description
The description field is enterable for users who have the
ReplaceTemplateGroup privilege.

Figure 97: Template Group Property Sheet
3.6.7.4 Deleting Template Groups
To delete a property group, use either of the following methods:
• From the Template Explorer, right-click the desired template group,
and select Delete from the context menu.
• From the Template Explorer, click the desired template group, then
click the button in the Template Explorer toolbar.
If the template group contains templates, the action is not allowed and the
following error is displayed:
Figure 98: Delete Template Group Error
3.6.7.5 Creating Templates Using Deep Copy

New templates can be created using the Deep Copy feature. If you have a
prototypical hierarchy of records in a tree view, it is a simple task to create
a template from it — assuming that the Source record has Deep Copy
configured for it.

To create a template using Deep Copy:
1. Locate the desired top-level record on the tree view, right-click the
record, and choose the desired Deep Copy from the context menu.
If Deep Copy is not available for the record, contact your administrator
about creating a deep copy definition for it.
2. On the Template Explorer, right-click the template group that you want
the template to be created in, and then select Paste from the context
menu.
The New Template dialog box is displayed.
3. Fill in the template ID and an optional description.

You can also change the template group in the dialog box.

4. If the template should be available to all e-terrasource users, set the
model authority to null. Otherwise, set the name of the model authority
whose users should have access to the template.
A template can have a lifecycle/status, so you can optionally set the
state of the template. The model schema indicates which business
model schema the template is relevant to. Generally, this value should
not be changed.
When the OK button is clicked, the template is created and is shown
under the proper group on the Template Explorer.
5. Once the basic template structure is created, use the methods
described in section 3.6.7.8 Viewing/Modifying Template Properties to
make final changes to the template.
When you have tested the template and are happy with it, you can
change the template state to indicate that it is available for use.
3.6.7.6 Creating Templates Using Graphic Modeler
New templates can be created using a selection of records from the
Graphic Modeler. If you have a prototypical collection of records in the
Graphic Modeler, it is a simple task to create a template from it.
To create a template from the Graphic Modeler:
1. Select the desired collection of records on the Graphic Modeler
canvas.
2. Press <Ctrl> and the left mouse button and hold.
3. Drag the records to the Template Explorer and release/drop them on

the desired template group.
The New Template dialog box is ACLineSegmentTemplateDisplayed.

4. Fill in the template ID and an optional description.
You can also change the template group in the dialog box. If the
template should be available to all e-terrasource users, set the model
authority to null. Otherwise, set the name of the model authority whose
users should have access to the template.
A template can have a lifecycle/status, so you can optionally set the
state of the template. The model schema indicates which business
model schema the template is relevant to. Generally, this value should
not be changed.
When the OK button is clicked, the template is created and is shown
under the proper group on the Template Explorer.
5. Once the basic template structure is created, use the methods
described in section 3.6.7.8 Viewing/Modifying Template Properties to
make final changes to the template.
3.6.7.7 Creating Templates Manually
Templates can be created manually, although this is the most tedious
method of creating a template. It is generally more efficient to locate
records in your model that closely resemble the desired template, and
then use either Deep Copy or Graphic Modeler to create a template from
them.

To create a template manually, use either of the following methods:
• From the Template Explorer, click the button to add a new

template.
• From the Template Explorer, right-click the desired template group,
and choose Add Template from the context menu.
The New Template dialog box is shown:
Figure 99: New Template Dialog Box

Fill in the template ID and an optional description.
You can also change the template group in the dialog box. If the template
should be available to all e-terrasource users, set the model authority to
null; otherwise, set the name of the model authority whose users should
have access to the template.
A template can have a lifecycle/status, so you can optionally set the state
of the template. The model schema indicates which business model
schema the template is relevant to. Generally, this value should not be
changed.
Once the basic template structure is created, use the methods described
in section 3.6.7.8 Viewing/Modifying Template Properties to make final
changes to the template.

3.6.7.8 Viewing/Modifying Template Properties
A template is very much like a project. It contains a set of change items
that provide instructions on how to add records to the model and fill in
certain properties and relationships. You can also think of a template as a
“macro” that is executed each time you instantiate the template.
The Template Explorer provides the following capabilities with regards to
viewing and modifying templates:
• The properties of a template can be viewed or modified.
• Hovering the cursor over a template displays a graphic thumbnail view,
if possible.
• Template parameters can be viewed, modified, and deleted.
• Template change items can be displayed in a grid view.
• Templates can be edited.
3.6.7.8.1 Template Properties
The property sheet for a template can be viewed using either of the
following methods:
• From the Template Explorer, click the desired template.
• From the Template Explorer, right-click the desired template, and
choose Properties from the context menu.
The template property sheet is shown:
Figure 100: Template Property Sheet

The property sheet shows the following properties:
• Template ID
• Description
• Group template belongs to
• Model authority whose users have access to the template
If null, the template is available to all users.
• Current state of the template
• Business model schema that the template applies to
3.6.7.8.2 Template Parameters
Template parameters are a powerful feature that can simplify modeling
tasks for users. In a typical template, there may be many properties on
several records that are identical (or very similar). For example:
• If a template represents a piece of equipment, there may be many
records that can have their name derived by a naming convention
based on a single user-entered “equipment name”.
• Parameters can also be used with metadata calculations to set certain
properties. A single user-entered “Voltage Level” parameter can
possibly be used to derive values for ratings, limits, and alarm
categories.
Judicious use of template parameters can allow you to have a small
number of powerful templates, instead of having many similar templates
that vary in small ways.
To create a new template parameter, right-click the template on the
Template Explorer, and choose Add Parameter from the context menu.
The New Template Parameter dialog box is shown:

Figure 101: New Template Parameter Dialog Box
Enter a name for the template parameter that is unique for the template.
Also fill in the UI Label that the user sees, and fill the optional description
field with additional tips for the user on providing a proper value. If the
value should be restricted to a picklist, choose the desired picklist ID (for
information about creating picklists, refer to the e-terrasource Metamodel
Guide). Click OK to add the template parameter.
To view the property sheet for the template parameter, click the parameter
name on the Template Explorer, or right-click the parameter name, and
Figure 102: Template Parameter Property Sheet

For information about how template parameters can be used in template
change items, refer to section 3.6.7.9 Template Editor.
For examples of how parameters and rules are used during template
instantiation, refer to sections 3.6.7.12 Instantiating Templates on Tree
Views and 3.6.7.13 Instantiating Templates on Graphic Modeler.
3.6.7.8.3 Template Parameter Rules
There may be cases where validation rules should be applied to a
template parameter. The Template Explorer allows one or more rules to
be added to template parameters, where each rule is implemented as a
regular expression (for more details about regular expressions, refer to
section 3.6.6.2 Regular Expressions).
Range expressions are not currently supported for validating template
parameters. If rules are defined for a parameter, then the user interface
ensures that the value entered by the user satisfies the rule.
For example, you may want to check that the “Name” parameter entered
by the user is 8 uppercase characters or fewer.
To add a new template parameter rule, right-click the template parameter
on the Template Explorer, and choose Add Validation Rule from the
context menu. The Add Validation Rule dialog box is shown:
Figure 103: Add Template Parameter Validation Rule Dialog Box

The figure above is an example of a validation rule that ensures that the
user enters 1–8 uppercase letters for the SwitchName parameter of the
MySwitch template.

The rule ID must be unique for the template, and the regular expression is
the implementation of the validation rule. The Test Expression field allows
entry of a sample string that can be used to test the regular expression. If
the Test Expression fails the regular expression check, it is highlighted in
red. Click OK to add the validation rule.
To view the property sheet for the template parameter validation rule, click
the rule name on the Template Explorer, or right-click the rule name, and
Figure 104: Template Parameter Validation Rule Property Sheet

For examples of how parameters and rules are used during template
instantiation, refer to section 3.6.7.12 Instantiating Templates on Tree
Views.
3.6.7.8.4 Template Change Items
The set of change items that implement a template can be viewed from
the Template Explorer using either of the following methods:
• Expand the desired template, and select the Change Items folder.
• Right-click the desired template, and choose Details.
A grid display of the template change items is shown:

Figure 105: Template Change Items
The grid display is read-only. To modify the template change items, right-
click the template in Template Explorer, and choose Edit Template to
launch the Template Editor.
3.6.7.9 Template Editor
Once a template has been created, whether it was created via
Deep Copy, Graphic Modeler, or manually, the Template Editor can be
used to make improvements to the template. Using the Template Editor,
you can set the desired values for record properties, whether the
properties are static, parameter-driven, or calculated. Records can be
pruned from the template, or additional records can be added to it.
The Template Editor is very similar to the Graphic Modeler’s Clipboard
Scratchpad editor.

To launch the Template Editor, right-click the template on the Template
Explorer, and choose Edit Template. The Template Editor is displayed in
three panels in the center pane.
Figure 106: Template Editor

The Template Editor is displayed in three panels in the center pane.
• The first panel in the Template Editor is a tree view of all the records
that make up the template. This panel can be used to add new records
to the template, or delete records from the template.
• If you select a record in the first panel, its property sheet is shown in
the second panel. This panel can be used to fill the record properties
with static, parameter-based, or calculated values.
• The third panel displays a graphic representation of the template. The
layout can be adjusted and saved as part of the template.
Furthermore, the graphic layout is used as a thumbnail for the
template when you hover the cursor over the template in Template
Explorer. You can also paste additional records into the template
(sourced from Deep Copy or Graphic Modeler) by right-clicking the
canvas and choosing Edit > Paste.

The Template Editor has a toolbar that contains the following buttons.
Toolbar Button Description
Clear, delete all items – Deletes all records and
change items from the template.
Copies all template change items to the clipboard.
Click and drag this icon to drag the template and
drop it onto a Graphic Modeler canvas.
3.6.7.9.1 Template Editor – Tree View Panel

The tree view panel hierarchically displays the records that make up the
template. In Figure 106, this consists of one Switch record and two
Terminal records that are children of the Switch.
Records can be deleted from the template by right-clicking the record, and
choosing Delete or Delete Subtree from the context menu. The Delete
option deletes only the target record and causes its children records to be
orphaned, so they can be reassigned to a different parent. The Delete
Subtree option deletes the target record and its children.
Records can be added to the template, one by one, using either of the
following methods:
• Right-click the desired parent record and choose Insert from the
context menu, then choose the record type from the Insert submenu.
The new record is inserted as a child.
• Choose the desired record type at the top of the tree view panel, and
then click the button. The new record is inserted as a top-level
record. If you want to link it to another record in the template, fill the
desired relationship property with a local template reference on the
property sheet (for more information, see section 3.6.7.9.2 Template
Editor – Property Sheet Panel).
Multiple records can be added to the template (sourced from Deep Copy
or Graphic Modeler) by pasting them onto the Template Editor’s Graphic
Modeler panel.
3.6.7.9.2 Template Editor – Property Sheet Panel
To view the property sheet for a template record, simply click on the
desired record in the tree view panel. The Template Editor property sheet
is somewhat similar to a “normal” property sheet, but there are some
important differences in how property and relationship values are set.

The top of the property sheet has the following fields, as well as a
button that expands the property sheet panel by hiding the Graphic
Modeler panel.
Figure 107: Template Record ID and Create QueryId

• The Record ID field is how the record is identified within the template.
By default, the form of the ID is <table>n, but it can be changed to
something more meaningful if desired.
• The Create QueryId field is used if the instantiation of the record
should be conditional. Click the button, and choose the desired
calculation.
Figure 108: Conditional Creation Query

Figure 108 depicts a situation where the creation of a record is conditional
on whether the LoadBayAddMW calculation returns a 1 or a 0. The
calculation is defined as:
select <%HasMW> from dual
and the “HasMW” template parameter is a picklist where Yes=1, No=0.
Therefore, if the user enters Yes, the record is created; otherwise, the
record is not created.
Although a complete description of calculations is beyond the scope of
this document, the “select” statement above is an example where the
value that the user enters for the “HasMW” template parameter is used to
decide whether to return 0 or 1 for the property value.

For properties (e.g., not relationships to other records), there are four
choices for setting the value, as can be seen by clicking the button
next to the property.
Figure 109: Template Editor – Property Value Sources

• Null Value – Click the Set Field to Null and Close button to nullify the
property value. This indicates that the template does not set the value
for this property. When this template is instantiated, the property is left
null.
• Manual Input – Check this box to manually enter a static value for the
property on the property sheet.
• QueryId Reference – If the property value should be calculated, select
this check box and use the drop-down list to select the name of the
calculation (a.k.a. query) that computes the property value.
In order to define a new calculation, refer to the e-terrasource
Metamodel Guide for information about defining a metaComputation
and exporting an upgrade script to create it.

The figure above specifies a case where an “alarm category” property
is calculated by the LoadBayCBAlarmCat calculation, which is defined
as:
select case
when <%VoltageLevel> = 500 then 'AA'
when <%VoltageLevel> = 345 then 'AB'
when <%VoltageLevel> = 230 then 'AC'
else 'AD'
end
from dual
Although a complete description of calculations is beyond the scope of
this document, the “select” statement above is an example where the
value that the user enters for the “Voltage Level” template parameter is
used to decide whether to return AA, AB, AC, or AD for the property
value.
• Parameter Reference – If the property value should be derived from a
template parameter, select this check box, and select the template
parameter from the drop-down list.

The figure above shows that the property value is based on the
“SwitchName” template parameter. Therefore, if the property sheet
shows “CB_<%SwitchName>_1” and the user enters “ABC” for the
SwitchName property, the actual property value is set to “CB_ABC_1”.
In other words, if you choose the Parameter Reference option, then for
a given template parameter “xyz”, the parameter value is substituted
where “<%xyz>” occurs in the property value.
For properties that are relationships to other records, there are four
choices for setting the value, as can be seen by clicking the button
next to the property.
Figure 110: Template Editor – Relationship Sources

• Null Value – Click the Set Field to Null and Close button to nullify the
property value. This indicates that the template does not set the value
for this relationship. When the template is instantiated, the relationship
is left null.
• Local Reference – Check this box to create a relationship to another
record within the template, and then use the drop-down list to select
the template record ID to “point” to.
The figure above shows that the relationship points to a Switch within
the template that has a Record ID of “Switch1”. Clicking the button
next to the property calls up the property sheet of the record that the
relationship points to.
• External Reference – Check this box to create a relationship to a
record outside of the template, then use the drop-down list to select
the specific record. For example, it is common for a template to have
an external reference to a reference table.
If the reference is invalid (that is, there is no such external record),
then “### INVALID ###” is displayed. Invalid external references
should be corrected before you try to use (instantiate) the template.

Clicking the button next to the property calls up the property sheet
of the external record in the auxiliary pane.
• QueryId Reference – If the relationship value should be calculated,
select this check box, and use the drop-down list to select the name of
the calculation (a.k.a. query) that computes the relationship value.
Keep in mind that, in order to make this work, the calculation has to
return the MRID of the external record to point to.
select case
when <%VoltageLevel> = 500 then
'e48f0ad49b214247af6130410e58e6a9'
' e48f0ad49b214247af6130410e58e6a8'
' e48f0ad49b214247af6130410e58e6a7'
else ' e48f0ad49b214247af6130410e58e6a6'
end
from dual
In order to define a new calculation, refer to the e-terrasource
Metamodel Guide for information about defining a metaComputation
and exporting an upgrade script to create it.
3.6.7.9.3 Template Editor – Graphic Modeler Panel
The Graphic Modeler panel of the Template Editor provides a visual
layout of the records in the template — assuming that the template
actually has records that can be viewed on the Graphic Modeler.
The functions and capabilities of the Graphic Modeler are discussed in
section 3.6.4 Graphic Modeler and are not repeated here. The only note
particular to templates is that the graphic model of the template is used to
provide a thumbnail of the template on the Template Explorer. If the

template contains no records with any graphic information, no thumbnail is
shown.
You can add additional records to the template (sourced from Deep Copy
or Graphic Modeler) by right-clicking the canvas and choosing Edit >
Paste. Records can also be added singly in the Template Editor’s Tree
View panel.
3.6.7.10 Copying/Cloning Templates
Templates can be copied and pasted, or cloned.
To copy a template:
1. Right-click the template on the Template Explorer, and choose Copy
2. Right-click the template group that the template should be pasted
under, and choose Paste from the context menu.
A New Template dialog box is shown.
3. After entering information for the new template, click OK to create the
copy under the specified template group.
Figure 111: Copy/Paste Template – New Template Dialog Box

Cloning a template is a quick way to copy/paste a template under the
same template group. Only a new template ID must be provided.
To clone a template:
1. Right-click the template on the Template Explorer, and choose Clone
A New Template dialog box is shown.
2. After entering a new template ID, click OK to create the clone under
the same template group.
Figure 112: Clone Template – New Template Dialog Box

Whether using Copy/Paste or Clone, the new template has the same
template change items, template parameters, and template parameter
rules as the source template. The Template Editor can be used to make
modifications to the new template.
3.6.7.11 Deleting Templates
Templates can be deleted if desired. Keep in mind that any instances
created from the template retain information about the originating
template ID and record ID, but this information is of limited use if the
originating template is deleted.
To delete a template:
1. Right-click the desired template on the Template Explorer, and choose
Delete from the context menu.
A confirmation dialog box is shown.
2. Click OK to delete the template.

3.6.7.12 Instantiating Templates on Tree Views
The purpose of templates is to use them to create many copies, or
instances, of the pattern of records in the template. Templates provide a
powerful method of building a model quickly and consistently.
Templates are typically created from either hierarchies in tree views or a
group of records in Graphic Modeler. Therefore, when creating an
instance of a template, the instances are created on either tree views or
the Graphic Modeler.
To create an instance of a template on a tree view:
Copy from the context menu.
2. On the appropriate tree view, locate the parent record that you want to
paste the template instance under. Right-click the parent record, and
choose Paste from the context menu.
If the Paste option is disabled, you have chosen the wrong type of
record from the tree view.
If the template has no parameters, the instance is created. If the
template has parameters, a dialog box is displayed to allow the user to
enter the template parameters.
The parameters that are entered are typically used to derive various
property values for the instance. You can hover the cursor over a
parameter label to obtain a tool tip that provides more information
about the parameter.
Once the instance is created and the resulting change items are
saved, each record that was created from the template has information
at the top of its property sheet that identifies the template ID and
record ID from which it originated.

3.6.7.13 Instantiating Templates on Graphic Modeler
The purpose of templates is to use them to create many copies, or
instances, of the pattern of records in the template. Templates provide a
powerful method of building a model quickly and consistently.
Templates are typically created from either hierarchies in tree views or a
group of records in Graphic Modeler. Therefore, when creating an
instance of a template, the instances are created on either tree views or
the Graphic Modeler.
To create an instance of a template in Graphic Modeler:
Copy from the context menu.
2. On the Graphic Modeler canvas, press <ctrl>V to paste — or right-click
the canvas, and choose Edit > Paste from the context menu.
If the template has no parameters, the instance is created. If the
template has parameters, a dialog box is displayed to allow the user to
enter the template parameters.
The parameters that are entered are typically used to derive various
property values for the instance. You can hover the cursor over a
parameter label to obtain a tool tip that provides more information
about the parameter.
WARNING: If you instantiate a template on a Graphic Modeler canvas,

it is possible that some, or even all, of the records are not visible on
the canvas — but they are created anyway, as you can see from

checking the Unsaved Change Items view. You may need to use a
tree view or grid to view the newly created records.
Once the instance is created and the resulting change items are
saved, each record that was created from the template has information
at the top of its property sheet that identifies the template ID and
record ID from which it originated.
3.6.8 Modeling in Excel

The e-terrasource user interface provides powerful grid displays, and
supplements them by providing the capability to integrate with Microsoft
Excel.
Integration with Excel means that you can:
• Export model data from a paged grid display (or Search results grid) to
an Excel workbook.
• Export hierarchical model data from any tree view to an Excel
workbook. A separate worksheet is created for each record type.
Note that hierarchical export is prevented for certain record types

(such as HostControlArea, GeographicalRegion, and
SubGeographicalRegion) because of the potentially large quantity of
data in the hierarchy.
• Insert, delete, or modify records in Excel. Handy picklists are provided

to ensure accurate data entry.
• Import a modified Excel workbook back into e-terrasource. The
changes that were made in Excel are identified and represented as
new change items in the active project.
These capabilities allow you to send an Excel file containing model data to
a non–e-terrasource user. Any modifications they make can be imported
back into an e-terrasource project.

Furthermore, e-terrasource grids that contain data other than model data
can also be exported to Excel. For example, the Project View grid display
can be exported to Excel. Import of such data is not allowed.
3.6.8.1 Exporting from Tree Views
Most tree view records have two options to Export to Excel on the context
menu:
• Choose Tables – When this option is chosen, a dialog box is
presented that allows the user to choose the tables to export. The
choices are retained in your user preferences. This option should be
used when the user knows which tables are important and which can
be omitted to speed up the export.
• Entire Hierarchy – When this option is chosen, all tables in the
hierarchy are exported. With large hierarchies, this can be time-
consuming.
The Excel file contains the data for the parent record, as well as data for
each selected child record type in the tree view.
Note that there is currently a limitation where a maximum of 256 columns
can be exported per record type.
3.6.8.1.1 Exporting an Entire Hierarchy
This option is used to export a selected record and all child records
belonging to it. When this option is chosen, a standard Save File dialog
box is shown, which allows you to choose the name and location of the
Excel file. Clicking OK in the Save File dialog box begins the export of the
hierarchy to Excel.
This option allows importing the created spreadsheet into a different
workspace to create a record hierarchy from scratch.
Note that dumping an entire record hierarchy might be time-consuming,
depending on the number of child record types and the record count.
3.6.8.1.2 Exporting Chosen Tables
It is not always necessary to export all possible child record types for a
given parent record. Instead, the user might want to export a limited set of
record types, modify them in Excel, and import the changes back into
e-terrasource. The export and the subsequent import are performed more
quickly if fewer tables are chosen.
When this option is selected, a dialog box for picking the desired child
record types is shown:

Figure 113: Choose Tables to Export to Excel
Any modifications to the check boxes are retained in your user
preferences and used for all subsequent exports.
After clicking OK, a standard Save File dialog box is shown. The rest of
the export process is similar to dumping the entire hierarchy.
Note that an Excel spreadsheet created using this option cannot be
imported using the Import All Data from Excel option, which is used to
create an entire record hierarchy. It is possible only to Import Changes
from Excel.
3.6.8.2 Exporting from Grid Views
The current page of a grid display can be exported to Microsoft Excel
using the Export to Excel option on the grid’s context menu. If you have
more than one page of data that you want to export, you can increase
your grid page size using View > User Preferences.
After choosing this option, a standard Save File dialog box is shown,
which allows you to choose the name and location of the Excel file.

Clicking OK in the Save File dialog box begins the export of the grid data
to Excel.
Note that there is currently a limitation where a maximum of 256 columns
can be exported.
3.6.8.3 Modifying Data in Excel
Excel workbooks that are exported from e-terrasource are not “plain”
workbooks. They have some particular features and characteristics to
help with modeling and importing changes back into e-terrasource.
• There is an invisible copy of every visible worksheet. When importing
the workbook back into e-terrasource, the modified visible worksheet
is compared to the original invisible copy to determine what changes
were made, and change items are created accordingly.
• There are invisible worksheets to support picklists and foreign key
selections.
• Macros are used for certain functions.
• Hidden columns are used to store values such as the record MRID.
Therefore, in order to perform modeling in Excel, you must start with an
Excel workbook that was exported from e-terrasource, and enable
macros.
Figure 114: Excel Export of Hierarchy

Figure 114 depicts an Excel workbook of a substation hierarchy.
On each worksheet, records can be modified, inserted, or deleted:
• Modify – Enter a new value in the desired cell. For cells containing
relationships, a picklist is available to choose the target record.
Properties with picklists in e-terrasource also have picklists in Excel.

• Insert – Fill the cells in a new row, or copy/paste an existing row and
modify it as desired.
• Delete – Delete the desired row. Do not simply blank out each cell in
the row.
3.6.8.4 Importing Changes from Excel
After changes have been made to model data in an Excel workbook that
originated from e-terrasource, the modifications can be imported into the
active project.
To import changes from an Excel workbook, perform the following steps:
1. Click the drop-down list on the Import toolbar button, and choose
Import Changes from Excel.
A standard Open File dialog box is displayed that allows you to
browse, and select the desired Excel workbook file.
2. Click OK to import the file.
After the import completes, a dialog box is displayed that indicates the
number of changes that were imported.
During this type of Excel import, e-terrasource compares the modified

worksheets with the (invisible) original spreadsheets to determine what
modifications were made. Change items are created in the active
project to represent those modifications.
During the import process, the changes are checked against any range
expressions or regular expressions to ensure that the entered data is
valid. If any errors are encountered, the cells failing validation are
highlighted and a dialog box appears asking if you want to import the
changes — even if they do not satisfy the range or regular
expressions.
3. To review the change items that were created, right-click the active
project in the Loaded Projects section of the home page, and choose

3.6.8.5 Importing All Data from Excel
This option is typically used when you want to perform a wholesale
replacement of a record hierarchy with an updated version from Excel.
For example, suppose workspace A has an old version of substation
Chenaux, and workspace B has a new version of substation Chenaux. To
replace the substation model:
1. Export substation Chenaux to Excel from a tree view in workspace B.
2. Switch to Workspace A, create a new active project, and delete
substation Chenaux.
3. Use the Import All Data from Excel option to create change items that
represent the entire Chenaux substation from the Excel file.
To import all data from an Excel workbook, perform the following steps:
1. Click the drop-down list on the Import toolbar button, and choose
Import All Data from Excel.
A standard Open File dialog box is displayed that allows you to
browse, and select the desired Excel workbook file.
2. Click OK to import the file.
After the import completes, a dialog box is displayed that indicates the
number of changes that were imported.
During the import process, the changes are checked against any range
expressions or regular expressions to ensure that the entered data is
valid. If any errors are encountered, the cells failing validation are
highlighted and a dialog box is displayed asking if you want to import
the changes — even if they do not satisfy the range or regular
expressions.
3. To review the change items that were created, right-click the active
project in the Loaded Projects section of the home page, and choose
Note that only the spreadsheets created by the Export Entire Hierarchy
function can be imported in the All Data mode.

3.7 Importing/Exporting Data
e-terrasource provides several formats for importing and exporting data:
• CIM/XML – CIM/XML files representing a complete model authority set
can be imported into a workspace or exported from a workspace. Also,
CIM/XML difference models (incremental files) can be exported from
projects, or imported into e-terrasource as projects.
• Model Authority Set Dump/Load – e-terrasource has a native format
for writing out model authority set data to a file. Model authority sets
can be dumped to files or loaded from files in this format.
• Project Dump/Load – e-terrasource also has a native format for writing
out projects to a file. Projects can be dumped to files or loaded from
files in this format.
• Excel – The e-terrasource user interface supports the ability to export
model data to Excel and import changes from Excel (for additional
information, refer to section 3.6.3.10 Export to Excel). The remainder
of this section is not relevant to Excel imports and exports.
The Administration Explorer lets suitably authorized users view and
configure the types of import and exports that are available (for more
information, refer to section 4.6 Managing Import/Export Metadata).
When an import or export request is submitted, the workspace associated
with it is automatically locked. The e-terrasource Import/Export server
releases the lock when the request is completed. In addition, the request
queue is monitored to make sure that any stalled requests eventually time
out and release their lock on the workspace. The workspace is locked in
order to prevent the model data from changing while the import or export
is being performed. Multiple requests can be successively queued for the
same workspace, and each request executes when the prior request in
the queue completes.
If an import/export request terminates abnormally, it is possible that the
workspace could be left in a locked state (until the request times out). If
this occurs, you can manually unlock the workspace, as described in
section 4.2.2 Viewing/Modifying Workspace Information.
When importing into a workspace, keep in mind that the workspace is not
automatically reset, and imported data is inserted alongside any
pre-existing data.
Be aware that a model authority set is not automatically created as part of
the import process. You must create a model authority set after the import
completes if you want to preserve the data.

Importing data into a workspace generally requires the user to specify the
model authority set type associated with the data. This is used for two
purposes:
• Model Authority Set Type Assignment – After import, all records in the
workspace that are not saved in a model authority set are assigned to
the model authority set type specified during import. It is important to
make sure this setting is correct before performing the import;
otherwise, all imported records will be assigned to an incorrect model
authority set type, which is tedious to correct afterwards.
WARNING: If you are re-importing data that was previously imported,

the original model authority set type assignment is retained. The
assignments of records to model authority set types can be viewed
and changed on property sheets (for more information, refer to section
3.6.2.1 Header Information.
WARNING: If you plan to import multiple files and assign the imported
records to different model authority set types, it is important to create a
model authority set after each import. For example, consider the
scenario where files A and B contain data intended for model authority
set types A and B, respectively.
The proper sequence is:

1. Set the default model authority set type on the toolbar to A.
2. Import file A.
3. Create a model authority set (A version 1).
4. Set the default model authority set type on the toolbar to B.
5. Import file B.
6. Create a model authority set (B version 1).
7. If you skip step 3, after step 5 all records will be assigned to model
authority set type B.
• Data Security – At the end of the import, the model authority that owns
the model authority set type is granted read-write access to all
imported records.
For import types other than CIM/XML, constraints are disabled prior to the
import, and enabled at the end of the import. If you receive a warning that
some constraints cannot be enabled, you should check the Constraint
Violations view to determine which constraints are violated by the
imported data.
By default, referential constraints are disabled while resetting a workspace
or loading data into a workspace. Check constraints are not disabled

unless you set the “db_disable_check_constraints” parameter in the
Administration Explorer.
When you build a model using e-terrasource, the referential and check
constraints are enforced by the user interface, so you cannot enter data
that violates these constraints. However, if you import data from an
external source, such as a CIM/XML file, the imported data can be of
questionable quality and may not satisfy the referential and check
constraints. Therefore, when importing data from an external source, it
may be desirable to set “db_disable_check_constraints” to Yes so that
check constraint violations do not prevent the data from being loaded. For
more information about constraints, refer to section 3.10 Constraint
Violations.
There are four important concepts with regards to import/export:
• Sequence – An import or export is expressed as a sequence of one or
more steps to execute. The user requests execution of a particular
sequence, and the Import/Export Progress dialog box reports the
progress of each step in the sequence. When all steps are finished,
the sequence is considered complete.
In some cases, individual steps execute in parallel, whereas other
steps may execute sequentially. If any step fails or times out, any
remaining steps in the sequence are not performed. For example, a
sequence named “Deploy Full Model” might be made up of many
steps.
• Type – Each step in a sequence executes a particular type of task.
Such a task might include the actual importing or exporting of data, or
the execution of a script that furthers the process. Each step identifies
the type of task to perform.
For example, “CIM/XML Import” is a type that handles reading a full
CIM/XML file.
• Target – Imports are performed from a “source”, and exports are
performed to a “destination”. These “sources” and “destinations” are
referred to as “targets”. A typical source target might be “File”.
For export, multiple destinations can be configured, such as
“Production System” or “Test System”.
• Parameters – Parameters are used to hold configurable values for a
particular target.
For example, a CIM/XML Import from a File target might have
parameters that specify the file name and directory name. Some
parameters may reference “proxy strings” using the notation
“<%Proxy>” (for more information, refer to section 4.6.7 Proxies).

3.7.1 Local File vs. Server File
For file-based imports and exports, there are typically two possible
targets:
• Local file – A file on the user’s local PC (or a mapped network drive)
• Server file – A file on the e-terrasource server
Local file imports and exports require a bit more time because the file
must be transferred to or from the server. Although the file is compressed
prior to the transfer, it always takes longer than server file imports —
particularly since files containing model data can be quite large.
When choosing the server file target, files to import should reside in
<drive>:\ETERRA\e-terrasource\import
on the e-terrasource server.
Exported files can be found in
<drive>:\ETERRA\e-terrasource\export
on the e-terrasource server.
If you choose Local File for an import operation, the e-terrasource client
first zips the file (unless it is already zipped), and then transfers it to the
server for processing. The server stores the received file in a user-specific
directory that defaults to:
<drive>:\ETERRA\e-terrasource\user\<username>
If you choose Local File for an export operation, the file is exported on the
server, then zipped and transferred to the local PC in the directory you
specify. If you give the file a “.gz” extension, it remains compressed on
your local drive.
If you choose Server File for an import operation, and the file has a “.gz”
extension, the file is unzipped first, then imported.
If you choose server file for an export operation, and you specify a file
name with a “.gz” extension, the file is compressed after it is exported.
3.7.2 CIM/XML Import/Export

3.7.2.1 Overview
The International Electrotechnical Commission (IEC) has developed a
Common Information Model (CIM), primarily for the purpose of supporting
the exchange of power system models. This exchange standard is known

as “IEC 61970”, but this standard has several subparts defining more-
specific functionality.
The IEC 61970 data exchange standard is more commonly referred to as
the “CIM/XML standard”, because of Extensible Markup Language (XML)
formatting of the data in the CIM/XML packages.
CIM is a versioned data model. For information about the particular
version of CIM supported by e-terrasource, refer to the e-terrasource
Release Notes.
A CIM/XML file can represent a full model authority set or incremental
modifications to a model authority set. Full model authority set files
produced by e-terrasource have names of the form “<xyz>_cim.xml”.
Incremental files have names of the form “<xyz>_ciminc.xml”. It is
recommended that this naming convention be used so that it is obvious to
users whether a file is a full or incremental CIM/XML file.
Currently, there is one public CIM interface standard supported:
IEC 61970-452. The 452 part was originally known by the acronym
“CPSM” (Common Power System Model). The 452 standard is re-issued
by the IEC infrequently; it is typically updated on an annual basis as part
of EPRI-sponsored CIM interoperability testing.
As a general rule, new e-terrasource versions support the latest
interoperability test version that can be accommodated in a given release
development schedule. It normally also supports backward compatibility
with older interoperability tests; however, backward compatibility is subject
to practical constraints and is not guaranteed.
The CIM model is designed to support extensions. Indeed, the model
delivered with e-terrasource contains extensions to support Alstom Grid’s
Energy Management System (EMS) suite: e-terraplatform. Thus the
business model schema is called “CIM/EMS”.
A common synonym for a “CIM interface standard” is “profile”. The
e-terrasource product comes with several preconfigured profiles, and it is
not uncommon to create additional profiles. A profile filters the model by
identifying classes, properties, and associations that are relevant for a
particular purpose. The purpose of the CPSM profile is to identify the
portions of the model that are required to support execution of a network
power flow. This profile is used most commonly in EPRI-sponsored
vendor interoperability testing.
Another profile provided with e-terrasource filters the portions of the
model that are necessary to support e-terraplatform. The CIM/XML
transfers between e-terrasource and e-terraplatform through the
transformation subsystem use this profile.

Figure 115: CIM/XML Import/Export
It is a common practice to create additional profiles to select the type of
information sent to a particular type of external target system. For
example, if e-terrasource is configured in your environment to send model
data to a market system (such as e-terramarket), it is very likely that a
profile is created to select only the data that the market system is
interested in receiving. For additional information about creating CIM
profiles, refer to the e-terrasource Metamodel Guide and the
e-terrasource Software Installation and Maintenance Guide.

3.7.2.2 Warnings and Errors
Import or export of CIM/XML files can result in warnings or errors.
If warnings occur, they are logged as described below, but processing
continues. It is important to note that the import status will indicate
success even if warnings are encountered.
If errors occur, the processing is terminated abnormally, and the import
status indicates failure.
During the import or export of CIM/XML files, data that cannot be mapped
between e-terrasource and the selected CIM profile is not processed, and
one or more warning messages are displayed in the Import/Export
Progress dialog box. Further information about the mapping process and
troubleshooting the mapping can be obtained in the e-terrasource
Software Installation and Maintenance Guide.
The following warnings may appear in the Import/Export Progress dialog
box during CIM/XML import/export processing:
• One or more CIM classes not found in CIM Profile
This warning indicates that the CIM/XML file included data for a CIM
class, but that class was not found in the CIM profile. This implies that
the CIM/XML file is not actually following the selected profile.
• One or more associations (CIM type) not defined in CIM profile
This warning indicates that the CIM/XML file included an association
that was not found in the CIM profile. This implies that the CIM/XML
file is not actually following the selected profile.
• One or more CIM properties not defined in CIM profile
This warning indicates that the CIM/XML file included a property that
was not found in the CIM profile. This implies that the CIM/XML file is
not actually following the selected profile.
• One or more CIM properties data type not defined
This warning indicates that, although the CIM property was defined in
the profile, its data type was not defined.
• One or more CIM properties does not have mapping CSM column
This warning indicates that no matching e-terrasource column can be
found for a particular CIM property. For troubleshooting information,
refer to the e-terrasource Software Installation and Maintenance
Guide.

• One or more CIM classes does not have mapping CSM table
This warning indicates that no matching e-terrasource table can be
found for a particular CIM class. For troubleshooting information, refer
to the e-terrasource Software Installation and Maintenance Guide.
• CIM Profile is not selected or selected profile is not found
This warning indicates that a valid CIM profile was not selected in the
Import/Export dialog box.
• One or more records are already assigned to a different Model
Authority Set Type
This warning indicates that the user has requested the imported
records to be assigned to a certain Model Authority Set Type.
However, one or more records were already found to have been
assigned to a different Model Authority Set Type.
Errors can also occur during the processing of CIM/XML files. A complete
list of error conditions is not possible, but two common errors are listed
here:
• Failure to open or access the file – Ensure that you have properly
chosen Local File vs. Server File. For Server File imports, ensure that
the file is in the server’s import directory.
• Failure to parse the file – When the input CIM/XML file contains
characters that are invalid for the defined XML encoding, the file
parsing fails. The error message indicates the object name, MRID, line
number, and character position of the offending character.
In the event that any errors or warnings are displayed, additional
information can be obtained from log files on the server. For more
information, refer to the e-terrasource Software Installation and
Maintenance Guide.
3.7.2.3 CIM MRID vs. CSM MRID
During a full CIM/XML import, two important artifacts are created:
• A mapping between the e-terrasource Master Resource Identifier
(CSM MRID) and the CIM MRID is established. The first time a CIM
record is imported, an e-terrasource MRID is generated and assigned.
The mapping between the e-terrasource MRID and the CIM MRID is
retained in the database so that any future imports of the CIM model
authority set file result in the same e-terrasource MRID being used.
Note: The default behavior is to reuse the same e-terrasource MRID if
the imported CIM/XML file is assigned to the same model authority set

type, and assign a new e-terrasource MRID if the imported CIM/XML
file is assigned to a new model authority set type. The default behavior
can be changed if necessary. For more information, refer to the
• Information that tracks the CIM MRID, the CIM class name, and the
CIM profile name for each imported record is retained. This
information is required in order to properly process any future CIM
incremental files associated with the full model. This means that a CIM
incremental file cannot be properly processed unless the full model on
which it is based was previously imported.
When importing data from e-terrahabitat savecases through the
Transformation subsystem, an intermediate CIM/XML “ETS” file is
created. Generally speaking, the CIM MRIDs in this file correspond to
e-terrahabitat OIDs. In other words, after importing from savecases, you
will probably find that the CIM MRID of a particular record corresponds to
the Hdb OID of the record in the savecase.
During a CIM/XML export, the CIM MRID of a record is written to the
CIM/XML file. However, if the CIM MRID is blank, the e-terrasource MRID
(CSM MRID) is written instead. This means that you are not required to fill
the CIM MRID field for newly created records. When writing CIM/XML
files, the CSM MRID is used as the CIM MRID.
3.7.3 Model Authority Set Dump/Load

e-terrasource uses an efficient format for dumping model authority set
data out to a file. The format is closely aligned with the internal
representation of model data in the e-terrasource client; therefore, this
format is typically quicker to process than CIM/XML, and does not require
creation of a CIM profile.
Files in model authority set format have names of the form
“<xyz>_MAS.xml”. It is recommended that this naming convention be
used so that it is obvious to users that a file represents a model authority
set dump.
3.7.4 Project Dump/Load

e-terrasource uses a proprietary format for dumping project data out to a
file. The format is closely aligned with the “change item” representation;
therefore, this format is typically quicker to process than CIM/XML, and
does not require creation of a CIM profile.
Files in project format have names of the form “<xyz>_project.xml”. It is
recommended that this naming convention be used so that it is obvious to
users that a file represents a project dump.

3.7.5 Export Workspace
Model data can be exported from e-terrasource using the
Export Workspace option. Upon installation, e-terrasource typically has
the following workspace export sequences defined:
• CIM/XML exports of model authority sets
• Model authority set dumps
• Options to export one or more models to e-terraplatform
Although it is not required, it is generally a good idea to:
• Validate the model as completely as possible within e-terrasource
before it is exported to a target system
• Create a model or model authority set prior to export so that it is easy
to reload the data that was exported to a target system
When performing an import or export, a wizard-like series of dialog boxes
are used to enter the desired sequence, targets, and parameters. All
entries and selections you make in the dialog boxes are retained in your
user preferences and used as initial values in your next export. To clear
all import/export user preferences, select Restore Defaults in View > User
Preferences.
You can also restore default parameters per target, as described below.
In order to export model data from a workspace, perform the following
steps:
1. Select the Export Workspace option in the drop-down list on the Export
toolbar button.
2. In the first dialog box, choose a workspace export sequence from the
list of available sequences.
A description of the selected sequence is displayed based on your
selection. Also, the dialog box reminds you that the workspace is
locked for the duration of the export.
3. If you do not need to change any target or parameter information, click
Finish to begin the export. Otherwise, choose Next.

The next dialog box displays each step in the selected sequence. If a
step is optional, a check box is shown to indicate if the step should be
executed or skipped. Each step has an Edit button next to it, which
allows the target and parameters to be viewed and modified.
4. After setting the check boxes appropriately, click Next to view a
summary of the sequence, or click Finish to begin the sequence
immediately, or choose Edit to change the target or parameters for a
step.

If the Edit button is chosen for a step, a dialog box is shown that
contains a picklist of available targets, and a list of the target
parameter values that are to be used. You can change the target and
the parameter values as desired, although some parameter values
may not be editable.
Note that some parameter values can contain “proxy strings” (for more
information, refer to section 4.6.7 Proxies). If you click the Restore
Defaults button, the parameter values revert to their default values for
this target.
5. Click OK to save the choices for this target.
If you chose “Next” in step 3, a final confirmation dialog box is shown
that lists each step in the sequence, as well as the parameter values
that are to be used.
6. Click Finish to begin the export sequence.

When the export sequence is started, the Import/Export Progress
dialog box is displayed (for more information, refer to section
3.7.9 Import/Export Progress Dialog Box).
3.7.6 Export Project

Projects can be exported from e-terrasource using the Export option on
the project’s context menu. Upon installation, e-terrasource typically has
the following project export sequences defined:
• Incremental CIM/XML exports of projects
• Project dumps
Although it is not required, it is generally a good idea to validate the
project or model as completely as possible within e-terrasource before it
is exported to a target system.
Preferences. You can also restore default parameters per target, as
described below.
In order to export a project, perform the following steps:
1. Locate the desired project in one of the following displays:
− The Loaded Projects section of the home page
− The Project view
− The Loaded Projects section of the Workspace Explorer
2. Right-click the project to display its context menu, and choose the
Export option.
A dialog box is shown that allows you to choose an export sequence.
3. In the first dialog box, choose a project export sequence from the list of
available sequences.
locked for the duration of the export.
Finish to begin the export. Otherwise, choose Next.

step.

this target.
7. Click Finish to begin the export sequence.

When the export sequence is started, the Import/Export Progress
3.7.7 Import into Workspace

Model data can be imported into e-terrasource using the
Import into Workspace option. Upon installation, e-terrasource typically
has the following workspace import sequences defined:
• CIM/XML imports of model authority sets
• Model authority set dumps
• Options to import one or more models from e-terraplatform
Although it is not required, it is generally a good idea to create a model or
model authority set after import so that it is easy to revert back to the data
set that was originally imported.
described below.
In order to import model data into a workspace, perform the following
steps:
1. Click the Import into Workspace option in the drop-down list on the
Import toolbar button.
2. In the first dialog box, choose a workspace import sequence from the
list of available sequences.
locked for the duration of the import.

Finish to begin the import. Otherwise, choose Next.
step.

this target.

6. Click Finish to begin the import sequence.
When the import sequence is started, the Import/Export Progress

3.7.8 Import into Project

Model changes can be imported into an e-terrasource project using the
Import into Project option. Upon installation, e-terrasource typically has
the following project import sequences defined:
• Incremental CIM/XML imports of model changes
• Project load
• Import of e-terrascada “change documents” into projects
described below.

In order to import model changes into a project, perform the following
steps:
1. Select the Import into Project option in the drop-down list on the Import
toolbar button.
2. In the first dialog box, choose a project import sequence from the list of
available sequences.
locked for the duration of the import.
Finish to begin the import. Otherwise, choose Next.

step.
this target.

6. Click Finish to begin the import sequence.
When the import sequence is started, the Import/Export Progress

3.7.9 Import/Export Progress Dialog Box

Once an import or export is requested, the e-terrasource user interface
displays the Import/Export Progress dialog box.
Figure 116: Import/Export Progress Dialog Box

The top portion contains:
• The unique request number for this particular execution
• The name of the import or export sequence
• A list of steps in the sequence, with the following information per step:

− The name of the step
− A progress bar that disappears when the step completes
− The start and end times for the step
− The current status for the step
− The name of the target that is the source of the import, or the
destination of the export
− The project ID if this was a request to import/export a particular
project
− The workspace ID and user requesting the validation
− If the target system reports a status back to e-terrasource, it is
shown in the Target Status column
− Identification of the machine and process that is executing the
request
The bottom portion of the dialog box contains the messages associated
with the request. If any of the steps fail, the reason for failure is reported
here. Generally speaking, much more information about the failure can be
obtained by examining the log files of the Import/Export services. For
more information about troubleshooting import/export failures, refer to the
Depending on how the sequence was defined, there can be one or more
steps in the sequence, and steps may execute sequentially or in parallel.
Each step has a completion status. If any step fails or times out, the
remainder of the sequence is not executed.
During the processing of a request, a Cancel button appears next to

the sequence name. To request cancellation of the sequence, click the
button. Any future steps have their status set to Canceled, and any
in-progress steps are set to Canceling. The import/export services
periodically check to see if cancellation has been requested, and the
status is updated from Canceling to Canceled. In some cases,
cancellation does not stop the step that is in progress, so the sequence
does not stop until it completes.
WARNING: If an import sequence fails or times out, the content of the

workspace cannot be trusted. You must assume the worst case scenario:
that the data was partially imported. You should reset your workspace to
clear it before retrying the import. You may also have to unlock the
workspace first using the workspace property sheet.

WARNING: If the request status is Timeout, this means that the
import/export sequence took longer than expected; however, it does not
terminate the import/export sequence. You can modify the timeout value
for an import/export type, as described in section 4.6.4 Creating an
Import/Export Type.
When an export sequence completes, the Recent Deployments section of

the home page is updated to display information about the export.
If you close the Import/Export Progress dialog box, you can still access
information about imports and exports by clicking View > Import/Export
History (for more information, refer to section 3.7.10 Import/Export History
View).
3.7.10 Import/Export History View

A history of completed import/export requests is retained for a
configurable period of time (seven days, by default). To view the history,
choose View > Import/Export History.
The Import/Export History view is very similar to the Import/Export
Progress dialog box.
Figure 117: Import/Export History View

The top level contains:
• The unique request number for each execution
• The name of the import/export sequence
• A button to open the messages associated with this request in the log
pane
Each request can be expanded to view the list of steps in the sequence,
with the following information per step:
• The name of the step
• The start and end times for the step
• The overall completion status for the step

• If the target system reports a status back to e-terrasource, it is shown
in the Target Status column
• Identification of the machine and process that executed the request
3.7.11 e-terraplatform Exports and Imports

One of the main purposes of e-terrasource is to supply EMS models to
e-terraplatform. Although the particulars regarding target environments
(e.g., test vs. production) and modeling business processes may vary
widely from organization to organization, the basic concept is the same:
extract a portion of the model from e-terrasource, transform it, and place
it into an e-terraplatform Hdb database. Imports into e-terrasource simply
work in the opposite direction.
The following e-terraplatform models are supported by e-terrasource:
Hdb Database Description
NETMOM e-terratransmission model
GENMOM e-terrageneration model
SCADAMOM SCADA model
DTSMOM e-terrasimulator model
ALARM Alarm model
OAGMOM e-terracomm model
CTGS Contingency analysis model
RASMOM Remedial action scheme model
RGALM e-terrageneration alarm model
DYDEF e-terrasimulator dynamics default model
3.7.11.1 Exports
Upon installation, e-terrasource is configured with several export
sequences that are useful for exporting models to e-terraplatform. Each
sequence has three basic steps:
1. Produce CIM/XML that represents the model data in the workspace.
The CIM/XML Import/Export service creates the CIM/XML using a CIM
profile called “ETS”. At this time, the same ETS profile is used
regardless of the Hdb database that is being processed, and it
contains all modeled fields; nothing is filtered out. So, whether you
intend to populate only NETMOM or only ALARM, the same profile is
used. For more information about CIM profiles, refer to section
3.7.2 CIM/XML Import/Export.

2. Feed the CIM/XML data to the transformation subsystem and produce
data that can be loaded into an Hdb database.
For each supported Hdb database, the transformation subsystem has
modules that contain instructions on how to convert the e-terrasource
data into Hdb data (and vice versa for imports).
3. Load the resulting Hdb data into a clone or savecase.
Optionally, e-terraplatform validation programs can be executed, and
the savecases can be compressed into a zip archive.
The following EMS export sequences are configured when e-terrasource
is installed. The sequences available on your system may vary from this
list.
EMS Export Sequence Description
EMS Export – with Zip Export CIM/XML, run transformations for
all e-terraplatform models to produce
savecases. All e-terraplatform validation
programs are executed and, if successful,
a zip archive is created containing all
savecases.
EMS Export – All Export CIM/XML, run transformations for
each e-terraplatform model, and run
validation. A zip archive is not created.
EMS Export – <database> Export CIM/XML, run transformation and
e-terrasource validation for the specified
database.
Note that individual steps in a sequence can be skipped by unchecking
the step in the Edit Workspace Export Targets dialog box.
The zip archive produced by the “EMS Export – with Zip” sequence is
intended to be used by the e-terraplatform DBSEQ (database sequence)
utility.
The e-terrasource database has no concept of a maximum number of
records per table, such as the “MX” concept in the e-terrahabitat Hdb
databases. Therefore, e-terrasource allows you to model records beyond
the limits of any Hdb MX values. If the exported data set exceeds the MX
value for any record, the export process reports an error when attempting
to load the data into the Hdb clone. If this occurs, you must increase the
record’s MX value in Hdb or reduce the number of records in
e-terrasource.

3.7.11.2 Imports
There are some very important considerations when importing models
from e-terraplatform:
• The primary purpose for importing models from e-terraplatform should
be to initialize e-terrasource. It is expected that, once e-terrasource is
initialized, the models will be maintained in e-terrasource and exported
to e-terraplatform.
• The e-terraplatform models that are being imported must be
successfully validated, cross-mapped, and imported together in a
single import sequence. This requirement is mandatory because the
transformation process must “federate” the model during import.
The term “federate” refers to the creation of a single e-terrasource
record, even though that record can be represented in several
e-terraplatform databases. The federation relies on name matching,
as well as the use of SCADA (SCAPI) keys to identify linked records.
For example, if the transformation process is unable to properly link
records, this can result in the creation of GenericEquipment rather
than the proper equipment type.
• Records from e-terraplatform are expected to have stable Hdb OIDs
with no duplicates across any Hdb databases. During import, the
object identifiers (OIDs) are used as the CIM MRIDs; therefore,
duplicate OIDs lead to import errors. If the OIDs change, the records
are treated as new records and new e-terrasource MRIDs are
generated. If new e-terrasource MRIDs are generated for records that
are really the “same” record, your projects may now have change
items that cannot be applied because they reference old MRIDs. Use
the “find_duplicate_oids” tool (described in the e-terrasource Software
Installation and Maintenance Guide) to locate and correct any
duplicate OIDs prior to importing.
• Generally speaking, there may be discrepancies if you perform a
comparison between a source e-terraplatform savecase and a
savecase exported from e-terrasource. For example, when importing a
contingency model, only valid contingencies are imported. For further
information, refer to the e-terrasource Release Notes.
3.8 Validation
Validation of model data is performed on several levels:
• Data entry restrictions – The e-terrasource user interface prevents
illegal data entry by restricting what the user can enter. Examples of
this are:

− Picklists – Properties that reference picklists have their values
constrained so that only values from the picklist (including null) can
be chosen. The user does not have the ability to enter an illegal
value (for more information, refer to section 3.10 Constraint
Violations).
− Relationships – Relationships have their values constrained so that
only values from the foreign key editor (including null) can be
chosen. The user does not have the ability to enter an illegal value
(for more information, refer to section 3.10 Constraint Violations).
− Date/Time – Date/Time fields have text fields that are constrained
to legal date/time values. The user does not have the ability to
enter an illegal value.
− Length – If the metadata for a property specifies a maximum
length, the user interface does not allow entry of a value that
exceeds the maximum length.
• Data entry validation – The e-terrasource user interface performs data
entry validation as soon as the user leaves an enterable field.
Examples of such checks are:
− Data type checks – For numeric fields, entry of non-numeric text is
prohibited.
− Range expression – For numeric fields, if a range expression has
been specified in the metadata, the user entry is validated against
the range expression (for more information, refer to section
3.6.6.1 Range Expressions).
• Regular expression checks – For text fields, if a regular expression has
been specified in the metadata, then the user entry is validated against
the regular expression (for more information, refer to section
3.6.6.2 Regular Expressions).
• Workspace validation – Workspace validation is executed upon user
request. Workspace validation checks all of the workspace data
against the validation rules that are associated with the validation
sequence that was requested.
• Project validation – Project validation is executed upon user request.
Project validation checks only the validation rules that are associated
with the requested validation sequence, and also associated either
directly or indirectly with the change items in a project.
• External validation – Additional validation can be performed in external
systems, such as e-terraplatform.

• Overlapping change items – e-terrasource informs the user when
there are potentially conflicting change items in different projects (for
more information, refer to section 3.4.5 Viewing Overlapping Change
Items).
• Unapplied change items – e-terrasource informs the user when
change items in a project cannot be applied successfully (for more
information, refer to section 3.4.4 Viewing Unapplied Change Items).
Validation rules are grouped into modules. These validation modules are
in turn grouped into validation sequences. When requesting either project
or workspace validation, the user selects the desired validation sequence
from the user interface.
A validation sequence, consisting of one or more modules, can be
configured to run serially or in parallel. The rules in each module are
checked independently, and the results are returned back to the user and
viewable in the Validation Progress dialog box or the Validation History
view.
Validation sequences, modules, and rules are defined in the
e-terrasource metadata. For further information, refer to the e-terrasource
Metamodel Guide.
3.8.1 Starting a Validation Sequence

Validation can be requested for a project or the entire workspace.
To request validation of a project, perform any of the following steps:
• On the toolbar, select the drop-down list on the Validation button, and
choose Validate Active Project to validate the currently active project.
desired project, and choose Validate from the context menu.
• From the Projects View, right-click on the desired project, and select
Validate from the context menu.
• From the Workspace Explorer, right-click on a loaded project, and
select Validate from the context menu.
To request validation of a workspace, select the drop-down list on the
validation button, and choose Validate Workspace.
Figure 118: Toolbar Validation Button

A dialog box lists the available validation sequences that can be
performed. When a validation sequence is selected, a description of the
sequence is shown in the dialog box.
Figure 119: Validation Sequence Dialog Box

Click OK to execute the validation sequence. A Validation Progress dialog
box lists each module in the sequence, as well as the validation
messages (for more information, refer to section 3.8.2 Validation Progress
Dialog Box).
3.8.2 Validation Progress Dialog Box

Once validation is requested, the e-terrasource user interface displays the
Validation Progress dialog box.
Figure 120: Validation Progress Dialog Box

The top portion contains:
• The unique request number for this particular execution
• The name of the validation sequence
• A list of modules in the sequence, with the following information per
module:

− The name of the module
− A progress bar that disappears when the module completes
− The start and end times for the module
− The overall completion status for the module
− The project ID if this was a request to validate a particular project
− The workspace ID and user requesting the validation
− Identification of the machine and process that is executing the
request
The bottom portion contains the validation messages associated with the
request. If any of the modules fail, the detailed error messages are
reported here. If the message is associated with a particular record (the
table and path name are filled), then clicking the button on the left
results in the record’s property sheet being displayed in the auxiliary pane.
3.8.3 Validation History View

A history of completed validation requests is retained for a configurable
period of time (seven days, by default). To view the validation history,
choose View > Validation History.
The Validation History view is very similar to the Validation Progress
dialog box:
Figure 121: Validation History View

The top level contains:
• The unique request number for each execution
• The name of the validation sequence

• A button to open the messages associated with this request in the log
pane
Each request can be expanded to view the list of modules in the
sequence, with the following information per module:
• The name of the module
• The start and end times for the module
• The overall completion status for the module
• Identification of the machine and process that executed the request
3.9 Activity Log

All significant user activity is recorded in the Activity Log. Each activity is
associated with a particular user, and may also be associated with a
particular workspace, model authority set, or project. The Activity Log can
be viewed without filtering, or it can be filtered to show messages for a
specific user, workspace, model authority set, or project.
You can view the Activity Log using one of the following methods:
• From the Recent System Activity section of the home page, the five
most recent actions are shown. Click the More button in the top right
corner to open an unfiltered view of the Activity Log in the log pane.
• Choose View > Activity Log to open an unfiltered view of the Activity
Log in the log pane.
• From the Workspace Explorer, right-click on a workspace name and
click Activity Log on the context menu for messages associated with
the workspace.
• From the Workspace Explorer, Model Explorer, or the Loaded
Models/Model Authority Sets section of the home page, right-click on a
model authority set name and click Activity Log on the context menu
for messages associated with the model authority set.
• From the Workspace Explorer, Project view, or the Loaded Projects
section of the home page, right-click on the project name and click
Activity Log for messages associated with the project.
The Activity Log dialog box is displayed. The dialog box shows the time,
text, user ID, workspace ID, project ID, and model authority set ID and
version. All fields are read-only. The title of the pane indicates the filter
criteria used on the Activity Log (e.g., “Activity Log for Workspace xyz”,
“Activity Log for Model Authority Set xyz version xx”, “Activity Log for User
jdoe”, “Activity Log for Project xyz”, etc.).

Figure 122: Activity Log View
3.10 Constraint Violations

There are many levels of validating a business model, and one level is
implemented as constraints in the database. These “constraints” are
conditions that must be satisfied in order for the entered data to be
accepted for storage. e-terrasource supports check constraints and
referential constraints.
A “check constraint” enforces that the entered value matches one of a list
of allowable values. For example, the allowable values for a particular
property might be “Yes” or “No”. These choices are modeled as picklists in
the business model metadata and are enforced as check constraints.
A “referential constraint” comes into play when one type of record
references another type of record. For example, if an employee must
belong to a department, a referential constraint enforces that any value
entered for an employee’s department must actually be a valid
department ID.
By default, referential constraints are disabled while resetting a workspace
or loading data into a workspace. Check constraints are not disabled
unless you set the “db_disable_check_constraints” parameter in the
When you build a model using e-terrasource, the referential and check
constraints are enforced by the user interface, so that you cannot enter
data that violates these constraints. However, if you import data from an
external source, such as a CIM/XML file, the imported data can be of
questionable quality and may not satisfy the referential and check
constraints. Therefore, when importing data from an external source, it
may be desirable to set “db_disable_check_constraints” to Yes so that
check constraint violations do not prevent the data from being loaded.
The Constraint Violations view lists all of the referential and check
constraints that are disabled. By expanding each tree node representing a
disabled constraint, a list of specific records that violate the constraint is
shown, along with a button to bring up its property sheet.

When all of the records that violate the constraint have been corrected,
the constraint can be enabled. The view also provides buttons at the top
to enable or disable all constraints.
Figure 123: Constraint Violations View
3.11 Viewing Unsaved Changes

Change items that have not been saved to your active project are
available for viewing on the user interface. To view unsaved change
items, click View > Unsaved Change Items. The Unsaved Change Items
view appears in a dialog box.
The operation, order, table, path name, property, old value, and new value
are shown. Clicking on a column header sorts the data by that column and
displays an indicator of the sort direction. Clicking on the column header
again reverses the sort direction. The title bar indicates the name of the
active project to which the change items are saved.
Change items related to graphic layout are intentionally not shown on this
view.
Figure 124: Unsaved Change Items View

Once change items are saved to the active project, they disappear from
this view and are safely stored in the database to protect against loss of
data.

4. Administrative Tasks
Certain administrative tasks can be performed from the e-terrasource
user interface using the Administration Explorer. You must have the
UseAdminExplorer privilege in order to access the Administration
Explorer.
4.1 About the Administration Explorer

The Administration Explorer allows suitably privileged users to perform
certain administrative tasks. The UseAdminExplorer privilege is required
to display the Explorer, and further privileges are required in order to view,
insert, delete, and modify the various objects. For example:
• The QueryWorkspace privilege is required to view workspace
information.
• The CreateWorkspace privilege is required to create a new
workspace.
• The RemoveWorkspace privilege is required to remove a workspace.
• The ReplaceWorkspace privilege is required to modify workspace
properties.
A complete list of the privileges used by e-terrasource can be found in
section 4.4.9 Available Roles and Privileges.
The Administration Explorer supports the following tasks:
• Workspaces
− A list of all workspaces can be viewed, and their properties
modified.
− Workspaces can be created or removed.
• Model Authorities
− A list of available model authorities can be viewed.
− Model authorities can be created, modified, and deleted.
• Users
− A list of all users can be viewed, and their properties modified.
− New users can be added, and users can be disabled or removed.
− Roles can be assigned to users or removed from users.
Proprietary – See Copyright Page 213 Administrative Tasks

• Roles
− A list of available roles can be viewed.
− The privileges belonging to roles can be modified.
• Privileges
− A list of available privileges can be viewed.
− Additional privileges can be created or deleted, but privileges
required for the proper function of e-terrasource cannot be
removed.
• Model Types and Model Authority Set Types
− A list of available model types and model authority set types can be
viewed.
− New model types can be created and have model authority set
types associated with them. Model types can also be modified and
deleted.
− Model authority set types can be created, modified, and deleted.
• Import/Export
− A list of available import/export sequences and types can be
viewed.
− Sequences can be created, modified, and deleted, including
information about the steps belonging to a sequence.
− Import/export types can be created, modified, and deleted,
including information about their children targets, target
parameters, and exportable states.
• Application Parameters
− A grid display of application parameters can be displayed, and
parameter values can be modified.
− Additional parameters can be created or deleted, but parameters
required for the proper function of e-terrasource cannot be
removed.
• States
− The states and state transitions that define the lifecycle for
projects, models, model authority sets, and templates can be
viewed.

− States and transitions can be created, deleted, and modified.
• Custom Attributes
− Custom attributes for projects, models, model authority sets, users,
workspaces, and templates can be viewed.
− Custom attributes can be created, deleted, and modified.
The Administration Explorer is a tree display with top-level records for
workspaces, users, roles, privileges, model types, model authority set
types, import/export, model authorities, parameters, states, and custom
attributes.
To access the Administration Explorer, click View > Administration
Explorer. If you do not have the UseAdminExplorer privilege, the
Administration Explorer is not available on the View menu.
The Administration Explorer opens in the left pane, showing administrative
data in a tree view.
Figure 125: Administration Explorer

4.2 Managing Workspaces
A workspace is an environment where models are viewed and edited. Its
Each workspace is an independent repository for working with model
authority sets and projects. A workspace has a single owner. Although it is
allowable to have other (non-owner) users view the same workspace, only
the owner can modify the content of a workspace.
Generally speaking, users who perform modeling tasks should have one
or more workspaces created specifically for their own use.
4.2.1 Creating a Workspace

If you have the CreateWorkspace privilege, a new workspace can be
created using the following steps:
1. From the Administration Explorer, right-click on the Workspaces node,
and select Insert from the context menu.
The New Workspace dialog box appears.
A new child node is created with the given workspace ID.

• Workspace ID: A case-sensitive identifier for the workspace that must
be unique.
• Password: In Oracle-based systems, a database user/schema is
created for each workspace, so a password must be supplied for the
database user/schema. Enter a case-sensitive password for the
workspace. For SQL Server–based systems, the password must still
be entered, but it is not used.
• Confirm Password: Enter the same password a second time.
• Owner: It is customary, but not mandatory, to also supply the user that
owns the workspace. Although many users can concurrently open the
same workspace, only the owner can modify the contents of the
workspace. The owner can be left null, and/or changed at a later time.
• Model Schema ID and Version: These fields are used to specify
which version of the business model should be used when creating the
workspace. Although many schema versions can be created as the
business model changes over time, generally the latest version is the
correct choice.
• Description: An optional description for the workspace can be
entered.
• Custom Attributes: If any custom attributes have been defined in
your system for workspaces, they also appear in the dialog box and
can be entered (for details, refer to section 4.10 Managing Custom
Attributes).
For each workspace, a database user/schema is created; therefore,
workspace creation requires elevated database privileges. For information
about “runtime” versus “administrative” privileges, refer to the
The database schema name is created from the supplied ID by converting
it to uppercase and then extracting only alphanumeric characters and
underscore characters. The creation fails if the schema name matches
any existing database schema name. For example, a schema name of
“SYS” fails in Oracle because all Oracle databases have a pre-installed
schema called “SYS”. Other naming restrictions (the name cannot be a
reserved word, etc.) may also cause the creation to fail. The password
supplied in the New Workspace dialog box is used as the password of the
database schema for the workspace.
In Oracle systems, there are several e-terrasource application parameters
that control the names of the tablespaces that are used when workspaces

are created. For more information about tablespaces, refer to the
e-terrasource Software Installation and Maintenance Guide, or see
section 4.8 Managing Application Parameters.
4.2.2 Viewing/Modifying Workspace Information

After a workspace is created, certain properties can be modified: the
description, the owner, the password, and the locked flag.
To view or modify workspace properties, use one of the following
methods:
• From the Administration Explorer, expand the Workspaces node, and
click the workspace name.
• From the Administration Explorer, expand the Workspace node, right-
click the workspace name, and choose Properties from the context
menu.
• From the Workspace Explorer, click the workspace name.
• From the Workspace Explorer, right-click the workspace name, and
The property sheet can be used to modify properties for a workspace.
Figure 126: Workspace Property Sheet

If you are the owner of the workspace, you must have the
ReplaceWorkspace privilege to modify information on the property sheet.
If you are not the owner, you must have the ReplaceAnyWorkspace
privilege.
The following properties can be modified:
• Owner: The owner of the workspace can be changed if necessary.
Keep in mind that only the owner of the workspace can change
content of the model data in the workspace.
• Locked: The workspace can be locked or unlocked on the property
sheet.
If a workspace is locked, its content cannot be changed until the
workspace is unlocked by the user who locked it or a user with the
UnlockAnyWorkspace privilege. The workspace is automatically locked
during import and export operations. It is possible that, if an
import/export operation terminates abnormally, the workspace is left in
a locked state. The property sheet can be used to unlock the
workspace.
• Lock Time: If Locked is Yes, then the time at which the workspace
was locked is shown.
• Locked By: If Locked is Yes, then the name of the user who locked
the workspace is shown.
• Lock Reason: If Locked is Yes, the reason that the workspace is
locked is shown.
To change the password for a workspace, right-click the workspace on the
Workspace Explorer, and choose the Change Password option on the
context menu. The following dialog box is displayed:
Figure 127: Change Workspace Password Dialog Box

Enter the old password, then enter the new password twice and click OK
to change the password.

To view properties for all workspaces at the same time, click the
Workspaces node on the Administration Explorer to display the
Workspaces grid view. The grid is read-only.
Figure 128: Workspaces Grid View
4.2.3 Viewing Workspace Activity

The information in the Activity Log can be filtered for a particular
workspace. From the Workspace Explorer, right-click the workspace, and
choose Activity Log from the context menu.
the selected workspace (for more information about the Activity Log, refer
to section 3.9 Activity Log).
4.2.4 Removing a Workspace

Deleting a workspace removes all data in the workspace tables, so you
should be sure that any desired model changes have been saved into
model authority sets or projects. A workspace cannot be deleted if it is
locked, or if there are users assigned to it. You must have the
RemoveWorkspace privilege to remove a workspace you own, and the
RemoveAnyWorkspace privilege to delete a workspace that you do not
own.
Also, since the database user/schema is deleted, workspace removal
requires elevated database privileges. For information about “runtime”
versus “administrative” privileges, refer to the e-terrasource Software
Installation and Maintenance Guide.
To delete a workspace:
1. From the Administration Explorer, expand the Workspaces node.
2. Right-click on the workspace name that you want to remove, and
select Delete from the context menu.
A confirmation dialog box appears.
3. Click OK to confirm deleting the workspace.

4.3 Managing Users
Upon installation of e-terrasource, users are created for the following
server-tier services:
User Service
cimimportexport e-terrasource CIM/XML Import/Export
csmimportexport e-terrasource Import/Export
csmvalidation e-terrasource Validation
The users listed above should not be deleted or modified.
Additional user records must be created for each Windows user ID that
uses the e-terrasource user interface client, and the user must be granted
a role that determines what actions they can perform. For proper
operation of the user interface, the minimal set of privileges are those
associated with the Guest role (for more information, refer to section
4.4 Managing Roles and Privileges).
4.3.1 Creating a User

If you have the CreateUser privilege, a new user can be created using the
following steps:
1. From the Administration Explorer, right-click Users, and select Insert
The New User dialog box appears.
A new child node is created with the given user ID.
Keep in mind that, after the user is created, that user does not have any
privileges until assigned one or more roles, as described in section
4.4.4 Assigning or De-Assigning Roles.

Figure 129: New User Dialog Box
• User ID: The user ID must be unique and must match the user’s
Windows user name. Because e-terrasource ignores case for user
IDs, it automatically converts the entered value to lowercase.
• First Name/Last Name: You can optionally enter the user’s first and
last name.
• Disabled: Set this field to Yes to prevent the user from performing any
actions in e-terrasource, and to prevent the user from logging in.
• Access Type: The access type determines if the user has read-only,
read-write, or full access to model data (for more information, see
chapter 5 Data Security).
• Workspace: You can optionally assign the user to a workspace at this
time.
• Model Authority: Choose the model authority that the user is
associated with.
• Default Model Authority Set Type: You can optionally provide an
initial value for the user’s default model authority set type. Otherwise,
the user can set or change it on the toolbar.

• Language: Choose the user’s language. Although the picklist lists all
possible language/culture combinations, you should only choose a
language for which e-terrasource has been localized (for example,
“en-US” for United States English).
your system for users, they also appear in the dialog box and can be
entered. In the example above, e-mail is a custom attribute (for details,
refer to section 4.10 Managing Custom Attributes).
4.3.2 Viewing/Modifying User Information

To view a user’s information, use one of the following methods:
• In the User Notes section of the home page, click the user ID in the top
right corner to view the property sheet for the currently logged-in user.
• From the Administration Explorer, expand the Users node, and select
the desired user.
• From the Administration Explorer, expand the Users node, right-click
the desired user, and select Properties from the context menu.
• From the Workspace Explorer, expand the Workspace Users node
under a workspace, and then click on the desired user.
• From the Workspace Explorer, expand the Workspace Users node
under a workspace, and then right-click on the desired user and
The property sheet can be used to modify properties for a user.

Figure 130: User Property Sheet
You must have the ReplaceUser privilege to modify your own information.
You must have the ReplaceAnyUser privilege to modify information for
other users.
• First Name/Last Name: You can optionally enter the user’s first and
last name.
• Active Project: In some cases, it may be necessary to clear the active
project for a user. For example, the user may be unavailable but their
active project is needed by someone else. An administrator with
ReplaceAnyUser privilege can clear the active project property.
• Access Type: The access type determines if the user has read-only,
read-write, or full access to model data (for more information, see
chapter 5 Data Security). A user cannot change the access type
without the ReplaceUserAccessType privilege.

• Model Authority: Choose the model authority that the user is
associated with.
• Default Model Authority Set Type: You can change the user’s default
model authority set type. Otherwise, the user can change it on the
toolbar.
• Language: Choose the user’s language. Although the picklist lists all
possible language/culture combinations, you should only choose a
language for which e-terrasource has been localized (for example,
“en-US” for United States English).
• Current Workspace: You can change the user’s workspace
assignment.
• Disabled: Set this field to Yes to prevent the user from performing any
actions in e-terrasource, and to prevent the user from logging in.
A user that is “active” cannot be disabled. When users log off, they are
immediately set to “inactive”; therefore, users can be disabled
immediately after logging off. If a user session terminates abnormally,
the user is considered active until N seconds pass. Therefore, you
cannot disable the user until you wait N seconds.
The value of “N” is shown on the Parameters display in Admin Explorer
as “user_activity_period” and the default value is 15 seconds. For
more information about the “user_activity_period” parameter, see
section 4.8 Managing Application Parameters, or refer to the
your system for users, they also appear in the dialog box and can be
entered. In the example above, e-mail is a custom attribute (for details,
refer to section 4.10 Managing Custom Attributes).
To view properties for all users at the same time, click the Users node on
the Administration Explorer to display the Users grid view. The grid is
read-only.
Figure 131: Users Grid View

4.3.3 Viewing User Activity
The information in the Activity Log can be filtered for a particular user
using one of the following methods:
• From the Users node of the Administration Explorer, right-click the
user, then choose Activity Log from the context menu.
• From the Workspace Explorer, expand the Workspace Users node,
and then right-click the user and choose Activity Log from the context
menu.
the selected user (for more information about the Activity Log, refer to
section 3.9 Activity Log).
4.3.4 Removing a User

To remove a user:
1. From the Administration Explorer, right-click on a user ID, and select
A dialog box appears.
2. Click OK to confirm.
You must have the RemoveUser privilege to remove a user. You cannot
remove yourself or any other “active” user.
When users log off, they are immediately set to “inactive”; therefore, users
can be deleted immediately after logging off. If a user session terminates
abnormally, the user is considered active until N seconds pass. Therefore,
you cannot disable the user until you wait N seconds.
The value of “N” is shown on the Parameters display in Admin Explorer as
“user_activity_period” and the default value is 15 seconds. For more
information about the “user_activity_period” parameter, see section
4.8 Managing Application Parameters, or refer to the e-terrasource
Software Installation and Maintenance Guide. Also, a user cannot be
removed if they currently have a workspace locked.
If a user is removed, all information related to the user is deleted from the
e-terrasource repository. It may be preferable to disable users instead of
permanently removing them.
4.4 Managing Roles and Privileges

There are separate privileges that are associated with virtually all
e-terrasource operations, whether those operations are available on the
user interface or not. Generally speaking, if a user lacks the privilege

required to perform an operation, then that operation is disabled in the
e-terrasource user interface. For example, a user without the
CreateProject privilege has the Project option disabled on the New toolbar
button. In some cases, disabling the operation on the user interface is not
possible, but an attempt to perform the operation results in an error (e.g.,
“User jdoe does not have XXX privilege”).
A “role” is simply a named bundle of privileges, and a user can have one
or more roles assigned. Roles make it easier to manage user privileges
(for information about the roles that are created during installation, refer to
section 4.4.9 Available Roles and Privileges).
In order to do anything useful in e-terrasource, a user must have one or
more roles assigned that grant them the privileges they need to do their
work.
There are circumstances in which a user might have more than one role
assigned. For example, Fred might normally have the “Modeler” role and
George might have the “ModelSupervisor” role. But if George goes on
vacation, Fred may assume George’s duties temporarily. In this case, the
ModelSupervisor role can be added to Fred. When George returns to
work, the ModelSupervisor role can be removed from Fred.
The Administration Explorer allows roles to be viewed, created, deleted,
assigned to users, or de-assigned from users. Furthermore, the privileges
assigned to a role can be viewed and modified.
4.4.1 Creating Roles

Several roles are created upon installation of e-terrasource, as described
in section 4.4.9 Available Roles and Privileges. However, if you have the
CreateRole privilege, additional roles can be created.
Keep in mind that a minimal set of privileges are required for proper
operation of the e-terrasource user interface. This set is encapsulated in
the Guest role that is created during installation.
To create a new role, right-click the Roles node on the Administration
Explorer, and choose Insert from the context menu. The Add Role dialog
box is shown. Enter the required fields, as indicated by an asterisk (*), and
click OK.
A new child node is created with the given role ID.

Figure 132: Add Role Dialog Box
• Role: Enter an ID for the role.
• Description: Enter an optional description of the role.
4.4.2 Viewing/Modifying Roles

The Administration Explorer can be used to view and modify information
for roles. This includes assigning new privileges to a role, or removing
privileges from a role.
To view information for a role, use one of the following methods:
• From the Administration Explorer, expand the Roles node, and click
the desired role name.
• From the Administration Explorer, expand the Roles node, right-click
the desired role, and choose Properties from the context menu.
The role property sheet can be used to modify the properties of a role.

Figure 133: Role Property Sheet
You must have the ReplaceRole privilege to modify properties of a role.
The following property can be modified:
• Description: An optional description can be entered.
Additionally, you can change the list of privileges that belong to the role.
To do so, right-click the role name on the Administration Explorer, and
choose Modify Privileges from the context menu. The Modify Privileges
dialog box is shown.
Figure 134: Modify Privileges Dialog Box

The left side of the dialog box lists all of the privileges that are not
currently part of the role. The right side of the dialog box lists all of the
privileges that do currently belong to the role.
To add a privilege to the role, select the privilege from the left side and
click the button. To remove a privilege from the role, select the
privilege from the right side and click the button. Click the OK button to
save your changes. The privilege changes take effect immediately.
Keep in mind that a minimal set of privileges are required for proper
operation of the e-terrasource user interface. This set is encapsulated in
the Guest role that is created during installation.
4.4.3 Viewing Roles for a User

To view the roles currently assigned to a user, expand the Users node on
the Administration Explorer, then expand the node for the desired user.
Each role that is assigned to the user is shown as a child node.
Figure 135: Viewing User Roles

4.4.4 Assigning or De-Assigning Roles
Privileges are granted to users by assigning one or more roles. A user is
granted privilege XYZ if that privilege belongs to any one of the user’s
currently assigned roles. Each functional user must therefore have at least
one role assigned.
To assign a role to a user, expand the Users node on the Administration
Explorer, right-click the desired user, and choose Assign Role on the
context menu. Then choose the desired role from the submenu.
Figure 136: Assign a Role to a User

To de-assign a role from a user, expand the Users node on the
Administration Explorer, right-click the desired user, and choose
Remove Role on the context menu. Then choose the desired role from
the submenu.

Figure 137: Deassign a Role from a User
A user with no assigned roles is effectively disabled from performing any
operations in e-terrasource.
4.4.5 Removing Roles

A user with the RemoveRole privilege can delete roles using the
Administration Explorer. This operation should be used with caution
because there are certain roles that are required for proper operation of
e-terrasource (for more information, refer to section 4.4.9 Available Roles
and Privileges).
Removing a role is not a common task. If your intention is to take away
privileges for a specific user, then refer to section 4.4.4 Assigning or De-
Assigning Roles.
To remove a role, expand the Roles node on the Administration Explorer,
right-click the desired role, and choose Delete from the context menu.

Roles that are currently assigned to users cannot be deleted. An attempt
to delete such a role results in the following error:
Figure 138: Error Removing Role
4.4.6 Creating a Privilege

Upon installation, e-terrasource has a fixed set of privileges that are
required for proper operation of the application. However, there are
certain circumstances in which you may want to create a new
e-terrasource privilege:
• You are creating a new custom attribute type, and you want to specify
a new privilege that is necessary to enter/modify the attribute value.
• You are creating a new application parameter, and you want to specify
a new privilege that is necessary to enter/modify the parameter value.
• You have created a new schema in the metamodel, and you want to
specify a new privilege that is necessary to modify the schema.
To create a new privilege, perform the following steps:
1. Click the Privileges node on the Administration Explorer.
The Privileges grid is displayed.
2. On the top line, enter the name and description of the new privilege.
Press Enter to create it.
The new privilege is created and appears in the main body of the grid.
4.4.7 Viewing/Modifying Privileges

To view the available privileges, click the Parameters node on the
Administration Explorer. The Privileges grid is displayed.
Only the Description field can be modified. The name of a privilege cannot
be changed.

4.4.8 Removing Privileges
Upon installation, e-terrasource has a fixed set of privileges that are
required for proper operation of the application. These privileges cannot
be removed; only their descriptions can be modified.
Privileges that you have created for your own use can be removed if
desired. To do so, select the Parameters node on the Administration
Explorer to display the privileges grid. Locate the desired privilege, right-
click the row, and choose Delete from the context menu.
A confirmation dialog box is shown. Click OK to delete the privilege.
The user must have the RemovePrivilege privilege in order to delete a
privilege. Furthermore, privileges that are currently assigned to a role
cannot be removed. You must remove a privilege from all roles prior to
deleting it, as described in section 4.4.2 Viewing/Modifying Roles.
4.4.9 Available Roles and Privileges

e-terrasource has a fixed set of available privileges that generally
correspond to available user actions. Roles, which are a collection of
privileges, can be created and assigned to individual users. Therefore, the
actions that a user can perform are controlled by the roles assigned to the
user and the privileges assigned to those roles.
e-terrasource is preconfigured with four general-purpose roles: Guest,
Modeler, ModelSupervisor, and Superuser. There are also roles
specifically created for e-terrasource server processes: CsmValidation,
CsmImportExport, and CimImportExport.
The CsmValidation, CsmImportExport, and CimImportExport roles are
used by e-terrasource server processes. You should not delete these
roles or alter the privileges that belong to these roles. If you do so, the
server processes may not operate properly.
For the four remaining roles, the table below lists each privilege name and
description, and indicates which roles the privilege is assigned to.
Additional roles can be created as desired; however, the Guest,
Superuser, CsmValidation, CsmImportExport, and CimImportExport roles
should not be altered or removed.
• The minimal set of privileges that are required for proper operation of
the e-terrasource user interface are encapsulated in the Guest role.
This role allows a user to start the user interface and view displays, but
the user cannot create, delete, or modify anything. You should not
modify the privileges associated with the Guest role.

• The Superuser role is granted every available privilege. This role
should be granted only to advanced users. You should not remove any
privileges associated with the Superuser role.
• The Modeler and ModelSupervisor roles should be considered as
sample roles that you can use as is, use as an example in creating
your own roles, or modify as desired. You can scan the table below for
details, but the general idea is that a Modeler has fewer privileges than
a ModelSupervisor. For example, a user with the Modeler role can
create projects, but the ModelSupervisor role is needed to create
model authority sets.
• You are encouraged to create your own roles based on the privileges
that you want to assign to different classes of users.
Privilege Description Super Model Modeler Guest

-User Sup
ChangeStatsOptions Allow modification of X
“db_stats_*” parameters for
Oracle statistics gathering
ChangeWorkspace Change workspace X X X
assignment for user
CopyAnyProject Copy a project created by X X
another user
CopyAnyTemplate Copy a template created by X
another user belonging to
another model authority
CopyProject Copy a project X X X
CopyTemplate Copy a template created by X
the user or copy template
belonging to users model
authority or copypublic
template
CreateAnyRowAccess Grant access for any row of X
data
CreateAnyRowMdlAuthSetType Assign the model authority X
set for any row of data
CreateAttributeType Create new attribute type X
CreateCalendarEntry Create new calendar entry X X X
CreateCimProfile Create new CIM profile X
CreateDeepCopy Create new deep copy type X
CreateImpExpSequence Create new import/export X
sequence
CreateImpExpType Create new import/export X
type
CreateMdlAuth Create new model authority X
CreateMdlAuthSet Create a model authority set X X

-User Sup
CreateMdlAuthSetType Create a model authority set X
type
CreateModel Create a model X X
CreateModelType Create a model type X
CreateMsgDef Create new message X
definition
CreateNamespace Create new namespaces X
CreateNote Create new note X X
CreateParameter Create new parameters X
CreatePicklist Create new picklist X
CreateProject Create new project X X X
CreatePropertyGroup Create new property group X
CreateQuery Create new stored query X
CreateRole Create new role X
CreateRowAccess Grant access for a row of X X X
data you own
CreateRowMdlAuthSetType Assign the model authority X X X
set for a row of data you
own
CreateSchema Create new schema X
CreateSnapshot Create new snapshot X X X
CreateState Create new state X
CreateSysPriv Create system privileges X
CreateTable Create new table X
CreateTableAccessMdlAuth Grant table access to a X
model authority
CreateTableAccessUser Restrict table access for a X
user
CreateTableGroup Create new table group X
CreateTemplate Create new template X X X
CreateTemplateGroup Create new template group X X
CreateUser Create new user X
CreateValModule Create validation module X
CreateValRule Create validation rule X
CreateValSequence Create validation sequence X
CreateWorkspace Create new workspaces X X
DropSchema Drop the master model data X
schema in CSM
GenerateSchema Generate the master model X
data schema in CSM
LoadWorkspace Load model authority sets X X X
and projects into a
workspace
MetadataValidation Validate metadata X

-User Sup
ModifyCIM/EMS X
ModifyMetaModel Privilege needed to modify X
metamodel schema
PutImpExpReq Perform requests for imports X X X
and exports
PutValidationReq Perform requests for X X X
validation
QueryActivityLog View Activity Log X X X X
QueryAttributeType View attribute types X X X X
QueryCalendarEntry View calendar entry X X X X
QueryCimProfile View CIM profiles X X X X
QueryDeepCopy View deep copy types X X X X
QueryImpExpMsg View import/export X X X X
messages
QueryImpExpReq View status of import and X X X X
export requests
QueryImpExpSequence View import/export X X X X
sequence
QueryImpExpType View import/export type X X X X
QueryMdlAuth View model authorities X X X X
QueryMdlAuthSet View model authority sets X X X X
QueryMdlAuthSetAncestry View model authority set X X X X
ancestry
QueryMdlAuthSetType View model authority set X X X X
types
QueryModel View models X X X X
QueryModelType View model types X X X X
QueryMsgDef View message definitions X X X X
QueryNamespace View namespaces X X X X
QueryNote View notes X X X X
QueryParameter View parameters X X X X
QueryPicklist View picklists X X X X
QueryProject View projects X X X X
QueryPropertyGroup View property groups X X X X
QueryQuery View stored queries X X X X
QueryRole View roles X X X X
QueryRowAccess View access information for X X X X
any row of data
QuerySchema View schema X X X X
QuerySnapshot View snapshots X X X X
QueryState View states X X X X
QuerySysPriv View system privileges X X X X
QueryTable View tables X X X X

-User Sup
QueryTableAccessMdlAuth View table access by a X X X X
model authority
QueryTableAccessUser View table access X X X X
restrictions for a user
QueryTableGroup View table groups X X X X
QueryTemplate View template X X X X
QueryTemplateGroup View template group X X X X
QueryUser View users X X X X
QueryValModule View validation module X X X X
QueryValRule View validation rule X X X X
QueryValSequence View validation sequence X X X X
QueryValidationMsg View validation messages X X X X
QueryValidationReq View status of validation X X X X
requests
QueryWorkspace View workspaces X X X X
RemoveAnyMdlAuthSet Remove model authority set X X
created by another user
RemoveAnyModel Remove model created by X X
another user
RemoveAnyProject Remove project created by X X
another user
RemoveAnyRowAccess Revoke access for any row X
of data
RemoveAnyRowMdlAuthSetType Deassign the model X
authority set for any row of
data
RemoveAnySnapshot Remove any snapshot X X
RemoveAnyTemplate Remove template created X
by another user belonging to
RemoveAnyWorkspace Remove workspace created X X
by another user
RemoveAttributeType Remove attribute type X
RemoveCalendarEntry Remove calendar entry X X X
RemoveCimProfile Remove CIM profile X
RemoveDeepCopy Remove deep copy type X
RemoveImpExpSequence Remove import/export X
sequence
RemoveImpExpType Remove import/export type X
RemoveMdlAuth Remove model authorities X
RemoveMdlAuthSet Remove model authority X X
sets
RemoveMdlAuthSetType Remove model authority set X
types
RemoveModel Remove models X X

-User Sup
RemoveModelType Remove model types X
RemoveMsgDef Remove message X
definitions
RemoveNamespace Remove namespaces X
RemoveNote Remove note X X
RemoveParameter Remove parameters X
RemovePicklist Remove picklists X
RemoveProject Remove project X X X
RemovePropertyGroup Remove property groups X
RemoveQuery Remove stored queries X
RemoveRole Remove roles X
RemoveRowAccess Revoke access for a row of X X X
data you own
RemoveRowMdlAuthSetType Deassign the model X X X
authority set for a row of
data you own
RemoveSchema Remove schema X
RemoveSnapshot Remove snapshot X X X
RemoveState Remove states X
RemoveSysPriv Remove system privileges X
RemoveTable Remove tables X
RemoveTableAccessMdlAuth Revoke table access from a X
model authority
RemoveTableAccessUser Remove table access X
restriction for a user
RemoveTableGroup Remove table groups X
RemoveTemplate Remove template created X X X
by the user or remove
template belonging to users
model authority or remove
public template
RemoveTemplateGroup Remove template group X X
RemoveUser Remove users X
RemoveValModule Remove validation module X
RemoveValRule Remove validation rule X
RemoveValSequence Remove validation X
sequence
RemoveWorkspace Remove workspaces X X
ReplaceAnyMdlAuthSet Modify model authority set X X
created by another user
ReplaceAnyModel Modify model created by X X
another user
ReplaceAnyProject Modify project created by X X
another user

-User Sup
ReplaceAnyRowAccess Modify access for any row of X X
data
ReplaceAnyRowMdlAuthSetType Modify the model authority X X
set for any row of data
ReplaceAnySnapshot Modify any snapshot X X
ReplaceAnyTemplate Modify template created by X
another user belonging to
ReplaceAnyUser Modify attributes of another X X
user
ReplaceAnyWorkspace Modify workspace created X X
by another user
ReplaceAttributeType Modify attribute type X
ReplaceCalendarEntry Modify calendar entry X X X
ReplaceCimProfile Modify CIM profile X
ReplaceDeepCopy Modify deep copy type X
ReplaceImpExpSequence Modify import/export X
sequence
ReplaceImpExpType Modify import/export type X
ReplaceMdlAuth Modify model authorities X
ReplaceMdlAuthSet Modify model authority sets X X
ReplaceMdlAuthSetType Modify model authority set X
types
ReplaceModel Modify models X X
ReplaceModelType Modify model types X
ReplaceMsgDef Modify message definitions X
ReplaceNamespace Modify namespaces X
ReplaceNote Modify note X X
ReplaceParameter Modify parameters X X
ReplacePicklist Modify picklists X
ReplaceProject Modify project X X X
ReplacePropertyGroup Modify property groups X
ReplaceQuery Modify stored queries X
ReplaceRole Modify roles X
ReplaceRowAccess Modify access for a row of X X X
data you own
ReplaceRowMdlAuthSetType Modify the model authority X X X
set for a row of data you
own
ReplaceSchema Modify schema X
ReplaceSnapshot Modify snapshot X
ReplaceState Modify states X
ReplaceSysPriv Replace system privileges X
ReplaceTable Modify tables X

-User Sup
ReplaceTableAccessMdlAuth Modify table access for a X
model authority
ReplaceTableAccessUser Modify table access X
restriction for a user
ReplaceTableGroup Modify table groups X
ReplaceTemplate Modify template created by X X X
the user or modify template
belonging to users model
authority or modify public
template
ReplaceTemplateGroup Modify template group X X
ReplaceUser Modify users X X X X
ReplaceUserAccessType Change the access type for X
any user
ReplaceValModule Modify validation module X
ReplaceValRule Modify validation rule X
ReplaceValSequence Modify validation sequence X
ReplaceWorkspace Replace workspaces X X
ResetImpExpMsg Reset import/export X X X
messages
ResetValidationMsg Reset validation messages X X X
ResetWorkspace Reset workspaces to empty X X X
RestoreAnySnapshot Restore any snapshot into X X
workspace
RestoreSnapshot Restore snapshot into X X X
workspace
UseAdminExplorer Allow usage of the X X X
Administration Explorer

4.5 Managing Model Types and Model Authority Set Types
A model is an e-terrasource concept that is completely optional. It is
simply a collection of model authority sets at a given point in time. They
are used only if you want to break up your full model into pieces. In this
case, each piece is a model authority set, and all the pieces form a
complete model.
A model authority set is a complete model (or model portion) at a given
point in time:
• If your system is configured to break up a model into portions, then a
model authority set represents a portion of the model.
• If your system is not configured to break up the model, then you
probably have a single model authority set type that represents the
whole model.
If you refer back to Figure 1, you can see that the full model is broken into
North, South, East, and West regions. Given this scenario, one can create
a model type called “Full”, and four model authority set types: North,
South, East, and West. Furthermore, you declare that:
Full = North + South + East + West
This tells e-terrasource that:
• When creating a Full model, it actually needs to create four model
• When loading a Full model, it actually needs to load four model
Before you can use models and model authority sets in e-terrasource,
you must define model types and model authority set types in the
4.5.1 Creating a Model Type

If you want to subdivide your complete model into multiple model authority
sets, you must define a model type and specify the model authority set
types that it is composed of (for more information, refer to section
3.2 Models). You must have the CreateModelType privilege to create a
model type.
To create a model type, right-click the Model Types node on the
Administration Explorer, and choose Insert from the context menu. The
New Model Type dialog box is shown. Enter the required fields, as
indicated by an asterisk (*), and click OK.

A new child node is created with the given ID.
Figure 139: New Model Type Dialog Box

• Name: You must provide a name for the model.
• Model Schema: You must specify the business model schema that
the model applies to.
4.5.2 Viewing/Modifying a Model Type

for model types.
To view information for a model type, use one of the following methods:
• From the Administration Explorer, expand the Model Types node, and
click the desired model type name.
• From the Administration Explorer, expand the Model Types node,
right-click the desired model type, and choose Properties from the
context menu.
The model type property sheet can be used to modify the properties of a
model type.

Figure 140: Model Type Property Sheet
You must have the ReplaceModelType privilege to modify properties of a
model type.
Additionally, you can change the list of model authority set types that
belong to the model type. To do so, right-click the model type on the
Administration Explorer, and choose Add/Remove Model Authority Set
Types from the context menu. The following dialog box is shown.

Figure 141: Add/Remove Model Authority Set Types Dialog Box
The left side of the dialog box lists all of the model authority set types that
are not currently part of the model type. The right side of the dialog box
lists all of the model authority set types that do currently belong to the
model type.
To add a model authority set type to the model type, select the model
authority set type from the left side and click the button. To remove a
model authority set type from the model type, select the model authority
set type from the right side and click the button. Click the OK button to
save your changes.
The changes take effect only for models that are to be created in the
future. For example, if you add model authority set type East to the Full
model type, then only new Full models contain East model authority sets.
If you remove model authority set type West from the Full model type,
then new Full models do not include West model authority sets. Past
models are unaffected by the changes.
4.5.3 Removing a Model Type

A user with the RemoveModelType privilege can delete model types using
the Administration Explorer.
Removing a model type is not a common task. The removal is prevented if
there are any models that use the model type. Therefore, you must
remove all models before you can remove the model type.
To remove a model type, expand the Model Types node on the
Administration Explorer, right-click the desired model type, and choose

4.5.4 Creating a Model Authority Set Type
Model authority sets provide the mechanism for capturing model data over
time (for more information, refer to section 3.3 Model Authority Sets). You
must have the CreateMdlAuthSetType privilege to create a model
authority set type.
To create a model authority set type, right-click the Model Authority Set
Types node on the Administration Explorer, and choose Insert from the
context menu. The New Model Authority Set Type dialog box is shown.
Enter the required fields, as indicated by an asterisk (*), and click OK.
Figure 142: New Model Authority Set Type Dialog Box

• Name: You must provide a name for the model.
• Model Authority: You must provide the name of the model authority
that is responsible for the model data in this model authority set.
• Model Schema: You must specify the business model schema that
the model authority set applies to.

4.5.5 Viewing/Modifying Model Authority Set Types
for model authority set types.
To view information for a model authority set type, use one of the
following methods:
• From the Administration Explorer, expand the Model Authority Set
Types node, and click the desired name.
• From the Administration Explorer, expand the Model Authority Set
Types node, right-click the desired name, and choose Properties from
the context menu.
The model authority set type property sheet can be used to modify the
properties of a model authority set type.
Figure 143: Model Authority Set Type Property Sheet

You must have the ReplaceModelAuthoritySetType privilege to modify
properties of a model authority set type.

4.5.6 Removing a Model Authority Set Type
A user with the RemoveModelAuthoritySetType privilege can delete model
authority set types using the Administration Explorer.
Removing a model authority set type is not a common task. The removal
is prevented if there are any model authority sets that use the model
authority set type.
To remove a model authority type, expand the Model Authority Set Types
node on the Administration Explorer, right-click the desired model
authority set type, and choose Delete from the context menu.
4.6 Managing Import/Export Metadata

e-terrasource provides mechanisms for importing and exporting data.
These mechanisms must be configured using the Administration Explorer.
There are four important concepts with regards to import/export:
• Sequence – An import or export is expressed as a sequence of one or
more steps to execute. The user requests execution of a particular
sequence, and the Import/Export Progress dialog box reports the
progress of each step in the sequence. When all steps are finished,
the sequence is considered complete.
In some cases, individual steps execute in parallel, whereas other
steps may execute sequentially. If any step fails or times out, any
remaining steps in the sequence are not performed. For example, a
sequence named “Deploy Full Model” might be made up of many
steps.
• Type – Each step in a sequence executes a particular type of task.
Such a task might include the actual importing or exporting of data, or
the execution of a script that furthers the process. Each step identifies
the type of task to perform.
For example, “CIM/XML Import” is a type that handles reading a full
CIM/XML file.
• Target – Imports are performed from a “source”, and exports are
performed to a “destination”. These “sources” and “destinations” are
referred to as “targets”. A typical source target might be “File”. For
export, multiple destinations can be configured, such as “Production
System” or “Test System”.

• Parameters – Parameters are used to hold configurable values for a
particular target.
For example, a CIM/XML Import from a File target might have
parameters that specify the file name and directory name. Some
parameters may reference “proxy strings” using the notation
“<%Proxy>” (for more information, refer to section 4.6.7 Proxies).
The first step when configuring import/export metadata is to define the
import/export types. Then the types can be used when creating
sequences.
4.6.1 Creating an Import/Export Sequence

Each sequence defines one or more steps that are undertaken to import
or export data, and each step involves the execution of an import or
export type. You must have the CreateImpExpSequence privilege to
create a sequence.
To create a new sequence, expand the Import/Export node on the
Administration Explorer, right-click the Sequences node, and choose
Insert from the context menu. The New Import/Export Sequence dialog
click OK.
Figure 144: New Import/Export Sequence Dialog Box

• Sequence: You must enter a unique ID for the sequence.
• Import/Export: You must indicate if this represents an import
sequence or an export sequence.
• Available for Projects: Set this value to Yes if this sequence is valid
for projects. In other words, this sequence supports incremental model
changes. Import sequences that are Available for Projects are listed on
the Import toolbar button under Import into Project. Export sequences
that are Available for Projects are listed when you choose the Export
option on a project’s context menu. A sequence that supports both full
and incremental imports/exports can be marked as both Available for
Projects and Available for Workspaces.
• Available for Workspaces: Set this value to Yes if this sequence is
valid for workspaces. In other words, this sequence supports full model
imports/exports. Import sequences that are Available for Workspaces
are listed on the Import toolbar button under Import into Workspace.
Export sequences that are Available for Workspaces are listed on the
Export toolbar button under Export Workspace. A sequence that
supports both full and incremental imports/exports can be marked as
both Available for Projects and Available for Workspaces.
• Model Schema: You must enter the name of the business model
schema to which this sequence applies.
• Description: You can optionally enter a description for the sequence
that provides the user with information about the purpose of the
sequence. The description appears in the Import/Export dialog box for
this sequence.
4.6.1.1 Creating a Sequence Step
An import or export sequence must have one or more steps. Each step
references an import/export type. The steps are ordered and can be
executed sequentially or in parallel, such that executing the steps in the
specified order performs the desired import or export.
You must have the ReplaceImpExpSequence privilege to add a step to a
sequence.
To create a sequence step, expand the Sequences node under the
Import/Export node on the Administration Explorer, right-click the desired
sequence, and choose Add Step from the context menu. The New
Import/Export Sequence Step dialog box is shown. Enter the required
fields, as indicated by an asterisk (*), and click OK.

Figure 145: New Import/Export Sequence Step Dialog Box
• Step: You must enter a step number that indicates the order of this
step in the sequence.
• Import/Export Sequence: This is filled with the name of the parent
sequence.
• Import/Export Type: You must fill in the name of the import/export
type that this step executes.
• Can Skip: If the user is allowed to skip this step, check this box.
4.6.1.2 Creating a Sequence Step Prerequisite
It is important to note that all steps in an import/export sequence can
potentially execute simultaneously. For example, on a multi-CPU server,
the Import/Export service can process the steps in parallel on different
CPUs. To enforce a specific execution sequence, you can identify one or
more prerequisite steps.
Step B
Step A Step D
Step C
Figure 146: Prerequisite Example

For example, to enforce the sequence in the above diagram:
• Step A has no prerequisite steps.
• Step B has Step A as a prerequisite step.
• Step C has Step A as a prerequisite step.
• Step D has both Step B and Step C as prerequisite steps.
You must have the ReplaceImpExpSequence privilege to add a
prerequisite to a sequence step.
To create a prerequisite for an import/export sequence step, expand
Import/Export on the Administration Explorer, and then expand
Sequences. Under the desired sequence, expand Steps, right-click the
desired step, and choose Add Prerequisite from the context menu. The
New Step Prerequisite dialog box is shown. Enter the required fields, as
A new child node is created with the given dependant step ID.
Figure 147: New Step Prerequisite Dialog Box

• Sequence: The name of the parent sequence is automatically filled.
• Dependent Step: The name of the dependent step is automatically
filled.
• Prerequisite Step: Choose the name of the prerequisite step. The
prerequisite step must be another step in the same sequence.
4.6.2 Viewing/Modifying Sequences

The Administration Explorer can be used to view and modify import/export
sequences, as well as the steps and prerequisites that belong to them.
You must have the ReplaceImpExpSequence privilege to modify
properties of sequences, steps, or prerequisites.

To view the properties of an import/export sequence, use one of the
following methods:
• From the Administration Explorer, expand Import/Export, then expand
Sequences and click on the desired sequence name.
Sequences and right-click the desired sequence name, then choose
The Import/Export Sequence property sheet is displayed.
Figure 148: Import/Export Sequence Property Sheet

• Import/Export: You must indicate if this represents an import
sequence or an export sequence.
• Available for Projects: Set this value to Yes if this sequence is valid
for projects. In other words, this sequence supports incremental model
changes. Import sequences that are Available for Projects are listed on
the Import toolbar button under Import into Project. Export sequences
that are Available for Projects are listed when you choose the Export
option on a project’s context menu. A sequence that supports both full
and incremental imports/exports can be marked as both Available for
Projects and Available for Workspaces.
• Available for Workspaces: Set this value to Yes if this sequence is
valid for workspaces. In other words, this sequence supports full model
imports/exports. Import sequences that are Available for Workspaces
are listed on the Import toolbar button under Import into Workspace.
Export sequences that are Available for Workspaces are listed on the
Export toolbar button under Export Workspace. A sequence that

supports both full and incremental imports/exports can be marked as
both Available for Projects and Available for Workspaces.
• Model Schema: You must enter the name of the business model
schema to which this sequence applies.
• Description: You can optionally enter a description for the sequence
that provides the user with information about the purpose of the
sequence. The description appears in the Import/Export dialog box for
this sequence.
To view the properties of an import/export sequence step, use one of the
following methods:
• From the Administration Explorer, expand Import/Export, then
Sequences. Under the desired sequence, expand the Steps folder,
and click the step name.
Sequences. Under the desired sequence, expand the Steps folder,
right-click the step name, and choose Properties from the context
menu.
The Import/Export Sequence Step property sheet is displayed.
Figure 149: Import/Export Sequence Step Property Sheet

• Step: You must enter a step number that indicates the order of this
step in the sequence.
• Can Skip: If the user is allowed to skip this step, check this box.
To view the properties of a step prerequisite, use one of the following
methods:
Sequences. Under the desired sequence, expand the Steps folder and
the step name. Under the Prerequisites folder, click the prerequisite
name.

Sequences. Under the desired sequence, expand the Steps folder and
the step name. Under the Prerequisites folder, right-click the
prerequisite name, and choose Properties from the context menu.
The Import/Export Prerequisite property sheet is displayed.
Figure 150: Import/Export Prerequisite Property Sheet

There are no modifiable properties on this property sheet. If you want to
modify the prerequisite information, you must delete the record and create
a new one.
4.6.3 Removing a Sequence

A user with the RemoveImpExpSequence privilege can delete
import/export sequences using the Administration Explorer.
Removing a sequence is not a common task. The removal is prevented if
there is an import/export in progress for the sequence.
To remove an import/export sequence, expand the Import/Export node on
the Administration Explorer, then expand the Sequences node, right-click
the desired sequence, and choose Delete from the context menu.
When a sequence is removed, its associated steps and prerequisites are
also removed.
4.6.4 Creating an Import/Export Type

Import/export types in e-terrasource are components of import/export
sequences. Each type performs a step in a sequence, such as reading or
writing a CIM/XML file. You must have the CreateImpExpType privilege to
create a type.
Types can be created on the Administration Explorer by expanding the
Import/Export node, right-clicking on Types, and selecting Insert from the

context menu. The New Import/Export Type dialog box is shown. Enter
the required fields, as indicated by an asterisk (*), and click OK.
Figure 151: New Import/Export Type Dialog Box

• Import/Export Type ID: You must enter a name for the import/export
type.
• Import/Export Format: An import/export type can specify one of the
following formats:
− CIM – Choose CIM if this import/export type represents the import
or export of a CIM/XML file (*cim.xml or *ciminc.xml).
− CSM – Choose CSM if this import/export type represents the import
or export of a CSM dataset XML file that holds a model authority
set or project (*MAS.xml or *project.xml).
− Hdb – This option is obsolete and should not be used.
− MetaDocument – Choose this option for exports that produce an
HTML document of metadata. For details, refer to the

− MetaInstall – Choose this option for exports that produce an
installation script from a metamodel. For details, refer to the
− MetaUpdate – Choose this option for exports that produce an
upgrade script from a metamodel project. For details, refer to the
− Notify – This option is reserved for Web service notifications.
− Powershell – Choose this option to execute a Microsoft Powershell
script.
− Script – Choose this option to execute a Microsoft MS-DOS
command script.
• Import/Export: You must indicate if this type represents an import or
an export.
• Is Full Export Allowed: Set this option to Yes if the import/export type
supports full exports.
• Is Incremental Export Allowed: Set this option to Yes if the
import/export type supports incremental exports.
• Timeout: You should enter a value (in seconds) that represents the
maximum expected time that should be allowed for the import or
export. If the duration of the import/export exceeds this value, the
status is set to Timeout in the Import/Export Progress dialog box;
however, processing does not terminate when a timeout occurs. If the
timeout value is less than or equal to 0, timeout detection is disabled.
• Description: You can enter an optional description of the
import/export type.
4.6.4.1 Creating a Target
Each import/export type must specify one or more targets. When
importing data, the target specifies the source of the model data. When
exporting data, the target specifies the destination for the model data. You
must have the ReplaceImpExpType privilege to create a target for a type.
Targets can be created on the Administration Explorer by expanding the
Import/Export node, then expanding the Types node, right-clicking the
desired type, and selecting Add Target from the context menu. The New
Import/Export Target dialog box is shown. Enter the required fields, as

Figure 152: New Import/Export Target Dialog Box
• Target: You must supply a name for the target.
• Import/Export Type: You must supply the name of the parent
import/export type.
• Sort Order: Enter a numeric value that determines the order of this
target in the Import/Export dialog boxes.
• Description: You can optionally provide a description of the target.
4.6.4.2 Creating Target Parameters
Each import/export target usually has parameters associated with it. The
parameters provide detailed information about how to process the
request. You must have the ReplaceImpExpType privilege to create a
parameter for a target.
Parameters can be created on the Administration Explorer by expanding
the Import/Export node, expanding the Types node, expanding the
Targets folder, then right-clicking the desired target and selecting
Add Parameter from the context menu. The New Import/Export Parameter
dialog box is shown. Enter the required fields, as indicated by an
asterisk (*), and click OK.

Figure 153: New Import/Export Parameter Dialog Box
• Name: You must enter a name for the target parameter.
• Label: Enter the label for the parameter that should appear in the
• Picklist: If the value for the parameter should be constrained to a
picklist of valid choices, select the desired picklist. You can create
additional picklists using the information in the e-terrasource
Metamodel Guide.
• Value: Enter an initial value for the parameter if desired. The value
may contain a “proxy” string (for more information, refer to section
4.6.7 Proxies).
• Public: If this parameter should be included in exported CIM and
CSM XML files, set this value to Yes.
• Visible: If this parameter should be visible on the user interface, set
this value to Yes.
• Editable: If this parameter should be editable by the user in the
Import/Export dialog box, set this value to Yes.

• Import/Export Target: This value is automatically filled with the name
of the parent target.
• Import/Export Type: This value is automatically filled with the name of
the parent type.
parameter in the Import/Export dialog boxes.
• Selection Type: The selection type should be provided if the user
interface should display a control to assist the user with entering the
value. Possible choices are:
− File – Set the selection type to File if the user interface should
display a standard File selection dialog box.
− Directory – Set the selection type to Directory if the user interface
should display a standard Directory selection dialog box.
− Date – Set the selection type to Date if the user interface should
display a Date picker control. [Not currently supported]
− Date/Time – Set the selection type to Date/Time if the user
interface should display a Date/Time picker control. [Not currently
supported]
− Model Type – Choose this selection type if the user interface
should display a picklist of model types. [Not currently supported]
− Model Authority Set Type – Choose this selection type if the user
interface should display a picklist of model authority set types. [Not
currently supported]
− Project – Choose this selection type if the user interface should
display a picklist of projects. [Not currently supported]
− User – Choose this selection type if the user interface should
display a picklist of users. [Not currently supported]
− Workspace – Choose this selection type if the user interface should
display a picklist of workspaces. [Not currently supported]
− Schema – Choose this selection type if the user interface should
display a picklist of business model schemas. [Not currently
supported]
− Picklist – Choose this selection type if the user interface should use
display the picklist specified by the Picklist property. [Not currently
supported]

4.6.4.3 Defining Exportable States
If a project, or a workspace containing one or more projects, is being
exported to a target, then a check is made to see if any restrictions have
been defined with regards to the state of the project(s). By defining
allowable exportable states, you can restrict the exports so that only
projects in certain states can be exported.
For example, you can specify that the only projects that can be exported
to a production target are projects with a state of “Approved for
Production”. However, exports to a test target are allowed for projects in
other states (for more information about states, refer to section
4.9 Managing States).
You must have the ReplaceImpExpType privilege to create an exportable
state for a target.
Exportable states can be created on the Administration Explorer by
expanding the Import/Export node, expanding the Types node, expanding
the Targets folder, then right-clicking the desired target and selecting Add
State from the context menu. The New State dialog box is shown. Enter
the required fields, as indicated by an asterisk (*), and click OK.
Figure 154: New State Dialog Box

• Allowable Project State: You must supply the name of a project state
that is allowed for the type/target.
• Import/Export Target: This value is automatically filled with the name
of the parent target.
• Import/Export Type: This value is automatically filled with the name of
the parent type.

4.6.5 Viewing/Modifying a Type
The Administration Explorer can be used to view and modify import/export
types, as well as the targets, parameters, and exportable states that
belong to them.
You must have the ReplaceImpExpType privilege to modify properties of
types, targets, parameters, and exportable states.
To view the properties of an import/export type, use one of the following
methods:
Types and click on the desired type name.
Types, then right-click the desired type name and choose Properties
The Import/Export Type property sheet is displayed.
Figure 155: Import/Export Type Property Sheet

• Import/Export Format: An import/export type can specify one of the
following formats:
− CIM – Choose CIM if this import/export type represents the import
or export of a CIM/XML file (*cim.xml or *ciminc.xml).

− CSM – Choose CSM if this import/export type represents the import
or export of a CSM dataset XML file that holds a model authority
set or project (*MAS.xml or *project.xml).
− Hdb – This option is obsolete and should not be used.
− MetaDocument – Choose this option for exports that produce an
HTML document of metadata. For details, refer to the
− MetaInstall – Choose this option for exports that produce an
installation script from a metamodel. For details, refer to the
− MetaUpdate – Choose this option for exports that produce an
upgrade script from a metamodel project. For details, refer to the
− Notify – This option is reserved for Web service notifications.
− Powershell – Choose this option to execute a Microsoft Powershell
script.
− Script – Choose this option to execute a Microsoft MS-DOS
command script.
• Import/Export: You must indicate if this type represents an import or
an export.
• Timeout: You should enter a value (in seconds) that represents the
maximum expected time that should be allowed for the import or
export. If the duration of the import/export exceeds this value, the
status is set to Timeout in the Import/Export Progress dialog box.
• Description: You can enter an optional description for the type.
To view or modify the properties for an import/export target, use one of
the following methods:
Types. Under the desired type, expand the Targets folder, and click
the target name.
Types. Under the desired type, expand the Targets folder, right-click
the target name, and choose Properties from the context menu.
The Import/Export Target property sheet is displayed.

Figure 156: Import/Export Target Property Sheet
• Description: You can enter an optional description for the target.
• Sort Order: You can enter a numeric value that determines the order
of this target in the Import/Export dialog boxes.
To view the properties of a target parameter, use one of the following
methods:
Types. Under the desired type, expand the Targets folder and the
target name. Under the Parameters folder, click the parameter name.
target name. Under the Parameters folder, right-click the parameter
name, and choose Properties from the context menu.
The Import/Export Parameter property sheet is displayed.

Figure 157: Import/Export Parameter Property Sheet
• Label: Enter the label for the parameter that should appear in the
• Picklist: If the value for the parameter should be constrained to a
picklist of valid choices, select the desired picklist. You can create
Metamodel Guide.
• Value: Enter an initial value for the parameter if desired.
• Public: If this parameter should be included in exported CIM and
CSM XML files, set this value to Yes.
• Visible: If this parameter should be visible on the user interface, set
this value to Yes.
• Editable: If this parameter should be editable by the user in the
Import/Export dialog box, set this value to Yes.

parameter in the Import/Export dialog boxes.
• Selection Type: The selection type should be provided if the user
interface should display a control to assist the user with entering the
value. Possible choices are:
− File – Set the selection type to File if the user interface should
display a standard File selection dialog box.
− Directory – Set the selection type to Directory if the user interface
should display a standard Directory selection dialog box.
− Date – Set the selection type to Date if the user interface should
display a Date picker control. [Not currently supported]
− Date/Time – Set the selection type to Date/Time if the user
interface should display a Date/Time picker control. [Not currently
supported]
− Model Type – Choose this selection type if the user interface
should display a picklist of model types. [Not currently supported]
− Model Authority Set Type – Choose this selection type if the user
interface should display a picklist of model authority set types. [Not
currently supported]
− Project – Choose this selection type if the user interface should
display a picklist of projects. [Not currently supported]
− User – Choose this selection type if the user interface should
display a picklist of users. [Not currently supported]
− Workspace – Choose this selection type if the user interface should
display a picklist of workspaces. [Not currently supported]
− Schema – Choose this selection type if the user interface should
display a picklist of business model schemas. [Not currently
supported]
− Picklist – Choose this selection type if the user interface should use
display the picklist specified by the Picklist property. [Not currently
supported]
To view the properties of an exportable state, use one of the following
methods:
target name. Under the States folder, click the state name.

target name. Under the States folder, right-click the state name, and
The Import/Export State property sheet is displayed.
Figure 158: Import/Export State Property Sheet

There are no fields that can be modified on this property sheet. If you
want to modify the state information, you must delete the record and
create a new one.
4.6.6 Removing a Type

A user with the RemoveImpExpType privilege can delete import/export
types using the Administration Explorer.
Removing a type is not a common task. The removal is prevented if there
is an import/export in progress that uses the type, or if there is an
import/export sequence step that references the type.
To remove an import/export type, expand the Import/Export node on the
Administration Explorer, then expand the Types node, right-click the
desired type, and choose Delete from the context menu.
When a type is removed, its associated targets, parameters, and
exportable states are also removed.
4.6.7 Proxies
Each Import/Export type and Target pair has a set of parameters to
control their behavior.
Import/Export proxies are special “tags” that are dynamically resolved at
the time the request is processed by the Import/Export service.

Below is a list of the currently supported proxies. The proxy tags are case-
sensitive and should not contain any additional white space.
Proxy Name Description
[%RequestId] An import/export sequence can consist of several
steps, and each step has its own request placed in
the import/export queue. However, each step in a
sequence has the same RequestId number.
[%Sequence] The sequence ID of the request currently being
processed.
[%Type] The import/export type identifier (i.e., CIM/XML
Export).
[%Target] The import/export target for the request (i.e., File,
Production).
[%UserId] The ID of the user who submitted the request.
[%UserDefaultModelAuthoritySetType] The default model authority set type for the user who
submitted the request. Newly imported records are
assigned to this model authority set type.
[%DateTime] The date/time that processing starts on the request.
The format is YYYYMMDDTHHMMSS (i.e.,
20091201T140159). This is based on the ISO 8601
standard for date/time representations, with a slight
alteration to allow it to be a workable file name. This
ensures a meaningful sort order when the date/time
is used in a file name.
[%ProjectId] The project ID associated with the request.
[%WorkspaceId] The workspace associated with the request.
[%CsmParameter(parameterId)] A special proxy that allows a lookup into the
csmParameter table that holds the application
parameters of an e-terrasource system.
This proxy resolves to the value of the parameterId
provided. For more information, refer to section
4.8 Managing Application Parameters.
For any import/export parameter, a proxy can be used as the sole
parameter value or can be included in a string value. You can include
several proxies in a string value.
Here are some examples on the use of proxies within Import/Export
parameters:
• A file name for a CIM/XML export:
filename = [%Type]_ReqNum[%RequestID]_[%DateTime]_cim.xml
can resolve to:

filename = NETMOM Export_ReqNum555_200901209-T083032_cim.xml
• A global directory is established to hold all e-terrasource exports:

directory = [%CsmParameter( global_export_dir )]

If you use this value for every “directory” parameter in the
import/export parameter table, you can change the directory value with
a single change to the “global_export_dir” application parameter value.
4.7 Managing Model Authorities

A model authority is an organization that is responsible for managing the
contents of a data model. The content can be split across one or more
model authority set types.
4.7.1 Creating a Model Authority

You must have the CreateMdlAuth privilege in order to create a new
model authority.
To create a model authority, right-click the Model Authority node in the
Administration Explorer, and select Insert from the context menu. The
New Model Authority dialog box is shown. Enter the required fields, as
Figure 159: New Model Authority Dialog Box

• Name: You must enter a name for the model authority.
• Description: You can optionally enter a description for the model
authority.
4.7.2 Viewing/Modifying a Model Authority

The Administration Explorer can be used to view and modify model
authorities.
You must have the ReplaceMdlAuth privilege to modify properties of
model authorities.

To view the properties of a model authority, use one of the following
methods:
• On the Administration Explorer, expand the Model Authorities node,
and then click the desired model authority name.
• On the Administration Explorer, expand the Model Authorities node,
and then right-click the desired model authority name and choose
The Model Authority property sheet is displayed.
Figure 160: Model Authority Property Sheet

• Description: You can enter an optional description for the model
authority.
4.7.3 Removing a Model Authority

A user with the RemoveMdlAuth privilege can delete model authorities
using the Administration Explorer.
Removing a model authority is not a common task. The removal is
prevented if the model authority owns any model authority sets.
To remove a model authority, expand the Model Authorities node on the
Administration Explorer, right-click the desired model authority, and
choose Delete from the context menu.

4.8 Managing Application Parameters
Application parameters can be used for a variety of purposes. Some
parameters provide information about the installation, while other
parameters control the behavior of the e-terrasource application.
The description of a parameter contains information about its purpose.
Additional information can be found in the e-terrasource Software
Installation and Maintenance Guide.
4.8.1 Creating an Application Parameter

There are some circumstances in which creation of a new application
parameter is necessary. As discussed in section 4.6.7 Proxies, an
import/export target parameter can reference an application parameter.
For example, if the import/export parameter value is
[%CsmParameter(xxx)], the value of the application parameter with the
name “xxx” is substituted.
To create a new privilege, perform the following steps:
1. Click the Parameters node on the Administration Explorer.
The Parameters grid is displayed.
2. On the top line, enter the properties of the new parameter. Press Enter
to create it.
The new parameter is created and appears in the main body of the
grid.
Figure 161: Application Parameters Grid View

The following properties are available for entry on the grid:
• Name: You must enter a name for the application parameter.
• Value: You can enter a value for the parameter. It may be acceptable
to leave the value null, depending on how it is used.
• Description: Enter a description of the parameter that explains how it
is used.
• Picklist: If you want to restrict the values of the parameter, you can
specify a picklist that contains the allowed values. You can create
Metamodel Guide.
• SysPrivId: You can optionally specify which privilege is required to
modify or delete the parameter. If necessary, you can create a new
privilege for this purpose (for more information, refer to section
4.4.6 Creating a Privilege).
4.8.2 Viewing/Modifying an Application Parameter

To view or modify an application parameter, from the Administration
Explorer, choose the Parameters node. A grid display listing all
parameters is shown.
Figure 162: Application Parameters Grid View

• Value: You can enter a value for the parameter. It may be acceptable
to leave the value null, depending on how it is used.

• Description: Enter a description of the parameter that explains how it
is used.
• Picklist: If you want to restrict the values of the parameter, you can
specify a picklist that contains the allowed values. You can create
Metamodel Guide.
4.8.3 Removing an Application Parameter

You should not remove any application parameters created by
e-terrasource, as this may cause the application to behave incorrectly.
However, you may want to remove parameters that you have created for
your own use.
To remove an application parameter:
1. From the Administration Explorer, choose the Parameters node.
2. Locate the desired parameter, right-click the row, and choose Delete
A confirmation dialog box is shown.
3. Click OK in the confirmation dialog box to remove the parameter.
4.9 Managing States

e-terrasource allows you to create states (and transitions between states)
that represent a lifecycle for the following objects:
• Projects
• Models
• Model Authority Sets
• Templates
Taking projects as an example, a project usually starts in the “initial state”
when it is created. Users can change the state of the project to a new
state if the transition from the old state to the new state is allowed. This
lifecycle of states and transitions can be depicted as a state diagram.
The lifecycle information is separated by business model schema. During
installation, e-terrasource creates two schemas: CIM/EMS and
MetaModel. This means, for example, that the project lifecycle for
CIM/EMS projects can be completely different than the lifecycle for
MetaModel projects.

Upon installation, the following lifecycles are created strictly as examples.
It is expected that these sample lifecycles will be modified to meet your
needs.
Figure 163: Sample Project Lifecycle

The sample project lifecycle is a reasonably realistic example that
contains several different states and transitions. The Editing state is the
initial state, and is the only state that is not “locked” — meaning that
change items can only be added to a project in the Editing state.
Figure 164: Sample Model and Model Authority Set Lifecycle

The sample lifecycle for models and model authority sets is trivial. It
contains only two states. The initial state is “Created”.
Figure 165: Sample Template Lifecycle

The sample lifecycle for templates is similarly trivial. It also contains only
two states. The Editing state, which is the initial state, indicates that the
template is still being constructed and is not ready for use.
Projects are required to have a current state that is not null. For models,
model authority sets, and templates, the current state is optional and can
be left null.
4.9.1 Creating States and Transitions

On the Administration Explorer, states and transitions can be found under
the States node. Under that node, the information is separated by
business model schema. During installation, e-terrasource creates two
schemas: CIM/EMS and MetaModel. This means, for example, that the
project lifecycle for CIM/EMS projects can be completely different than the
lifecycle for MetaModel projects.
You must have the CreateState privilege to create new states, and the
ReplaceState privilege to create new transitions.
To create a new state for a project, model, model authority set, or
template, right-click the States node on the Administration Explorer, and
choose Insert from the context menu. The New State dialog box is shown.
Enter the required fields, as indicated by an asterisk (*), and click OK.
A new state node is created under the indicated schema with the given ID.
Figure 166: New State Dialog Box

• ID: You must enter a unique identifier for the state.
• Label: You must enter a label for the state that is shown on the user
interface.
• Parent Type: You must specify whether this state applies to projects,
models, model authority sets, or templates.
• Is Initial State: If Yes, this state is the first state in the lifecycle. Only
one state can be marked as the initial state.
• Locked: If Yes, then projects or templates in this state cannot be
modified. That is, change items cannot be added, modified, or
removed from the project/template. This property is not relevant if the
parent type is Model or Model Authority Set.
• Schema: This property identifies the business model schema that the
state applies to. You can define separate lifecycles (states and
transitions) per parent type for each schema.
• Description: You can enter an optional description of the state.
To create a new transition, expand the States node on the Administration
Explorer, then expand the desired business model schema and parent
type. Right-click the desired parent (“from”) state, and choose
Add Transition from the context menu. The New State Transition dialog
click OK.
A new transition node is created under the parent state with the given ID.

Figure 167: New State Transition Dialog Box
• Action: You must provide a label for the transition action.
• Parent State: The parent (“from”) state is automatically filled in.
• Target State: You must provide the target (“to”) state.
• Description: You can enter an optional description for the transition.
4.9.2 Viewing/Modifying States and Transitions

The Administration Explorer can be used to view and modify the states
and transitions for projects, models, model authority sets, and templates.
You must have the ReplaceState privilege to modify properties of states
and transitions.
To view the properties of a state, use one of the following methods:
• On the Administration Explorer, expand the States node, then expand
the business model schema node, and then expand the proper parent
type node. Locate the desired state, and click the state name.
type node. Right-click the desired state, and choose Properties from
the context menu.
The State property sheet is displayed.

Figure 168: State Property Sheet
• Description: You can enter an optional description for the state.
• Label: You must enter a label for the state that is shown on the user
interface.
• Is Initial State: If Yes, this state is the first state in the lifecycle. Only
one state can be marked as the initial state.
• Locked: If Yes, then projects or templates in this state cannot be
modified. That is, change items cannot be added, modified, or
removed from the project/template. This property is not relevant if the
parent type is Model or Model Authority Set.
To view the properties of a state transition, use one of the following
methods:
type node and state node. Locate the desired transition, and click the
transition name.

type node and state node. Locate the desired transition. Right-click the
transition name, and choose Properties from the context menu.
The State Transition property sheet is displayed.
Figure 169: State Transition Property Sheet

• Description: You can enter an optional description for the transition.
4.9.3 Removing States and Transitions

A user with the RemoveState privilege can remove states using the
Administration Explorer. The ReplaceState privilege is needed to remove
transitions from a state.
The removal of a state is prevented if any project, model, model authority
set, or template is currently in that state.
To remove a state, expand the States node on the Administration
Explorer, right-click the desired state, and choose Delete from the context
menu.
4.10 Managing Custom Attributes

e-terrasource provides the ability to create custom attributes for certain
objects. Custom attributes are very much like “normal” properties and
provide a powerful mechanism for extending e-terrasource.
Custom attributes can be defined for:
• Projects

• Models
• Users
• Workspaces
• Templates
Upon installation, e-terrasource creates the following custom attributes:
• User e-mail – An attribute for holding e-mail addresses
• Project category – An attribute for tracking a project’s category
Custom attributes support several different data types such as text fields,
date fields, numeric fields, picklists, and URLs. Furthermore, custom
attributes are automatically created for all objects for which they are
defined and appear on property sheets just like other “built-in” properties.
4.10.1 Creating Custom Attributes

Users with the CreateAttributeType privilege can create custom attributes
for:
• Projects
• Models
• Users
• Workspaces
• Templates
To create a custom attribute, right-click the Custom Attribute Types node
on the Administration Explorer, and choose Insert. The New Attribute
Type dialog box is shown. Enter the required fields, as indicated by an
asterisk (*), and click OK.
A new node is created under the indicated parent type with the given ID.

Figure 170: New Attribute Type Dialog Box
• ID: You must enter a unique ID for this custom attribute type.
• Label: You must enter a label for this attribute that is used on the
property sheet.
• Default Value: You can optionally enter a default value for the
attribute.
• Picklist: If the values of this attribute should be constrained by a
picklist, choose the desired picklist. You can create additional picklists
using the information in the e-terrasource Metamodel Guide.
• Data Type: You must provide a data type for the attribute:
− String – Choose this data type for text attributes (except URL
strings).
− URL – Choose this data type for text attributes that represent
URLs. A navigation arrow is shown next to the property that opens
the URL.

Examples of URLs are:
∗ http://www.grid.alstom.com – Opens a Web site in the default
browser
∗ file:///d:/temp/MyDocument.doc – Opens a Word document
∗ mailto:john.doe@acme.com – Creates an e-mail
∗ ftp://ftp.acme.com – Connects to an FTP site
− Boolean – Choose this data type for Boolean attributes where the
only possible values are 0 and 1. Typically, a picklist is also
specified (for example, the “YesNo” picklist) to restrict the values
that the user can enter.
− Date – Choose this data type for Date fields. A calendar control is
shown on the UI to assist the user with entering date values.
− DateTime – Choose this data type for Date/Time fields. A calendar
control is shown on the UI to assist the user with entering date
values.
− Integer – Choose this data type for integer attributes.
− Real – Choose this data type for real (floating point) number
attributes.
− Double – Choose this data type for double precision floating point
numbers.
• Parent Type: Custom attributes can be created for one of the
following parent types: projects, models, model authority sets, users,
workspaces, and templates.
• Schema: For parent types other than user and workspace, you can
specify a particular business model schema that the attribute type
pertains to.
• Is Public: If Yes, this attribute type is included in CIM/XML exports.
Applies only to projects and model authority sets.
• Sort Order: You can enter a number that is used for ordering the
custom attributes on property sheets.
• Privilege: You can optionally enter the privilege that is required in
order to enter a value for this custom attribute. If no privilege is
specified, the required privilege is the same privilege used by the
“built-in” properties; for example, ReplaceUser for users.

• Description: You can optionally enter a description for this custom
attribute type.
When a custom attribute is created, each instance of the parent type
receives the attribute. Based on the custom attribute shown in Figure 170,
every project property sheet displays the new attribute, and values for the
attribute can be entered, as shown in Figure 171.
Figure 171: Custom Attribute on a Property Sheet

4.10.2 Viewing/Modifying Custom Attributes
To modify an attribute value, simply bring up the property sheet for the
desired project, model, model authority set, user, workspace, or template
and enter the desired value for the attribute.
In order to view the available custom attributes and modify their
properties, you must have the ReplaceAttributeType privilege.
To view or modify custom attribute types, expand the Custom Attribute
Types node on the Administration Explorer, then expand the desired
parent type and click on the desired attribute.
The attribute type property sheet is displayed.
Figure 172: Attribute Type Property Sheet

• Label: You must enter a label for this attribute that is used on the
property sheet.
• Default Value: You can optionally enter a default value for the
attribute.
• Is Public: If Yes, this attribute type is included in CIM/XML exports.
Applies only to projects and model authority sets.
• Sort Order: You can enter a number that is used for ordering the
custom attributes on property sheets.
• Privilege: You can optionally enter the privilege that is required in
order to enter a value for this custom attribute. If no privilege is
specified, the required privilege is the same privilege used by the
“built-in” properties; for example, ReplaceUser for users.
• Description: You can optionally enter a description for this custom
attribute type.
4.10.3 Removing Custom Attributes

A user with the RemoveAttributeType privilege can remove custom
attributes using the Administration Explorer.
Be very careful when removing custom attributes because it results in all
attributes referencing the attribute type to be deleted. For example,
removal of the UserEmail attribute type results in the e-mail property
being removed from all users.
To remove an attribute, expand the Custom Attribute Types node on the
Administration Explorer, expand the desired parent type, then right-click
the desired attribute name and choose Delete from the context menu.

5. Data Security
Preventing unauthorized access to model data is an important feature of
e-terrasource — particularly in cases where the model has several
contributing model authorities.
There are several pieces of information that determine a particular user’s
access to a particular set of data in a table:
• The type of security used by the table – A table may use row-level
security or table-level security. This is configured in the business
model metadata when defining tables.
• The access type of the user – This is viewable on the user’s property
sheet.
• The access type of the user with regards to the table – For tables that
use table-level security, this is viewable by examining the security
information (User tab) for a table on the table’s context menu in the
Tables Explorer.
• The access type of the user’s model authority with regards to the
table – For tables that use table-level security, this is viewable by
examining the security information (Model Authority tab) for a table on
the table’s context menu in the Tables Explorer.
• The access type of the user’s model authority with regards to a
specific row of data – For tables that use row-level security, this is
viewable by right-clicking the button on the record’s property sheet,
and choosing Security from the context menu.
• Whether a particular property is marked for public access – This is
configured in the business model metadata when defining the
property.
5.1 Row-Level vs. Table-Level Security

The first factor in determining a user’s access to data is the security type
used by the table: row-level security or table-level security.
In the case of table-level security, the user’s access to the data in the
table is exactly the same for all rows in the table. That is, the user has
either read-write, read-only, or no access to the entire table. There is no
variation in access from row to row.
In the case of row-level security, the user’s access can vary for each row
in the table. The user may have read-write access to some rows,
read-only access to some rows, and no access to some rows. Row-level
Proprietary – See Copyright Page 286 Data Security

security is typically used in cases where multiple model authorities are
involved and you need to ensure that model authorities only modify their
own portions of the model.
As an example, a commonly used reference table might use table-level
security because it is not important that the security be different for each
row in the table. The CIM BaseVoltage table is an example of such a
table. It is simply a list of valid voltages that is referenced by other
records.
However, the CIM GeneratingUnit table might use row-level security if the
generating unit data is being modeled by different model authorities.
In e-terrasource systems that are oriented toward a single model
authority, it should be sufficient to use table-level security on all tables.
5.2 Access Type "Full"

The general rule followed with regards to data security is that, given all the
components involved in the determination, the user is ultimately granted
the most-restrictive access. However, the access type “Full” trumps
everything. A user with the “Full” access type is granted read-write access
to all data in all tables, regardless of any other settings.
Figure 173: User with Access Type “Full”

5.3 Row-Level Security
If a table uses row-level security, there are only two components that
come into play:
• The access that the user’s model authority has to the row (read-write,
read-only, or none)
• The user’s access type (full, read-write, read-only, or none)
The security information for each record in the table is checked to see
what level of access the user’s model authority has. The user’s access is
determined by the model authority’s access and the user’s access type —
whichever is most restrictive.
The security information for records using row-level security can be
viewed by clicking the Security button on the record’s property sheet.
Figure 174: Row-Level Security Information

Properly authorized users can modify the security information by adding or
removing access to the record for specific model authorities.
Figure 175: Adding Access to a Record for a Model Authority

5.4 Table-Level Security
If a table uses table-level security, there are three components that come
into play:
• The access that the user’s model authority has to the table (read-write,
read-only, or none)
• The user’s access type (full, read-write, read-only, or none)
• Any specific restrictions to that table for that user
The security information for the table is checked to see what level of
access the user’s model authority has, and to see if there are any access
restrictions for this particular user. These two pieces of information, along
with the user’s access type, are considered, and the end result is the
most-restrictive access.
Figure 176: Table-Level Security Information

The security information for tables using table-level security can be
viewed by right-clicking the table name in the Table Explorer (Tables
toolbar item), then choosing Security.

Properly authorized users can modify the security information by:
• Granting access to the table for specific model authorities.
• Restricting access to the table for specific users.
5.5 Public Access

As a final variation on data security, in the business model metadata there
is a notion of marking specific properties as “publicly accessible”. This
means that, even if the user has no access to a record, the publicly
accessible properties are still shown (in a read-only fashion).
The premise behind this is that there may be some properties that can be
displayed to users who have no other access to a record. For example, it
is typically harmless to show the name of a record, and perhaps some of
its relationships to other records, so those specific properties can be
marked as publicly accessible in the metadata.

5.6 Effect on the User Interface
The end result of the data security implementation is that each record is
tagged with the user’s access: read-write, read-only, or none. The effect
of this tag varies depending on the display.
For property sheets:
• If the tag indicates read-write access, all properties can be viewed and
modified, unless some other restriction not related to data security
prevents this, such as a calculated property or a non-enterable
property.
• If the tag indicates read-only access, all properties are shown but none
can be changed.
• If the tag indicates no access, no information is shown except for
properties that are publicly accessible.
For grid views:
• If the tag indicates read-write access, all properties can be viewed and
modified, unless some other restriction not related to data security
prevents this, such as a calculated property or a non-enterable
property.
• If the tag indicates read-only or no access, the cells in the grid cannot
be modified.
For tree views, the situation is slightly different. The information about the
tree view is read-only by nature. In order for the tree view to function
properly, the names and relationships used by the tree view must be
publicly accessible or the tree view does not function properly.
In the Graphic Modeler, if any equipment in the substation is read-only,
the entire substation is treated as read-only, as shown below.

Figure 177: Graphic Modeler – Read-Only Access
If the user has no access to any substation equipment, the entire
substation is not displayed, as shown below.
Figure 178: Graphic Modeler – No Access
5.7 Effect on Exports

The end result of the data security implementation is that each record is
tagged with the user’s access: read-write, read-only, or none. When the
data is exported to a CIM/XML file, the processing is as follows:
• If the access is read-write or read-only, all properties in the record are
written to the file.
• If the access is none, then only the properties that are publicly
accessible are written to the file.

5.8 Changing Data Security Settings
Sections 5.3 Row-Level Security and 5.4 Table-Level Security describe
the components that are used to determine a user’s access to data. Also,
those sections provide figures that depict how to view and modify these
data security components.
A key thing to remember is that changing security settings is a privileged
operation, so it is controlled by privileges — which are, in turn, assigned to
roles, as described in section 4.4 Managing Roles and Privileges.
Users with the CreateRowAccess, RemoveRowAccess, and
ModifyRowAccess privileges (which are part of the Modeler role by
default) are allowed to modify the row-level security settings for records
that their model authority currently has read-write access to.
Users with CreateAnyRowAccess, RemoveAnyRowAccess, and
ModifyAnyRowAccess privileges (which are part of the Superuser role by
default) are allowed to modify the row-level security settings for any
records regardless of whether or not their model authority currently has
read-write access to the record.
For the case of table-level security, the CreateTableAccessMdlAuth,
RemoveTableAccessMdlAuth, and ModifyTableAccessMdlAuth privileges
are needed to grant a model authority access to a table. The
CreateTableAccessUser, RemoveTableAccessUser, and
ModifyTableAccessUser privileges are needed to restrict a user’s access
to a table. All of these privileges, by default, are available only with the
Superuser role.
Caution: When security settings are changed, they only affect data that is
newly queried by the user interface. The new settings do not affect data
that has already been queried. Therefore, after changing security settings,
it is recommended that the user interface be restarted.

6. Configuration Information
6.1 Graphic Modeler Configuration Editor
The configuration, background, and symbols used in the Graphic Modeler
can be modified on each client.
The Graphic Modeler Configuration Editor is composed of a resource
editor for editing colors and graphic symbols, and an advanced
configuration options editor. The Configuration Editor stores results in a
configuration file that can be propagated to other clients, if necessary.
The Graphic Modeler’s functional components are targeted to a specific
database schema through its configuration file. The top-level configuration
consists of names of database table relationships defined in the
e-terrasource metadata. From that, the hierarchy of database tables is
established and the database tables are assigned to functional roles.
The database tables that are assigned to the role of “Symbol” have
additional configuration detail, such as graphic orientation, the number of
terminals, and the detail of terminal attachment.
The graphic representations of symbols are defined in eXtensible
Application Markup Language (XAML) files.
Each XAML file contains a complete collection of symbol definitions that
represents a theme; for example, a European theme or a North American
theme. The user can also create and name a custom theme.
The Graphic Modeler Configuration Editor tool can be accessed via the
crossed wrench and hammer button in the Graphic Modeler window, as
shown below:
Figure 179: Launching the Graphic Modeler Configuration Editor

This action triggers the pop-up of the Graphic Modeler Configuration
Editor dialog box, as shown below:
Proprietary – See Copyright Page 294 Configuration Information

Figure 180: Graphic Modeler Configuration Editor Dialog Box
There are four buttons in the Graphic Modeler Configuration Editor dialog
box:
• OK: The OK button creates a new version of the Graphic Modeler
configuration file (GraphicModelerConfig_SubstationDetail.xml).
• Cancel: The Cancel button reverts all changes made since the
configuration data was last saved.
• Export: The Export button calls up a dialog box that allows you to
export the current versions of the Graphic Modeler configuration files.
• Import: The Import button calls up a dialog box that allows you to
import other versions of the Graphic Modeler configuration files.

6.1.1 Modifying Node, Line, and Background Color
The user can change the background color of the work surface and also
customize the voltage level color coding using the Graphic Modeler
Configuration Editor.
Color attributes can be modified using the Color Selector dialog box:
Figure 181: Color Selector Dialog Box

To change the background color:
1. Move the cursor over the tree view item labeled Background Color,
and click the rectangle that displays the current background color.
The Color Selector dialog box pops up, presenting several ways of
selecting the desired color.
As the user changes the color in the dialog box, the work surface
background color also changes.
2. Click OK to accept the color, or click Cancel to restore the original
background color.
To change the voltage level colors:
1. Move the cursor over the tree view item labeled Min xxx, Max xxx
representing the voltage level range for a particular color.
2. Click the rectangle for the voltage level range of interest.
The Color Selector dialog box pops up.

As you change the color in the Color Selector dialog box, the node and
line colors for that voltage level range also change on the drawing
work surface.
3. Click OK to save the new settings, or click Cancel to revert to the
original settings.
This process can be repeated for all defined voltage level ranges.
6.1.2 Modifying a Symbol's Visual Image

The user can customize the visual images of equipment symbols. This
operation requires the use of a symbol editor or graphic editing tool that
has the ability to export a XAML file.
The tool used for this explanation was Microsoft Expression Design 4. The
information below is provided to help with navigation, but it intentionally
does not fully describe use of the symbol editor. For access to more-
detailed information about using the Configuration Editor, contact your
Alstom Grid representative.
Note: The default symbol size is 320px by 320px. Any symbols created
smaller than this appear too small when loaded into the Graphic Modeler.
1. After creating the new icon, export the XAML file. To do this in
Microsoft Expression Design, select the File menu, and choose Export.
You see the dialog box below.

2. Choose “Whole document” under Items to Export, and choose
“XAML Silverlight 4 / WPF Canvas” under Export Properties.
3. From the Graphic Modeler Configuration Editor dialog box, move the
cursor over the tree view item containing the symbol image that you
want to edit.
When you click the symbol image, a XAML editor dialog box appears.
In the center is the existing XAML template for the symbol.
4. Open the XAML file that was exported in step 1, copy the text of the
XAML file minus the first line, and replace the text in the XAML text
editor with the text that you copied.

5. Click the Apply to Graphic Modeler button in the Symbol Editor dialog
box. Alternatively, click the Cancel button on the toolbar to exit without
saving.
All matching existing symbol images on the Graphic Modeler work
surface change to the new customized image.
When you are finished, you can decide whether or not to keep the
modifications. You can revert back to the original settings by clicking the
Cancel button, or you can save the new settings by clicking the OK button
in the Configuration Editor dialog box.
6.1.3 Advanced Configuration

In e-terrasource 1.0, most of the detailed configuration options are
intended for Alstom Grid use only. The tabs shown on the advanced
configuration options are presented in the order of complexity. The tabs
labeled Symbols, Tables, and Relations are for use by Alstom Grid
personnel and require expert knowledge.
The two items that are meant for initial setup by the user administrator are
the graphic “Theme” selection on the Model tab and the “Color Range” on
the Colors tab.
The graphic theme specifies which XAML symbol definition file to use.
The combo selection box is populated from the names of existing symbol
theme XAML files. Users can create their own theme simply by copying
and renaming an existing theme file, as described in section 6.1 Graphic
Modeler Configuration Editor.
The color range table enables the user to specify the number of different
colors and the range of voltage level for that color.

Figure 182: Color Definitions
Rows can be deleted from the table by clicking on the row header to the
left of each row, and then clicking the Delete key. Rows can be added at
the bottom of the table.
The color value is encoded as a hex number. You do not want to modify
the color value here. This table simply defines the number of colors and
the voltage level range. After you have specified all the voltage ranges
and the thickness of related terminal lines, click the Apply toolbar button.
Then click on the crossed hammer and wrench icon on the toolbar, to

bring you back to the resource editor. Here, you can conveniently use the
Color Selector dialog box to assign the color for your voltage level range.
Remember to click the OK button when you are done.
6.1.4 Selection of Themes
Figure 183: Selection of Themes

The user does have the option of selecting different configuration themes.
The concept of themes is used to provide options for supporting different
configurations of standard symbols.
For example, it is well known that common electrical symbols in North
America and Europe are different. For this reason, e-terrasource provides
both North American and European theme configurations.

Figure 184: North American Theme Symbols

Figure 185: European Theme Symbols

6.1.5 Configuration Files
The configuration files follow a naming convention that identifies the files’
functions. The prefix “GraphicModelerConfig_” identifies a Graphic
Modeler configuration. The specific schema type is the suffix
“SubstationDetail”.
Each Graphic Modeler configuration can have one or more symbol theme
definition XAML files. The theme file names have the prefix
“GraphicModelerSymbols_” followed by the specific schema type name
“SubstationDetail_” followed by the theme name “NorthAmerican”.
Users can create and name their own custom theme by copying and
renaming an existing symbol definition XAML file.
For consistency, do not embed spaces in the file name.
Figure 186: Configuration File Locations

Configuration file names:
• GraphicModelerConfig_SubstationDetail.xml
• GraphicModelerSymbols_SubstationDetail_Custom.xaml
• GraphicModelerSymbols_SubstationDetail_European.xaml
• GraphicModelerSymbols_SubstationDetail_NorthAmerican.xaml
• GraphicModelerSymbols_SubstationDetail_<YOUR_THEME_HERE>.
xaml
• GraphicModelerViewport_MenuStrip.xml
• GraphicModelerNavigate_ContextMenuList.xml
The Graphic Modeler preserves the previous version of the configuration
and symbol files.
Configuration file:
• GraphicModelerConfig_SubstationDetail.xml
Symbol definition file:
• GraphicModelerSymbols_SubstationDetail_European.xaml

Appendix A. Terminology
Active Project
An active project is the project to which model edits are saved. Therefore,
the active project:
• Must be loaded into the workspace.
• Must be in a state that allows editing (is not in a “locked” state).
• Is indicated in a picklist in the toolbar.
• Cannot currently be another user’s active project.
Business Model
The business model is a representation of the objects you are modeling,
their properties, and their relationships to other objects. Whether modeling
an electrical network or anything else, the business model describes the
system you want to model. As the business model changes over time,
new business model schema versions are created.
Change Item
A change item represents an atomic edit operation that is performed as
part of a project. There are three types of change items: add a record,
delete a record, and modify a property.
Check Constraint
A check constraint is created when a property value must match a value
in a picklist. A check constraint is violated if the value does not match an
entry in the picklist.
Constraint
This term is used to refer to database constraints, which are restrictions
on the value of a particular property. As used in e-terrasource, there are
two types of constraints: referential constraints and check constraints.
Constraint Violation
This term is used to refer to constraints that are not enforced because
there are one or more records that contain data that violates the
constraint. A list of constraints that are violated is available on the
Constraint Violations view.
Proprietary – See Copyright Page 306 Terminology

CSM
Common Source Modeler was the internal name of this product before it
was branded as e-terrasource.
CSV
It is common for changes to models to be encapsulated into files
containing comma-separated values. Typically, selected columns in a line
identify a record, and the remainder of the line represents new values for
the record. Also, data in grid displays can be exported to Microsoft Excel
using the standard Microsoft Windows clipboard copy/paste mechanism.
Export
This term is used to describe the process of extracting a model into a
format for transmission to an external system.
Graphical Editing / Graphical Modeling
Editing the model graphically means adding equipment using graphic
templates on a schematic of the network. This function is about
configuring the database.
Import
This term is used to describe the process of receiving data into
e-terrasource and encapsulating it into a project or loading it into a
workspace.
Import/Export Parameter
Parameters (name/value pairs) are used to provide information necessary
for performing an import/export from/to a particular target. The parameter
names are dependent on the import/export type, and the parameter
values can vary from target to target.
Import/Export Sequence
An import/export sequence is an ordered list of one or more import/export
types. When the user selects a sequence, each import/export type
belonging to that sequence is performed.
Import/Export Target
For a given import/export type, multiple “targets” can be configured. Each
target represents an environment or context that is the source or
destination of model data. For example, for a given import/export type,
there might be a “production” target and a “test” target.

Import/Export Type
An import/export type defines a source of model data (in the case of
import types) or a destination for model data (in the case of export types).
It can also represent other steps in a sequence, such as execution of
command scripts.
Metadata
Metadata is data about data. e-terrasource uses metadata to store the
bulk of its configuration. Everything from the business model, to data
security, to user interface presentation is configured in the e-terrasource
metadata.
Model
A model is a collection of model authority sets that represents the entire
business model at a point in time. You can choose not to work with
“models”, and to use only “model authority sets” instead. In e-terrasource,
a model is identified by a “type” and a “version”. The version is
incremented each time a new model is created.
Model Type
A model type is a name you assign to your model. Furthermore, a model
type identifies the model authority set types that it is comprised of. For
example, you may define a model type named “Full” that is comprised of
model authority set types “North”, “South”, “East”, and “West”. Model
types are generally created only when initially setting up e-terrasource.
Model Authority
An organization that is responsible for modeling some portion of the
business model. The users associated with the modeling authority can
view and (usually) edit the objects in the model that “belong to” the
modeling authority.
Model Authority Set
A model authority set encapsulates a business model, or a portion
thereof, at a point in time. It contains data for every property of every
object at a particular time. Workspaces are usually initialized by loading in
at least one model authority set (and zero or more projects) as a starting
point. In e-terrasource, a model authority set is identified by a “type” and a
“version”. The version is incremented each time a new model authority set
is created.
Model Authority Set Type
A model authority set type is a name you assign to represent a model, or
portion of a model. For example, you may define a model authority set

type named “East”, which contains the eastern portion of your model.
Model authority set types are generally created only when initially setting
up e-terrasource.
MRID
Master Resource IDentifier. A universally unique identifier used by
e-terrasource and the Naming Service. e-terrasource uses Globally
Unique Identifiers (GUIDs) for its MRIDs.
Overlapping Change Item
When multiple projects are loaded into a workspace, it is possible that two
or more projects contain change items that modify the exact same
property. These are referred to as “overlapping change items”. The
property value corresponds to the value in the project that was loaded
most recently.
Path Name
The path name for a record is a character string that uniquely identifies
the record. If the record is part of a hierarchy, the path name generally
consists of the names of the record and each of its ancestors
concatenated together.
Project
A project is a collection of change items (edits) that are performed in a
workspace. A project is the smallest unit of change that can be applied to
a model.
Referential Constraint
A referential constraint is created for relationships between tables — that
is, when a record property must “point” to another record. A referential
constraint is violated if the value does not reference a valid record.
Schema
A schema is a representation of the tables, columns, and relationships in
a business model. The schema has a name, and it is versioned as the
business model changes over time.
Snapshot
A snapshot captures all of the data in all workspace tables at a point in
time. Snapshots can be created before a potentially risky operation, then
restored into the workspace as desired.

Target System
A target system accepts models from e-terrasource, whether transferred
in full or incrementally. Examples include an Energy Management System
(EMS), a market system, or an ICCP node.
Unapplied Change Item
When loading a project into a workspace, it is possible that one or more of
the change items cannot be applied to the workspace. These are referred
to as “unapplied change items”. Typically, this occurs when a change item
is attempting to modify a property of a record that does not exist in the
workspace.
Workspace
A workspace is an environment in which a model is viewed and edited. Its


E Terrasource Ug

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

E Terrasource Ug

Uploaded by

Copyright:

Available Formats

e-terrasource User’s Guide

This document provides information about the use of the e-terrasource

Software Version: e-terrasource 2.0

Document Date: May 8, 2012

NOTE: CONTAINS PROPRIETARY INFORMATION OWNED BY ALSTOM GRID INC.

About This Document............................................................................. xv

2. User Interface Basics ......................................................................... 10

Proprietary – See Copyright Page iii

3. Using e-terrasource ............................................................................ 38

Proprietary – See Copyright Page iv

Proprietary – See Copyright Page v

Proprietary – See Copyright Page vi

Proprietary – See Copyright Page vii

4. Administrative Tasks........................................................................ 212

Proprietary – See Copyright Page viii

5. Data Security..................................................................................... 285

Proprietary – See Copyright Page ix

Appendix A. Terminology..................................................................... 305

Proprietary – See Copyright Page x

Proprietary – See Copyright Page xi

Proprietary – See Copyright Page xii

Proprietary – See Copyright Page xiii

Proprietary – See Copyright Page xiv

Purpose of This Document

Who Should Use This Document

Structure of This Document

For More Information

Proprietary – See Copyright Page xv

Proprietary – See Copyright Page xvi

Proprietary – See Copyright Page xvii

1.1.1 Metadata-Based Model

Proprietary – See Copyright Page 1 Overview

Model Authority Set

Model Authority Set Model Authority Set

Model Authority Set

Figure 1: Model Authority Sets

Proprietary – See Copyright Page 2 Overview

Proprietary – See Copyright Page 3 Overview

Figure 2: Projects and New Model Authority Sets

1.1.4 Independent Workspaces

1.1.5 Model Validation

Proprietary – See Copyright Page 4 Overview

1.1.7 Data Security

Proprietary – See Copyright Page 5 Overview

Proprietary – See Copyright Page 6 Overview

1.1.10 Web Service Interface

Proprietary – See Copyright Page 7 Overview

Proprietary – See Copyright Page 8 Overview

Proprietary – See Copyright Page 9 Overview

Proprietary – See Copyright Page 10 User Interface Basics

Proprietary – See Copyright Page 11 User Interface Basics

Figure 3: Viewport with Workspace Explorer Pane

Proprietary – See Copyright Page 12 User Interface Basics

Figure 4: e-terrasource Home Page

Proprietary – See Copyright Page 13 User Interface Basics

Figure 5: Home Page – Timeline

Proprietary – See Copyright Page 14 User Interface Basics

Figure 6: Timeline – Date Options Dialog Box

Proprietary – See Copyright Page 15 User Interface Basics

Proprietary – See Copyright Page 16 User Interface Basics

Figure 8: Timeline – Add Calendar Entry Dialog Box

Figure 9: Home Page – Loaded Models/Model Authority Sets

Proprietary – See Copyright Page 17 User Interface Basics