EcoStruxure Building Operation

IT
Reference Guide
04-40008-03-en
June 2022
EcoStruxure Building Operation
IT
Reference Guide
04-40008-03-en
June 2022
Copyright © 2022 Schneider Electric. All rights reserved.
The Schneider Electric brand and any registered trademarks of Schneider Electric Industries SAS referred to in this guide are the sole property of
Schneider Electric SA and its subsidiaries. They may not be used for any purpose without the owner's permission, given in writing. This guide and its
content are protected, within the meaning of the French intellectual property code (Code de la propriété intellectuelle français, referred to hereafter as
"the Code"), under the laws of copyright covering texts, drawings and models, as well as by trademark law. You agree not to reproduce, other than for
your own personal, non-commercial use as defined in the Code, all or part of this guide on any medium whatsoever without Schneider Electric's
permission, given in writing. You also agree not to establish any hypertext links to this guide or its content. Schneider Electric does not grant any right or
license for the personal and non-commercial use of the guide or its content, except for a non-exclusive license to consult it on an "as is" basis, at your
own risk. All other rights are reserved.
Trademarks and registered trademarks are the property of their respective owners.
 Contents

Introduction
1 About This Guide ........................................................ 23
1.1 Purpose of This Guide ............................................................... 25
1.2 How This Guide is Organized ..................................................... 26
1.3 Safety Information ...................................................................... 27
1.3.1 Important Information ............................................................... 27
1.3.2 Cybersecurity Safety Notice ..................................................... 28

2 Additional Information ................................................. 29

2.1 Where to Find Additional Information ......................................... 31

Reference
3 Installation .................................................................. 35
3.1 Installation Overview .................................................................. 37
3.1.1 Installation Packages ............................................................... 37
3.1.2 Products .................................................................................. 37
3.1.3 Installation Folder ..................................................................... 37
3.1.4 Installation Example ................................................................. 38
3.1.5 Installation Reparation ............................................................. 38
3.1.6 Reinstall ................................................................................... 38
3.1.7 System Upgrade Overview ...................................................... 38
3.1.8 Uninstallation ........................................................................... 39
3.1.9 Version Numbers and Parallel Installations ............................. 39
3.1.10 Software Administrator ............................................................. 39
3.2 Products ..................................................................................... 40
3.2.1 WorkStation ............................................................................. 40
3.2.2 Graphics Editor ........................................................................ 40
3.2.3 Script Editor ............................................................................. 40
3.2.4 Menta Editor ............................................................................. 41
3.2.5 Function Block Editor ............................................................... 41
3.2.6 WorkPlace Tech ....................................................................... 41
3.2.7 Enterprise Central .................................................................... 42
3.2.8 Enterprise Server ..................................................................... 42
3.2.9 Software Administrator ............................................................. 42

04-40008-03-en, June 2022 IT

5
 3.2.10 Device Administrator ................................................................ 42
3.2.11 License Administrator .............................................................. 43
3.2.12 License Server ......................................................................... 43
3.2.13 WebReports ............................................................................. 43
3.2.14 Language Package .................................................................. 43
3.3 Installation Example ................................................................... 44
3.4 Version Numbers and Parallel Installations ................................ 46
3.5 Installing the License Administrator and the License Server ...... 48
3.6 Installing WorkStation and Client Tools ...................................... 50
3.7 Installing a Language Pack ........................................................ 52
3.8 Installing Enterprise Central ....................................................... 53
3.9 Installing the Enterprise Server .................................................. 55
3.10 Installing the Device Administrator ............................................. 57

4 Installation Repair ....................................................... 59

4.1 Installation Reparation ............................................................... 61
4.2 Repairing the License Administrator and the License Server ..... 62
4.3 Repairing WorkStation and Client Tools Installation .................. 63
4.4 Repairing the Enterprise Server ................................................. 65
4.5 Repairing the Device Administrator Installation .......................... 67

5 Reinstallation .............................................................. 69
5.1 Reinstallation ............................................................................ 71
5.2 Reinstalling the License Administrator and the License Server . 72
5.3 Reinstalling WorkStation and Client Tools ................................. 73
5.4 Reinstalling the Enterprise Server .............................................. 75
5.5 Reinstalling the Device Administrator Installation ...................... 77

6 Computer Maintenance .............................................. 79

6.1 Replace Enterprise Server or WebReports Computer
Workflow .................................................................................... 81
6.1.1 Preparation .............................................................................. 81
6.1.2 Install EcoStruxure Building Operation Software ..................... 82
6.1.3 Restore the Enterprise Server Database ................................. 83
6.1.4 WebReports Migration Preparation .......................................... 85
6.1.5 Install WebReports ................................................................... 86

7 Uninstallation .............................................................. 89
7.1 Uninstallation ............................................................................. 91
7.2 Uninstalling the License Administrator ....................................... 92
7.3 Uninstalling the License Server .................................................. 93
7.4 Uninstalling a Language Pack .................................................... 94
7.5 Uninstalling WorkStation ............................................................ 95
7.6 Uninstalling Enterprise Central ................................................... 96
7.7 Uninstalling Enterprise Server .................................................... 97
7.8 Uninstalling Device Administrator .............................................. 98

8 Installation User interface ........................................... 99

8.1 Installation Wizard – Choose Components Page ..................... 101

IT 04-40008-03-en, June 2022

6
 8.2 Installation Wizard – Installation Type Page ............................ 103
8.3 Installation Wizard – License Server Configuration Page ........ 104
8.4 Server Installation Wizard – Configuration Page ...................... 105

9 Licensing Introduction .............................................. 107

9.1 Licensing Overview .................................................................. 109
9.1.1 EcoStruxure Building Operation Licensing ............................ 109
9.1.2 Automation Server Licenses .................................................. 109
9.1.3 Demo Licenses ...................................................................... 109
9.1.4 License Enforcement ............................................................. 109
9.1.5 License Information ................................................................ 109
9.1.6 Reclaim Licenses ................................................................... 110
9.2 License Enforcement ............................................................... 111
9.2.1 License Violation .................................................................... 111
9.3 License Information ................................................................. 112
9.3.1 License Information on Servers ............................................. 112
9.3.2 License Status ....................................................................... 112
9.4 Order Information Request ...................................................... 113
9.4.1 EcoStruxure Building Operation Software License Order
Request ................................................................................. 114
9.4.2 Automation Server Licensing Order Request ......................... 115
9.5 Reclaim Licenses ..................................................................... 117
9.5.1 Reclaim licenses on Automation Servers ............................... 117
9.5.2 Reclaim licenses on Enterprise Central or Enterprise
Servers .................................................................................. 117
9.6 Reclaiming Licenses for Licenses on Automation Servers ....... 118
9.7 Reclaiming Licenses for Licenses on License Administrator .... 119

10 EcoStruxure Building Operation Licensing ............... 121

10.1 EcoStruxure Building Operation Software Licensing
Overview .................................................................................. 123
10.1.1 EcoStruxure Building Operation Software License
Components .......................................................................... 123
10.1.2 EcoStruxture Building Operation Software and Features that
Require Licenses ................................................................... 123
10.1.3 EcoStruxure Building Operation Software Licensing Installation
and Location .......................................................................... 123
10.1.4 EcoStruxure Building Operation Licensing Workflow ............. 123
10.1.5 EcoStruxure Building Operation Software License Distribution
and Selection ......................................................................... 124
10.1.6 Inherited Licenses .................................................................. 124
10.1.7 EcoStruxure Building Operation Software Feature Licenses
Strings ................................................................................... 124
10.1.8 EcoStruxure Building Operation Software License
Maintenance .......................................................................... 124
10.1.9 License Server Configuration and Diagnostics ...................... 124
10.2 EcoStruxure Building Operation Software License
Components ............................................................................ 125
10.2.1 License Activation Server ...................................................... 125

04-40008-03-en, June 2022 IT

7
 10.2.2 License Server ....................................................................... 125
10.2.3 License Administrator ............................................................ 125
10.3 Licenses Activation Server ....................................................... 126
10.4 License Server ......................................................................... 128
10.5 License Administrator .............................................................. 129
10.6 EcoStruxure Building Operation Software Licensing Installation
and Location ............................................................................ 130
10.6.1 License Server Installation and Location ............................... 131
10.6.2 License Administrator Installation and Location ..................... 131
10.7 Software and Features that Require Licenses ......................... 132
10.8 Field Bus Device Licenses ....................................................... 137
10.9 EcoStruxure Building Operation Software Licensing Workflow 138
10.10 Inherited Licenses .................................................................... 140
10.11 Starting License Administrator ................................................. 141
10.12 Activating EcoStruxure Building Operation Software Licenses
................................................................................................. 142
10.13 Configuring the License Server Recovery Settings ............... 143
10.14 EcoStruxure Building Operation Software License Distribution and
Selection .................................................................................. 144
10.14.1 EcoStruxure Building Operation Software License
Distribution ............................................................................. 144
10.14.2 EcoStruxure Building Operation Software License Selection . 147
10.15 EcoStruxure Building Operation Software Feature License
Strings ...................................................................................... 148

11 License Maintenance ............................................... 151

11.1 EcoStruxure Building Operation Software License
Maintenance ............................................................................ 153
11.1.1 EcoStruxure Building Operation Software License Backup and
Restore .................................................................................. 153
11.1.2 License Server Replacement and Relocation ........................ 153
11.1.3 EcoStruxure Building Operation Software License Return ..... 153
11.1.4 License Server Address Change ........................................... 153
11.1.5 License Server Reinstallation ................................................ 154
11.1.6 EcoStruxure Building Operation Software Diagnostics .......... 154
11.1.7 EcoStruxure Building Operation Software License Log File ... 154
11.2 EcoStruxure Building Operation Software License Backup and
Restore .................................................................................... 155
11.3 Backing Up EcoStruxure Building Operation Software Licenses
................................................................................................. 156
11.4 Restoring EcoStruxure Building Operation Software Licenses 157
11.5 License Server Replacement and Relocation Workflow .......... 158
11.6 EcoStruxure Building Operation Software License Return ....... 159
11.7 Returning an EcoStruxure Building Operation Software License
................................................................................................. 161
11.8 Configuring the Address to the License Server ........................ 162
11.9 WorkStation and Client Tools Address Configuration .............. 163
11.10 Enterprise Server Address Configuration ................................. 164
11.11 Accessing License Server Using the Interface ......................... 166

IT 04-40008-03-en, June 2022

8
 11.12 Viewing Activated EcoStruxure Building Operation Software
Licenses .................................................................................. 167
11.13 Viewing Diagnostic EcoStruxure Building Operation Software
License Information .................................................................. 168
11.14 Copying EcoStruxure Building Operation Software License
Diagnostics to the Clipboard ................................................... 169
11.15 Showing the EcoStruxure Building Operation Software Licenses
Log File ................................................................................... 170

12 Automation Server Licenses .................................... 171

12.1 Automation Server Licensing Overview ................................... 173
12.1.1 Licenses on Automation Servers ........................................... 173
12.1.2 Entitlements, Products, and Licenses .................................... 173
12.1.3 Automation Server Licensing Workflow ................................. 174
12.1.4 Certificates ............................................................................. 174
12.2 Assign and Activate Licenses .................................................. 175
12.2.1 Assign Licenses ..................................................................... 175
12.2.2 Activate Licenses ................................................................... 175
12.3 Automation Server Licensing Workflow ................................... 176
12.4 Adding an Entitlement to Device Administrator ........................ 177
12.5 Removing an Entitlement ........................................................ 178
12.6 Assigning Licenses .................................................................. 179
12.7 Activating Licenses Online ...................................................... 180
12.8 Offline Activation of Licenses Workflow ................................... 181
12.9 Creating the Request Files ....................................................... 183
12.10 Activating Request Files to Receive Response Files ............... 184
12.11 Sending the Response Files to the Automation Server ............ 185
12.12 Automation Server Feature License Strings ............................. 186
12.13 Adding and Removing License Columns in Device
Administrator ............................................................................ 187

13 Demo Licenses ......................................................... 189

13.1 Demo Licensesing Overview ................................................... 191
13.1.1 EcoStruxure Building Operation Software Demo Licenses
Management .......................................................................... 191
13.1.2 Automation Server Demo License ......................................... 191
13.2 EcoStruxure Building Operation Demo License Management . 192
13.2.1 EcoStruxure Building Operation Demo Licensing Workflow .. 192
13.2.2 EcoStruxure Building Operation License Activation ............... 193
13.2.3 Demo License Removal ........................................................ 193
13.3 EcoStruxure Building Operation Demo Licensing Workflow .... 194
13.4 Activating an EcoStruxure Building Operation Demo License . 196
13.5 Removing an EcoStruxure Building Operation Software Demo
License .................................................................................... 197

14 Licensing User Interface ........................................... 199

14.1 Licenses View ......................................................................... 201
14.2 Licenses View Toolbar ............................................................. 202
14.3 Licenses View Columns ........................................................... 203

04-40008-03-en, June 2022 IT

9
 14.4 Add License Dialog Box ........................................................... 204
14.5 License Activation Dialog Box .................................................. 205
14.6 License Progress Dialog Box ................................................... 206
14.7 License Server Address View .................................................. 207
14.8 Diagnostics View ...................................................................... 208
14.9 License Violation Bar ............................................................... 209
14.10 License Information Enterprise Server .................................... 210
14.11 License Information Enterprise Central .................................... 211
14.12 Add Entitlement Dialog Box ..................................................... 212
14.13 Assign Licenses View .............................................................. 213
14.14 Show Licenses View Toolbar ................................................... 215
14.15 Entitlements View .................................................................... 216
14.16 Entitlements Contents View ..................................................... 217
14.17 Entitlements Product Licenses View ........................................ 218
14.18 License Settings Dialog Box .................................................... 220
14.19 Activate Licenses Dialog Box .................................................. 221
14.20 Activate Request Files on License Activation Server (FNO) Dialog
Box .......................................................................................... 223
14.21 Send Response Files to Automation Servers Dialog Box ........ 224
14.22 License Status Bar ................................................................... 225
14.23 Select Columns Dialog Box ...................................................... 226

15 Software Administrator ............................................. 227

15.1 Software Administrator ............................................................ 229
15.1.1 Service ................................................................................... 229
15.1.2 Ports ...................................................................................... 229
15.1.3 Database Location ................................................................. 229
15.1.4 Enterprise Server and Enterprise Central System Logs ......... 229
15.2 Starting Software Administrator ............................................... 230
15.3 Configuring Server Port Settings .............................................. 231
15.4 Starting the Enterprise Central Windows Service .................... 232
15.5 Stopping the Enterprise Central Windows Service ................... 233
15.6 Starting the Enterprise Server or Enterprise Central Windows
Service ..................................................................................... 234
15.7 Stopping the Enterprise Server Windows Service .................... 235
15.8 Restarting the Enterprise Server Windows Service ................. 236
15.9 Enterprise Server and Enterprise Central System Logs ........... 237
15.10 Viewing the Enterprise Server or Enterprise Central System
Log ........................................................................................... 238
15.11 Resolving Enterprise Server or Enterprise Central Port
Conflicts ................................................................................... 239
15.12 Software Administrator – Enterprise Central View ................... 240
15.13 Software Administrator – Enterprise Server View .................... 242

16 User Account Management ...................................... 245

16.1 User Account Management Overview ..................................... 247
16.1.1 User Accounts and User Account Groups .............................. 248
16.1.2 Domains ................................................................................ 248

IT 04-40008-03-en, June 2022

10
 16.1.3 Software Permissions ............................................................ 248
16.1.4 Log on Methods ..................................................................... 248
16.1.5 Workspace Management ....................................................... 248
16.1.6 Automatic Logoff .................................................................... 249
16.1.7 Guest User Account ............................................................... 249
16.1.8 Automatic Logoff to Guest Account ........................................ 249
16.1.9 Guest Log On in WebStation ................................................. 249
16.2 Opening the Account Management Control Panel ................... 250
16.3 User Accounts and User Account Groups ............................... 251
16.3.1 Windows Active Directory User Groups ................................. 252
16.3.2 WorkStation Account Management ....................................... 253
16.4 Creating a User Account .......................................................... 254
16.5 Editing a User Account Profile .................................................. 255
16.6 Renaming a User Account ...................................................... 256
16.7 Disabling a User Account ......................................................... 257
16.8 Enabling a Disabled User Account ........................................... 258
16.9 Setting an Expiration Date for a User Account ......................... 259
16.10 Removing the Expiration Date for a User Account ................... 260
16.11 Deleting a User Account .......................................................... 261
16.12 Automatic Logoff ...................................................................... 262
16.13 Setting the Automatic Logoff Time ........................................... 263
16.14 Guest User Account ................................................................. 264
16.15 Automatic Logoff to Guest Account .......................................... 265
16.16 Configuring a User Account Group to Log off to the Guest User
Account .................................................................................... 266
16.17 Configuring a User Account Group to Only Use Classic Mode for
Function Block Programs ......................................................... 267

17 User Account Groups ................................................ 269

17.1 Windows Active Directory User Groups ................................... 271
17.2 Creating a User Account Group ............................................... 273
17.3 Editing the Description of a User Account Group ..................... 275
17.4 Adding a User Account to a User Account Group ................... 276
17.5 Removing a User Account from a User Account Group ........... 277
17.6 Reviewing the User Account Group Memberships for a User
Account .................................................................................... 278
17.7 Adding a User Account Group to a User Account Group ......... 279
17.8 Removing a User Account Group from another User Account
Group ....................................................................................... 280
17.9 Reviewing the User Account Group Memberships for a User
Account Group ......................................................................... 281
17.10 Preventing a Group of Users from Exiting WorkStation ........... 282
17.11 Enabling a Group of Users to Exit WorkStation ........................ 283
17.12 Deleting a User Account Group ................................................ 284
17.13 Syntax for IP Address Allow List .............................................. 285

18 Domains .................................................................... 287

18.1 Domains ................................................................................... 289

04-40008-03-en, June 2022 IT

11
 18.1.1 Windows Active Directory Domain ......................................... 291
18.1.2 Server Local Domain ............................................................. 291
18.1.3 Unify Domains in the Server Structure Workflow ................... 291
18.1.4 Administration Accounts in Server Local Domain .................. 292
18.2 Log On Methods ...................................................................... 293
18.2.1 Log On as a Windows User .................................................... 293
18.2.2 Log On as an EcoStruxure Building Operation User .............. 293
18.2.3 Password Administration ....................................................... 293
18.3 Creating and Configuring a Domain ......................................... 294
18.4 Editing the Windows Domain Name ......................................... 295
18.5 Editing the Description of a Domain ......................................... 296
18.6 Editing the Maximum Logon Attempts ...................................... 297
18.7 Assigning an Automation Server to a Domain .......................... 298
18.8 Removing an Automation Server from a Domain ..................... 299
18.9 Deleting a Domain ................................................................... 300
18.10 Unify Domains in the Server Structure Workflow .................... 301
18.11 Administration Accounts in EcoStruxure BMS Server Local
Domain .................................................................................... 303
18.11.1 Admin Account ....................................................................... 303
18.11.2 Reports Administrator Account .............................................. 303

19 Software Permissions ............................................... 305

19.1 Software Permissions .............................................................. 307
19.1.1 Path Permissions ................................................................... 307
19.1.2 Command Permissions .......................................................... 307
19.1.3 Extended Software Permissions ............................................ 307
19.1.4 Relative Path Permissions ..................................................... 307
19.1.5 Type Permissions .................................................................. 308
19.1.6 Software Permissions Management ...................................... 308
19.2 Path Permissions ..................................................................... 309
19.2.1 Path Permissions Rules ......................................................... 309
19.2.2 Property Permissions ............................................................. 309
19.2.3 Relative Path Permissions ..................................................... 309
19.3 Path Permissions Rules ........................................................... 310
19.4 Property Permissions ............................................................... 311
19.5 Assigning Path Permissions to User Accounts or User Account
Groups ..................................................................................... 312
19.6 Editing Path Permissions of User Accounts or User Account
Groups ..................................................................................... 313
19.7 Removing Path Permissions from User Accounts or User Account
Groups ..................................................................................... 314
19.8 Command Permissions ........................................................... 315
19.8.1 Command Permissions Rules ................................................ 315
19.9 Command Permissions Rules .................................................. 316
19.10 Assigning Command Permissions to User Account Groups .... 318
19.11 Editing Command Permissions of User Account Groups ......... 319
19.12 Removing Command Permissions from User Account Groups 320
19.13 Extended Software Permissions .............................................. 321

IT 04-40008-03-en, June 2022

12
 19.14 Relative Path Permissions ....................................................... 322
19.14.1 Relative Path Permissions Rules ........................................... 322
19.15 Relative Path Permissions Rules ............................................. 323
19.16 Creating Relative Path Templates ........................................... 324
19.17 Editing Relative Path Permissions Templates .......................... 325
19.18 Deleting Relative Path Templates ............................................ 326
19.19 Assigning Relative Path Permissions to User Accounts or User
Account Groups ....................................................................... 327
19.20 Removing Relative Path Permissions from User Accounts or User
Account Groups ....................................................................... 328
19.21 Type Permissions .................................................................... 329
19.21.1 Custom Type Permissions ..................................................... 329
19.21.2 In-built Type Permissions ....................................................... 329
19.21.3 Type Permission Rules .......................................................... 329
19.22 Type Permissions Rules .......................................................... 330
19.23 Creating Type Permissions Templates .................................... 331
19.24 Editing Type Permissions Templates ....................................... 332
19.25 Removing Path Permissions Templates .................................. 333
19.26 Assigning Type Permissions to User Accounts or User Account
Groups ..................................................................................... 334
19.27 Removing Type Permissions from User Accounts or User Account
Groups ..................................................................................... 335
19.28 Software Permissions Management ........................................ 336
19.28.1 Software Permissions, User Accounts and User Account Groups
Management .......................................................................... 336
19.28.2 Software Permissions Rules Management ............................ 336
19.29 Software Permissions, User Accounts, and User Account
Groups ..................................................................................... 337
19.30 Software Permissions Rules Management .............................. 339

20 Login Configuration ................................................... 341

20.1 Password Administration ......................................................... 343
20.2 Editing a User Account Password ............................................ 344
20.3 Allowing Users to Change their Password ............................... 345
20.4 Changing Your Password ........................................................ 346
20.5 Changing the Password for Local Administrator Accounts ....... 347
20.6 Turning off Remember Me On This Computer ......................... 348
20.7 Forcing a User to Change the Password at Next Logon .......... 349
20.8 Preventing Users from Changing Their Passwords ................. 350
20.9 Administrator Password Reset ................................................. 351
20.10 Password Reset Workflow ....................................................... 352
20.11 Connecting to an Enterprise Server or Enterprise Central ....... 354
20.12 Setting an EcoStruxure PCT Server in Password Reset Mode
................................................................................................. 355
20.13 Setting an EcoStruxure BMS Server to Password Reset
Mode ........................................................................................ 356
20.14 Copying the Session ID when Resetting the Password ........... 357
20.15 Resetting the Password using WorkStation ............................. 358

04-40008-03-en, June 2022 IT

13
 21 Workspaces .............................................................. 359
21.1 Workspace Management ......................................................... 361
21.1.1 Predefined Workspaces ......................................................... 361
21.1.2 Workspace Components and Customization ......................... 362
21.1.3 WebStation in Kiosk Mode ..................................................... 362
21.2 Predefined Workspaces ........................................................... 363
21.3 Workspace Components and Customization ........................... 364
21.3.1 Workspace Customization ..................................................... 365
21.3.2 Workspace Content References ............................................ 365
21.3.3 Panel Components ................................................................ 365
21.4 Workspace Customization ....................................................... 366
21.4.1 Customized Navigation .......................................................... 366
21.4.2 Workspace Path, Object, and Command Customization ...... 367
21.5 Workspace Path, Object, and Command Customization ......... 368
21.6 Workspace Content References .............................................. 369
21.7 Creating a Workspace .............................................................. 370
21.8 Editing the Layout of a Workspace ........................................... 372
21.9 Editing the Description of a Workspace ................................... 373
21.10 Adding a Component to a Workspace ...................................... 374
21.11 Removing a Component from a Workspace ............................ 375
21.12 Editing a Workspace Component ............................................. 376
21.13 Adding a Workspace to a User Account Group ........................ 377
21.14 Removing a Workspace from a User Account Group ............... 378
21.15 Reviewing the Workspace Memberships for a User Account
Group ....................................................................................... 379
21.16 Panel Components .................................................................. 380
21.17 Creating a Panel ..................................................................... 381
21.18 Editing a Panel ......................................................................... 382
21.19 Customized Navigation ............................................................ 383
21.20 Customized Navigation Workflow ............................................ 384
21.21 WebStation in Kiosk Mode ....................................................... 385
21.21.1 Kiosk Mode ............................................................................ 385
21.21.2 Remove the Toolbars from WebStation ................................. 385

22 Audit Trails ................................................................ 387

22.1 WorkStation Account Management ......................................... 389
22.1.1 Audit Trailing of User Activity ................................................. 389
22.1.2 WorkStation Account Validation ............................................. 389
22.2 Audit Trailing of User Activity ................................................... 390
22.3 Disabling Audit Trail for a Group of Users ................................ 391
22.4 Enabling Audit Trail for a Group of Users ................................. 392
22.5 Viewing an Audit Trail Log ........................................................ 393
22.6 WorkStation Account Validation ............................................... 394

23 User Management User Interface ............................. 395

23.1 User Management System Tree Icons ..................................... 399
23.2 Domain Properties ................................................................... 400

IT 04-40008-03-en, June 2022

14
 23.3 Profile Properties ..................................................................... 402
23.4 Workspace Properties .............................................................. 403
23.5 Pane Properties ....................................................................... 405
23.6 Panel Properties ...................................................................... 406
23.7 Navigation Pane ....................................................................... 408
23.8 Building Operation WorkStation Window ................................. 409
23.9 Domain Control Panel .............................................................. 411
23.10 Edit Permissions Dialog Box .................................................... 412
23.11 Account Management Control Panel ....................................... 414
23.12 Select Default Workspace Window .......................................... 417
23.13 Change Password Dialog Box ................................................. 418
23.14 Domain Wizard – Authentication Page ..................................... 419
23.15 Domain Wizard – Domain Members Page ............................... 420
23.16 Domain Wizard – Domain Policies Page .................................. 421
23.17 Domain – Summary Tab .......................................................... 422
23.18 Domain – Policies Tab ............................................................. 423
23.19 Domain – Domain Members Tab ............................................. 424
23.20 User Account – Summary Tab ................................................. 425
23.21 User Account – Group Membership Tab .................................. 426
23.22 User Account – Profile Tab ...................................................... 428
23.23 User Account – Software Permissions Tab .............................. 429
23.24 User Account – Audit Trailing Events Tab ................................ 431
23.25 User Account Group Properties .............................................. 432
23.26 User Account Properties .......................................................... 434
23.27 Guest Account Properties ........................................................ 436
23.28 User Account Group Wizard – Users Belonging to this Group
Page ........................................................................................ 438
23.29 User Account Group Wizard – Workspaces Belonging to this
Group Page .............................................................................. 439
23.30 User Account Group Wizard – Windows Group Name and Group
Policies Page ........................................................................... 441
23.31 User Account Group – Summary Tab ...................................... 443
23.32 User Account Group – Policies Tab ......................................... 444
23.33 User Account Group – Group Membership Tab ....................... 446
23.34 User Account Group – Software Permissions Tab ................... 448
23.35 User Account Group – Workspaces Tab .................................. 451
23.36 User Account Wizard – General Page ..................................... 452
23.37 User Account Wizard – Member Of Page ................................ 453
23.38 User Account Management Folder Properties ......................... 455
23.39 Workspace Wizard – Workspace Configuration Page ............. 456
23.40 Workspace Wizard – Pane Configuration Page ....................... 458
23.41 Workspace – Summary Tab ..................................................... 459
23.42 Workspace – Content Tab ....................................................... 460
23.43 Workspace – Members Tab ..................................................... 462
23.44 Edit Layout Workspace ............................................................ 463
23.45 Panel Wizard – Panel Configuration Page ............................... 464
23.46 Domains Properties ................................................................. 465

04-40008-03-en, June 2022 IT

15
 23.47 Local Properties ....................................................................... 466
23.48 Work Area Window Properties ................................................. 467
23.49 Create Work Area Window Wizard – Name Page .................... 468
23.50 Windows User Group Dialog Box ............................................. 469
23.51 Property Permissions Dialog Box ............................................. 470

24 Connect Agent .......................................................... 473

24.1 Connect Agent Overview ......................................................... 475
24.2 Configuring Connect Agent Settings ........................................ 476
24.3 Transferring Crash Information ................................................ 477
24.3.1 Crash Information .................................................................. 477
24.4 Applying Proxy Settings to the Connect Agent Service Log
On ............................................................................................ 478
24.5 Configuring Windows Firewall for Connect Agent .................... 479
24.6 Getting Connect Agent Debug Information .............................. 480

25 Connect Agent User Interface ................................... 481

25.1 Connect Agent Settings - Basic Tab ........................................ 483
25.2 Connect Agent Settings - Advanced Tab ................................ 484

26 Backup and Restore ................................................. 485

26.1 Backup and Restore Overview ................................................ 487
26.1.1 Backup ................................................................................... 487
26.1.2 Restore .................................................................................. 487
26.1.3 BACnet Backup and Restore ................................................. 487
26.1.4 Archiving Overview ................................................................ 487
26.1.5 Comparison of Backup and Restore Methods ........................ 488
26.1.6 Retain Level ........................................................................... 488
26.1.7 Backup and Restore using WebStation ................................. 488
26.2 Comparison of Backup and Restore Methods ......................... 489
26.3 Retain Level ............................................................................ 491
26.4 Configuring the Retain Level .................................................... 493
26.5 Mass Editing the Retain Level of Properties ............................. 494

27 Backups .................................................................... 495

27.1 Backup ..................................................................................... 497
27.1.1 Types of Data ......................................................................... 497
27.1.2 Backup Sets ........................................................................... 497
27.1.3 Scheduled Backups ............................................................... 497
27.1.4 Manual Backups .................................................................... 497
27.1.5 Mass Backup ......................................................................... 498
27.1.6 System Backup ...................................................................... 498
27.1.7 Backup Status ........................................................................ 498
27.2 Types of Data ........................................................................... 499
27.3 Backup Status .......................................................................... 500
27.4 Checking the Backup Status of an EcoStruxure BMS Server .. 501
27.5 Manual Backups ...................................................................... 502
27.5.1 Backup Set Naming ............................................................... 502
27.5.2 Local Backup and Restore of EcoStruxure BMS Servers ...... 502

IT 04-40008-03-en, June 2022

16
 27.5.3 Remote Backup and Restore of Automation Servers ............. 503
27.5.4 Local Backup of EcoStruxure BMS Servers using Device
Administrator ......................................................................... 503
27.6 Mass Backup ........................................................................... 504
27.7 Backing Up EcoStruxure BMS Servers Manually ..................... 505
27.8 System Backup ........................................................................ 506
27.9 Local Backup and Restore of EcoStruxure BMS Servers ........ 508
27.9.1 Local Backup and Restore of a Standalone Automation Server
............................................................................................... 508
27.9.2 Local Backup and Restore of an Enterprise Server ............... 508
27.9.3 Local Backup and Restore of an Enterprise Central .............. 508
27.10 Remote Backup and Restore of Automation Servers ............... 509
27.11 Local Backup of EcoStruxure BMS Servers using Device
Administrator ............................................................................ 510
27.12 Getting Backup set from an EcoStruxure BMS Server using
Device Administrator ............................................................... 511

28 Backup Sets ............................................................. 513

28.1 Backup Sets ............................................................................. 515
28.1.1 Backup Sets Location ............................................................ 515
28.1.2 Backup Sets and Server Name .............................................. 515
28.1.3 Backup Set Storage and Protection ....................................... 515
28.1.4 Backup Set Import from WorkStation ..................................... 515
28.1.5 Automatic Purge of Backup Sets ........................................... 516
28.2 Location of Backup Sets .......................................................... 517
28.2.1 Multi Server System ............................................................... 517
28.2.2 Stand-alone System ............................................................... 517
28.3 Backup Set Storage and Protection ......................................... 519
28.4 Locating the Local Backup Path on the Enterprise Server or
Enterprise Central .................................................................... 521
28.5 Saving an Enterprise Server or Enterprise Central Backup Set to
Another Location ...................................................................... 522
28.6 Saving an Automation Server Backup Set to Another
Location ................................................................................... 523
28.7 Copying a Backup Set to the Enterprise Server or Enterprise
Central Local Directory ............................................................. 524
28.8 Backup Set Import from WorkStation ....................................... 525
28.9 Importing a Backup Set to an Enterprise Server or Enterprise
Central ..................................................................................... 527
28.10 Importing a Backup Set to Automation Server ......................... 528
28.11 Automatic Purge of Backup Sets .............................................. 529
28.12 Configuring Purge Settings on an Enterprise Server ................ 530
28.13 Configuring Purge Settings on an Enterprise Central ............... 531
28.14 Deleting a Backup Set from an Enterprise Server or Enterprise
Central ..................................................................................... 532

29 Scheduled Backups ................................................. 533

29.1 Scheduled Backups ................................................................. 535
29.1.1 Backup Rules ......................................................................... 535

04-40008-03-en, June 2022 IT

17
 29.1.2 Backup Schedules ................................................................. 536
29.1.3 Synchronized Backups .......................................................... 536
29.2 Backup Rules ........................................................................... 537
29.3 Creating a Backup Rule ........................................................... 538
29.4 Editing a Backup Rule .............................................................. 539
29.5 Deleting a Backup Rule ............................................................ 540
29.6 Removing a Lead Rule from a Backup Rule ............................ 541
29.7 Backup Schedules ................................................................... 542
29.8 Editing a Backup Schedule ...................................................... 543
29.9 Synchronized Backups ............................................................ 544
29.10 Synchronizing EcoStruxure BMS Server Backups on a
Network .................................................................................... 545

30 Restore ..................................................................... 547

30.1 Restore .................................................................................... 549
30.1.1 Restored Data ........................................................................ 549
30.1.2 Automation Server Replacement Using Restore ................... 549
30.1.3 Duplicate Automation Server Using Restore .......................... 549
30.2 Restored Data .......................................................................... 550
30.3 Restoring the EcoStruxure BMS Server ................................... 552
30.4 Restoring an Automation Server from the Enterprise Server ... 553
30.5 Restoring an Enterprise Server from the Enterprise Central .... 554
30.6 Automation Server Replacement Using Restore ..................... 555
30.6.1 Automation Server Replacement Using Restore Workflow .... 556
30.7 Automation Server Replacement Using Restore Workflow ...... 557
30.8 Duplicate Automation Server from a Backup Set ..................... 559
30.8.1 Duplicate Automation Server from a Backup Set Workflow ... 560
30.9 Duplicating an Automation Server Using Restore ................... 562

31 Backup and Restore User Interface .......................... 563

31.1 Backup and Restore Manager Properties (Enterprise Central) –
Basic Tab ................................................................................. 565
31.2 Backup and Restore Manager Properties (Enterprise Server) –
Basic Tab ................................................................................. 567
31.3 Backup and Restore Manager Properties (Automation Servers) –
Basic Tab ................................................................................. 569
31.4 Backup and Restore Manager on the Enterprise Server .......... 570
31.5 Backup and Restore Manager on an Automation Server ........ 572
31.6 Backup Options Dialog Box ..................................................... 573
31.7 Create Object Wizard – Configure Backup Rule Page ............. 575
31.8 Backup Rule Properties – Basic Tab ........................................ 576
31.9 Backup Rules View .................................................................. 577
31.10 Backup Rules Toolbar .............................................................. 578
31.11 Backup Rules List .................................................................... 579
31.12 Digital Schedule Properties – Basic Tab .................................. 580
31.13 Backup Set Properties – Basic Tab .......................................... 582
31.14 Backup Sets View .................................................................... 583
31.15 Backup Status Dialog Box ........................................................ 584

IT 04-40008-03-en, June 2022

18
 31.16 Control Panel – Backup and Archiving ..................................... 585
31.17 Backup Rule Dialog Box .......................................................... 586
31.18 Backup and Restore System Tree Icons .................................. 587
31.19 Restore Options Dialog Box ..................................................... 588
31.20 Restore Status Dialog Box ....................................................... 590
31.21 Backup and Restore Folder Properties .................................... 591
31.22 Save Backup Set Dialog Box ................................................... 592

32 Backup and Restore in WebStation .......................... 593

32.1 Backup and Restore using WebStation .................................... 595
32.2 Backing up and Restoring using WebStation ........................... 596

33 Backup and Restore in WebStation User Interface ... 597

33.1 Backup and Restore Dialog in WebStation .............................. 599

04-40008-03-en, June 2022 IT

19
Introduction

The Introduction part contains information on the purpose of

this guide, how this guide is organized, where to find more
information, and information on safety.
1 About This Guide

Topics
Purpose of This Guide
How This Guide is Organized
Safety Information
 1 About This Guide
1.1 Purpose of This Guide

1.1 Purpose of This Guide

This guide provides information about EcoStruxure Building Operation software
from an Information Technology perspective, so you can perform tasks to support
an EcoStruxure BMS.

04-40008-03-en, June 2022 IT

25
1 About This Guide
1.2 How This Guide is Organized

1.2 How This Guide is Organized

This EcoStruxure Building Guide is divided into the following parts:

Introduction
The Introduction part contains information on the purpose of this guide, how this
guide is organized, where to find more information, and information on safety.

Reference
The Reference part contains conceptual information, procedures, user interface
descriptions and troubleshooting information. If you want more information, see
WebHelp or the other EcoStruxure Building guides.

IT 04-40008-03-en, June 2022

26
 1 About This Guide
1.3 Safety Information

1.3 Safety Information

Read this information carefully and look at the equipment to become
familiar with the device before trying to install, operate, service or maintain
it.

1.3.1 Important Information

The following special messages may appear throughout this bulletin or on the
equipment to warn of potential hazards or to call attention to information that
clarifies or simplifies a procedure.

The addition of either symbol to a “Danger” or “Warning” safety label

indicates that an electrical hazard exists which will result in personal
injury if the instructions are not followed.

This is the safety alert symbol. It is used to alert you to potential personal
injury hazards. Obey all safety messages that follow this symbol to avoid
possible injury or death.

DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in
death or serious injury.

WARNING
WARNING indicates a hazardous situation which, if not avoided, could result
in death or serious injury.

CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result
in minor or moderate injury.

NOTICE
NOTICE is used to address practices not related to physical injury.

Please Note
Electrical equipment should be installed, operated, serviced, and maintained only
by qualified personnel. No responsibility is assumed by Schneider Electric for any
consequences arising out of the use of this material.
A qualified person is one who has skills and knowledge related to the
construction, installation, and operation of electrical equipment and has received
safety training to recognize and avoid the hazards involved.

04-40008-03-en, June 2022 IT

27
1 About This Guide
1.3 Safety Information

1.3.2 Cybersecurity Safety Notice

NOTICE
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
• Change default passwords at first use to help prevent unauthorized access to
device settings, controls, and information.
• Change passwords regularly to help prevent unauthorized access to device
settings, controls, and information.
• Do not share accounts. Each user must have their own account.
• When creating user and display names, it is important to avoid using personal
information, and to consider regional privacy policies. Display names will
appear in event logs to identify who performed operations on the device.
• It is recommended that log files be encrypted before transmission to help with
security and privacy.
• Disable unused ports, services, and default accounts to help minimize
pathways for malicious attackers.
• Place networked devices behind multiple layers of cyber defenses (such as
firewalls, network segmentation, and network intrusion detection and
protection).
• Use the recommended cybersecurity safety measures (for example, least
privilege, separation of duties) to help prevent unauthorized exposure, loss,
modification of data and logs, or interruption of services.
Failure to follow these instructions can result in loss of data, unauthorized
system access, or equipment damage.

IT 04-40008-03-en, June 2022

28
2 Additional Information

Topics
Where to Find Additional Information
 2 Additional Information
2.1 Where to Find Additional Information

2.1 Where to Find Additional Information

All the technical EcoStruxure BMS information is available online, on WebHelp.
WebHelp is a web-based help system for the EcoStruxure Building Operation
software and SpaceLogic devices, the software and hardware that powers the
EcoStruxure BMS.
By pressing F1 or clicking a Help button in the EcoStruxure Building Operation
software your web browser opens WebHelp with the latest, up-to-date, technical
documentation.

Figure: Help in EcoStruxure Building Operation software

Some EcoStruxure Building Operation software products give you context-

sensitive help by opening a WebHelp page that explains the view or dialog box
you have in focus. Some programs open up an overview page. From these
pages, you can follow the links to get more detailed information.
WebHelp contains all the technical information that is in the guides, specification
sheets, and installation sheets.

The WebHelp site

One of the advantages with WebHelp is that you can reach Help without having
the EcoStruxure Building Operation software installed on your computer. By
entering the URL address https://ecostruxure-building-help.se.com/bms you can
access WebHelp from any computer, smartphone, or tablet connected to the
internet.

Finding information
The easiest way to find information on WebHelp is to search for it.

Figure: Home page search

All technical information is gathered in one place, so you do not need to know
which guide, specification sheet, or installation sheet the information is in.

Filtering the information

To narrow down the search results, you can use these filters:
• Product
• Functionality
• Information type

04-40008-03-en, June 2022 IT

31
2 Additional Information
2.1 Where to Find Additional Information

Figure: Search filters

IT 04-40008-03-en, June 2022

32
Reference

The Reference part contains conceptual information,

procedures, user interface descriptions and troubleshooting
information. If you want more information, see WebHelp or
the other EcoStruxure Building guides.
3 Installation

Topics
Installation Overview
Products
Installation Example
Version Numbers and Parallel Installations
Installing the License Administrator and the License Server
Installing WorkStation and Client Tools
Installing a Language Pack
Installing Enterprise Central
Installing the Enterprise Server
Installing the Device Administrator
 3 Installation
3.1 Installation Overview

3.1 Installation Overview

The EcoStruxure Building Operation software products are installed using
installation packages.
With the installation packages you install, repair, upgrade, or reinstall
EcoStruxure Building Operation software products. When upgrading or
reinstalling, you can keep or remove software settings, licenses, or the Enterprise
Server database.

3.1.1 Installation Packages

EcoStruxure Building Operation software consists of the following installation
packages:
• WorkStation: Graphics Editor, Script Editor, Menta Editor, Function Block
Editor, WorkPlace Tech Editor
• Language Packages
• Device Administrator
• License Administrator
• Enterprise Server
• Enterprise Central
The installation files for Graphic Editor, Script Editor, Menta Editor, Function
Block Editor, and WorkPlace Tech Editor are bundled into the WorkStation
installation package.

3.1.2 Products
Depending on your needs, you can install all EcoStruxure Building Operation
products or a few products, such a single automation server with a connected
WorkStation.
For more information, see section 3.2 “Products” on page 40.

3.1.3 Installation Folder

You have to select an installation folder for the first EcoStruxure Building
Operation software product you install. All later installed EcoStruxure Building
Operation software products are installed in the selected installation folder.
The following conditions apply for the installation folder:
• It has to be located on the local computer
• It cannot be the root folder
• It cannot be the WINDOWS folder
• The folder path cannot be longer than 100 Unicode characters.

04-40008-03-en, June 2022 IT

37
3 Installation
3.1 Installation Overview

NOTE: In cases where more than one version of WorkStation is installed on

the same computer, each version of WorkStation is installed in its own
folder. When WorkPlace Tech Editor is also selected in the Installation
wizard, a copy of WorkPlace Tech Editor matching the WorkStation version
is installed. However, all versions of WorkPlace Tech Editor are installed in a
single, designated folder, separate from the WorkStation folders.
The installers save a detailed log file on each installation. The files are stored in
the installation folder and are given the same name as the installer file, for
example, Workstation-x.y.z.log.

3.1.4 Installation Example

Schneider Electric recommends that you install the license server framework
before installing other EcoStruxure Building Operation software applications and
automation servers. The license server installation is included in the License
Administrator license package. During the installation of WorkStation or
Enterprise Server, the installation software asks for the address to the license
server.
For more information, see section 3.3 “Installation Example” on page 44.

3.1.5 Installation Reparation

If something unexpected happens to an EcoStruxure Building Operation product,
for example, the EcoStruxure Building Operation product does not start or
software files are missing, you can try to solve the problem by repairing the
installation.
For more information, see section 4.1 “Installation Reparation” on page 61.

3.1.6 Reinstall
To replace your current version, you start with the installation package of the
product you want to reinstall. If the installation package recognizes an earlier
installation of the EcoStruxure Building Operation product within the same major
and minor version number but lower maintenance number, the installation wizard
asks if you want to uninstall the current version before installing this package.
For more information, see section 5.1 “Reinstallation ” on page 71.

3.1.7 System Upgrade Overview

A system upgrade can include an Enterprise Server, Reports Server, one or
more automation servers and WorkStations, and the supporting administrator
software, such as Device Administrator.
For more information, see the System Upgrade Overview topic on WebHelp.

IT 04-40008-03-en, June 2022

38
 3 Installation
3.1 Installation Overview

3.1.8 Uninstallation
To uninstall an EcoStruxure Building Operation product you use the Windows
Add Remove Program tool. The Windows Add Remove Program tool
permanently removes the EcoStruxure Building Operation product from the
computer or server.
For more information, see section 7.1 “Uninstallation” on page 91.

3.1.9 Version Numbers and Parallel Installations

The EcoStruxure Building Operation software version number is constructed with
four numbers, which represents different parts of the version: Major, Minor,
Maintenance, and Build.
For more information, see section 3.4 “Version Numbers and Parallel
Installations” on page 46.

3.1.10 Software Administrator

The Software Administrator installs with the Enterprise Server installation
package. You use the Software Administrator to start and stop the Enterprise
Server service and configure the ports of the Enterprise Server.
For more information, see section 15.1 “Software Administrator” on page 229.

04-40008-03-en, June 2022 IT

39
3 Installation
3.2 Products

3.2 Products
Depending on your needs, you can install all EcoStruxure Building Operation
products or a few products, such a single automation server with a connected
WorkStation.

3.2.1 WorkStation
WorkStation is the interface where you supervise your EcoStruxure BMS. In
WorkStation you can also create, modify, and delete some of the objects that are
used to build an EcoStruxure BMS.
IMPORTANT: Ensure that you have a working and available WorkStation
license. A working license is required to log on to WorkStation. For more
information, see section 10.6 “EcoStruxure Building Operation Software
Licensing Installation and Location” on page 130.
When you install WorkStation, you have the option to install the bundled tools:
Graphics Editor, Script Editor, Menta Editor, Function Block Editor, and
WorkPlace Tech. WorkStation is required to run these client tools.
For more information, see the WorkStation topic on WebHelp.

3.2.2 Graphics Editor

You can use Graphics Editor to create and edit graphics representing a site and
the devices that make up the site.
IMPORTANT: You have to have a valid Graphics Editor license to start the
Graphics Editor. For more information, see section 10.6 “EcoStruxure
Building Operation Software Licensing Installation and Location” on page
130.
The installation of Graphics Editor is bundled into the WorkStation installation
package.
For more information, see the Graphics Editor topic on WebHelp.

3.2.3 Script Editor

Script Editor is a text programming tool you use to create Script programs that
control and monitor building automation systems. For example, in WorkStation,
you can create a basic program, called OfficeLights, to control lighting and
ventilation in a room based on occupancy.
IMPORTANT: Ensure that you have a working and available Script license.
A working license is required to start Script. For more information, see
section 10.6 “EcoStruxure Building Operation Software Licensing Installation
and Location” on page 130.
The installation of Script Editor is bundled into the WorkStation installation
package.
For more information, see the Script Editor Program Creation topic on WebHelp.

IT 04-40008-03-en, June 2022

40
 3 Installation
3.2 Products

3.2.4 Menta Editor

Menta Editor is a graphical programming tool for Xenta 208/300/401 LonWorks
device, which you use to create function block programs that control and monitor
building automation systems. For example, you create a program to control an air
handling unit.
IMPORTANT: Ensure that you have a working and available Menta Editor
license. A working license is required to start the Menta Editor software. For
more information, see section 10.6 “EcoStruxure Building Operation
Software Licensing Installation and Location” on page 130.
The installation of Menta Editor is bundled into the WorkStation installation
package.
For more information, see TAC Menta, Technical Manual (04-00030).

3.2.5 Function Block Editor

Function Block Editor is a graphical programming tool for EcoStruxure BMS
servers and MP controllers, which you use to create function block programs that
control and monitor building automation systems. For example, you create a
basic program, called OfficeLight, to control lighting in a room based on
occupancy.
IMPORTANT: Ensure that you have a working and available Function Block
Editor license. A working license is required to start the Function Block Editor
software. For more information, see section 10.6 “EcoStruxure Building
Operation Software Licensing Installation and Location” on page 130.
The installation of Function Block Editor is bundled into the WorkStation
installation package.
For more information, see the Function Block Editor Overview topic on WebHelp.

3.2.6 WorkPlace Tech

The WorkPlace Tech component of WorkStation consists of two graphical tools:
WorkPlace Tech Monitor and WorkPlace Tech Editor. With WorkPlace Tech
Editor, you can create, modify, monitor, and troubleshoot MNL LonWorks and
MNB BACnet device applications. With WorkPlace Tech Monitor, you can
monitor and troubleshoot applications in MNL LonWorks and MNB BACnet
devices.
IMPORTANT: Ensure that you have a working and available WorkPlace
Tech license. A working license is required to start the WorkPlace Tech
Editor or WorkPlace Tech Monitor software. For more information, see
section 10.6 “EcoStruxure Building Operation Software Licensing Installation
and Location” on page 130.
The installation of WorkPlace Tech is bundled into the WorkStation installation
package, and is specific to the particular version of WorkStation in that package.
IMPORTANT: The WorkPlace Tech Editor component requires the
installation of the appropriate version of Microsoft Visio.
For more information, see the WorkPlace Tech Editor topic on WebHelp.

04-40008-03-en, June 2022 IT

41
3 Installation
3.2 Products

For more information, see the Information Technology System Planning

Guide topic on WebHelp.
For more information, see the WorkPlace Tech Overview topic on WebHelp.

3.2.7 Enterprise Central

Enterprise Central is the hierarchical EcoStruxure BMS server at the top of the
system architecture hierarchy of a large Building Management System.
Enterprise Central is primarily used for administration and data aggregation in an
EcoStruxure BMS that has multiple Enterprise Servers. From one location, you
can manage operations across large Building Management Systems that have
multiple Enterprise Server subsystems.
For more information, see the Enterprise Central topic on WebHelp.

3.2.8 Enterprise Server

Enterprise Server is the hierarchical EcoStruxure BMS server at the top of the
system architecture hierarchy of a medium size Building Management System, or
at the middle of the hierarchy in a large system. Enterprise Server is primary
used for administration, system supervision and engineering of automation
servers. Enterprise Server aggregates data that can be accessed by Enterprise
Central.
IMPORTANT: Ensure that you have a working and available Enterprise
Server license. A working license is required to start the Enterprise Server.
For more information, see section 10.6 “EcoStruxure Building Operation
Software Licensing Installation and Location” on page 130.
For more information, see the Enterprise Server topic on WebHelp.

3.2.9 Software Administrator

The Software Administrator installs with the Enterprise Server installation
package. You use the Software Administrator to start and stop the Enterprise
Server service and configure the ports of the Enterprise Server.
For more information, see section 15.1 “Software Administrator” on page 229.

3.2.10 Device Administrator

The Device Administrator is used to configure and upgrade the software of
EcoStruxure BMS servers through a network or USB connection.
For more information, see the Automation Server Software topic on WebHelp.

IT 04-40008-03-en, June 2022

42
 3 Installation
3.2 Products

3.2.11 License Administrator

The License Administrator administers the activation, return, and repair of
licenses.
For more information, see section 10.5 “License Administrator” on page 129.

3.2.12 License Server

The License Server manages the administration of network licenses. An
EcoStruxure BMS running with network licenses must contain at least one
License Server.
For more information, see section 10.4 “License Server” on page 128.
The License Server Installation is bundled into the License Administration
installation package.

3.2.13 WebReports
WebReports is a Web application that you use to create, view, and administer
reports. The reports provide information about alarms, trends, and user and
system activity. You use the reports to help manage your building automation
system.
For more information, see the WebReports Overview topic on WebHelp.

3.2.14 Language Package

At the main installation, WorkStation contains English and languages that are
avaílable at the time. To support a language, WorkStation needs the specific
language package.
For more information, see the Language Packages topic on WebHelp.

04-40008-03-en, June 2022 IT

43
3 Installation
3.3 Installation Example

3.3 Installation Example

Schneider Electric recommends that you install the license server framework
before installing other EcoStruxure Building Operation software applications and
automation servers. The license server installation is included in the License
Administrator license package. During the installation of WorkStation or
Enterprise Server, the installation software asks for the address to the license
server.
License files used to activate time-limited local licenses can be distributed under
certain circumstances.
For more information, see section 13.1 “Demo Licensesing Overview” on page
191.
NOTE:
• Plan the license management carefully and purchase network licenses
early to avoid unexpected operational stops caused by expired local
licenses.
This work flow describes an EcoStruxure BMS where license server and
Enterprise Server are located on the same computer.
To install the EcoStruxure Building Operation software smoothly use the
following installation order:

Figure: Installation and configuration order

IT 04-40008-03-en, June 2022

44
 3 Installation
3.3 Installation Example

Table: Installation and Configuration Order

Number, client/server Description

1. License Server • Install the License Server and License

Administrator.
• When the License Administrator
installation wizard prompts, type the
address to the license server. In this
case, type @localhost.
• Activate network licenses, on the
license server. For more information,
see the Network License Management
topic on WebHelp.
• Note the network address of the
license server.

2. Enterprise Server • Install the Enterprise Server.

• When Enterprise Server installation
wizard prompts, type the address to
the license server.
• Optional: Install License Administrator
to edit the address to the license
server or activate a local license.

3. Workstation • Install WorkStation together with the

bundled tools.
• When WorkStation installation
software prompts, type the address to
the license server.
• Optional: Install language packages.
• Optional: Install License Administrator
to edit the address to the license
server or activate a local license.

4. other applications • Install Device Administrator.

• Install Reports.

If network licenses are not purchased or are missing, local licenses can be
activated from license files. Replace local licenses with purchased licenses
before the local licenses expire.

04-40008-03-en, June 2022 IT

45
3 Installation
3.4 Version Numbers and Parallel Installations

3.4 Version Numbers and Parallel

Installations
The EcoStruxure Building Operation software version number is constructed with
four numbers, which represents different parts of the version: Major, Minor,
Maintenance, and Build.

Figure: The EcoStruxure Building Operation version number structure

Table: The EcoStruxure Building Operation Version Number Structure

Version number Description

Major Increment when major functionality

changes are released.

Minor Increment when minor functionality

changes are released.

Maintenance Increment when correctional changes are

released.

Build A sequential number to guarantee

uniqueness of the version release.

When installing a product with a higher version number than what is already
installed, the installation package asks you if you want to upgrade or replace your
current installation. When starting an installation package with the same version
number as the software that is already installed, the installation package asks
you whether you want to repair or reinstall the installation.

IT 04-40008-03-en, June 2022

46
 3 Installation
3.4 Version Numbers and Parallel Installations

NOTICE
LOSS OF DATA
Do not execute or run two different versions of a product simultaneously on
your server or computer. Running parallel installations can cause data loss or
corruption.
Failure to follow these instructions can result in loss of data.

On the same computer or server, you can install products parallel to each other
that have different major or minor version numbers. For example, you can install
WorkStation 2.1.6.0 on a computer that already has version 1.2.1.0 installed. You
have to use different installation folders for parallel versions.
IMPORTANT:
• You cannot install parallel License Administrators.
• You should always run the latest maintenance version of the License
Administrator or License Server for your EcoStruxure Building Operation
version.

Version history log

The version history log contains the following information:
• The EcoStruxure Building Operation versions that have been installed on the
computer
• The hotfix versions that have been installed on the computer
• The date and time the installation was performed
• The name of the Windows user account that performed the installation
The version log is created in the installation folder of each EcoStruxure Building
Operation product. The name of the log file is: version_history.txt.

04-40008-03-en, June 2022 IT

47
3 Installation
3.5 Installing the License Administrator and the License Server

3.5 Installing the License Administrator and

the License Server
You install License Administrator and License Server to administer the activation,
return, repair, check out, and the check in of the EcoStruxure Building Operation
licenses. An EcoStruxure BMS has to include one software license server. The
License Administrator has to be installed on all clients or servers that run any
licensed products.
For more information, see section 3.2 “Products” on page 40.

To install the License Administrator and License Server

1. Double-click on the License Administrator installation file to start the
installation wizard.
2. Click Yes to confirm that you want to run the License Administrator
installation package.
3. Click Next.
4. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then click I Agree.
5. In the Installation Folder page, browse to the folder where you want to
install License Administrator and License Server and then click Next.
IMPORTANT:
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.
NOTE:
• EcoStruxure Building Operation products are installed in the same
folder that you selected for the first product you installed
6. In the Choose Components page, select the components you want to
install and then click Next.
7. In the License Server Configuration page, in the License Server
Address box, type @ and then type the address to the license server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
8. Click Install.
9. In the Installation Complete page, click Next.
NOTE: Click Show details to follow the progress of the installation.
10. Click Finish.

IT 04-40008-03-en, June 2022

48
 3 Installation
3.5 Installing the License Administrator and the License Server

It is recommended that you configure the license server recovery settings to

ensure that the license server restarts if it unexpectedly stops. For more
information, see section 10.13 “Configuring the License Server Recovery
Settings ” on page 143.

04-40008-03-en, June 2022 IT

49
3 Installation
3.6 Installing WorkStation and Client Tools

3.6 Installing WorkStation and Client Tools

You install WorkStation and client tools to create and supervise your EcoStruxure
BMS.
IMPORTANT:
• Ensure that you have working and available WorkStation, Graphics,
Script, WorkPlace Tech Editor, and Menta / Function Block licenses. A
working license for each product is required to start and log on. For more
information, see section 10.6 “EcoStruxure Building Operation Software
Licensing Installation and Location” on page 130.
• It is recommended that you install the latest version of .NET Framework
4.7 before installing WorkStation and Client Tools.
For more information, see section 3.1 “Installation Overview” on page 37.

To install WorkStation and client tools

1. Install the latest version of .NET Framework 4.7.
2. Double-click on the WorkStation installation file to start the installation
wizard.
IMPORTANT: If User Account Control (UAC) is enabled, you must run
the installer as administrator. Right-click the installation file and then
click Run as administrator.
3. Click Yes to confirm that you want to run the Workstation installation
package.
4. In the Installation wizard, click Next.
5. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then click I Agree.
6. In the Installation Folder page, browse to the folder where you want to
install WorkStation and client tools and then click Next.
IMPORTANT:
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.
NOTE:
• EcoStruxure Building Operation products are installed in the same
folder that you selected for the first product you installed.
• If you are installing WorkStation and client tools on a 64-bit operating
system and you specify a location under \Program Files\,
WorkPlace Tech Editor and its components are installed in the folder
\Program Files (x86)\.

IT 04-40008-03-en, June 2022

50
 3 Installation
3.6 Installing WorkStation and Client Tools

7. In the Choose Components page, select the components that you want to
install and then click Next.
IMPORTANT: Before selecting the WorkPlace Tech Editor component,
be sure the appropriate versions of Microsoft Visio and .NET are
installed.
For more information, see the WorkPlace Tech Editor topic on
WebHelp.
For more information, see the EcoStruxure Building Operation Software
Requirements topic on WebHelp.
8. In the WorkStation Shortcut Selection page, select the shortcuts you want
to be created and then click Next.
9. In the License Server Address box, type @ and then type the address to
the license server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
10. Click Install.
11. Click Next.
12. Click Finish.
NOTE: Click Show details to follow the progress of the installation.

04-40008-03-en, June 2022 IT

51
3 Installation
3.7 Installing a Language Pack

3.7 Installing a Language Pack

You install a language pack to upgrade an existing language pack with a newer
version, or to install an additional language pack.
NOTE:
• A WorkStation installation is a prerequisite to install additional language
packs.
• The version of the language pack to install must correspond with your
WorkStation version.
For more information, see the Language Packages topic on WebHelp.

To install language pack

1. Double-click on the language pack installation file to start the installation
wizard.
2. In the Installation wizard, click Yes.
3. In the Language Pack Setup screen, click Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
5. Click Next.
NOTE: Click Show details to follow the progress of the installation.
6. Click Finish.
The language to display in WorkStation is determined by the operating system
language on which the WorkStation is installed.

IT 04-40008-03-en, June 2022

52
 3 Installation
3.8 Installing Enterprise Central

3.8 Installing Enterprise Central

You install the Enterprise Central to collect data throughout the EcoStruxure BMS
while providing supervisory control.
For more information, see section 3.1 “Installation Overview” on page 37.

To install Enterprise Central

1. Double-click on the Enterprise Central installation file to start the installation
wizard.
IMPORTANT: If User Account Control (UAC) is enabled, you must run
the installer as administrator. Right-click the installation file and then
click Run as administrator.
2. In the User Account Control page, click Yes to confirm that you want to
run the installation package.
3. In the Welcome to the Enterprise Central Setup page, click Next.
4. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then, click I Agree.
5. In the Installation Folder - Program Files page, click Next.
6. In the Installation Folder - Database Files page, in Database Folder box,
enter the path to the location where you want to save the Enterprise Central
database.
NOTE: The database folder path can contain up to 140 characters.
7. Click Next.
8. In the Communication Ports page, in the HTTP Port box, type the port
number the Enterprise Central listens to when communicating through the
Hypertext Transfer Protocol.
9. In the HTTPS Port box, type the port number Enterprise Central listens to
when communicating through the Hypertext Transfer Protocol Secure.
10. In the TCP Port box, type the port number Enterprise Central listens to
when communicating through the Transmission Control Protocol.
11. Click Next.
12. In the Windows Service page, select the account:
• Select Local system to run Enterprice Central service under the Local
system account.
• Select Custom to run the EcoStruxure BMS server from a customized
location.
13. In the User account in format DOMAIN/USER box, type the user account
name.
14. Click Verify Account to make sure this user account exists.
15. In the User account password box, type password.
16. In the Confirm password box, type password.

04-40008-03-en, June 2022 IT

53
3 Installation
3.8 Installing Enterprise Central

17. Click Next.

18. In the License Server page, in the License Server address box, type @
and then type the address to the License Server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
19. Click Next.
20. In the Summary page revise the information and then, click Install.
21. Click Next.
NOTE: Click Show details to follow the progress of the installation.
22. In the Installation Completed page, click Next.
23. In the Enterprise Central Setup page, click Finish.

IT 04-40008-03-en, June 2022

54
 3 Installation
3.9 Installing the Enterprise Server

3.9 Installing the Enterprise Server

You install the Enterprise Server to collect data throughout the EcoStruxure BMS
while providing supervisory control.
IMPORTANT: Ensure that you have a working and available Enterprise
Server license. A working license is required to start the Enterprise Server.
For more information, see section 10.6 “EcoStruxure Building Operation
Software Licensing Installation and Location” on page 130.
For more information, see section 3.1 “Installation Overview” on page 37.

To install the Enterprise Server

1. In Windows, disable any anti-virus program.
2. Double-click on the Enterprise Server installation file to start the installation
wizard.
IMPORTANT: If User Account Control (UAC) is enabled, you must run
the installer as administrator. Right-click the installation file and then
click Run as administrator.
3. Click Yes to confirm that you want to run the installation package.
4. Click Next.
5. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
6. Browse to the folder where you want to install the Enterprise Server and
then click Next.
IMPORTANT:
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.
NOTE:
• EcoStruxure Building Operation products are installed in the same
folder that you selected for the first product you installed
7. In the Database Folder box, enter the path to the location where you want
to save the Enterprise Server database.
IMPORTANT: The database folder path can contain up to 140
characters.
8. Click Next.
9. In the HTTP Port box, type the port number the Enterprise Server listens to
when communicating through the Hypertext Transfer Protocol.
10. In the HTTPS Port box, type the port number the Enterprise Server listens
to when communicating through the Hypertext Transfer Protocol Secure.
11. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.

04-40008-03-en, June 2022 IT

55
3 Installation
3.9 Installing the Enterprise Server

12. In the GraphDB Port box, type the port number the Enterprise Server uses
to communicate with the Graph database that is used for semantic tagging.
13. Click Next.
14. Select Local system to run the Enterprice Server service under the Local
system account.
IMPORTANT:
• For security reasons, it is recommended that you run the Enterprise
Server service under a custom Windows user account with limited
permissions.
• To run the Enterprise Server service under a custom Windows
account, select Custom, enter the domain and user account names,
click Verify Account to verify that the account exists, and then type
the user account password.
• To be able to log on to WebStation, the selected Windows user
account has to have write permissions to C:\Program Files
(x86)\Schneider Electric EcoStruxure\Building Operation
X.X\Enterprise Server.
15. In the License Server Address box, type @ and then type the address to
the License Server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
16. Click Next.
17. Revise the information on the Summary page and then click Install.
18. Click Next.
NOTE: Click Show details to follow the progress of the installation.
19. Click Finish.
20. In Windows, enable any anti-virus program.
21. When the installation is completed, make sure that the HTTP port, HTTPS
port, and TCP port are not used exclusively by any other application.
IMPORTANT: In case of a port conflict, users are not able to log on to
the EcoStruxure BMS. In Software Administrator, resolve any port
conflict. For more information, see section 15.11 “Resolving Enterprise
Server or Enterprise Central Port Conflicts” on page 239..

IT 04-40008-03-en, June 2022

56
 3 Installation
3.10 Installing the Device Administrator

3.10 Installing the Device Administrator

You install the Device Administrator to configure and upgrade the software of
automation server through a network or USB connection.
For more information, see section 3.1 “Installation Overview” on page 37.

To install the Device Administrator

1. Double-click on the Device Administrator installation file to start the
installation wizard.
2. Click Yes, to confirm that you want to run the Device Administrator
installation package.
3. Click Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
5. Browse to the folder where you want to install Device Administrator and
click Next.
IMPORTANT:
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.
NOTE:
• EcoStruxure Building Operation products are installed in the same
folder that you selected for the first product you installed
6. Select Device Administrator and then click Next.
7. Click Next.
NOTE: Click Show details to follow the progress of the installation.
8. Click Finish.

04-40008-03-en, June 2022 IT

57
4 Installation Repair

Topics
Installation Reparation
Repairing the License Administrator and the License Server
Repairing WorkStation and Client Tools Installation
Repairing the Enterprise Server
Repairing the Device Administrator Installation
 4 Installation Repair
4.1 Installation Reparation

4.1 Installation Reparation

If something unexpected happens to an EcoStruxure Building Operation product,
for example, the EcoStruxure Building Operation product does not start or
software files are missing, you can try to solve the problem by repairing the
installation.
To repair an installation you must have access to the installation package that
was used to install the product. When starting the installation the wizard asks if
you want to reinstall or repair the current installation. When repairing an
EcoStruxure Building Operation product, the current product related database,
files created by the user, and user settings are kept intact. System files are
replaced with the files from the installation package.
NOTE: Before repairing a License Server or Enterprise Server, you must
stop related Windows services.

04-40008-03-en, June 2022 IT

61
4 Installation Repair
4.2 Repairing the License Administrator and the License Server

4.2 Repairing the License Administrator and

the License Server
You repair the License Administrator and the License Server installation if any
problems are caused by the current installation.
For more information, see section 4.1 “Installation Reparation” on page 61.
IMPORTANT:
• To repair an installation, you must have access to the installation package
that was used to install the product.

To repair the License Administrator and License Server

1. On the License Server, open the Service management console.
NOTE: In Windows, open the Run dialog box and enter services.msc
2. In the Services console, right-click Building Operation x.x License
Server.
3. Select Stop.
4. Double-click on the License Administrator installation file to start the
installation wizard.
5. Click Yes to confirm that you want to run the License Administrator
installation package.
6. Click Next.
7. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
8. In the Program Files page, click Next.
9. In the Choose Components page, select the components you want to
repair and then click Next.
10. In the Installation Type page, select Repair current version to repair the
current License Administrator installation.
11. Click Next.
12. In the License Server page, in the License Server Address box, type @
and then type the address to the license server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
13. Click Install.
14. In the Installation Complete page, click Next.
NOTE: Click Show details to follow the progress of the installation.
15. Click Finish.

IT 04-40008-03-en, June 2022

62
 4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

4.3 Repairing WorkStation and Client Tools

Installation
You repair the WorkStation and client tools installation if any problems are
caused by the current installation.
IMPORTANT: To repair an installation, you must have access to the
installation package that was used to install the product.
NOTE: During the repair of WorkStation, additional language packages are
removed.
For more information, see section 4.1 “Installation Reparation” on page 61.

To repair the WorkStation and client tool installation

1. Double-click on the WorkStation installation file to start the installation
wizard.
IMPORTANT: If User Account Control (UAC) is enabled on the
computer on which you are installing WorkStation, you must run the
installer as an administrator. To do this, right-click the WorkStation
installation file and then, in the shortcut menu, choose Run as
administrator.
2. Click Yes to confirm that you want to run the Workstation installation
package.
3. Click Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
5. In the Program Files page, click Next.
6. In the Choose Components page, select the components that you want to
repair and then click Next.
IMPORTANT: Before selecting the WorkPlace Tech Editor component,
be sure the appropriate versions of Microsoft Visio and .NET are
installed.
For more information, see the WorkPlace Tech Editor topic on
WebHelp.
For more information, see the EcoStruxure Building Operation Software
Requirements topic on WebHelp.
7. In the WorkStation Shortcut Selection page, select the shortcuts you want
to be created and then click Next.
8. In the WorkStation Installation Type page, select Repair current
version.
9. Click Next.

04-40008-03-en, June 2022 IT

63
4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

10. In the License Server Configuration page, in the License Server

Address box, type @ and then type the address to the license server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
11. Click Install.
12. In the Installation Complete page, click Next.
NOTE: Click Show details to follow the progress of the installation.
13. Click Finish.

IT 04-40008-03-en, June 2022

64
 4 Installation Repair
4.4 Repairing the Enterprise Server

4.4 Repairing the Enterprise Server

You repair the Enterprise Server installation if any problems are caused by the
current installation.
IMPORTANT:
• To repair an installation, you must have access to the installation package
that was used to install the product.
For more information, see section 4.1 “Installation Reparation” on page 61.

To repair the Enterprise Server

1. Ensure that you have a backup of the Enterprise Server data.
2. In Windows, disable any anti-virus program.
NOTE: The Enterprise Server Windows Service is automatically
stopped.
3. Double-click on the Enterprise Server installation file to start the installation
wizard.
4. Click Yes to confirm that you want to run the EcoStruxure Building
Operation installation package.
5. Click Next.
6. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
7. In the Installation Folder page, click Next.
8. Accept the database folder or browse to select another installation folder for
the database and then click Next.
IMPORTANT: The database folder path can contain up to 140
characters.
9. Click Next.
10. In the Installation Type page, select Repair current version to repair the
current Enterprise Server installation.
11. Click Next.
12. In the Communication Ports page, in the HTTP Port box, type the port
number the Enterprise Server listens to when communicating through the
Hypertext Transfer Protocol.
13. In the HTTPS Port box, type the port number the Enterprise Server listens
to when communicating through the Hypertext Transfer Protocol Secure.
14. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.
15. Click Next.

04-40008-03-en, June 2022 IT

65
4 Installation Repair
4.4 Repairing the Enterprise Server

16. In the Windows Services page, select Local system to run the Enterprice
Server service under the Local system account.
IMPORTANT:
• For security reasons, it is recommended that you run the Enterprise
Server service under a custom Windows user account with limited
permissions.
• To run the Enterprise Server service under a custom Windows
account, select Custom, enter the domain and user account names,
click Verify Account to verify that the account exists, and then type
the user account password.
• To be able to log on to WebStation, the selected Windows user
account has to have write permissions to C:\Program Files
(x86)\Schneider Electric EcoStruxure\Building Operation
X.X\Enterprise Server.
17. In the License Server page, in the License Server Address box, type @
and then type the address to the license server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
18. Click Next.
19. In the Summary page, revise the information and then click Install.
20. In the Installation Complete page, click Next.
NOTE: Click Show details to follow the progress of the installation.
21. Click Finish.

IT 04-40008-03-en, June 2022

66
 4 Installation Repair
4.5 Repairing the Device Administrator Installation

4.5 Repairing the Device Administrator

Installation
You repair the Device Administrator installation if any problems are caused by
the current installation.
IMPORTANT: To repair an installation, you must have access to the
installation package that was used to install the product.
For more information, see section 4.1 “Installation Reparation” on page 61.

To repair the Device Administrator installation

1. Double-click on the Device Administrator installation file to start the
installation wizard.
2. Click Yes to confirm that you want to run the Device Administrator
installation package.
3. Click Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
5. CIn the Installation Folder page, click Next.
6. In the Device Administrator Installation Type page, select Repair
current version.
7. Click Next.
8. In the Installation Complete page, click Next.
NOTE: Click Show details to follow the progress of the installation.
9. Click Finish.

04-40008-03-en, June 2022 IT

67
5 Reinstallation

Topics
Reinstallation
Reinstalling the License Administrator and the License
Server
Reinstalling WorkStation and Client Tools
Reinstalling the Enterprise Server
Reinstalling the Device Administrator Installation
 5 Reinstallation
5.1 Reinstallation

5.1 Reinstallation
This is an additional solution instead of first manually uninstalling the current
product and then installing a new copy.

NOTICE
LOSS OF DATA
Back up the Enterprise Server before reinstalling the product. All user settings,
database information, and system files related to this product are erased and
replaced. For more information, see section 27.7 “Backing Up EcoStruxure
BMS Servers Manually” on page 505.
Failure to follow these instructions can result in loss of data.

To replace your current version, you start with the installation package of the
product you want to reinstall. If the installation package recognizes an earlier
installation of the EcoStruxure Building Operation product within the same major
and minor version number but lower maintenance number, the installation wizard
asks if you want to uninstall the current version before installing this package.
NOTE: Before reinstalling a License Server or Enterprise Server, you must
stop related Windows services.

04-40008-03-en, June 2022 IT

71
5 Reinstallation
5.2 Reinstalling the License Administrator and the License Server

5.2 Reinstalling the License Administrator

and the License Server
You reinstall the License Administrator and the License Server to replace your
current installation with a fresh copy.
For more information, see section 5.1 “Reinstallation ” on page 71.

To reinstall the License Administrator and License Server

1. On the License Server, open the Service management console.
NOTE: In Windows, open the Run dialog box and enter services.msc
2. Right-click Building Operation x.x License Server.
3. Select Stop.
4. Double-click on the License Administrator installation file to start the
installation wizard.
5. Click Yes, to confirm that you want to run the License Administrator
installation package.
6. Click Next.
7. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
8. Click Next.
9. Select the components you want to reinstall and then click Next.
10. Select Uninstall current version before reinstalling to reinstall the current
License Administrator installation.
11. Click Next.
12. In the License Server Address box, type @ and then type the address to
the license server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
13. Click Install.
14. Click Next.
15. Click Finish.

IT 04-40008-03-en, June 2022

72
 5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

5.3 Reinstalling WorkStation and Client

Tools
You reinstall WorkStation and client tools to replace your current installation with
a fresh copy.
IMPORTANT: For reinstallation, it is assumed that you already have
working and available WorkStation, Graphics, Script, and Menta / Function
Block licenses. A working license for each product is required to start and log
on. If necessary, acquire the needed licenses. For more information, see
section 10.6 “EcoStruxure Building Operation Software Licensing Installation
and Location” on page 130.
NOTE: When reinstalling the WorkStation, additional language packages
are removed.
For more information, see section 5.1 “Reinstallation ” on page 71.

To reinstall WorkStation and client tool installation

1. Double-click on the WorkStation installation file to start the installation
wizard.
IMPORTANT: If User Account Control (UAC) is enabled on the
computer on which you are installing WorkStation, you must run the
installer as an administrator. To do this, right-click the WorkStation
installation file and then click Run as administrator.
2. Click Yes to confirm that you want to run Workstation installation pakage.
3. Click Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
5. In the Installation Folder page, click Next.
6. Select the components that you want to reinstall and then click Next.
IMPORTANT: Before selecting the WorkPlace Tech Editor component,
be sure the appropriate versions of Microsoft Visio and .NET are
installed.
For more information, see the WorkPlace Tech Editor topic on
WebHelp.
For more information, see the EcoStruxure Building Operation Software
Requirements topic on WebHelp.
7. Select the shortcuts you want to be created and then click Next.
8. Select Uninstall current version before reinstalling.
9. Click Next.

04-40008-03-en, June 2022 IT

73
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

10. In the License Server address box, type @ and then type the address to
the license server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
11. Click Install.
12. Click Uninstall to remove the current installation.
13. Click Close.
NOTE: Click Show details to follow the progress of the installation.
14. Click Next.
15. Click Finish.

IT 04-40008-03-en, June 2022

74
 5 Reinstallation
5.4 Reinstalling the Enterprise Server

5.4 Reinstalling the Enterprise Server

You reinstall the Enterprise Server to replace your current installation with a fresh
copy.

NOTICE
LOSS OF DATA
Back up the Enterprise Server before reinstalling the product. All user settings,
database information, and system files related to this product are erased and
replaced. For more information, see section 27.7 “Backing Up EcoStruxure
BMS Servers Manually” on page 505.
Failure to follow these instructions can result in loss of data.

For more information, see section 5.1 “Reinstallation ” on page 71.

To reinstall the Enterprise Server

1. Ensure that you have a backup of the Enterprise Server data.
2. In Windows, disable any anti-virus program.
3. Double-click the Enterprise Server installation file to start the installation
wizard.
4. Click Yes to confirm that you want to run the EcoStruxure Building
Operation installation package.
NOTE: The Enterprise Server Windows Service is automatically
stopped.
5. Click Next.
6. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then click I Agree.
7. In the Installation Folder page, click Next.
8. Accept the database folder or browse to select another installation folder for
the database and then click Next..
IMPORTANT: The database folder path can contain up to 140
characters.
9. Click Next.
10. In the Installation Type page, select Uninstall current version before
reinstalling.
11. Click Next.
12. In Communication Ports page, in the HTTP Port box, type the port
number the Enterprise Server listens to when communicating through the
Hypertext Transfer Protocol.
13. In the HTTPS Port box, type the port number the Enterprise Server listens
to when communicating through the Hypertext Transfer Protocol Secure.
14. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.

04-40008-03-en, June 2022 IT

75
5 Reinstallation
5.4 Reinstalling the Enterprise Server

15. Click Next.

16. In the Windows Service page, select Local system to run the Enterprise
Server under the Local system account.
IMPORTANT:
• For security reasons, it is recommended that you run the Enterprise
Server service under a custom Windows user account with limited
permissions.
• To run the Enterprise Server service under a custom Windows
account, select Custom, enter the domain and user account names,
click Verify Account to verify that the account exists, and then type
the user account password.
• To be able to log on to WebStation, the selected Windows user
account has to have write permissions to C:\Program Files
(x86)\Schneider Electric EcoStruxure\Building Operation
X.X\Enterprise Server.
17. In the License Server Address box, type @ and then type the address to
the License Server.
NOTE:
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
18. Click Next.
19. Revise the information on the Summary page and then click Install.
20. Click Uninstall to remove the Enterprise Server from your computer.
21. Click Close to confirm the uninstallation of the Enterprise Server.
22. Click Next.
NOTE: Click Show details to follow the progress of the reinstallation.
23. Click Finish.
24. In Windows, enable any anti-virus program.

IT 04-40008-03-en, June 2022

76
 5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

5.5 Reinstalling the Device Administrator

Installation
You reinstall the Device Administrator to replace your current installation with a
fresh copy.
For more information, see section 5.1 “Reinstallation ” on page 71.

To reinstall the Device Administrator installation

1. Double-click on the Device Administrator installation file to start the
installation wizard.
2. Click Yes to confirm that you want to run the Device Administrator
installation package.
3. Click Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree.
5. Click Next.
6. In the Device Administrator Installation Type page, select Uninstall
current version before reinstalling.
7. Click Next.
8. Click Uninstall to remove the current installation.
9. Click Close.
NOTE: Click Show details to follow the progress of the installation.
10. In the Installation Complete page, click Next.
11. Click Finish.

04-40008-03-en, June 2022 IT

77
6 Computer Maintenance

Topics
Replace Enterprise Server or WebReports Computer
Workflow
 6 Computer Maintenance
6.1 Replace Enterprise Server or WebReports Computer Workflow

6.1 Replace Enterprise Server or

WebReports Computer Workflow
Use this workflow to change the operating system on the computer where the
Enterprise Server is installed. You can also use this workflow to migrate
WebReports or the Enterprise Server to another computer.

6.1.1 Preparation
Prior to changing the operating system where the Enterprise Server is installed or
migrating the Enterprise Server to another computer, complete the tasks listed in
the following flowchart. Related information can be found in the sections after the
diagram.

Figure: Enterprise Server Replacement Preparation flowchart

04-40008-03-en, June 2022 IT

81
6 Computer Maintenance
6.1 Replace Enterprise Server or WebReports Computer Workflow

Perform a system backup of EcoStruxure BMS servers

Before changing the operating system or replacing the computer, it is strongly
recommended that you archive the historical data and back up the EcoStruxure
BMS servers to preserve the current data and configurations. For more
information, see section 27.8 “System Backup” on page 506.

Stop Enterprise Server Windows service

Use Software Administrator (or the Services tool) to stop the Enterprise Server
Windows service. For more information, see section 15.7 “Stopping the
Enterprise Server Windows Service” on page 235.

Stop License Server Windows service

If you are upgrading the License Server, stop the License Server Windows
service. For more information, see the Stopping the License Server topic on
WebHelp.

Stop Reporting Agent Windows service

If your system includes WebReports, stop the Reports Agent Windows service.
For more information, see the Stopping the Reporting Agent Windows Service
topic on WebHelp.

Replace operating system or migrate Enterprise Server

Complete one or more of the following tasks:
• Replace the operating system on the computer where the Enterprise Server
is installed. Refer to the Microsoft Windows documentation on installation or
upgrade instructions for the supported operating system. For more
information, see the EcoStruxure Building Operation Software Requirements
topic on WebHelp.
• Migrate the Enterprise Server to another computer.
To install or migrate the Enterprise Server on the targeted operating system or
computer, you need to continue.

Start Reporting Agent Windows service

After replacing the operating system or migrating the Enterprise Server, start the
Reports Agent Windows service. For more information, see the Starting the
Reporting Agent Windows Service topic on WebHelp.

6.1.2 Install EcoStruxure Building Operation

Software
The following flowchart shows the tasks for installing the Enterprise Server and
other Build Operation software on a replacement operating system or computer.
Related information can be found in the sections after the diagram.

IT 04-40008-03-en, June 2022

82
 6 Computer Maintenance
6.1 Replace Enterprise Server or WebReports Computer Workflow

Figure: Reinstall EcoStruxure Building Operation software flowchart

Install Enterprise Server

Install the Enterprise Server and Software Administrator, which is bundled with
the Enterprise Server software. For more information, see section 3.9 “Installing
the Enterprise Server” on page 55.

Install other EcoStruxure Building Operation software

Install any other EcoStruxure Building Operation software, such as WorkStation.

6.1.3 Restore the Enterprise Server Database

The following flowchart shows the tasks for restoring the Enterprise Server
database. Related information can be found in the sections after the diagram.

04-40008-03-en, June 2022 IT

83
6 Computer Maintenance
6.1 Replace Enterprise Server or WebReports Computer Workflow

Figure: Restore Enterprise Database flowchart

Stop Reporting Agent Windows service

If your system includes WebReports, stop the Reporting Agent Windows service.
For more information, see the Stopping the Reporting Agent Windows Service
topic on WebHelp.

IT 04-40008-03-en, June 2022

84
 6 Computer Maintenance
6.1 Replace Enterprise Server or WebReports Computer Workflow

Restore Enterprise Server database

In WorkStation, log on to the Enterprise Server and restore the server using the
previously saved backup set. For more information, see section 30.3 “Restoring
the EcoStruxure BMS Server” on page 552.

Verify TCP protocol and server communication

Use the Communications properties of the Enterprise Server to verify that TCP is
set as the communications protocol for the automation servers and Enterprise
Server, and the servers are communicating with each other. For more
information, see the Updating Communication Parameters topic on WebHelp.

Verify control and monitoring operations

Use Software Administrator (or the Services tool) to verify that the Enterprise
Server Windows service is running, which ensures that extended trend logging
restarts. For more information, see section 15.6 “Starting the Enterprise Server or
Enterprise Central Windows Service” on page 234.
In WorkStation, verify that the control and monitoring operations of the Enterprise
Server are functioning normally according to the guidelines specified for your site.

Back up the EcoStruxure BMS servers

Perform a mass backup of all the EcoStruxure BMS servers. For more
information, see section 27.8 “System Backup” on page 506.

Install WorkStation Language Pack

If you are using a language pack for WorkStation, install the language pack.
For more information, see section 3.7 “Installing a Language Pack” on page 52.

Install WebStation Language Pack

If you want to use a language pack in WebStation, install the language pack and
change the language setting in WebStation.
For more information, see the Adding a Language in WebStation topic on
WebHelp.
For more information, see the Changing the Language in WebStation topic on
WebHelp.
The process of changing the operating system or replacing the computer is now
complete.

Migrate WebReports?
If you plan to migrate WebReports to another computer, you need to continue.

6.1.4 WebReports Migration Preparation

Prior to migrating WebReports, complete the tasks in the following flowchart.
Related information can be found in the sections after the diagram.

04-40008-03-en, June 2022 IT

85
6 Computer Maintenance
6.1 Replace Enterprise Server or WebReports Computer Workflow

Figure: WebReports Migration Preparation flowchart

Detach WebReports database

To avoid a potential loss of data, detach the WebReports database and save the
file to a safe location. For more information, see the Detaching a WebReports
Database topic on WebHelp.

Export Reports schedules

Use Task Scheduler to export all the Reports schedules to a USB memory
device. For more information, see the Transferring Reports Schedules topic on
WebHelp.

6.1.5 Install WebReports

The following flowchart shows the tasks for installing WebReports on the targeted
computer. Related information can be found in the sections after the diagram.

IT 04-40008-03-en, June 2022

86
 6 Computer Maintenance
6.1 Replace Enterprise Server or WebReports Computer Workflow

Figure: Reinstall WebReports flowchart

Configure Windows roles and features

Use the Windows Server Manager to configure the roles and features. For more
information, see the Configuring Windows Roles and Features topic on WebHelp.

Install Microsoft SQL Server

Install a Microsoft SQL Server operating system on the targeted computer. For
more information, refer to the Microsoft SQL Server installation documentation.

Attach WebReports database

Use SQL Server Management Studio to attach the WebReports database. For
more information, see the Attaching a WebReports Database topic on WebHelp.

04-40008-03-en, June 2022 IT

87
6 Computer Maintenance
6.1 Replace Enterprise Server or WebReports Computer Workflow

Confirm administrator role memberships for WebReports database

A WebReports installer must use an admin-level SQL Server Management
Studio user account to log on to a computer running WebReports. This installer
account also requires the addition of three database permissions that permit
access to and control of the WebReports database during installs or upgrades.
For example, an administrator can detach the database.
In SQL Server Management Studio, verify that the Login Properties for the
NTAuthority\IUSR and designated WebReports installer user accounts include
the db_datareader, db_datawriter, and db_owner database role memberships.

Install WebReports Installer

Run the WebReports installation package to install the WebReports Installer. For
more information, see the Installing the WebReports Installer topic on WebHelp.

Install WebReports and select upgrade option

Install WebReports and select the Install software (upgrade existing
database) option to install WebReports on a new computer or operating system
and retain the existing database. For more information, see the Installing
WebReports topic on WebHelp.

Import or recreate Reports schedules

Import or recreate the Reports schedules on the computer running WebReports.
For more information, see the Transferring Reports Schedules topic on WebHelp.
The WebReports migration is now complete.

IT 04-40008-03-en, June 2022

88
7 Uninstallation

Topics
Uninstallation
Uninstalling the License Administrator
Uninstalling the License Server
Uninstalling a Language Pack
Uninstalling WorkStation
Uninstalling Enterprise Central
Uninstalling Enterprise Server
Uninstalling Device Administrator
 7 Uninstallation
7.1 Uninstallation

7.1 Uninstallation
To uninstall an EcoStruxure Building Operation product you use the Windows
Add Remove Program tool. The Windows Add Remove Program tool
permanently removes the EcoStruxure Building Operation product from the
computer or server.

NOTICE
LOSS OF DATA
Return all activated network licenses to the License Activation Server before
uninstalling the License Server and License Administrator. Licenses cannot be
returned without a License Administrator. For more information, see section
13.5 “Removing an EcoStruxure Building Operation Software Demo License ”
on page 197.
Failure to follow these instructions can result in loss of data.

NOTICE
LOSS OF DATA
Back up the EcoStruxure BMS server before uninstalling the product. All user
settings, database information, and system files related to this product are
erased. Files and backups created by the user remain and are not erased. For
more information, see section 27.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 505.
Failure to follow these instructions can result in loss of data.

Client tools and language packages are uninstalled together with the
uninstallation of WorkStation.

04-40008-03-en, June 2022 IT

91
7 Uninstallation
7.2 Uninstalling the License Administrator

7.2 Uninstalling the License Administrator

You uninstall License Administrator to permanently remove the application from
your computer.

NOTICE
LOSS OF DATA
Return all activated network licenses to the License Activation Server before
uninstalling the License Server and License Administrator. Licenses cannot be
returned without a License Administrator. For more information, see section
13.5 “Removing an EcoStruxure Building Operation Software Demo License ”
on page 197.
Failure to follow these instructions can result in loss of data.

For more information, see section 7.1 “Uninstallation” on page 91.

To uninstall the License Administrator

1. In Windows Control Panel, select Schneider Electric EcoStruxure
Building Operation License Administrator x.y and then click Uninstall.
2. In the Building Operation x.y License Administrator Uninstall dialog
box, click Uninstall.
3. Click Close.
NOTE: Click Show details to follow the progress of the installation.

IT 04-40008-03-en, June 2022

92
 7 Uninstallation
7.3 Uninstalling the License Server

7.3 Uninstalling the License Server

You uninstall a License Server to permanently remove the application from your
computer.

NOTICE
LOSS OF DATA
Return all activated network licenses to the License Activation Server before
uninstalling the License Server and License Administrator. Licenses cannot be
returned without a License Administrator. For more information, see section
13.5 “Removing an EcoStruxure Building Operation Software Demo License ”
on page 197.
Failure to follow these instructions can result in loss of data.

For more information, see section 7.1 “Uninstallation” on page 91.

To uninstall the License Server

1. Ensure that you have returned all activated network licenses before you
uninstall the License Server.
2. In Windows Control Panel, select Schneider Electric EcoStruxure
Building Operation License Server x.y and then click Uninstall.
3. In the Building Operation x.y License Server Uninstall dialog box, click
Uninstall.
4. Click Close.
NOTE: Click Show details to follow the progress of the installation.

04-40008-03-en, June 2022 IT

93
7 Uninstallation
7.4 Uninstalling a Language Pack

7.4 Uninstalling a Language Pack

You uninstall a language pack before you uninstall Workstation.

To uninstall a language pack

1. In Windows Control Panel, select Schneider Electric EcoStruxure
Building Operation Language Pack x.y and then click Uninstall.
2. In the Language Pack x.y Uninstall dialog box, click Uninstall.
3. Click Close.

IT 04-40008-03-en, June 2022

94
 7 Uninstallation
7.5 Uninstalling WorkStation

7.5 Uninstalling WorkStation

You uninstall WorkStation to permanently remove the application from your
computer.
IMPORTANT: Before you uninstall WorkStation, make sure that you do not
have any language pack installed. If you have language packs installed, you
must uninstall them before you uninstall WorkStation.
NOTE:
• Client tools are uninstalled together with the uninstallation of WorkStation.
For more information, see section 7.1 “Uninstallation” on page 91.

To uninstall WorkStation
1. In Windows Control Panel, select Schneider Electric EcoStruxure
Building Operation WorkStation x.y and then click Uninstall.
2. In the WorkStation x.y Unistall dialog box, click Uninstall.
NOTE: A common installation component is shared by all versions of
WorkPlace Tech, whether they are versions of WorkPlace Tech Editor
or WorkPlace Tech Tool. On a computer where multiple versions of
WorkPlace Tech Editor, WorkPlace Tech Tool, or both coexist,
uninstalling any one version of WorkPlace Tech causes this common
component to also be uninstalled. You can restore the shared
component automatically, either by starting a version of WorkPlace
Tech Editor that was installed with WorkStation version 1.2 or later, or
by starting WorkPlace Tech Tool 5.8 or later.
Version 1.1 of WorkStation does not allow parallel installation. If version
1.1 is the only version that remains, it must be reinstalled to restore the
shared WorkPlace Tech component. For more information, see
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-
27745) for a troubleshooting topic that restores this shared component
in WorkStation 1.1.
3. Click Close.

04-40008-03-en, June 2022 IT

95
7 Uninstallation
7.6 Uninstalling Enterprise Central

7.6 Uninstalling Enterprise Central

You uninstall an Enterprise Central to permanently remove the application from
your computer.

NOTICE
LOSS OF DATA
Back up the EcoStruxure BMS server before uninstalling the product. All user
settings, database information, and system files related to this product are
erased. Files and backups created by the user remain and are not erased. For
more information, see section 27.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 505.
Failure to follow these instructions can result in loss of data.

For more information, see section 7.1 “Uninstallation” on page 91.

To uninstall Enterprise Central

1. Ensure that you have a backup of the Enterprise Server data.
2. In Windows Control Panel, select Schneider Electric EcoStruxure
Enterprise Central Building Operation x.y and then click Uninstall.
3. In the Enterprise Central x.y Uninstall dialog box, click Uninstall.
4. Click Close.
NOTE: Click Show details to follow the progress of the installation.

IT 04-40008-03-en, June 2022

96
 7 Uninstallation
7.7 Uninstalling Enterprise Server

7.7 Uninstalling Enterprise Server

You uninstall an Enterprise Server to permanently remove the application from
your computer.

NOTICE
LOSS OF DATA
Back up the EcoStruxure BMS server before uninstalling the product. All user
settings, database information, and system files related to this product are
erased. Files and backups created by the user remain and are not erased. For
more information, see section 27.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 505.
Failure to follow these instructions can result in loss of data.

For more information, see section 7.1 “Uninstallation” on page 91.

To uninstall Enterprise Server

1. Ensure that you have a backup of the Enterprise Server data.
2. In Windows Control Panel, select Schneider Electric EcoStruxure
Enterprise Server Building Operation x.y and then click Uninstall.
3. In the Enterprise Server x.y Uninstall dialog box, click Uninstall.
4. Click Close.
NOTE: Click Show details to follow the progress of the installation.

04-40008-03-en, June 2022 IT

97
7 Uninstallation
7.8 Uninstalling Device Administrator

7.8 Uninstalling Device Administrator

You uninstall Device Administrator to permanently remove the application from
your computer.
For more information, see section 7.1 “Uninstallation” on page 91.

To uninstall Device Administrator

1. In Windows Control Panel, select Schneider Electric EcoStruxure Device
Administrator Building Operation x.y and then click Uninstall.
2. In the Device Administrator x.y Uninstall dialog box, click Uninstall.
3. Click Close.
NOTE: Click Show details to follow the progress of the installation.

IT 04-40008-03-en, June 2022

98
8 Installation User interface

Topics
Installation Wizard – Choose Components Page
Installation Wizard – Installation Type Page
Installation Wizard – License Server Configuration Page
Server Installation Wizard – Configuration Page
 8 Installation User interface
8.1 Installation Wizard – Choose Components Page

8.1 Installation Wizard – Choose

Components Page
Use the Choose Components page to define which products to install.

Figure: Choose Components page

Table: Choose Components Page

Component Description

Device Administrator Select to install Device Administrator,

which you use to connect to automation
servers and upgrade them.

License Administrator Select to install the License Administrator,

which you use to configure and maintain
the license system.

License Server Select to install the license server, which

you use to manage network licenses.

WorkStation Select to install WorkStation, which you use

to configure and supervise your
EcoStruxure BMS.

Graphics Editor Select to install Graphics Editor, which you

use to create and edit graphics that
represent a site or device.

Script Editor Select to install Script Editor, which you use

to create custom script program for your
Building Automation System.

04-40008-03-en, June 2022 IT

101
8 Installation User interface
8.1 Installation Wizard – Choose Components Page

Continued
Component Description

Menta / Function Block Editor Select to install Menta Editor and Function
Block Editor, which you use to graphically
design function block programs for Xenta
280/300/401 LonWorks devices and
automation servers.

Continuum Conversion Tool Select to install the Continuum Conversion

Tool, which you use to move your Andover
Continuum legacy Building Management
System to EcoStruxure BMS.
For more information, see the Continuum
Conversion Overview topic on WebHelp.

Workplace Tech Editor Select to install Workplace Tech Editor,

which you use to program, modify, and
compile control applications for MNL
LonWorks devices.
The WorkPlace Tech Editor component
requires the installation of the appropriate
version of Microsoft Visio.
For more information, see the WorkPlace
Tech Editor topic on WebHelp.
For more information, see the EcoStruxure
Building Operation Software Requirements
topic on WebHelp.

Language Packs Select to install the languages available for

the user interface of the installed
components.

Enterprise Server Select to install Enterprise Server, which

you use to administer your EcoStruxure
BMS site. Software Administrator is also
installed.

IT 04-40008-03-en, June 2022

102
 8 Installation User interface
8.2 Installation Wizard – Installation Type Page

8.2 Installation Wizard – Installation Type

Page
Use the Installation Type page to define which type of installation to perform
when corresponding product is already installed on your computer or server.

Figure: Installation Type

Table: Installation Type

Component Description

Uninstall current version before Select to uninstall your current installation

reinstalling before the installation of a fresh copy starts.

Repair current version Select to repair your current installation.

Upgrade current version Select to upgrade your current installation

to a newer version.

Upgrade existing database Select to upgrade your current Enterprise

Server database to a newer version.

Install parallel to current version(s) Select to install the product on a computer

or server that already contains the product
with another major version number.

Replace database Select to replace your current Enterprise

Server database with an empty installation.

04-40008-03-en, June 2022 IT

103
8 Installation User interface
8.3 Installation Wizard – License Server Configuration Page

8.3 Installation Wizard – License Server

Configuration Page
Use the License Server Configuration page to configure the address to the
license server.

Figure: License server configuration page

Table: License Server Configuration Page

Component Description

License Server Address Type the address to the license server

where licenses are available for check out.
The address must begin with @. To define
the port number, if other than the default
port range 27000-27009, type the port
number in front of the @, Port-
number@Address. Use a semicolon to
separate addresses.

IT 04-40008-03-en, June 2022

104
 8 Installation User interface
8.4 Server Installation Wizard – Configuration Page

8.4 Server Installation Wizard –

Configuration Page
Use the Configuration page to configure the port number the Enterprise Server
listens to when communicating through a specific protocol.

Figure: Configuration page

Table: Configuration Page

Component Description

HTTP Port Type the port number that the Enterprise

Server listens to when communicating
through the Hypertext Transfer Protocol.

HTTPS Port Type the port number that the Enterprise

Server Server listens to when
communicating through a secure version of
the Hypertext Transfer Protocol.

TCP Port Type the port number that the Enterprise

Server listens to when communicating
through the Transmission Control Protocol.

04-40008-03-en, June 2022 IT

105
9 Licensing Introduction

Topics
Licensing Overview
License Enforcement
License Information
Order Information Request
Reclaim Licenses
Reclaiming Licenses for Licenses on Automation Servers
Reclaiming Licenses for Licenses on License Administrator
 9 Licensing Introduction
9.1 Licensing Overview

9.1 Licensing Overview

The EcoStruxure Building Operation software is available for all to download and
install. However, you need valid licenses to use the software. The number of
users of the software is limited to the number of licenses owned by the customer.

9.1.1 EcoStruxure Building Operation Licensing

Licenses are needed for EcoStruxure Building Operation products and features
that run on Windows.
For more information, see section 10.1 “EcoStruxure Building Operation Software
Licensing Overview” on page 123.

9.1.2 Automation Server Licenses

Device Administrator is used to manage licenses on automation servers.
For more information, see section 12.1 “Automation Server Licensing Overview”
on page 173.

9.1.3 Demo Licenses

Demo licenses are used for demonstration purposes, training, or when building a
site.
For more information, see section 13.1 “Demo Licensesing Overview” on page
191.

9.1.4 License Enforcement

License enforcement is the process of checking whether a software application
has a valid license available to it at runtime. If you do not have enough licenses, a
license violation occurs. This is accomplished by a license violation bar in
WorkStation and WebStation.
If a client, such as WorkStation or one of the editors, attempts to start and cannot
locate an available license, the client does not start.
For more information, see section 9.2 “License Enforcement” on page 111.

9.1.5 License Information

The License Information in the Control Panel gives you an overview of the
licenses in your EcoStruxure BMS.
For more information, see section 9.3 “License Information” on page 112.

04-40008-03-en, June 2022 IT

109
9 Licensing Introduction
9.1 Licensing Overview

9.1.6 Reclaim Licenses

You can reclaim licenses on your automation servers so that the licenses are
updated with the latest information.

IT 04-40008-03-en, June 2022

110
 9 Licensing Introduction
9.2 License Enforcement

9.2 License Enforcement

License enforcement is the process of checking whether a software application
has a valid license available to it at runtime. If you do not have enough licenses, a
license violation occurs. This is accomplished by a license violation bar in
WorkStation and WebStation.
If a client, such as WorkStation or one of the editors, attempts to start and cannot
locate an available license, the client does not start.
For more information, see section 10.7 “Software and Features that Require
Licenses” on page 132.

9.2.1 License Violation

The first time you add an additional device to the Enterprise Server, other than an
automation server, in excess of the amount of licenses purchased, a license
violation bar is displayed. The license violation bar states that you have
exceeded the amount of licenses available, and urges you to purchase the
additional licenses required. The license violation bar displays every time you log
on to the system, and is displayed on all WorkStations and WebStations that are
logged into the system.
The system information alarm, License Violation, is triggered at the same time as
the License Violation bar is displayed.
To get more specific information regarding the licenses, you can click on
Licensing Information. For more information, see section 14.10 “License
Information Enterprise Server ” on page 210.

Figure: License violation bar in WorkStation

For more information, see section 14.9 “License Violation Bar” on page 209.

04-40008-03-en, June 2022 IT

111
9 Licensing Introduction
9.3 License Information

9.3 License Information

The License Information in the Control Panel gives you an overview of the
licenses in your EcoStruxure BMS.

9.3.1 License Information on Servers

License Information is found in the Control Panel for every EcoStruxure BMS
server but the information is slightly different for every server.

Enterprise Central
Enterprise Central displays all licenses for Enterprise Central. The License
Information in Enterprise Central also displays information regarding all
Enterprise Servers attached to the Enterprise Central and for all automation
servers attached to the Enterprise Servers.
In the License Information in Enterprise Central, you can select a specific
Enterprise Server and check the licenses for that server.
For more information, see section 10.1 “EcoStruxure Building Operation Software
Licensing Overview” on page 123.

Enterprise Server
Enterprise Server displays all licenses for the Enterprise Server and the attached
automation servers.
For more information, see section 10.1 “EcoStruxure Building Operation Software
Licensing Overview” on page 123.

Automation server
Automation server displays all licenses for products in used in the automation
server.
For more information, see section 12.1 “Automation Server Licensing Overview”
on page 173.

9.3.2 License Status

Licenses can have the following status:
• Required: Displays the number of licenses that are required for your
EcoStruxure BMS.
• Used: Displays the number of licenses that are currently in use for your
EcoStruxure BMS. If this number is lower than the number in Required, a
license violation is displayed in the License Information. A License Violation
bar is also displayed in WorkStation. For more information, see section 14.9
“License Violation Bar” on page 209.
• Available: Displays the number of available licenses that are activated on
the License Server but not in use in your EcoStruxure BMS.
• Activated: Displays the total number of licenses that are activated on the
License server, used and unused.

IT 04-40008-03-en, June 2022

112
 9 Licensing Introduction
9.4 Order Information Request

9.4 Order Information Request

All licenses bought from a Schneider Electric vendor are delivered in an
entitlement. The entitlements specify the products and features you are allowed
to use.
For more information on how to order, contact your local EcoStruxure BMS
vendor.

Entitlements
The entitlement ID is the designation that represents the license purchased by
the customer. This ID is included in the Entitlement that is sent by email when an
order is approved.
Licenses for EcoStruxure Building Operation software and for automation servers
are delivered in entitlements.
• Entitlements for EcoStruxure Building Operation software are managed by
License Administrator.
• Entitlements for automation servers are managed by Device Administrator.
You can add one or many entitlements to Device Administrator or License
Administrator.

Figure: An example of an Entitlement.

You can of course, at any time, buy a new entitlement with new products that you
add to your site.

Product
A product may contain one or many features. All products have an activation ID
that is used then the product is activated.

Order numer/Seat count/Number of licenses

The product may contain one or many licenses for a specific feature.

Example
You have a site with five automation servers. You want all automation servers to
use SNMP notification and you want all the users of the automation servers to be
able to create personal dashboards.

04-40008-03-en, June 2022 IT

113
9 Licensing Introduction
9.4 Order Information Request

Figure: An example of an Entitlement for automation servers.

Figure: Exmaple of an Entitlement for EcoStruxure Building Operation software

9.4.1 EcoStruxure Building Operation Software

License Order Request
The order request process involves License Activation Server and License
Server.

IT 04-40008-03-en, June 2022

114
 9 Licensing Introduction
9.4 Order Information Request

Figure: Workflow when requesting order information for EcoStruxure Building Operation
software

Table: Request Order Information for EcoStruxure Building Operation software

Number Description

1 The Entitlement ID, which contains the

licenses to activate, is entered into the
License Administrator.

2 The License Administrator sends the

entitlement ID to the License Activation
Server.

3 The License Activation Server sends the

order information to the License
Administrator.

For more information, see section 10.9 “EcoStruxure Building Operation Software
Licensing Workflow” on page 138.

9.4.2 Automation Server Licensing Order Request

The order request process for automation server licensing involves Device
Administrator, License Activation Server, and the automation server.

04-40008-03-en, June 2022 IT

115
9 Licensing Introduction
9.4 Order Information Request

Figure: Work flow when requesting order information for automation servers

Table: Request Order Information for Automation Servers

Number Description

1 The Entitlement ID, which contains the

licenses to activate, is entered into Device
Administrator.

2 Device Administrator sends the entitlement

ID to License Activation Server.

3 License Activation Server sends the order

information to Device Administrator.

For more information, see section 12.3 “Automation Server Licensing Workflow”
on page 176.

IT 04-40008-03-en, June 2022

116
 9 Licensing Introduction
9.5 Reclaim Licenses

9.5 Reclaim Licenses

You can reclaim licenses on your automation servers so that the licenses are
updated with the latest information.
This is typically done when expanding a license subscription.

9.5.1 Reclaim licenses on Automation Servers

Device Administrator is used to reclaim licenses installed automation servers.
For more information, see section 9.6 “Reclaiming Licenses for Licenses on
Automation Servers” on page 118.

9.5.2 Reclaim licenses on Enterprise Central or

Enterprise Servers
License administrator is used to reclaim licenses installed on Enterprise Central
or Enterprise Server.
For more information, see section 9.7 “Reclaiming Licenses for Licenses on
License Administrator” on page 119.

04-40008-03-en, June 2022 IT

117
9 Licensing Introduction
9.6 Reclaiming Licenses for Licenses on Automation Servers

9.6 Reclaiming Licenses for Licenses on

Automation Servers
You reclaim licenses when you think that your licenses have been updated with
new information, for example when you extend a subscription.

To reclaim licenses
1. In Device Administrator, click Servers.
2. Select Show licenses.
3. Select the automation servers with the licenses you want to reclaim.
4. Click Activate licenses.
5. Click Reclaim licenses.
6. In the Activate Licenses dialog box, click OK.

IT 04-40008-03-en, June 2022

118
 9 Licensing Introduction
9.7 Reclaiming Licenses for Licenses on License Administrator

9.7 Reclaiming Licenses for Licenses on

License Administrator
You reclaim licenses when you think that your licenses have been updated with
new information, for example when you extend a subscription.

To reclaim licenses for licenses on License Administrator

1. In the License list, select the licenses you want to reclaim.
2. In License Administrator, in the License view toolbar, click the arrow next

to the Refresh button.

3. Click Reclaim licenses.

04-40008-03-en, June 2022 IT

119
10 EcoStruxure Building
Operation Licensing

Topics
EcoStruxure Building Operation Software Licensing
Overview
EcoStruxure Building Operation Software License
Components
Licenses Activation Server
License Server
License Administrator
EcoStruxure Building Operation Software Licensing
Installation and Location
Software and Features that Require Licenses
Field Bus Device Licenses
EcoStruxure Building Operation Software Licensing
Workflow
Inherited Licenses
Starting License Administrator
Activating EcoStruxure Building Operation Software
Licenses
Configuring the License Server Recovery Settings
EcoStruxure Building Operation Software License
Distribution and Selection
 EcoStruxure Building Operation Software Feature License
10 Strings
 10 EcoStruxure Building Operation Licensing
10.1 EcoStruxure Building Operation Software Licensing Overview

10.1 EcoStruxure Building Operation

Software Licensing Overview
Licenses are needed for EcoStruxure Building Operation products and features
that run on Windows.

10.1.1 EcoStruxure Building Operation Software

License Components
To install and use EcoStruxure Building Operation software licenses, you need
three main components:
• License Activation Server
• License Server
• License Administrator
For more information, see section 10.2 “EcoStruxure Building Operation Software
License Components” on page 125.

10.1.2 EcoStruxture Building Operation Software

and Features that Require Licenses
There are a number of different clients, servers, and features that requires
licenses to operate.
For more information, see section 10.7 “Software and Features that Require
Licenses” on page 132.

10.1.3 EcoStruxure Building Operation Software

Licensing Installation and Location
License Administrator and License Server must run on the same computer as
Enterprise Server or Enterprise Central that will use the licenses.
For more information, see section 10.6 “EcoStruxure Building Operation Software
Licensing Installation and Location” on page 130.

10.1.4 EcoStruxure Building Operation Licensing

Workflow
Use this workflow to install and activate licenses on the License Administrator.
For more information, see section 10.9 “EcoStruxure Building Operation Software
Licensing Workflow” on page 138.

04-40008-03-en, June 2022 IT

123
10 EcoStruxure Building Operation Licensing
10.1 EcoStruxure Building Operation Software Licensing Overview

10.1.5 EcoStruxure Building Operation Software

License Distribution and Selection
EcoStruxure Building Operation software licenses are distributed and selected
from License Server.
For more information, see section 10.14 “EcoStruxure Building Operation
Software License Distribution and Selection” on page 144.

10.1.6 Inherited Licenses

Inherited licenses are used system-wide in multi-server systems.
For more information, see section 10.10 “Inherited Licenses” on page 140.

10.1.7 EcoStruxure Building Operation Software

Feature Licenses Strings
The feature strings are used when you troubleshoot a license problem. The
strings are visible in the Diagnostic tab of License Administrator.
For more information, see section 10.15 “EcoStruxure Building Operation
Software Feature License Strings” on page 148.

10.1.8 EcoStruxure Building Operation Software

License Maintenance
You can backup and restore EcoStruxure Building Operation software licenses
as well as relocate and replace the License Server.
For more information, see section 11.1 “EcoStruxure Building Operation Software
License Maintenance” on page 153.

10.1.9 License Server Configuration and

Diagnostics
You can configure the licensing components and do diagnostics on your system
regarding licensing.
For more information, see the License Server Configuration and Diagnostics
topic on WebHelp.

IT 04-40008-03-en, June 2022

124
 10 EcoStruxure Building Operation Licensing
10.2 EcoStruxure Building Operation Software License Components

10.2 EcoStruxure Building Operation

Software License Components
To install and use EcoStruxure Building Operation software licenses, you need
three main components:
• License Activation Server
• License Server
• License Administrator

10.2.1 License Activation Server

License Activation Server, sometimes called FNO server, is a server controlled
by Schneider Electric globally to manage the activation of licenses on customers'
License Servers.
For more information, see section 10.3 “Licenses Activation Server” on page 126.

10.2.2 License Server

License Server manages the administration of EcoStruxure Building Operation
software licenses.
For more information, see section 10.4 “License Server” on page 128.

10.2.3 License Administrator

The License Administrator administers the activation, return, and repair of
licenses.
For more information, see section 10.5 “License Administrator” on page 129.

04-40008-03-en, June 2022 IT

125
10 EcoStruxure Building Operation Licensing
10.3 Licenses Activation Server

10.3 Licenses Activation Server

License Activation Server, sometimes called FNO server, is a server controlled
by Schneider Electric globally to manage the activation of licenses on customers'
License Servers.
The License Activation Server handles return commissions. All communication
between the License Server and the License Activation Server is managed
through the License Administrator.

Figure: Activation of EcoStruxure Building Operation software license on License Server

by the License Activation Server

License Administrator is used to activate EcoStruxure Building Operation

software licenses. When activating a license, the License Administrator on the
receiving computer requests and administrates the activation.

IT 04-40008-03-en, June 2022

126
 10 EcoStruxure Building Operation Licensing
10.3 Licenses Activation Server

Figure: Work flow when activating EcoStruxure Building Operation software licenses on
License Server

Table: Activation of EcoStruxure Building Operation Software on License Server

Number Description

1 To activate a license, the registration

details need to be correctly entered.

2 The License Administrator sends an

activation request to the License Activation
Server. The activation request contains
information about the registration details
and the license to activate.

3 License Activation Server activates the

requested licenses on the License Server.
The registration details and the transaction
information are stored with the license on
the License Server.

The activated licenses are available on the License Server. Before the License
Server can distribute the licenses, the License Server has to be restarted.

04-40008-03-en, June 2022 IT

127
10 EcoStruxure Building Operation Licensing
10.4 License Server

10.4 License Server

License Server manages the administration of EcoStruxure Building Operation
software licenses.
An EcoStruxure BMS running with EcoStruxure Building Operation Software
licenses must contain at least one License Server. Use one License Server on
every computer that runs a feature that require an EcoStruxture Building
Operation software license.
License Server is a Microsoft Windows service named Building Operation
License Server.
Configure the License Server to automatically restart if it unexpectedly stops. For
more information, see section 10.13 “Configuring the License Server Recovery
Settings ” on page 143.
You can access License Server through a web interface. For more information,
see section 11.11 “Accessing License Server Using the Interface” on page 166.
With a default installation, the License Server port range is set to 27000-27009. A
valid number is any unused port between 0 and 64000.
If the License Server uses other ports than the default port range 27000-27009,
the port has to be added in front of the @ in the License Server address on the
WorkStation, Enterprise Server, or Client tools.

IT 04-40008-03-en, June 2022

128
 10 EcoStruxure Building Operation Licensing
10.5 License Administrator

10.5 License Administrator

The License Administrator administers the activation, return, and repair of
licenses.
You use License Administrator to activate EcoStruxure Building Operation
software licenses on the License Server. The licenses are then checked out from
the License Server by WorkStation, editors, or Enterprise Server. For more
information, see section 10.5 “License Administrator” on page 129.
During the installation of License Administrator on WorkStations or Enterprise
Servers, you can change the the network address to the License Server where
licenses are available for check out. The address to the License Server can later
be entered or edited through License Administrator on the computer that hosts
the licensed product.
When you use the default setting during installation, you do not have to change
the network address. For more information, see section 10.6 “EcoStruxure
Building Operation Software Licensing Installation and Location” on page 130.
The address to a License Server must begin with @ and is either a hostname or
IP address. If the communication to the License Server is through a port other
than the default port range 27000-27009, the port number is defined in front of
the @, Port-number@hostname.

Table: Examples of License Server Address

Address Description

19650@localhost Connects to localhost through port 19650

@server2c.schneider-electric.com Connects to License Server

server2c.schneider-electric.com through a
port in the default port range 27000-27009

[email protected] Connects to License Server 192.166.248.2

through port 14650

To separate License Server addresses in License Administrator, use a

semicolon.

04-40008-03-en, June 2022 IT

129
10 EcoStruxure Building Operation Licensing
10.6 EcoStruxure Building Operation Software Licensing Installation and Location

10.6 EcoStruxure Building Operation

Software Licensing Installation and
Location
License Administrator and License Server must run on the same computer as
Enterprise Server or Enterprise Central that will use the licenses.
Schneider Electric recommends that you install the license server framework
before installing other EcoStruxure Building Operation software applications and
automation servers. License Server installation is included in the License
Administrator license package. During the installation of WorkStation, Enterprise
Server, or Enterprise Central, the installation software asks for the address to
License Server.
In this example, the License Server and Enterprise Server are located on the
same computer. Several WorkStations check out licenses from the License
Server through the local area network. Licenses are activated on the License
Server by the License Activation Server that is controlled by Schneider Electric.

Figure: WorkStation system with License Server and Enterprise Server on same computer
and WorkStation in separate computers, one computer with client tool.

When you activate a license, the license is transferred from the License
Activation Server to your License Server. When activating a license, details about
the transaction and registration details are stored with the license on the License
Server.

IT 04-40008-03-en, June 2022

130
 10 EcoStruxure Building Operation Licensing
10.6 EcoStruxure Building Operation Software Licensing Installation and Location

10.6.1 License Server Installation and Location

License Identification Overview
Use one separate License Server for every Enterprise Central and Enterprise
Server to get an overview of your licenses. If two or more Enterprise Servers or
Enterprise Centrals gets their licenses from the same License Server, you cannot
identify which Enterprise Server or Enterprise Central got the license.
If you need to repair or move an EcoStruxure Building Operation software
license, the request must come from the License Server that was used to activate
the license.
If you try to install Enterprise Server or Enterprise Central on a computer without
a License Administrator, you get the system alarm "Invalid license server
configuration".

License Server Location

Install the License Server and Enterprise Server or Enterprise Central on the
same computer to avoid license problems caused by network problems. Use the
address @localhost so the Enterprise Server cannot connect to the License
server through the network.

License Server Internet access

Ensure that the License Server has access to the Internet and to the local area
network. Internet access is necessary when performing tasks that require
communication with the License Activation Server, such as activating or returning
licenses on your License Server. Instant access to the local area network
ensures that licensed WorkStations, client tools, Enterprise Servers, and
Enterprise Centrals can check out and check in licenses.
NOTE: For security reasons, Internet access can be disconnected when
communication with the License Activation Server is not needed.

10.6.2 License Administrator Installation and

Location
Install License Administrator on the same computer as the Enterprise Server or
Enterprise Central. This makes your system less vulnerable to network failure.

04-40008-03-en, June 2022 IT

131
10 EcoStruxure Building Operation Licensing
10.7 Software and Features that Require Licenses

10.7 Software and Features that Require

Licenses
There are a number of different clients, servers, and features that requires
licenses to operate.

Table: Space Logic

Feature name Client EC ES AS-P AS-B Description

Enterprise X Will not start if

Central license is
missing

Enterprise X Will not start if

Server license is
missing

Enterprise X Allows EC to
Servers host one ES

Automation X Allows ES to
Servers host one
automation
server

Field Devices X Allows ES to

host one field
device

Cloud X X X X Cloud
Connectivity connectivity -
Checked by
Cloud SMS

Table: Client

Feature Client EC ES AS-P AS-B Inherited Description

name

Clients X Allows
WorkStation
to log on to
an EC/ES or
automation
server

Clients X X X X Allows
WebStation
to log on to
an EC/ES or
automation
server

IT 04-40008-03-en, June 2022

132
 10 EcoStruxure Building Operation Licensing
10.7 Software and Features that Require Licenses

Continued
Feature Client EC ES AS-P AS-B Inherited Description
name

Graphics X Allows
Editor Graphics
editor to
start one or
multiple
sessions on
same PC

Script Editor X Allows

Script Editor
to start -
Script editor
is a multi
document
application

Function X Allows
Block Editor Function
Block Editor
to start one
or multiple
sessions on
same PC

CAD Import X Allows CAD

Tool Import Tool
to start one
or multiple
sessions on
same PC

Zoning Tool X X Enables use

of zoning
tools.
If license is
missing the
tools are not
available.
No AS
licence.
Zoning on
AS checks
for the ES
licence.

04-40008-03-en, June 2022 IT

133
10 EcoStruxure Building Operation Licensing
10.7 Software and Features that Require Licenses

Table: Server

Feature Client EC ES AS-P AS-B Inherited Description

name

SmartDriver X X Enables
s SmartDriver
s (Counted)
- Supported
on ES and
AS-P only

Personal X X X X Enables
Dashboards Personal
Dashboards

SNMP X X X X X Enables
Notifications SNMP
Notifications

TimescaleD X X X X X Enables
B Extended
log storage -
TimescaleD
B

Change X X Enables
Control Change
control /
Electronic
signature

PDF Signing X X Enables

Digital
signing of
documents
If license is
missing the
report will
get a
watermark
and an
alarm is
raised

MQTT X X X X Enables
MQTT Client
to publish
data on
MQTT
Broker and
to subscribe
to the same
data
(On/Off)

IT 04-40008-03-en, June 2022

134
 10 EcoStruxure Building Operation Licensing
10.7 Software and Features that Require Licenses

Continued
Feature Client EC ES AS-P AS-B Inherited Description
name

SAML X X X X X Enables
Authenticati SAML
on Authenticati
on on
Enterprise
Central. Can
be
configured
without a
license.

Table: Scalable AS

Feature name Client EC ES AS-P AS-B Description

Automation X X Allows
Server automation
server to start
without
violation bar.

Field Devices X X Bundle feature

- Allows
automation
server to host
one field
device

Server I/O X X Bundle

feature –
Allows
automation
server to host
I/O modules.
AS-B needs 1
license to host
any number of
I/O modules.
AS-P needs 1
license to host
one I/O
module.

Enterprise X X Bundle feature

Server - Allows
automation
server to be
hosted by an
Enterprise
Server

04-40008-03-en, June 2022 IT

135
10 EcoStruxure Building Operation Licensing
10.7 Software and Features that Require Licenses

Continued
Feature name Client EC ES AS-P AS-B Description

MS/TP X X Bundle feature

- Allows
automation
server serial
communicatio
n - MS/TP

BACnet/IP X X Bundle feature

- Allows
automation
server
BACnet/IP
communicatio
n

Modbus X X Bundle feature

- Allows
Modbus
communicatio
n

Table: Software Assurance

Feature name Client EC ES AS-P AS-B Description

Software X X X X Software
Assurance Assurance -
Allows usage
of older
licence
version

IT 04-40008-03-en, June 2022

136
 10 EcoStruxure Building Operation Licensing
10.8 Field Bus Device Licenses

10.8 Field Bus Device Licenses

Field bus devices attached to an Enterprise Server need licenses.
The following field bus devices require a license:
• BACnet IP devices
• MNB 1000 devices
• LonWorks devices
• Modbus TCP devices

04-40008-03-en, June 2022 IT

137
10 EcoStruxure Building Operation Licensing
10.9 EcoStruxure Building Operation Software Licensing Workflow

10.9 EcoStruxure Building Operation

Software Licensing Workflow
Use this workflow to add licenses for EcoStruxure Building Operation software
running on Windows.
Related information can be found in the sections after the flowchart.

Figure: Licensing workflow

EcoStruxure Building Operation Software Licensing Installation and

Location
Read the setup guide for installation and location of License Server and License
Administrator.
For more information, see section 10.6 “EcoStruxure Building Operation Software
Licensing Installation and Location” on page 130.

Install License Administrator and License Server

Install Licenses Administrator and License Server.
For more information, see section 3.5 “Installing the License Administrator and
the License Server” on page 48.

Start License Administrator

Start License Administrator.

IT 04-40008-03-en, June 2022

138
 10 EcoStruxure Building Operation Licensing
10.9 EcoStruxure Building Operation Software Licensing Workflow

For more information, see section 10.11 “Starting License Administrator” on page
141.

Activate EcoStruxure Building Operation Software Licenses

Activate EcoStruxure Building Operation Software Licenses.
For more information, see section 10.12 “Activating EcoStruxure Building
Operation Software Licenses ” on page 142.

Configure License Server Recovery Settings

Configure License Server to restart if it unexpectedly stops.
For more information, see section 10.13 “Configuring the License Server
Recovery Settings ” on page 143.

04-40008-03-en, June 2022 IT

139
10 EcoStruxure Building Operation Licensing
10.10 Inherited Licenses

10.10 Inherited Licenses

Inherited licenses are EcoStruxure Building Operation software licenses that are
inherited from an Enterprise Server by the attached automation servers.
When an inherited license is activated for the Enterprise Server all attached
automation servers can use the feature. Inherited licenses are activated using
License Administrator and the EcoStruxure Building Operation Software License
mechanism and workflow.
For more information, see section 10.1 “EcoStruxure Building Operation Software
Licensing Overview” on page 123.
For example, you want to use SNMP on some of your automation servers that
are attached to an Enterprise Server. When you activate the SNMP license on
your Enterprise Server, all attached automation servers are allowed to use
SNMP.
Some features can also be used on a stand-alone automation server. In this case
the licenses must be activated using the Device Administrator.
For more information, see section 10.7 “Software and Features that Require
Licenses” on page 132.

IT 04-40008-03-en, June 2022

140
 10 EcoStruxure Building Operation Licensing
10.11 Starting License Administrator

10.11 Starting License Administrator

You start License Administrator to administer the licenses on the License Server
and define the address to the License Servers for all licensed EcoStruxure
Building Operation products.
For more information, see section 10.5 “License Administrator” on page 129.

To start License Administrator

1. Click Start, point to All Programs, and then click Schneider Electric
EcoStruxure.
2. Click Building Operation x.x.
3. Click Building Operation License Administrator.
4. Click Yes to confirm that you want to run License Administrator.

04-40008-03-en, June 2022 IT

141
10 EcoStruxure Building Operation Licensing
10.12 Activating EcoStruxure Building Operation Software Licenses

10.12 Activating EcoStruxure Building

Operation Software Licenses
You activate EcoStruxure Building Operation software licenses, from the License
Activation Server, to make EcoStruxure Building Operation software licenses
available.
NOTE:
• This procedure requires that an entitlement with the licenses has been
received. For more information, see section 9.4 “Order Information
Request” on page 113.
For more information on how to place an order, contact your EcoStruxure
Building Operation vendor.
For more information, see section 10.9 “EcoStruxure Building Operation Software
Licensing Workflow” on page 138.

To activate EcoStruxure Building Operation software licenses

1. In License Administrator, click the Licenses tab.
2. On the Licenses toolbar, click the Add license from entitlement ID button

.
3. In the Add License dialog box, in the Enter license entitlement ID box,
type the entitlement ID that contains the licenses to activate. The
entitlement ID is printed on the entitlement.
4. Click OK.
5. In the Licenses View, in the Activate column, select the number of license
to activate.
6. Click Activate.
7. Click Close.
8. Click Restart now to restart the License Server and activate the license.
The activated licenses are now available on the License Server.

IT 04-40008-03-en, June 2022

142
 10 EcoStruxure Building Operation Licensing
10.13 Configuring the License Server Recovery Settings

10.13 Configuring the License Server

Recovery Settings
You configure License Server recovery settings to ensure that the License Server
restarts if it unexpectedly stops.
For more information, see section 10.4 “License Server” on page 128.

To configure the license server recovery settings

1. On the computer running License Server, open the Services management
console.
NOTE: In Windows, open the Run dialog box and type services.msc.
2. Right-click Building Operation License Server.
3. Select Properties.
4. Click the Recovery tab.
5. In the First failure box, select Restart the Service.
6. In the Second failure box, select Restart the Service.
7. In the Subsequent failures box, select Restart the Service.
8. Click OK.

04-40008-03-en, June 2022 IT

143
10 EcoStruxure Building Operation Licensing
10.14 EcoStruxure Building Operation Software License Distribution and Selection

10.14 EcoStruxure Building Operation

Software License Distribution and
Selection
EcoStruxure Building Operation software licenses are distributed and selected
from License Server.

10.14.1 EcoStruxure Building Operation Software

License Distribution
EcoStruxure Building Operation software licenses are distributed from License
Server. License Server shares a predetermined number of simultaneous
instances that are available network-wide. To start licensed clients and
EcoStruxure BMS servers using EcoStruxure Building Operation software
licenses, the required number of licenses have to be available on the License
Server.

IT 04-40008-03-en, June 2022

144
 10 EcoStruxure Building Operation Licensing
10.14 EcoStruxure Building Operation Software License Distribution and Selection

Figure: An EcoStruxure Building Operation software license is activated on a License

Server and can be used by any computer in the network.

04-40008-03-en, June 2022 IT

145
10 EcoStruxure Building Operation Licensing
10.14 EcoStruxure Building Operation Software License Distribution and Selection

To activate an EcoStruxure Building Operation software license from a License

Server, you have to define the License Server address where EcoStruxure
Building Operation Software licenses are available. You define the address to
License Server when installing the licensed product. You edit the License Server
address in License Administrator on the computer or EcoStruxure BMS server
that hosts the licensed product.
A activated license is not physically moved to the client or EcoStruxure BMS
server. The activated license is allocated in License Server until the license is
returned by the client or EcoStruxure BMS server.
When a licensed WorkStation, Enterprise Server, or client tool starts and no
demo license is activated, WorkStation or Enterprise Server searches License
Server for an available license. If an available license is found, the licensed
product activates the license and starts. If no licenses are available, the licensed
product does not start. When the application is closed, the license is returned to
the License Server.

Figure: The WorkStation activates a license from the License Server.

NOTE:
• On the EcoStruxure BMS server running both License Server and
Enterprise Server, use the address @localhost so the Enterprise Server
does not connect to the License Server through the network.

IT 04-40008-03-en, June 2022

146
 10 EcoStruxure Building Operation Licensing
10.14 EcoStruxure Building Operation Software License Distribution and Selection

Figure: License Server and Enterprise Server on same computer. Enterprise Server
activates license from License Server that is defined in the shared License Administrator.

10.14.2 EcoStruxure Building Operation Software

License Selection
When a licensed WorkStation, WebStation, client tool, Enterprise Server or
Enterprise Central starts, it first checks if a demo license is available. If a demo
license is not available or has expired, the WorkStation, Enterprise Server, or
Enterprise Central activates a EcoStruxure Building Operation Software license
from a License Server. If no license is available, the WorkStation, client tool,
Enterprise Server, or Enterprise Central does not start.

04-40008-03-en, June 2022 IT

147
10 EcoStruxure Building Operation Licensing
10.15 EcoStruxure Building Operation Software Feature License Strings

10.15 EcoStruxure Building Operation

Software Feature License Strings
The feature strings are used when you troubleshoot a license problem. The
strings are visible in the Diagnostic tab of License Administrator.

Table: EcoStruxure Building Operation Software Feature License Strings

Product license Feature string1 Description

Client Station client.station Use this license to start and

run WorkStation and
WebStation.

Client tools client.graphiceditor This license product group

consists of several products,
client.script
each required to run the
client.functionblock.view corresponding client tool.
Licensing of WorkPlace
Tech is included with the
Script Editor license.

Enterprise Central server.enterprise.central Use this license to start and

run an Enterprise Central.

Enterprise Server server.enterprise.base Use this license to start and

run an Enterprise Server.

Enterprise Server under server.ec.es Use this license to attach

Enterprise Central Enterprise Servers to an
Enterprise Central.

Field bus devices under server.device.es Use this license to attach

Enterprise Server Field bus devices to an
Enterprise Server.

Automation server under server.es.as Use this license to attach an

Enterprise Server automation server to an
Enterprise Server.

Change Control server.esignature Use this license to allow

Change Control.

Webservices, EWS Cons server.ws.ews.consume Use this license to start and

run Web Services, EWS
Consume.

Webservices, EWS Cons, server.ws.ews.server Use this license to start and

SRV run Web Services, EWS
Consume.

Webservices, EWS Cons, server.ws.ews.history Use this license to start and

SRV run Web Services, EWS
Consume.

Webservices, Generic Cons server.ws.generic.consume Use this license to start and

run Web Services.

IT 04-40008-03-en, June 2022

148
 10 EcoStruxure Building Operation Licensing
10.15 EcoStruxure Building Operation Software Feature License Strings

Continued
Product license Feature string1 Description

Cloud Connectivity server.cloud.demo Use this license to allow the

server to connect to the
cloud using Cloud
Connectivity.

Sign PDF server.dig.signed.docs Use this license to get PDF

reports digitally signed. One
license is required for every
Enterprise Central and
Enterprise Server that uses
the Sign PDF function.

04-40008-03-en, June 2022 IT

149
11 License Maintenance

Topics
EcoStruxure Building Operation Software License
Maintenance
EcoStruxure Building Operation Software License Backup
and Restore
Backing Up EcoStruxure Building Operation Software
Licenses
Restoring EcoStruxure Building Operation Software
Licenses
License Server Replacement and Relocation Workflow
EcoStruxure Building Operation Software License Return
Returning an EcoStruxure Building Operation Software
License
Configuring the Address to the License Server
WorkStation and Client Tools Address Configuration
Enterprise Server Address Configuration
Accessing License Server Using the Interface
Viewing Activated EcoStruxure Building Operation Software
Licenses
Viewing Diagnostic EcoStruxure Building Operation
Software License Information
Copying EcoStruxure Building Operation Software License
Diagnostics to the Clipboard
 Showing the EcoStruxure Building Operation Software
11 Licenses Log File
 11 License Maintenance
11.1 EcoStruxure Building Operation Software License Maintenance

11.1 EcoStruxure Building Operation

Software License Maintenance
You can backup and restore EcoStruxure Building Operation software licenses
as well as relocate and replace the License Server.

11.1.1 EcoStruxure Building Operation Software

License Backup and Restore
Backup the EcoStruxure Building Operation software license files on a regular
basis. To back up the license files, copy all files in the folder to an external
resource. Backups are useful if the hardware or the operating system
malfunctions.
For more information, see section 11.2 “EcoStruxure Building Operation Software
License Backup and Restore” on page 155.

11.1.2 License Server Replacement and Relocation

If you want to replace or relocate the License Server hardware, you must return
the licenses to the License Activation Server and then activate the licenses again
on the new License Server.
Use this workflow to to replace and relocate License Server.
For more information, see section 11.5 “License Server Replacement and
Relocation Workflow ” on page 158.

11.1.3 EcoStruxure Building Operation Software

License Return
When you return an EcoStruxure Building Operation software license, the license
is transferred from the License Server back to the License Activation Server.
For more information, see section 11.6 “EcoStruxure Building Operation Software
License Return” on page 159.

11.1.4 License Server Address Change

If the License Server is assigned a new network address, all EcoStruxure
Building Operation software that requires a license must be updated with the new
address.
For more information, see section 11.8 “Configuring the Address to the License
Server” on page 162.

04-40008-03-en, June 2022 IT

153
11 License Maintenance
11.1 EcoStruxure Building Operation Software License Maintenance

11.1.5 License Server Reinstallation

If you reinstall a License Server, the EcoStruxure Building Operation software
licenses on the License Server are not affected. The licenses on the License
Server do not have to be returned to the License Activation Server during
reinstallation.
For more information, see section 5.2 “Reinstalling the License Administrator and
the License Server” on page 72.

11.1.6 EcoStruxure Building Operation Software

Diagnostics
You can view information about all licenses located on the License Server in the
diagnostics view in License Administrator. This information is important when
troubleshooting or when you require help from product support service. For more
information, see section 11.13 “Viewing Diagnostic EcoStruxure Building
Operation Software License Information” on page 168.

11.1.7 EcoStruxure Building Operation Software

License Log File
You can get a log file of the license to get information regarding licenses, for
example when you are troubleshooting.
For more information, see section 11.15 “Showing the EcoStruxure Building
Operation Software Licenses Log File ” on page 170.

IT 04-40008-03-en, June 2022

154
 11 License Maintenance
11.2 EcoStruxure Building Operation Software License Backup and Restore

11.2 EcoStruxure Building Operation

Software License Backup and Restore
Backup the EcoStruxure Building Operation software license files on a regular
basis. To back up the license files, copy all files in the folder to an external
resource. Backups are useful if the hardware or the operating system
malfunctions.
Backed up licenses can only be restored on the same License Server that the
files were backed up from. If you plan to move the licenses to another License
Server, you first must return the licenses to the License Activation Server and
then activate them on the new License Server. For more information, see section
11.6 “EcoStruxure Building Operation Software License Return” on page 159.
The license files are located in: \ProgramData\FLEXnet in Windows.
The restored licenses files may on rare occasions be considered damaged by the
License Server. If so, they must be repaired. For more information, see the
EcoStruxure Building Operation Software License Repair topic on WebHelp.

04-40008-03-en, June 2022 IT

155
11 License Maintenance
11.3 Backing Up EcoStruxure Building Operation Software Licenses

11.3 Backing Up EcoStruxure Building

Operation Software Licenses
You back up EcoStruxure Building Operation software licenses to be able restore
them if something unexpected happens.
For more information, see section 11.2 “EcoStruxure Building Operation Software
License Backup and Restore” on page 155.

To back up EcoStruxure Building Operation software licenses

1. Close all EcoStruxure Building Operation software that requires licenses.
2. On the License Server, browse to the folder \ProgramData\FLEXnet.
3. Copy all files in the FLEX-net folder that start with taclic_ and paste the files
onto your external backup resource.

IT 04-40008-03-en, June 2022

156
 11 License Maintenance
11.4 Restoring EcoStruxure Building Operation Software Licenses

11.4 Restoring EcoStruxure Building

Operation Software Licenses
You restore the license data from a backup to restore a corrupt or non-functioning
License Server.
For more information, see section 11.2 “EcoStruxure Building Operation Software
License Backup and Restore” on page 155.

To restore EcoStruxure Building Operation software licenses

1. Close all EcoStruxure Building Operation software that requires license.
2. On the computer that runs License Server, browse to the the folder
\ProgramData\FLEXnet\
3. Paste all your backed up files to the FLEX-net folder.
NOTE:
• You may need to repair restored licenses before you check out the
restored licenses. For more information, see the Repairing a
Network License topic on WebHelp.
You now restart the License Server so you can check out the restored licenses.
For more information, see the Restarting the License Server topic on WebHelp.

04-40008-03-en, June 2022 IT

157
11 License Maintenance
11.5 License Server Replacement and Relocation Workflow

11.5 License Server Replacement and

Relocation Workflow
Use this workflow to replace and relocate License Server.
Related information can be found in the sections after the flowchart.

Figure: License Server replacement and relocation workflow

Return all EcoStruxure Building Operation software licenses

Return all EcoStruxure Building Operation software licenses to License Activation
Server. For more information, see section 11.7 “Returning an EcoStruxure
Building Operation Software License ” on page 161.

Activate the licenses on the new License Server

Activate the licenses on the new License Server using the entitlement ID that
originally was used to activate the licenses. For more information, see section
10.12 “Activating EcoStruxure Building Operation Software Licenses ” on page
142.

Update the address

If License Server has been relocated, updated the address using License
Administrator. For more information, see section 11.8 “Configuring the Address
to the License Server” on page 162.

IT 04-40008-03-en, June 2022

158
 11 License Maintenance
11.6 EcoStruxure Building Operation Software License Return

11.6 EcoStruxure Building Operation

Software License Return
When you return an EcoStruxure Building Operation software license, the license
is transferred from the License Server back to the License Activation Server.
The returned license is not available is not available for the WorkStation or
Enterprise Server to activate.
When a license is returned, all the licenses that were activated in the same
session are also returned. For example, if seven licenses are activated in the
same activation transaction, a single license cannot be returned to the License
Activation Server.
To activate the returned licenses again, use the entitlement ID that contains the
returned licenses.
This flow describes the return transaction of licenses from a License Server to the
License Activation Server.

Figure: Returning a license from License Server to the License Activation Server

Table: Returning Licenses from License Server to the License Activation Server
Number Description

1 In the License Administrator, select the

licenses to return.

04-40008-03-en, June 2022 IT

159
11 License Maintenance
11.6 EcoStruxure Building Operation Software License Return

Continued
Number Description

2 The License Administrator returns the

licenses to the License Activation Server.

NOTE:
• All licenses that were activated in same transaction are returned to the
License Activation Server.

IT 04-40008-03-en, June 2022

160
 11 License Maintenance
11.7 Returning an EcoStruxure Building Operation Software License

11.7 Returning an EcoStruxure Building

Operation Software License
You return EcoStruxure Building Operation software licenses to the License
Activation Server, for example when you move EcoStruxure Building Operation
software licenses to another License Server.
NOTE:
• When you return a license to the License Activation Server, all the
licenses that were activated in the same transaction with that license are
also returned.

To return a EcoStruxure Building Operation software license

1. In License Administrator, click the Licenses view.
2. Select the the EcoStruxure Building Operation license.

3. On the Licenses toolbar, click the Remove/return license button .

4. Click Yes.
5. Click Close.
6. In the Licenses dialog box, click Restart now to apply the changes to the
License Server.

04-40008-03-en, June 2022 IT

161
11 License Maintenance
11.8 Configuring the Address to the License Server

11.8 Configuring the Address to the License

Server
You configure the address to License Server so Enterprise Server, WorkStation,
or a client tool knows where to find available licenses to activate.
NOTE:
• Before a WorkStation or Enterprise Server starts to activate EcoStruxure
Building Operation software licenses from a License Server, any demo
licenses in use must be removed. For more information, see section 13.5
“Removing an EcoStruxure Building Operation Software Demo License ”
on page 197.
For more information, see the Network License Management topic on WebHelp.

To configure the address to the License Server

1. In License Administrator, click the Licenses server address view.
2. In the License server address box, type @ and then type the address to
the License Server.
NOTE:
• The address must begin with an @.
• If you use a port other than the default port of 27000, type the port
number in front of @. For example, 567@localhost.
• Use a semicolon to separate addresses to different License Servers.
3. Click Save.
Next time a WorkStation, client tool, or Enterprise Server starts, it activates
available EcoStruxure Building Operation software licenses from the defined
License Server.
NOTE:
• The License Server address is configured individually on all WorkStations
and Enterprise Servers.

IT 04-40008-03-en, June 2022

162
 11 License Maintenance
11.9 WorkStation and Client Tools Address Configuration

11.9 WorkStation and Client Tools Address

Configuration
After licenses are activated on the License Server you have to configure
Workstation and its client tools connection to License Server, where licenses are
available to be activated. The address to the License Server is defined during the
installation of WorkStation. This is done using License Administrator.

Figure: WorkStation configuration and client station license and client tool EcoStruxure
Building Operation Software licenses

Table: WorkStation Configuration

Number Description

1 Configure the WorkStation and client tool

address to the License Server.

2 Remove any activated demo licenses.

3 When you logon to WorkStation or start a

client tool, the required license is
automatically activated on the License
Server.

An activated ExoStruxure Buildning Oeration software license is not physically

moved to or activated on WorkStation. The client station and client tool licenses
remain in the License Server but are allocated to the dedicated WorkStation. The
license is therefore not available for other WorkStations to use.

04-40008-03-en, June 2022 IT

163
11 License Maintenance
11.10 Enterprise Server Address Configuration

11.10 Enterprise Server Address

Configuration
After licenses are activated on the License Server, you configure the Enterprise
Server connection to the License Server. The address to the License Server is
defined during the installation of Enterprise Server using License Administrator.

Figure: Enterprise Server configuration and activation of Enterprise Server EcoStruxure

Building Operation Software license

Table: Enterprise Server Configuration

Number Description

1 Configure the Enterprise Server address to

the License Server.

2 Remove any demo licenses.

3 When the Enterprise Server starts, it

automatically activates an EcoStruxure
Building Operation software license.

When the Enterprise Server starts, it automatically activates an available

EcoStruxure Building Operation software license from a License Server. An
activated license is not physically moved to the Enterprise Server. The license
remains in the License Server but is allocated to the dedicated Enterprise Server.
The license is therefore not available for other EcoStruxure BMS servers.

IT 04-40008-03-en, June 2022

164
 11 License Maintenance
11.10 Enterprise Server Address Configuration

NOTE:
• If the Enterprise Server does not start, refer to the Enterprise Server log
for more information. For more information, see section 15.10 “Viewing
the Enterprise Server or Enterprise Central System Log” on page 238.

04-40008-03-en, June 2022 IT

165
11 License Maintenance
11.11 Accessing License Server Using the Interface

11.11 Accessing License Server Using the

Interface
You access License Server using the interface to configure the settings, for
example, change the port number to the License Server.
For more information, see the Flexnet License Administrator, License Server
Manager topic on WebHelp.

To access License Server Using the Interface

1. On a computer that has access to the the same network as the License
Server, to configure is located, open a web browser.
2. In the address field, type the License Server IP or network. End the address
with a colon and then the port number.
NOTE:
• License Server has the HTTP protocol through port 8888 set as the
default. For example: http://162.192.10.1:8888
The default user name is: admin.
The default password is: admin.

For more information, click button Help button in the License Server
interface.

IT 04-40008-03-en, June 2022

166
 11 License Maintenance
11.12 Viewing Activated EcoStruxure Building Operation Software Licenses

11.12 Viewing Activated EcoStruxure Building

Operation Software Licenses
You view all the activated EcoStruxure Building Operation software licenses on
the License Server on the same computer as the License Administrator.
For more information, see section 10.6 “EcoStruxure Building Operation Software
Licensing Installation and Location” on page 130.

To view activated EcoStruxure Building Operation software

licenses
1. In License Administrator, click the Licenses view.
All EcoStruxure Building Operation software licenses activated on the License
Server are listed.

04-40008-03-en, June 2022 IT

167
11 License Maintenance
11.13 Viewing Diagnostic EcoStruxure Building Operation Software License Information

11.13 Viewing Diagnostic EcoStruxure

Building Operation Software License
Information
You view all EcoStruxure Building Operation software licenses and the license
details located on the License Server. This diagnostic information is helpful when
you are troubleshooting.
For more information, see the Service and Maintenance topic on WebHelp.

To view diagnostic EcoStruxure Building Operation software

license information
1. In License Administrator, click the Diagnostics view.

2. On the Diagnostics toolbar, click the Refresh the list button .

The diagnostics list is now populated with all licenses and license details located
on the License Server.

IT 04-40008-03-en, June 2022

168
 11 License Maintenance
11.14 Copying EcoStruxure Building Operation Software License Diagnostics to the Clipboard

11.14 Copying EcoStruxure Building

Operation Software License Diagnostics
to the Clipboard
You copy the EcoStruxure Building Operation software licenses diagnostics
information to your when troubleshooting.
For more information, see the Service and Maintenance topic on WebHelp.

To copy the EcoStruxure Building Operation software license

diagnostics to the clipboard
1. In License Administrator, click the Diagnostics view.

2. On the Diagnostics toolbar, click the Refresh the list button .

3. On the Diagnostics toolbar, click the Copy to clipboard button .

The diagnostics information is now on the clipboard so you can paste it into a
document or email.

04-40008-03-en, June 2022 IT

169
11 License Maintenance
11.15 Showing the EcoStruxure Building Operation Software Licenses Log File

11.15 Showing the EcoStruxure Building

Operation Software Licenses Log File
You show the EcoStruxure Building Operation software licenses log file to get
information regarding licenses, for example when you are troubleshooting.
For more information, see the Service and Maintenance topic on WebHelp.

To show the EcoStruxure Building Operation software licenses

log file
1. In the Licenses Administratior, click the Licenses tab.

2. In the Licenses toolbar, click the Show log button .

IT 04-40008-03-en, June 2022

170
12 Automation Server Licenses

Topics
Automation Server Licensing Overview
Assign and Activate Licenses
Automation Server Licensing Workflow
Adding an Entitlement to Device Administrator
Removing an Entitlement
Assigning Licenses
Activating Licenses Online
Offline Activation of Licenses Workflow
Creating the Request Files
Activating Request Files to Receive Response Files
Sending the Response Files to the Automation Server
Automation Server Feature License Strings
Adding and Removing License Columns in Device
Administrator
 12 Automation Server Licenses
12.1 Automation Server Licensing Overview

12.1 Automation Server Licensing Overview

Device Administrator is used to manage licenses on automation servers.

12.1.1 Licenses on Automation Servers

The following features of an automation server need licenses.

SmartDrivers
To be able to use SmartDrivers on an automation server one license is needed
for every SmartDriver that runs on the automation server.

SNMP Notifications
To be able to use SNMP Notification on an automation server, a license is
required.
For a stand-alone automation server, the license is local for the automation
server and administered by Device Administrator.
In a multi-server system, you can use inherited licenses.
For more information, see section 10.10 “Inherited Licenses” on page 140.

Personal Dashboards
To be able to create personal dashboards on an automation server, you need a
license. Personal dashboards are used in WebStation.
For a stand-alone automation server, the license can be local for the automation
server and administered by Device Administrator.
In a a multi-server system, you can use inherited licenses.
For more information, see section 10.10 “Inherited Licenses” on page 140.

TimescaleDB
To be able to use TimescaleDB on an automation server, a license is required.
For more information, see section 10.10 “Inherited Licenses” on page 140.

MQTT
To be able to read and write to an MQTT broker from an MQTT client on an
automation server, you need a license. For a stand-alone automation server, the
license is local for the automation server and administered by Device
Administrator.
In a multi-server system, you can use inherited licenses.
For more information, see section 10.10 “Inherited Licenses” on page 140.

12.1.2 Entitlements, Products, and Licenses

Licenses are bought as products and delivered in Entitlements. An Entitlement is
a container that can contain several products. The products contain the licenses
and they can differ in quantity and contents.

04-40008-03-en, June 2022 IT

173
12 Automation Server Licenses
12.1 Automation Server Licensing Overview

For more information, see the Entitlements, Products, and Licenses topic on
WebHelp.

12.1.3 Automation Server Licensing Workflow

Use this workflow to add licenses to automation servers using Device
Administrator.
For more information, see section 12.3 “Automation Server Licensing Workflow”
on page 176.

12.1.4 Certificates
It is recommended to use HTTPS for the communication between Device
Administrator and automation servers when you manage licenses.
For more information, see the Certificates in Device Administrator topic on
WebHelp.

IT 04-40008-03-en, June 2022

174
 12 Automation Server Licenses
12.2 Assign and Activate Licenses

12.2 Assign and Activate Licenses

When you have added the Entitlement to Device Administrator, you must assign
and then activate the licenses on the automation servers.

12.2.1 Assign Licenses

Assigning licenses is the process of distributing the licenses from the Entitlement
to the automation servers in the list.

12.2.2 Activate Licenses

When you have assigned the licenses to the automation servers, you must
activate the licenses. Activation is required for enabling features that require
licenses. Activation is done on the automation server level. You can activate
licenses for all Smart servers in the list at the same time. Or you can choose to
select a subset of servers and activate licenses for just those servers.

Online activation
Online activation is implemented immediately. Online activation requires that the
automation server is connected to the internet.
For more information, see section 12.7 “Activating Licenses Online ” on page
180.

Offline activation
Offline activation is used when the automation server does not have any access
to the internet. Offline activation is a multi-step process.
After the licenses are assigned, you create a set of request files using Device
Administrator. The request files are then uploaded to the FlexNet Operations
Administrator server. The FlexNet Operations administrator server processes the
request files and creates a set of response files. The response files are
downloaded and copied to the computer that runs Device Administrator. The
response files are sent from Device Administrator to the automation server.
For more information, see section 12.8 “Offline Activation of Licenses Workflow”
on page 181.
IMPORTANT: Activated licenses cannot be deactivated.

04-40008-03-en, June 2022 IT

175
12 Automation Server Licenses
12.3 Automation Server Licensing Workflow

12.3 Automation Server Licensing Workflow

Use this workflow to add licenses to automation servers using Device
Administrator.
Related information can be found in the sections after the flowchart.

Figure: Automation Serverr licensing workflow

Add Entitlements to Device Administrator

In Device Administrator, add an Entitlement that contains products and licenses
to Device Administrator.
For more information, see section 12.4 “Adding an Entitlement to Device
Administrator” on page 177.

Assign licenses to an automation server

Assign the licenses in the Entitlement for the features you want to use on the
automation servers.
For more information, see section 12.6 “Assigning Licenses” on page 179.

Activate licenses on an automation server

For more information, see section 12.7 “Activating Licenses Online ” on page
180.
If you do not have internet access, you can activate licenses offline.
For more information, see section 12.8 “Offline Activation of Licenses Workflow”
on page 181.
IMPORTANT: Activated licenses cannot be deactivated.

IT 04-40008-03-en, June 2022

176
 12 Automation Server Licenses
12.4 Adding an Entitlement to Device Administrator

12.4 Adding an Entitlement to Device

Administrator
You add an Entitlement to get a list of the licenses that you can assign.
For more information, see section 12.3 “Automation Server Licensing Workflow”
on page 176.

To Adding an Entitlement to Device Administrator

1. In Device Administrator, click Entitlements.
2. In the Entitlements view, click Entitlements or Product Licenses.
3. Click Add Entitlement.
4. In the Add Entitlements dialog box, type the name of the Entitlement or
click Add Entitlement from file and browse to the Entitlement file.
5. Click OK.

04-40008-03-en, June 2022 IT

177
12 Automation Server Licenses
12.5 Removing an Entitlement

12.5 Removing an Entitlement

You remove unused Entitlements.
For more information, see the Entitlements, Products, and Licenses topic on
WebHelp.

To remove an Entitlement
1. In the Device Administrator, click Entitlements.
2. Click Entitlements.
3. in the Entitlement Contents view, click the Entitlement you want to
remove.
4. Click Delete.
Removed Entitlements can be added again.
NOTE: Removing an Entitlement from Device Administrator does not, in any
way, affect the already activated licenses on the automation servers.

IT 04-40008-03-en, June 2022

178
 12 Automation Server Licenses
12.6 Assigning Licenses

12.6 Assigning Licenses

All licenses must be assigned before they can be activated.
For more information, see section 12.1 “Automation Server Licensing Overview”
on page 173.

To assign licenses
1. In Device Administrator, click Servers.
2. Select Show licenses.
3. In the Assign Licenses view, in the License status column, click the Show
products button .
4. In the Assign column, add the licenses you want to assign.

5. Click the Save current list button .

The licenses must be activated when the assignment is completed for all
automation servers.

04-40008-03-en, June 2022 IT

179
12 Automation Server Licenses
12.7 Activating Licenses Online

12.7 Activating Licenses Online

You activate licenses so that you can access the features.
For more information, see section 12.1 “Automation Server Licensing Overview”
on page 173.
IMPORTANT: Activated licenses cannot be deactivated.

To activate licenses online

1. In Device Administrator, click Servers.
2. Select Show licenses.
3. Select the automation servers where you want to activate the licenses.
4. Click Activate licenses.
5. Click Online.
6. In the Activate Licenses dialog box, click OK.
7. In the Detailed Progress dialog box, view the progress of the activation.
All assigned licenses are now activated.

IT 04-40008-03-en, June 2022

180
 12 Automation Server Licenses
12.8 Offline Activation of Licenses Workflow

12.8 Offline Activation of Licenses Workflow

Use this workflow to activate licenses offline. Offline activation is typically used
when Device Administrator and the automation servers are not connected to the
Internet. Related information can be found in the sections after the flowchart.

Figure: Offline activation of licenses workflow

Create the request files

In Device Administrator, create the request files.
For more information, see section 12.9 “Creating the Request Files” on page 183.

Activate request files on License Activation Server (FNO) to receive

response files
Using Device Administrator, activate request files on License Activation Server
(FNO) to receive response files. To be able to complete this procedure, you must
be on a computer that is connected to License Activation Server (FNO) via the
Internet, and have Device Administrator installed.
For more information, see section 12.10 “Activating Request Files to Receive
Response Files” on page 184.

Send response files to the automation servers

Using Device Administrator, send the response files to the automation server to
complete the license activation.
For more information, see section 12.11 “Sending the Response Files to the
Automation Server” on page 185.

04-40008-03-en, June 2022 IT

181
12 Automation Server Licenses
12.8 Offline Activation of Licenses Workflow

Backup the automation server

After the licenses has been installed, make a backup of the automation server to
make sure that you do not lose the licenses if the automation server crashes.
For more information, see section 27.1 “Backup” on page 497.

IT 04-40008-03-en, June 2022

182
 12 Automation Server Licenses
12.9 Creating the Request Files

12.9 Creating the Request Files

You create request files to request response files with activated licenses from
License Activation Server (FNO).
For more information, see section 12.1 “Automation Server Licensing Overview”
on page 173.

To create the request files

1. In Device Administrator, click Servers.
2. Select Show Licenses.
3. Select the automation servers.
4. Click Activate Licenses.
5. Click Offline Step 1 - Create request files.
6. Click OK.
7. In the Enter File Password, create a password.
8. Click OK.
9. Select a location for the request files.
10. Click Save.

04-40008-03-en, June 2022 IT

183
12 Automation Server Licenses
12.10 Activating Request Files to Receive Response Files

12.10 Activating Request Files to Receive

Response Files
You activate request files on License Activation Server (FNO) to receive
response files. To be able to complete this procedure, you must be on a
computer that is connected to the Internet and have Device Administrator
installed.
For more information, see section 12.1 “Automation Server Licensing Overview”
on page 173.
IMPORTANT: Activated licenses cannot be deactivated.

To activate request files to receive response files

1. In Device Administrator, click Servers.
2. Select Show Licenses.
3. Click Activate licenses.
4. Click Offline Step 2 - Activate request files on License Activation
Server (FNO) to receive response files.
5. Click OK.
6. In the Select the zip file containing the request files you want to
activate box, enter the request file.
7. Enter the password for the request file.
8. In the Select the name and location of the zip file that will contain the
response file, enter a name and a location for the response file.
9. Click Activate.

IT 04-40008-03-en, June 2022

184
 12 Automation Server Licenses
12.11 Sending the Response Files to the Automation Server

12.11 Sending the Response Files to the

Automation Server
You send the request files to the automation servers to complete the offline
activation of licenses.
For more information, see section 12.1 “Automation Server Licensing Overview”
on page 173.

To send response files to the Automation server

1. In Device Administrator, click Servers.
2. Select Show licenses.
3. Select the automation servers.
4. Click Offline Step 3 - Send response files to the selected automation
servers.
5. Click OK.
6. In the Select the zip file that contains the response files you want to
send, enter the response files.
7. Click Send.

04-40008-03-en, June 2022 IT

185
12 Automation Server Licenses
12.12 Automation Server Feature License Strings

12.12 Automation Server Feature License

Strings
The feature strings are used when you troubleshoot a license problem. To see
the strings, you need to log on to the automation server using WorkStation. The
strings are visible under licensemetadata in the System tree.

Table: Automation Server Feature License Strings

Product license Feature string1 Description

SmartDriver smartdriver.license Use this license to allow

SmartDrivers.

SNMP Notifications server.alarms.snmp Use this license to allow

SNMP notifications.

Personal Dashboards client.dashboard Use this license to allow

Personal Dashboards.

Cloud Connectivity server.cloud.customer Use this license to allow the

server to connect to the
cloud using Cloud
Connectivity.

MQTT server.mqtt.r.w Use this license to allow an

MQTT client to read and
write to an MQTT broker.

IT 04-40008-03-en, June 2022

186
 12 Automation Server Licenses
12.13 Adding and Removing License Columns in Device Administrator

12.13 Adding and Removing License Columns

in Device Administrator
You can add and remove license column in Device Administrator to get a better
overview.

To add and remove license columns in Device Administrator

1. In the Device Administrator, right-click in the license columns head.
2. Click Add/Remove columns.
3. Select the columns you want to display.
4. Click OK.

04-40008-03-en, June 2022 IT

187
13 Demo Licenses

Topics
Demo Licensesing Overview
EcoStruxure Building Operation Demo License Management
EcoStruxure Building Operation Demo Licensing Workflow
Activating an EcoStruxure Building Operation Demo License
Removing an EcoStruxure Building Operation Software
Demo License
 13 Demo Licenses
13.1 Demo Licensesing Overview

13.1 Demo Licensesing Overview

Demo licenses are used for demonstration purposes, training, or when building a
site.

13.1.1 EcoStruxure Building Operation Software

Demo Licenses Management
Demo licenses for EcoStruxure Building Operation software are local, bound to
the computer, and cannot be shared.
For more information, see section 13.2 “EcoStruxure Building Operation Demo
License Management” on page 192.

13.1.2 Automation Server Demo License

There are no demo licenses for stand alone automation servers.
To be able to use features on a SpaceLogic device for demonstration purposes,
training, or when building a site, you must use the EcoStruxure Building
Operation Software Demo Licenses. The automation server must be attached to
an Enterprise Server that uses the inherited licenses.
For more information, see section 10.10 “Inherited Licenses” on page 140.

04-40008-03-en, June 2022 IT

191
13 Demo Licenses
13.2 EcoStruxure Building Operation Demo License Management

13.2 EcoStruxure Building Operation Demo

License Management
Demo licenses for EcoStruxure Building Operation software are local, bound to
the computer, and cannot be shared.
The license file used to activate demo licenses can only be used once per
computer and is time-limited. The demo license is installed on License Server
from a license file with the extension .asr. Demo licenses must be activated on
the same computer that runs WorkStation, Enterprise Server or Enterprise
Central.

Figure: A local license is activated on the computer that will use it and cannot be shared
with other computers.

13.2.1 EcoStruxure Building Operation Demo

Licensing Workflow
Use this workflow to add demo licenses for EcoStruxure Building Operation
software running on Windows.
For more information, see section 13.3 “EcoStruxure Building Operation Demo
Licensing Workflow” on page 194.

IT 04-40008-03-en, June 2022

192
 13 Demo Licenses
13.2 EcoStruxure Building Operation Demo License Management

13.2.2 EcoStruxure Building Operation License

Activation
Use the License Administrator on the WorkStation or Enterprise Server
depending of where you want to activate the demo license.

Figure: Activation of demo license on a WorkStation with a demo license file

13.2.3 Demo License Removal

To remove a demo license, use the License Administrator on the WorkStation or
Enterprise Server where the demo license is activated.
For more information, see section 13.5 “Removing an EcoStruxure Building
Operation Software Demo License ” on page 197.

04-40008-03-en, June 2022 IT

193
13 Demo Licenses
13.3 EcoStruxure Building Operation Demo Licensing Workflow

13.3 EcoStruxure Building Operation Demo

Licensing Workflow
Use this workflow to add demo licenses for EcoStruxure Building Operation
software running on Windows.
Related information can be found in the sections after the flowchart.

Figure: Demo licensing workflow

EcoStruxure Building Operation Software Licensing Installation and

Location
Read the setup guide for installation and location for License Server and License
Administrator.
For more information, see section 10.6 “EcoStruxure Building Operation Software
Licensing Installation and Location” on page 130.

Install License Administrator and License Server

Install License Administrator and License Server.
For more information, see section 3.5 “Installing the License Administrator and
the License Server” on page 48.

Start License Administrator

Start License Administrator.
For more information, see section 10.11 “Starting License Administrator” on page
141.

IT 04-40008-03-en, June 2022

194
 13 Demo Licenses
13.3 EcoStruxure Building Operation Demo Licensing Workflow

Activate EcoStruxure Building Operation Software Demo Licenses

Activate the demo licenses.
For more information, see section 13.4 “Activating an EcoStruxure Building
Operation Demo License ” on page 196.

04-40008-03-en, June 2022 IT

195
13 Demo Licenses
13.4 Activating an EcoStruxure Building Operation Demo License

13.4 Activating an EcoStruxure Building

Operation Demo License
You activate EcoStruxure Building Operation demo licenses for demonstration,
training, or when building a site.
For more information, see section 13.1 “Demo Licensesing Overview” on page
191.
NOTE:
• Plan the license management carefully and purchase licenses early to
avoid unexpected operational stops caused by the demo licenses expired
time limit.
• For more information on how to order local licenses for client tools, please
contact your EcoStruxure BMS vendor.
For more information, see section 10.6 “EcoStruxure Building Operation Software
Licensing Installation and Location” on page 130.

To activate an EcoStruxure Building Operation demo license

1. In License Administrator, click the Licenses tab.

2. On the Licenses toolbar, click the Add license from file button .
3. Select the license file and then click Open.
4. Click Close.
5. Click Restart now to restart the License Server and activate the local
license.
The demo license is now activated and WorkStation, client tool, Enterprise
Server or Enterprise Central can start.

IT 04-40008-03-en, June 2022

196
 13 Demo Licenses
13.5 Removing an EcoStruxure Building Operation Software Demo License

13.5 Removing an EcoStruxure Building

Operation Software Demo License
You remove demo licenses after they have expired.

To remove an EcoStruxure Building Operation software demo

license
1. In License Administrator, click the Licenses tab.
2. Select the demo license to remove.

3. On the Licenses toolbar, click the Remove/return license button .

4. Click Yes.
5. Click Close.
6. In the Licenses dialog box, click Restart now, to apply the changes to the
License Server.

04-40008-03-en, June 2022 IT

197
14 Licensing User Interface

Topics
Licenses View
Licenses View Toolbar
Licenses View Columns
Add License Dialog Box
License Activation Dialog Box
License Progress Dialog Box
License Server Address View
Diagnostics View
License Violation Bar
License Information Enterprise Server
License Information Enterprise Central
Add Entitlement Dialog Box
Assign Licenses View
Show Licenses View Toolbar
Entitlements View
Entitlements Contents View
Entitlements Product Licenses View
License Settings Dialog Box
Activate Licenses Dialog Box
 Activate Request Files on License Activation Server (FNO)
14 Dialog Box
Send Response Files to Automation Servers Dialog Box
License Status Bar
Select Columns Dialog Box
 14 Licensing User Interface
14.1 Licenses View

14.1 Licenses View

Use the Licenses view to activate, remove, repair, or list activated licenses on
the License Server.

Figure: Licenses view

Table: Licenses View

Number Description

Use the Licenses view toolbar to activate or

remove licenses. For more information, see
section 14.2 “Licenses View Toolbar” on
page 202.

Use the Licenses view columns to view

information about activated licenses. For
more information, see section 14.3
“Licenses View Columns” on page 203.

Use the Licenses view icons to get

information on different licenses and status.
For more information, see the Licenses
View Icons topic on WebHelp.

04-40008-03-en, June 2022 IT

201
14 Licensing User Interface
14.2 Licenses View Toolbar

14.2 Licenses View Toolbar

Use the Licenses view toolbar to activate, remove, or repair licenses on the
License Server.

Table: Licenses View Toolbar

Button Description

Add license from entitlement ID

Click to activate a license on the License
Server with an entitlement ID.

Add license from file

Click to activate a license on the License
Server from a license file.

Remove/return license
Click to remove local licenses or return
network licenses to the License Activation
Server.

Show log
Click to open the license log file.

Refresh/Reclaim licenses
Click the arrow to refresh or reclaim
licenses.
For more information, see section 9.5
“Reclaim Licenses” on page 117.

IT 04-40008-03-en, June 2022

202
 14 Licensing User Interface
14.3 Licenses View Columns

14.3 Licenses View Columns

Use the Licenses view columns to view information about activated licenses.
Column Description

Product Displays the name of the license product.

Version Displays the version number of the

licenses.

Quantity Displays the amount of licenses that are

activated.

Status Displays the current license status.

Location Displays whether the license is a local or

network license.

Expiration date Displays the date when the license expires.

Software Assurance expiration date Displays the expiration date for a software
subscription.

Creation date Displays the date when the local license file
that was used to activate the local license
was created, or the date when the network
license was activated on the License
Server.

04-40008-03-en, June 2022 IT

203
14 Licensing User Interface
14.4 Add License Dialog Box

14.4 Add License Dialog Box

Use the Add license dialog box to activate licenses from the License Activation
Server with an entitlement ID.

Figure: Add license dialog box

Table: Add License Dialog Box

Component Description

Enter license entitlement ID Type the entitlement ID of the order from

which you want to activate licenses. The
entitlement ID is found on the entitlement
certificate.

IT 04-40008-03-en, June 2022

204
 14 Licensing User Interface
14.5 License Activation Dialog Box

14.5 License Activation Dialog Box

Use the License Activation dialog box to list and to activate licenses from an
entitlement.

Figure: License activation dialog box

Table: License Activation Dialog Box

Component Description

Network License
Indicates that network licenses are
available to activate on the License Server.

Local License
Indicates that local licenses are available to
activate on the License Server or computer.

Product Displays the name of the license.

Version Displays the version number of the license.

Location Displays whether the license is a local

license or a network license.

Quantity Displays the number of licenses tha are

available to activate.

Activate (column) Select the number of licenses to activate.

Activate (button) Click to activate the selected number of

licenses.

04-40008-03-en, June 2022 IT

205
14 Licensing User Interface
14.6 License Progress Dialog Box

14.6 License Progress Dialog Box

Use the License Progress dialog box to view the progress when activating or
removing licenses.

Figure: License progress dialog box

Table: License Progress Dialog Box

Component Description

Network License
Indicates that network licenses are
activated or returned.

Local License
Indicates that local licenses are activated or
removed.

Product Displays the name of the license.

Version Displays the version number of the license.

Quantity Displays the number of licenses to activate

or return.

Progress Displays the progress of the license

activation or return.

Status Displays the status of the activation or

return.

IT 04-40008-03-en, June 2022

206
 14 Licensing User Interface
14.7 License Server Address View

14.7 License Server Address View

Use the License Server Address view to specify the address to the License
Server.

Figure: License Server address view

Table: License Server Address View

Component Description

License server address Type the address to the License Server

where licenses are available for check out.
The address must begin with @. To define
a port number other than the default port
range 27000-27009, type the port number
in front of the @, Port-number@Address.
Use a semicolon to separate addresses.

04-40008-03-en, June 2022 IT

207
14 Licensing User Interface
14.8 Diagnostics View

14.8 Diagnostics View

Use the Diagnostics view to list the licenses with license details located on the
License Server, or local on a WorkStation or Enterprise Server.

Figure: Diagnostic view

Table: Diagnostics View

Button Description

Refresh the list

Click to populate or refresh the diagnostic
list.

Copy to clipboard
Click to copy the diagnostics information to
the clipboard.

IT 04-40008-03-en, June 2022

208
 14 Licensing User Interface
14.9 License Violation Bar

14.9 License Violation Bar

The License Violation bar is displayed when you need more licenses. For more
information, see section 9.2 “License Enforcement” on page 111.

Figure: License violation bar

Table: License Violation Bar

Component Description

Licensing Information Click to open License Manager to get

more information regarding required
licenses.
For more information, see section 14.10
“License Information Enterprise Server ” on
page 210.

Hide Click Hide to hide the License Violation

bar for 8 hours. You can use Hide to hide
the License Violation bar for 7 days. After 7
days, the Hide function is disabled. After 30
days, the bar turns red.

04-40008-03-en, June 2022 IT

209
14 Licensing User Interface
14.10 License Information Enterprise Server

14.10 License Information Enterprise Server

Use License Information to check the licenses for an Enterprise Server and the
attached automation servers.

Figure: License Information

Table: License Information

Property Description

Subserver Displays the license status for the attached

automation servers. For more information,
see section 9.3 “License Information” on
page 112.

[Licenses columns] Display the features that need licenses. For

more information, see section 10.7
“Software and Features that Require
Licenses” on page 132.

IT 04-40008-03-en, June 2022

210
 14 Licensing User Interface
14.11 License Information Enterprise Central

14.11 License Information Enterprise Central

Use the License Information Enterprise Central dialog box to view the status
of the licenses on the Enterprise Central or on the attached Enterprise servers.

Figure: License Information Enterprise Central dialog box

Table: License Information Enterprise Central Dialog Box

Component Description

Select Server Select to view license status for the

Enterprise Central or any Enterprise Server
attached to the Enterprise Server. For more
information, see section 14.10 “License
Information Enterprise Server ” on page
210.

[License column] Display the features that need licenses. For

more information, see section 10.7
“Software and Features that Require
Licenses” on page 132.

04-40008-03-en, June 2022 IT

211
14 Licensing User Interface
14.12 Add Entitlement Dialog Box

14.12 Add Entitlement Dialog Box

Use the Add Entitlement dialog box to add an entitlement to Device
Administrator.

Figure: Add Entitlement dialog box

Table: Add Entitlement Dialog Box

Component Description

Entitlement ID Type the Entitlement ID.

Add Entitlement from file Click to browse to add an entitlement from

a file. The Entitlement file is included in the
e-mail that you receive when you made
your purchase.

IT 04-40008-03-en, June 2022

212
 14 Licensing User Interface
14.13 Assign Licenses View

14.13 Assign Licenses View

Use the Assign Licenses view to assign the available licenses to the automation
servers in the list.

Figure: Assign Licenses view

Table: Assign Licenses View

Number Description

License status column

Current state displays the activated
licenses.
Edit state displays the sum of assigned and
activated licenses.

Show licenses view toolbar

Select to open the Show Licenses View
toolbar. For more information, see section
14.14 “Show Licenses View Toolbar” on
page 215.

Product name column

Displays the products in the Entitlements.
For more information, see the Entitlements,
Products, and Licenses topic on WebHelp.

04-40008-03-en, June 2022 IT

213
14 Licensing User Interface
14.13 Assign Licenses View

Continued
Number Description

Available licenses column

Displays the number of available licenses
for each product.

Assign column
Displays the Assign column where you
assign your available licenses.

Available feature licenses column

Displays the number of available licenses
that is included in each features.

IT 04-40008-03-en, June 2022

214
 14 Licensing User Interface
14.14 Show Licenses View Toolbar

14.14 Show Licenses View Toolbar

Use the Show Licenses view toolbar to manage licenses.

Table: Show Licenses View Toolbar

Button Description

Add Server Click to add an automation server to the

list. For more information, see the Connect
to Automation Servers topic on WebHelp.

Activate Licenses Click to activate the licenses on the

selected automation server. For more
information, see section 12.2 “Assign and
Activate Licenses” on page 175.

License Setting Click to the License Setting dialog box.

For more information, see section 14.18
“License Settings Dialog Box” on page 220.

Refresh License Status Click to refresh license status for the

selected automation servers.

Current state Select to view the current status of the

activated licenses.

Edited state Select to view the the sum of assigned and

activated licenses.

Show licenses Select to show the Show licenses view

toolbar.

04-40008-03-en, June 2022 IT

215
14 Licensing User Interface
14.15 Entitlements View

14.15 Entitlements View

Use the Entitlements view to view entitlements.

Figure: Entitlements view

Table: Entitlements View

Component Description

Add Entitlement Click to add an Entitlement.

For more information, see section 12.1
“Automation Server Licensing Overview” on
page 173.

Add demo license Click to add a demo license.

Refresh all Click to refresh the list of Entitlements.

Entitlement Click on the Entitlement to see the content

of the Entitlement in the Entitlement
Content view. For more information, see
section 14.16 “Entitlements Contents View”
on page 217.

IT 04-40008-03-en, June 2022

216
 14 Licensing User Interface
14.16 Entitlements Contents View

14.16 Entitlements Contents View

Use the Entitlements Contents view to get a list of the available feature license
for every Entitlement in the Device Administrator.

Figure: Entitlements Contents view

Table: Entitlements Contents View

Component Description

Refresh Click to refresh the list of Entitlements.

Delete Click to delete the selected Entitlement and

its products from Device Administrator.

Product name Displays the product name of the product

that contains the licenses in the row for the
product.

Activation ID Displays the activation ID. The activation ID

is unique for the product and cannot be
changed.

[License column] Displays the features that need licenses.

For more information, see section 10.7
“Software and Features that Require
Licenses” on page 132.

Total Displays the total number of licenses for

the product in this Entitlement.

Available Displays the available number of licenses

for the product in this Entitlement.

04-40008-03-en, June 2022 IT

217
14 Licensing User Interface
14.17 Entitlements Product Licenses View

14.17 Entitlements Product Licenses View

Use the Entitlements Product Licenses View to view automation server
licenses.

Figure: Entitlements Product Licenses view

Table: Entitlements Product Licenses View

Component Description

Add entitlement Click to add an Entitlement.

For more information, see section 12.1
“Automation Server Licensing Overview” on
page 173.

Add demo license Click to add a demo license.

For more information, see section 12.1
“Automation Server Licensing Overview” on
page 173.

Refresh all Click to refresh the list.

Product name Displays the product name of the product

that contains the licenses in the row for the
product.

Activation ID Displays the activation ID. The activation ID

is unique for the product and cannot be
changed.

[License column] Displays the features that need licenses.

For more information, see section 10.7
“Software and Features that Require
Licenses” on page 132.

IT 04-40008-03-en, June 2022

218
 14 Licensing User Interface
14.17 Entitlements Product Licenses View

Continued
Component Description

Total Displays the product's total number of

licenses.

Available Displays the product's available number of

licenses for the product that are not
activated.

04-40008-03-en, June 2022 IT

219
14 Licensing User Interface
14.18 License Settings Dialog Box

14.18 License Settings Dialog Box

Use the License Settings dialog box to view the license setting.

Figure: License settings dialog box

Table: License Settings Dialog Box

Component Description

Server address Displays the address to the server

managing the licensing.

User name Displays user name to the server managing

the licensing.

Password Displays the password to the server

managing the licensing.

License model Displays the license model.

Log level Select to log the communication between

automation server and Flex Net Operations
administrator server. Enter 1 to start
logging.
This is only used when trouble-shooting
together with PSS.

IT 04-40008-03-en, June 2022

220
 14 Licensing User Interface
14.19 Activate Licenses Dialog Box

14.19 Activate Licenses Dialog Box

Use the Activate Licenses dialog box to activate licenses on one or many
automation servers.

Figure: Activate Licenses dialog box

Table: Activate Licenses Dialog Box

Component Description

Online Click to activate licenses immediately if

your automation servers are connected to
internet.

Offline Step 1 - Create request files Select to create offline request files. For
more information, see section 12.8 “Offline
Activation of Licenses Workflow” on page
181.

Offline Step 2 - Activate request files on Select to activate the offline request files on
License Activation Server (FNO) to License Activation Server (FNO) to receive
receive response files response files. For more information, see
section 12.8 “Offline Activation of Licenses
Workflow” on page 181.

Offline Step 3 - Send response files to Select to send the response files to the
the selected automation servers selected automation servers. For more
information, see section 12.8 “Offline
Activation of Licenses Workflow” on page
181.

04-40008-03-en, June 2022 IT

221
14 Licensing User Interface
14.19 Activate Licenses Dialog Box

Continued
Component Description

Reclaim licenses Select when you think that your licenses

have been updated with new information,
for example when you extend a
subscription. For more information, see
section 9.5 “Reclaim Licenses” on page
117.

IT 04-40008-03-en, June 2022

222
 14 Licensing User Interface
14.20 Activate Request Files on License Activation Server (FNO) Dialog Box

14.20 Activate Request Files on License

Activation Server (FNO) Dialog Box
Use the Activate Request Files on License Activation Server (FNO) dialog
box for offline activation of licenses.
IMPORTANT: Activated licenses cannot be deactivated.

Figure: Activate request files on License Activation Server (FNO)

Table: Activate Request Files on License Activation Server (FNO)

Component Description

Select the zip file containing the Enter the selected request files to activate.
requested files you want to activate

Select the name and location of the zip Enter the name and location of response
file that will contain the response files files.

Progress Displays the progress of the activation.

Activate Click to activate licenses.

04-40008-03-en, June 2022 IT

223
14 Licensing User Interface
14.21 Send Response Files to Automation Servers Dialog Box

14.21 Send Response Files to Automation

Servers Dialog Box
Use the Send response files to Automation Servers dialog box for offline
activation of licenses.

Figure: Send response files to Automation Servers dialog box

Table: Send Response Files to Automation Servers Dialog Box

Component Description

Select the zip file that contains the Enter the zip file that contains the response
response files you want to send files.

Send Click to send the response files to

Automation Servers.

IT 04-40008-03-en, June 2022

224
 14 Licensing User Interface
14.22 License Status Bar

14.22 License Status Bar

License status bar displays the license status of the automation servers in the
list.
Message Status

Ok License status is ok for all servers.

Uncommitted license assignment One or more servers have uncommitted

license assignments.
You have assigned licenses to your
automation servers, but the licenses need
to be activated.
For more information, see section 12.2
“Assign and Activate Licenses” on page
175.

License violation One or more automation servers have

license violations.
The automation server uses features that
needs licenses. However, there is not
enough licenses activated for the features.
You must assign and activate enough
licenses that covers the relevant features.
For more information, see section 12.2
“Assign and Activate Licenses” on page
175.

Demo license One or more servers are using a demo

license.

04-40008-03-en, June 2022 IT

225
14 Licensing User Interface
14.23 Select Columns Dialog Box

14.23 Select Columns Dialog Box

Use the Select columns dialog box to add and remove license columns in
Device Administrator.

Figure: Select columns dialog box

Table: Select Columns Dialog Box

Component Description

(License columns list) Select the license columns that you want to
be displayed in Device Administrator.

IT 04-40008-03-en, June 2022

226
15 Software Administrator

Topics
Software Administrator
Starting Software Administrator
Configuring Server Port Settings
Starting the Enterprise Central Windows Service
Stopping the Enterprise Central Windows Service
Starting the Enterprise Server or Enterprise Central
Windows Service
Stopping the Enterprise Server Windows Service
Restarting the Enterprise Server Windows Service
Enterprise Server and Enterprise Central System Logs
Viewing the Enterprise Server or Enterprise Central System
Log
Resolving Enterprise Server or Enterprise Central Port
Conflicts
Software Administrator – Enterprise Central View
Software Administrator – Enterprise Server View
 15 Software Administrator
15.1 Software Administrator

15.1 Software Administrator

The Software Administrator installs with the Enterprise Server and Enterprise
Central installation package. You use the Software Administrator to start and stop
the server service and configure the ports of the Enterprise Server and Enterprise
Central.
Other server settings, for example e-mail service, time, and time zone settings
are configured through WorkStation.

15.1.1 Service
The Enterprise Server and Enterprise Central run in the background as Windows
services. You start and stop the server services through the Software
Administrator or Windows Service. Before shutting down a server, make sure the
stop does not negatively affect your site.

15.1.2 Ports
The Enterprise Server and Enterprise Central use HTTP and TCP protocols to
communicate with other servers and clients. In the Software Administrator, you
configure the port number of each protocol the server listens to when
communicating through a specific protocol.
To configure a protocol port number, you first have to stop the running Enterprise
Server or Enterprise Central service.
NOTE: Port changes you have made using Software Administrator are not
automatically updated in the Communication view for EcoStruxure BMS
servers.

15.1.3 Database Location

In the Software Administrator, you find the path to the location where the
Enterprise Server or Enterprise Central write and store data and objects that are
created by either the Enterprise Server, Enterprise Central, or the user.

15.1.4 Enterprise Server and Enterprise Central

System Logs
The Enterprise Server and Enterprise Central System logs contain events logged
by the Enterprise Server or Enterprise Central. Examples of logged events are
startup sequence, port settings, failures, run time, and current server status.

04-40008-03-en, June 2022 IT

229
15 Software Administrator
15.2 Starting Software Administrator

15.2 Starting Software Administrator

You start Software Administrator to be able to configure the port settings of the
Enterprise Server or Enterprise Central.
For more information, see section 15.1 “Software Administrator” on page 229.

To start Software Administrator

1. Click Start, point to All Programs, and then click Schneider Electric
EcoStruxure.
2. Click Building Operation x.x.
3. Click Building Operation Software Administrator.
4. Click Yes to confirm that you want to run Software Administrator.

IT 04-40008-03-en, June 2022

230
 15 Software Administrator
15.3 Configuring Server Port Settings

15.3 Configuring Server Port Settings

You configure server HTTP, HTTPS, and TCP ports to define the communication
of the different protocols. In Software Administrator, you can configure either the
ports of the Enterprise Server or Enterprise Central.
For more information, see section 15.1 “Software Administrator” on page 229.

To configure server ports

1. In Software Administrator, click the tab of the Enterprise Server or
Enterprise Central.
2. Click Stop Service.
3. In the HTTP Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Protocol.
4. In the HTTPS Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Secure Protocol.
5. In the TCP Port box, type the port number that the server listens to when
communicating through the Transmission Control Protocol.
6. Click Start Service.
7. Click OK.

04-40008-03-en, June 2022 IT

231
15 Software Administrator
15.4 Starting the Enterprise Central Windows Service

15.4 Starting the Enterprise Central Windows

Service
You start Enterprise Central manually if it has been stopped.
IMPORTANT: Ensure that you have a working and available license. A
working license is required to start the server. For more information, see
section 10.6 “EcoStruxure Building Operation Software Licensing Installation
and Location” on page 130.
NOTE:
• Enterprise Central is automatically started when installed and when
Windows is started.
For more information, see section 15.1 “Software Administrator” on page 229.

To start the Enterprise Central Windows service

1. In the Software Administrator, click the Enterprise Central tab.
2. Click Start Service.

IT 04-40008-03-en, June 2022

232
 15 Software Administrator
15.5 Stopping the Enterprise Central Windows Service

15.5 Stopping the Enterprise Central

Windows Service
You stop Enterprise Central to configure the port settings or to repair, upgrade,
or reinstall Enterprise Central.
For more information, see section 15.1 “Software Administrator” on page 229.

To stop the Enterprise Central Windows service

1. In Software Administrator, in the Enterprise Central view, click Stop
Service.

04-40008-03-en, June 2022 IT

233
15 Software Administrator
15.6 Starting the Enterprise Server or Enterprise Central Windows Service

15.6 Starting the Enterprise Server or

Enterprise Central Windows Service
You start the server manually in case you previously have stopped it.
IMPORTANT: Ensure that you have a working and available license. A
working license is required to start the server. For more information, see
section 10.6 “EcoStruxure Building Operation Software Licensing Installation
and Location” on page 130.
NOTE:
• Enterprise Server or Enterprise Central are automatically started when
installed and when Windows is started.
For more information, see section 15.1 “Software Administrator” on page 229.

To start the Enterprise Server Enterprise Central Windows

service
1. In the Software Administrator, click the tab of the Enterprise Server or
the Enterprise Central.
2. Click Start Service.

IT 04-40008-03-en, June 2022

234
 15 Software Administrator
15.7 Stopping the Enterprise Server Windows Service

15.7 Stopping the Enterprise Server

Windows Service
You stop the Enterprise Server to configure the port settings or to repair,
upgrade, or reinstall the Enterprise Server.
For more information, see section 15.1 “Software Administrator” on page 229.

To stop the Enterprise Server Windows service

1. In Software Administrator, in the Enterprise Server view, click Stop
Service.

04-40008-03-en, June 2022 IT

235
15 Software Administrator
15.8 Restarting the Enterprise Server Windows Service

15.8 Restarting the Enterprise Server

Windows Service
You restart the Enterprise Server Windows service to reset or apply new settings.
IMPORTANT: Ensure that you have a working and available Enterprise
Server license. A working license is required to start the Enterprise Server.
For more information, see section 10.6 “EcoStruxure Building Operation
Software Licensing Installation and Location” on page 130.
For more information, see section 15.1 “Software Administrator” on page 229.

To restart the Enterprise Server Windows service

1. In the Software Administrator, click the Enterprise Server tab.
2. In the Enterprise Server view, click Stop Service.
3. Click Start Service.

IT 04-40008-03-en, June 2022

236
 15 Software Administrator
15.9 Enterprise Server and Enterprise Central System Logs

15.9 Enterprise Server and Enterprise

Central System Logs
The Enterprise Server and Enterprise Central System logs contain events logged
by the Enterprise Server or Enterprise Central. Examples of logged events are
startup sequence, port settings, failures, run time, and current server status.

04-40008-03-en, June 2022 IT

237
15 Software Administrator
15.10 Viewing the Enterprise Server or Enterprise Central System Log

15.10 Viewing the Enterprise Server or

Enterprise Central System Log
You view logged server events in the Enterprise Server or Enterprise Central
system log to troubleshoot server problems that are traced to the Enterprise
Server or Enterprise Central.
For more information, see section 15.9 “Enterprise Server and Enterprise Central
System Logs” on page 237.

To view the Enterprise Server or Enterprise Central system log

1. In Software Administrator, click the Enterprise Server or Enterprise
Central tab.
2. In the System box, view the events in the system log.
3. Click OK.

IT 04-40008-03-en, June 2022

238
 15 Software Administrator
15.11 Resolving Enterprise Server or Enterprise Central Port Conflicts

15.11 Resolving Enterprise Server or

Enterprise Central Port Conflicts
You resolve Enterprise Server or Enterprise Central port conflicts so that users
can log on to the EcoStruxure BMS.
For more information, see section 15.1 “Software Administrator” on page 229.

To resolve Enterprise Server or Enterprise Central port

conflicts
1. Start Software Administrator.
2. On the Enterprise Server or Enterprise Central tab, click the Stop
Service button.
3. Check the HTTP Port, HTTPS Port, and TCP Port boxes to ensure that
there are no port conflicts indicated by a red border around the port number
box.
4. If necessary, change the conflicting port number.
5. Click the Start Service button.
6. Click OK.

04-40008-03-en, June 2022 IT

239
15 Software Administrator
15.12 Software Administrator – Enterprise Central View

15.12 Software Administrator – Enterprise

Central View
Use the Enterprise Central view to start and stop the Enterprise Central service
and configure the ports of Enterprise Central.

Figure: Enterprise Central view

Table: Enterprise Central View

Component Description

Status Displays the current status of the

Enterprise Central Windows service.

Start Service Click to start Enterprise Central.

Stop Service Click to stop Enterprise Central.

HTTP Port Type the port number that Enterprise

Central listens to when communicating
through the Hypertext Transfer Protocol.

HTTPS Port Type the port number that Enterprise

Central listens to when communicating
through the Hypertext Transfer Protocol
Secure.

TCP Port Type the port number that Enterprise

Central listens to when communicating
through the Transmitting Control Protocol.

System Displays the system log.

IT 04-40008-03-en, June 2022

240
 15 Software Administrator
15.12 Software Administrator – Enterprise Central View

Continued
Component Description

Path Displays the path to the folder where the

Enterprise Central database and other
objects created by Enterprise Central or
users are stored.

A warning indicates that you entered a

conflicting port number or that the service is
stopping.

04-40008-03-en, June 2022 IT

241
15 Software Administrator
15.13 Software Administrator – Enterprise Server View

15.13 Software Administrator – Enterprise

Server View
Use the Enterprise Server view to start and stop the Enterprise Server service
and configure the ports of the Enterprise Server.

Figure: Enterprise Server view

Table: Enterprise Server View

Component Description

Status Displays the current status of the

Enterprise Server Windows service.

Start Service Click to start the Enterprise Server.

Stop Service Click to stop the Enterprise Server.

HTTP Port Type the port number that the Enterprise

Server listens to when communicating
through the Hypertext Transfer Protocol.

HTTPS Port Type the port number that the Enterprise

Server listens to when communicating
through the Hypertext Transfer Protocol
Secure.

TCP Port Type the port number that the Enterprise

Server listens to when communicating
through the Transmitting Control Protocol.

System Displays the system log.

IT 04-40008-03-en, June 2022

242
 15 Software Administrator
15.13 Software Administrator – Enterprise Server View

Continued
Component Description

Path Displays the path to the folder where the

Enterprise Server database and other
objects created by the Enterprise Server or
users are stored.

A warning indicates that you entered a

conflicting port number or that the service is
stopping.

04-40008-03-en, June 2022 IT

243
16 User Account Management

Topics
User Account Management Overview
Opening the Account Management Control Panel
User Accounts and User Account Groups
Creating a User Account
Editing a User Account Profile
Renaming a User Account
Disabling a User Account
Enabling a Disabled User Account
Setting an Expiration Date for a User Account
Removing the Expiration Date for a User Account
Deleting a User Account
Automatic Logoff
Setting the Automatic Logoff Time
Guest User Account
Automatic Logoff to Guest Account
Configuring a User Account Group to Log off to the Guest
User Account
Configuring a User Account Group to Only Use Classic
Mode for Function Block Programs
 16 User Account Management
16.1 User Account Management Overview

16.1 User Account Management Overview

When logging on to an EcoStruxure BMS server, you have to authenticate
yourself by using a valid user account. The user account has to belong to the
same domain as the server you log on to.
The user account has to be a member of at least one user account group or be
mapped through an active directory user account group. To restrict the user,
software permissions are added to the user account group or to the individual
user account. One or more customized workspaces can be connected to the user
account group.
When logging on to the EcoStruxure BMS server that acts as the domain
controller, in this example an Enterprise Server, you have access to all
EcoStruxure BMS servers in the domain without using additional log on. If you log
on to an individual EcoStruxure BMS server you have no access to other
EcoStruxure BMS servers in the domain.

Figure: To log on to an EcoStruxure BMS server you have to use a valid user account that
is located in the same domain as the EcoStruxure BMS server.

The EcoStruxure BMS considers a user account valid when:

• The user account exists
• The user account is not disabled or expired
• The user account belongs to a user account group or mapped active
directory user group

04-40008-03-en, June 2022 IT

247
16 User Account Management
16.1 User Account Management Overview

• The user account group belongs to a domain

• The user account has defined software permissions, either defined on the
individual account or inherited from the user account group

16.1.1 User Accounts and User Account Groups

A user account can be a member of one or more user account groups and
belongs to a particular domain.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

16.1.2 Domains
An EcoStruxure Building Operation domain contains user accounts, user account
groups, software permissions, workspaces, and one or several EcoStruxure BMS
servers. The EcoStruxure BMS server that hosts and administers the domain is
called the domain controller.
For more information, see section 18.1 “Domains” on page 289.

16.1.3 Software Permissions

Software permissions are used to manage privileges that user account groups
and user accounts own to objects in Building Operation software. In the
EcoStruxure Building Operation software, you can assign two types of software
permissions to user account groups and user accounts: path permissions and
command permissions. You can also assign extended permissions to all the
instances of folder structure or of a custom type.
For more information, see section 19.1 “Software Permissions” on page 307.

16.1.4 Log on Methods

The EcoStruxure BMS provides two methods to log on to the system. Either you
log on as a Windows User with your Windows Active Directory user account or as
EcoStruxure Building Operation user with your EcoStruxure Building Operation
user account.
For more information, see section 18.2 “Log On Methods” on page 293.

16.1.5 Workspace Management

The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted different tasks for user accounts or user
account groups.
For more information, see section 21.1 “Workspace Management” on page 361.

IT 04-40008-03-en, June 2022

248
 16 User Account Management
16.1 User Account Management Overview

16.1.6 Automatic Logoff

The automatic logoff function makes it possible for the system to automatically
log off a user after a specified time of inactivity.
For more information, see section 16.12 “Automatic Logoff” on page 262.

16.1.7 Guest User Account

You create a Guest user account when you need a limited view of the system that
does not require any log on.
For more information, see section 16.14 “Guest User Account” on page 264.

16.1.8 Automatic Logoff to Guest Account

You can configure a user group to automatically log on to the Guest user account
when a user account that belongs to the group is manually or automatically
logged off.
For more information, see section 16.15 “Automatic Logoff to Guest Account” on
page 265.

16.1.9 Guest Log On in WebStation

A guest logon is used when you want the user to get immediate access to the
EcoStruxure Building Operation software using WebStation.
For more information, see the Guest Logon in WebStation topic on WebHelp.

04-40008-03-en, June 2022 IT

249
16 User Account Management
16.2 Opening the Account Management Control Panel

16.2 Opening the Account Management

Control Panel
You open the Account Management control panel in the Work area to create and
configure EcoStruxure Building Operation objects.
For more information, see the Control Panel topic on WebHelp.

To open the Account Management control panel

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.

IT 04-40008-03-en, June 2022

250
 16 User Account Management
16.3 User Accounts and User Account Groups

16.3 User Accounts and User Account

Groups
A user account can be a member of one or more user account groups and
belongs to a particular domain.

User Accounts
A user account uniquely identifies a user to the system. When setting up user
accounts, keep the following points in mind:
• Configure as few settings as possible at the user account level.
• Assign a required user name and password, which the system uses for
identification and authentication purposes. For more information, see section
20.1 “Password Administration” on page 343.
• The user account is unique within the domain it belongs to. For example, an
admin user account is located in Domain A. This account cannot be used to
administrate Domain B. For more information, see section 18.1 “Domains”
on page 289.
• Manage accounts at the domain level using a default administrator account.
For more information, see section 18.11 “Administration Accounts in
EcoStruxure BMS Server Local Domain” on page 303.
• Track user activity at the user-account level. For more information, see
section 22.2 “Audit Trailing of User Activity” on page 390.

User Account Groups

A User Account Group can contain both user accounts and other user account
groups. To facilitate the creation and administration of users, assign software
permissions and workspaces to user account groups instead of individual user
accounts.
In this example, Paul is a member of the Janitor group and the Administrator
group. His account inherits the software permissions and workspaces of both
groups. Susan is a member of the Administrator group and inherits the software
permissions and workspaces of the Administrator group.

04-40008-03-en, June 2022 IT

251
16 User Account Management
16.3 User Accounts and User Account Groups

Figure: A user account belongs to a domain and is a member of one or more user account
groups

NOTE:
• Although user accounts are members of user account groups, they are
not physically stored in user account groups. Instead, user accounts and
user account groups are parallel entities so that individual accounts can
be members of one or more groups.

16.3.1 Windows Active Directory User Groups

You can map Windows Active Directory groups to EcoStruxure Building
Operation user account groups if the EcoStruxure Building Operation software
runs on a network that uses this directory to manage users and user account
groups. An EcoStruxure Building Operation user account group that includes a
Windows account group can be member of another EcoStruxure Building
Operation user account group.
For more information, see section 17.1 “Windows Active Directory User Groups”
on page 271.

IT 04-40008-03-en, June 2022

252
 16 User Account Management
16.3 User Accounts and User Account Groups

16.3.2 WorkStation Account Management

As a WorkStation administrator, you can change passwords, track user activities,
validate accounts, and set up user and user and user group accounts.
For more information, see section 22.1 “WorkStation Account Management” on
page 389.

04-40008-03-en, June 2022 IT

253
16 User Account Management
16.4 Creating a User Account

16.4 Creating a User Account

You create and configure a user account for each person requiring access to the
EcoStruxure BMS.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To create a user account

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain box, select the domain the account is to be created in.
5. In the User Accounts area, click Add.
6. In the Create Object wizard, in the Name box, type a name for the user
account.
7. In the Description box, type a description.
8. Click Next.
9. In the General page, in the First name box, type the user's name.
10. In the Middle name box, type the user's middle name.
11. In the Last name box, type the user's last name.
12. In the Home email address box, type the user's email address.
13. In the Work email address, type the users work email address.
14. In the Expires on box, enter a date and time when the user account expires
or leave these fields empty if you do not want the user account to expire.
15. In the Password box, type a password for the user.
NOTE: The password is validated against the criteria for passwords in
the EcoStruxure Building Operation software.
16. In the Confirm Password box, type the password again.
17. Click Create.
18. Click OK.

IT 04-40008-03-en, June 2022

254
 16 User Account Management
16.5 Editing a User Account Profile

16.5 Editing a User Account Profile

You edit the profile information of a user account so that it is up-to-date with the
user's current situation.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To edit a user account profile

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In Domain Control Panel, in the Domain box, select the domain the user
account belongs to.
5. In the User Accounts list box, select the user account you want to edit the
profile information.
6. Click Summary.
7. Click the Profile tab.
8. Edit the user account profile information.

9. Click the Save button .

04-40008-03-en, June 2022 IT

255
16 User Account Management
16.6 Renaming a User Account

16.6 Renaming a User Account

You rename a user account, for example, to update the user account according
to a user's new name. Renaming the account does not affect the account's
membership in user account groups.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To rename a user account

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Account Management Control Panel, click List users.
5. In the Users dialog box, select the user account you want to rename.
6. On the Edit menu, click Rename.
7. In the Rename Object dialog box, in the Object Name box, type a new
name for the user account.
8. Click OK.

IT 04-40008-03-en, June 2022

256
 16 User Account Management
16.7 Disabling a User Account

16.7 Disabling a User Account

You disable a user account to prevent the user from accessing WorkStation.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To disable a user account

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Account Managerment Control Panel, in the Domain list, select the
domain the user account belongs to.
5. In the User Accounts list, select the user account you want to disable.
6. Click Summary.
7. In the Summary tab, in the Disabled box, select True to disable the
account.

8. Click the Save button .

04-40008-03-en, June 2022 IT

257
16 User Account Management
16.8 Enabling a Disabled User Account

16.8 Enabling a Disabled User Account

You enable a disabled user account to give the user access to WorkStation.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To enable a disabled user account

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list, select the domain the user account belongs to.
5. In the User Accounts list, select the user account.
6. Click Summary.
7. In Summary tab, in the Disabled box, select False to enable the account.
8. On the File, click Save.

IT 04-40008-03-en, June 2022

258
 16 User Account Management
16.9 Setting an Expiration Date for a User Account

16.9 Setting an Expiration Date for a User

Account
You set an expiration date for an account to limit the time period a user has
access to WorkStation.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To set an expiration date for a user account

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list, select the domain the user account belongs to.
5. In the User Accounts list, select the user account.
6. Click Summary.
7. In the Summary tab, in the Expires on boxes, select the date and the time
when you want the user account to expire.

8. Click the Save button .

04-40008-03-en, June 2022 IT

259
16 User Account Management
16.10 Removing the Expiration Date for a User Account

16.10 Removing the Expiration Date for a User

Account
You remove the expiration date for a user account so that there is no time limit for
how long a user can access WorkStation.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To remove the expiration date for a user account

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list, select the domain the user account belongs to.
5. In the User Accounts list, select the user account.
6. Click Summary.
7. In the Summary tab, in the Expires on boxes, remove the date and time
settings for the account.
8. On the File menu, click Save.

IT 04-40008-03-en, June 2022

260
 16 User Account Management
16.11 Deleting a User Account

16.11 Deleting a User Account

You delete a user account, for example, if an employee has left the company. All
references to other EcoStruxure Building Operation objects are deleted.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To delete a user account

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Account Management Control Panel, in the Domain list box, select
the domain the user account belongs to.
5. In the User Accounts list box, select the user account you want to delete.

6. Click the Delete button .

7. In the Confirm Delete dialog box, click Yes.

04-40008-03-en, June 2022 IT

261
16 User Account Management
16.12 Automatic Logoff

16.12 Automatic Logoff

The automatic logoff function makes it possible for the system to automatically
log off a user after a specified time of inactivity.
Inactivity means that no user-initiated activity using the mouse or keyboard has
been made. However, if a user has has started a large task in Workstation, for
example an import or a large copy and paste, the user is still considered to be
active as long as the process is ongoing in Workstation.
The automatic logoff function increases security and ensures that WorkStation
users do not occupy licenses they are not using.
When a user is logged off by the automatic logoff function all settings that are not
saved are lost.
The automatic logoff time is set at user group level. If a user belongs to more
than one group, the automatic logoff time for the user is defined by the group that
has the longest automatic logoff time.
For example, a user belongs to two groups: a group with the automatic logoff
time of five minutes and a group with the automatic log off time of 15 minutes.
The automatic logoff time for the user is 15 minutes.
If a user is belongs to a group that does not have the automatic log off function
enabled, the user is never logged off.
The default local admin account is logged off after ten minutes of inactivity. You
cannot change this setting.

IT 04-40008-03-en, June 2022

262
 16 User Account Management
16.13 Setting the Automatic Logoff Time

16.13 Setting the Automatic Logoff Time

Use the automatic logoff function to avoid access by unauthorized users and
ensure that WorkStation users do not occupy a license they are not using.
For more information, see section 16.12 “Automatic Logoff” on page 262.

To set the automatic logoff time

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Server list, select the EcoStruxure BMS server containing the user
account group you want to set the auto log off time for.
5. In the Domain list, select the domain the user account group belongs to.
6. In the User Account Groups list, select the user account group.
7. Click Policies.
8. Select Automatic logoff and then select the number of minutes a user in
the user account group can be idle before being logged off.

04-40008-03-en, June 2022 IT

263
16 User Account Management
16.14 Guest User Account

16.14 Guest User Account

You create a Guest user account when you need a limited view of the system that
does not require any log on.
The Guest user account is created in the Users folder of the default domain in the
System Tree pane. There can only be one Guest user account. You can rename
the Guest user account. The password for the Guest user account is
preconfigured and cannot be changed. The password for the Guest user account
never expires. You can disable the Guest user account when needed.
The Guest user account is used by both WebStation and WorkStation.
If the security banner is enabled the guest log on cannot be used. For more
information, see the Security Banner topic on WebHelp.
You can set the policies for a user account group to log on to the Guest user
account when a user account that belongs to the group is logged off. When
logging off from the Guest user account, you log off to another user account. For
more information, see section 16.15 “Automatic Logoff to Guest Account” on
page 265.
If the EcoStruxure Building Operation software fails to auto log on using the
Guest user account, no event is generated.

IT 04-40008-03-en, June 2022

264
 16 User Account Management
16.15 Automatic Logoff to Guest Account

16.15 Automatic Logoff to Guest Account

You can configure a user group to automatically log on to the Guest user account
when a user account that belongs to the group is manually or automatically
logged off.
When the user account is logged off, the Guest user account logs on to the same
server on the default domain. The workspace configured for the Guest user
account is displayed and the user account has the permissions that you have
configured for the Guest user account.
If a user account belongs to several user account groups and at least one of them
is configured for automatic logoff to guest account, the user is automatically
logged on to the Guest user account when the original user account is logged off.
If the Guest user account group is configured for automatic logoff to guest
account, the Guest user account group is logged off to the log on screen when
the Guest user account is manually or automatically logged off.

04-40008-03-en, June 2022 IT

265
16 User Account Management
16.16 Configuring a User Account Group to Log off to the Guest User Account

16.16 Configuring a User Account Group to

Log off to the Guest User Account
Use the Logoff to guest account function when you want to keep monitoring
certain functions in your EcoStruxure BMS even though the logged on user
account is manually or automatically logged off.
For more information, see section 16.15 “Automatic Logoff to Guest Account” on
page 265.

To configure a user account group to log off to the Guest user

account
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Server list, select the EcoStruxure BMS server containing the user
account group for which you want to configure the Logoff to guest account
property.
5. In the Domain list, select the domain the user account group belongs to.
6. In the User Account Groups list, select the user account group.
7. Click the Policies tab.
8. Select On logoff switch to guest account.
9. On the File menu, click Save.
When a logged on user account that belongs to a user account group with the
'Log off to guest account' property selected is manually or automatically logged
off, the Guest user account on the default domain automatically logs on.

IT 04-40008-03-en, June 2022

266
 16 User Account Management
16.17 Configuring a User Account Group to Only Use Classic Mode for Function Block Programs

16.17 Configuring a User Account Group to

Only Use Classic Mode for Function
Block Programs
You configure a user account group to only allow the use of classic function block
editor and views and turn off the possibility to use Builder for Function Block.

To configure a user account group to only use classic mode

for Function Block programs
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server.
2. In the Control Panel tab, select Account management.
3. In the Server list, select the EcoStruxure BMS server.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Policies.
7. Select “Only use classic mode for Function Block Programs”.
8. Click Save.

04-40008-03-en, June 2022 IT

267
17 User Account Groups

Topics
Windows Active Directory User Groups
Creating a User Account Group
Editing the Description of a User Account Group
Adding a User Account to a User Account Group
Removing a User Account from a User Account Group
Reviewing the User Account Group Memberships for a User
Account
Adding a User Account Group to a User Account Group
Removing a User Account Group from another User Account
Group
Reviewing the User Account Group Memberships for a User
Account Group
Preventing a Group of Users from Exiting WorkStation
Enabling a Group of Users to Exit WorkStation
Deleting a User Account Group
Syntax for IP Address Allow List
 17 User Account Groups
17.1 Windows Active Directory User Groups

17.1 Windows Active Directory User Groups

You can map Windows Active Directory groups to EcoStruxure Building
Operation user account groups if the EcoStruxure Building Operation software
runs on a network that uses this directory to manage users and user account
groups. An EcoStruxure Building Operation user account group that includes a
Windows account group can be member of another EcoStruxure Building
Operation user account group.
You can map Windows Active Directory universal and global groups to
EcoStruxure Building Operation user groups, but you cannot map Windows
Active Directory domain local user groups.
Mapping Windows Active Directory account groups to EcoStruxure Building
Operation user account groups has advantages both for administrators and
operators. Administrators can manage the user accounts in the Windows Active
Directory, rather than managing the accounts in two places. Any changes are
instantly implemented to the mapped EcoStruxure Building Operation user
account group. Operators only have to remember the Windows login. Once
logged in to a Windows user account that is mapped to an EcoStruxure Building
Operation account, the user is authenticated to access WorkStation without
having to log in a second time.
NOTE:
• Windows Active Directory account groups can only be mapped on
EcoStruxure BMS servers that are running on Microsoft Windows
operating system. Automation servers cannot map Windows Active
Directory groups.
For example, the Windows Active Directory user account groups Main Admin and
Main User are mapped to the EcoStruxure Building Operation user account
groups Administrators and External Users. The External Users user account
group is a member of the Operator user account group. The Administrators
account group, which is a member of the External Users, inherits access to the
Operator workspace.
IMPORTANT: If several Windows Active Directory account groups have the
same name, any EcoStruxure Building Operation user account group
mapped to one of these groups will also be mapped to the other Windows
Active Directory account groups with the same name.

04-40008-03-en, June 2022 IT

271
17 User Account Groups
17.1 Windows Active Directory User Groups

Figure: Windows Active Directory user account groups mapped to WorkStation user
account groups

The default account for running the Enterprise Server service or Enterprise
Central service is the Windows Local System account. The Windows Local
System account has sufficient permissions for accessing the Active Directory by
default.
Make sure that the Enterprise Server service or Enterprise Central service
account has sufficient access permissions to read all user groups necessary in all
locations in the Active Directory in order to be able to log on to the Enterprise
Server or Enterprise Central using the Windows authentication.

IT 04-40008-03-en, June 2022

272
 17 User Account Groups
17.2 Creating a User Account Group

17.2 Creating a User Account Group

You create a user account group to make it easier to manage users who require
the same software permissions and workspaces.
For more information, see section 19.29 “Software Permissions, User Accounts,
and User Account Groups” on page 337.

To create a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain box, select the domain where you want to create the user
account group.
5. In the User Account Groups area, click Add.
6. In the Create Object wizard, in the Name box, type a name for the user
account group.
7. In the Description box, type a description for the user account group.
8. Click Next.
9. In the Users Belonging to this Group page, in the Select from box, select
a user account group to auto select the user accounts belonging to that
group in the Available User Accounts list.
10. In the Available User Accounts list, select the user accounts you want to
add to the user account group.

11. Click the Add button .

12. Click Next.
13. In the Workspaces Belonging to this Group page, in the Select from box,
select a user account group to auto select the workspaces assigned to that
group in the Selected Workspaces list box.
14. In the Available Workspaces box, select the workspaces you want to add
to the user account group.

15. Click the Add button .

16. Click Next.
17. In the Windows Group Name and Group Policies page, select the User
Interactivity check box to enable the user account group members to close
the WorkStation software.
18. Select the Audit Trailing check box to activate actions logging for the user
account group members.
19. Select the Password check box to enable the user account group members
to change their own passwords.
20. Select the Web Configuration check box to enable the user account group
members to log on to automation servers' Web configuration sites.
Continued on next page

04-40008-03-en, June 2022 IT

273
17 User Account Groups
17.2 Creating a User Account Group

21. Select the Personal Favorites check box to enable the user account group
members to create personal favorites and a personal overview of their
system.
22. Select the Personal Dashboards check box to enable the user account
group members to create personal dashboard. For more information, see
the How Dashboards Work topic on WebHelp.
23. In the Automatic Logoff drop-down list box, select a time if you want the
user account group members to be logged off after a defined time of
inactivity. For more information, see section 16.12 “Automatic Logoff” on
page 262.
24. Select the Log Off To Guest Account check box to automatically log on to
the Guest user account after a user account group member has been
manually or automatically logged off. For more information, see section
16.15 “Automatic Logoff to Guest Account” on page 265.
25. In the IP Address Allow List box, type IP addresses or ranges of IP
addresses that can be used for log on by the user account group members.
For more information, see section 17.13 “Syntax for IP Address Allow List”
on page 285.
26. In the Activation Schedule browse box, browse to the multistate schedule
regulating the user account group members access hours.
27. In the Schedule Value When Active spin box, choose the value
corresponding to the user account group members access hours.
28. In the Windows Group Name box, select the Windows Active Directory
user account group you want to map to the EcoStruxure Building Operation
user account group.
IMPORTANT: You can map Windows Active Directory universal and
global account groups to EcoStruxure Building Operation user account
groups, but you cannot map Windows Active Directory domain local
user account groups.
NOTE: To connect a Windows Active Directory user account group to
an EcoStruxure Building Operation user account group, you need to
establish the connection between the EcoStruxure Building Operation
domain and Active Directory Windows domain. For more information,
see section 18.3 “Creating and Configuring a Domain” on page 294.
Windows Active Directory account groups can only be mapped on
EcoStruxure BMS servers that are running on Microsoft Windows
operating system. Automation servers cannot map Windows Active
Directory groups.
29. Select the Zoning check box to allow the user account group members to
perform zoning actions.
30. Select the Change Control check box to enable user account group
members to add comments and sign changes made in the system. For more
information, see the Change Control topic on WebHelp.
31. Select the User Settings check box to enable user account group members
to display invalid objects in WorkStation.
32. Select the User Settings check box to enable user account group members
to receive session notifications in WorkStation.
33. Click Create.

IT 04-40008-03-en, June 2022

274
 17 User Account Groups
17.3 Editing the Description of a User Account Group

17.3 Editing the Description of a User

Account Group
You edit the description of a user account group to reflect changes in the
organization.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To edit the description of a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain Control Panel, in the Domain list, select the domain the user
account group belongs to.
5. In the User Account Groups list, select the user account group you want to
edit the description for.
6. Click Summary.
7. In the Summary tab, in the Description box, type a new description for the
user account group.

8. Click the Save button .

04-40008-03-en, June 2022 IT

275
17 User Account Groups
17.4 Adding a User Account to a User Account Group

17.4 Adding a User Account to a User

Account Group
You add a user account to a user account group to add software permissions and
workspaces to a user.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To add a user account to a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain Control Panel, in the Domain list, select the domain the
user account belongs to.
5. In the User Accounts list, select the user account you wish to add to a user
account group.
6. Click Group membership.
7. In the User Account Group Membership tab, in the Available User
Account Groups list, select a user account group and click the Add button

.
8. On the File menu, click Save.

IT 04-40008-03-en, June 2022

276
 17 User Account Groups
17.5 Removing a User Account from a User Account Group

17.5 Removing a User Account from a User

Account Group
You remove a user account from a user account group to limit the users
permissions to objects and commands.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To remove a user account from a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Account Management Control Panel, in the Domain list, select the
domain the user account belongs to.
5. In the User Accounts list, select the user account.
6. Click Group membership.
7. In the Group Membership tab, in the Selected User Account Groups list,
select the user account group you want to remove, and click the Remove

button .
8. On the File menu, click Save.

04-40008-03-en, June 2022 IT

277
17 User Account Groups
17.6 Reviewing the User Account Group Memberships for a User Account

17.6 Reviewing the User Account Group

Memberships for a User Account
You review the user account group membership for a user account to determine
where a user account inherits its settings, either through direct or indirect
membership in user account groups.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To review the group memberships for a user account

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list, select the domain the user account belongs to.
5. In the User Account list, select the user account.
6. Click Group membership.

IT 04-40008-03-en, June 2022

278
 17 User Account Groups
17.7 Adding a User Account Group to a User Account Group

17.7 Adding a User Account Group to a User

Account Group
You add an user account group to a user account group to easier administrate
the settings for a group of users. User account groups inherit the settings of the
user account groups they are members of.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To add a user account group to a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Account Management Control Panel, in the Domain list, select the
domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Group membership.
7. In the Available User Account Groups list, select the user account group

you want to add the user account group to and click the Add button .

8. Click the Save button .

04-40008-03-en, June 2022 IT

279
17 User Account Groups
17.8 Removing a User Account Group from another User Account Group

17.8 Removing a User Account Group from

another User Account Group
You remove a user account group from a user account group, for example, if the
user account group does not anymore meet the required software permission.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To remove a user account group from another user account

group
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Account Management Control Panel, in the Domain list, select the
domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Group membership.
7. In the Group Membership tab, in the Selected User Account Groups list,
select the user account group you are removing the user account group

from and click the Remove button .

8. On the File menu, click Save.

IT 04-40008-03-en, June 2022

280
 17 User Account Groups
17.9 Reviewing the User Account Group Memberships for a User Account Group

17.9 Reviewing the User Account Group

Memberships for a User Account Group
You review the user account group memberships for a user account group as a
way of determining where a user account inherits its settings through direct or
indirect membership in user account groups.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To review the user account group memberships for a user

account group
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Group Membership.

04-40008-03-en, June 2022 IT

281
17 User Account Groups
17.10 Preventing a Group of Users from Exiting WorkStation

17.10 Preventing a Group of Users from

Exiting WorkStation
You prevent a group of users from exiting WorkStation to make sure that
WorkStation is not closed on a permanent EcoStruxure BMS computer. This
feature must be disabled for all user account groups the user is a member of.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To prevent a group of users from exiting WorkStation

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Policies.
7. In the Policies tab, clear the Allow members to close WorkStation box.

8. Click the Save button.

IT 04-40008-03-en, June 2022

282
 17 User Account Groups
17.11 Enabling a Group of Users to Exit WorkStation

17.11 Enabling a Group of Users to Exit

WorkStation
You enable a group of users to exit WorkStation. To enable a user to exit
WorkStation you only have to configure one of the user account groups that the
user is member of.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To enable a group of users to exit WorkStation

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Policies.
7. In the Policies tab, select the Allow members to close WorkStation box.
8. On the File menu, click Save.

04-40008-03-en, June 2022 IT

283
17 User Account Groups
17.12 Deleting a User Account Group

17.12 Deleting a User Account Group

You delete a user account group to reflect changes in the way users are set up
and assigned software permissions.
For more information, see section 16.3 “User Accounts and User Account
Groups” on page 251.

To delete a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain Control Panel, in the Domain list, select the domain the
user account group belongs to.
5. In the User Account Groups list, select the user account group you want to
delete.

6. Click the Delete button .

7. In the Confirm Delete dialog box, click Yes.

IT 04-40008-03-en, June 2022

284
 17 User Account Groups
17.13 Syntax for IP Address Allow List

17.13 Syntax for IP Address Allow List

You configure the Allow list to allow access only from specific IP addresses or
from ranges of IP addresses. If nothing is configured, then all IP addresses are
allowed.
You can use two different syntax for lists of IP addresses:
• A list of line separated IP addresses:
192.168.0.1
127.0.0.1
• A range of IP addresses in CIDR notation on one or many lines:
10.0.0.0/8
10.0.0.0/16
You can also use a combination of both.
NOTE: EcoStruxure BMS does not accept other syntax for specifying IP
range, eg. 10.0.0.0 - 10.0.0.255

04-40008-03-en, June 2022 IT

285
18 Domains

Topics
Domains
Log On Methods
Creating and Configuring a Domain
Editing the Windows Domain Name
Editing the Description of a Domain
Editing the Maximum Logon Attempts
Assigning an Automation Server to a Domain
Removing an Automation Server from a Domain
Deleting a Domain
Unify Domains in the Server Structure Workflow
Administration Accounts in EcoStruxure BMS Server Local
Domain
 18 Domains
18.1 Domains

18.1 Domains
An EcoStruxure Building Operation domain contains user accounts, user account
groups, software permissions, workspaces, and one or several EcoStruxure BMS
servers. The EcoStruxure BMS server that hosts and administers the domain is
called the domain controller.
Normally, a user account or user account group that is a member of a domain
that hosts several EcoStruxure Building Operation servers has access to all
servers within the domain without additional logon. The user account or user
account group can have restricted path permissions preventing the user to
access the servers.
You can set up domains in several ways. You can have a communication domain
that only contains EcoStruxure Building Operation servers and another domain
that contains users, workspaces, and software permissions. Or you can have a
combined domain that manages both servers and users.
NOTE: An EcoStruxure Building Operation server can belong to more than
one domain.
For example, an EcoStruxure BMS consists of two domains, the Inner City
domain and the Outer city domain. The user Larry has a user account in the Inner
City domain. The Inner City domain contains several Enterprise Servers and
automation servers. One of the automation servers belongs to both the Inner City
domain and the Outer City domain. Larry cannot access the servers in the Outer
City domain, except for the shared automation server.

04-40008-03-en, June 2022 IT

289
18 Domains
18.1 Domains

Figure: EcoStruxure Building Operation domain and its components.

NOTE: You cannot change the name of a domain that is shared between
EcoStruxure BMS servers.
If you add an Enterprise Server to an Enterprise Central and want to create a
user domain in Enterprise Central with the same name as already exist in any
Enterprise Server, you must remove the domain in the Enterprise Server first so
that it does not interfere with the new. It is possible to export a domain and import
it in the Enterprise Central.
If you want to add automation servers to a domain created in an Enterprise
Central, then you must first add the Enterprise server to the domain and then log
on to the Enterprise server and add the automation server to the domain there.
If an Enterprise Server is a member of an Enterprise Central domain, you add
automation servers to the same domain from the Enterprise Server domain
membership.

IT 04-40008-03-en, June 2022

290
 18 Domains
18.1 Domains

18.1.1 Windows Active Directory Domain

If your domain controller is within a network that has a Windows Active Directory,
you can establish a connection between your EcoStruxure Building Operation
domain and the Windows Active Directory. This connection enables inherited
user account groups from the Windows Active Directory to EcoStruxure Building
Operation software, and allows users to log on to WorkStation with their Windows
user accounts.
Do not name an EcoStruxure Building Operation domain with the same name as
any Windows domain in your network. An EcoStruxure Building Operation
domain and a Windows domain in your network that are named in the same way
can cause conflicts when you use an integrated Windows log on for the
EcoStruxure Building Operation domains.
IMPORTANT: If the Windows Active Directory name is changed, you have
to manually update the change in EcoStruxure Building Operation software.
EcoStruxure Building Operation software supports Fully Qualified Domain
Name (FQDN) and NetBIOS name. The NetBIOS name is displayed in the Log
on screen even if FQDN is used as a log on method.

18.1.2 Server Local Domain

By default, all servers have a local domain that includes a local administrator
account, administrator user account group, and administrator workspace. The
local domain of a server cannot hold an EcoStruxure Building Operation multi-
server system. When logging on to the local domain of a server, you access only
the unique server.
A local domain and its content cannot be deleted, edited or include other
EcoStruxure Building Operation servers.
IMPORTANT: On a Local domain, you cannot view bound values from an
EcoStruxure BMS server higher or on the same tier in the EcoStruxure BMS
hierarchy.

18.1.3 Unify Domains in the Server Structure

Workflow
Use this workflow to unify domains and to make sure all the servers have the
same domain after you add an Enterprise Central to your system. Related
information can be found in the sections after the flowchart.
For more information, see section 18.10 “Unify Domains in the Server Structure
Workflow ” on page 301.

04-40008-03-en, June 2022 IT

291
18 Domains
18.1 Domains

18.1.4 Administration Accounts in Server Local

Domain
You can manage user accounts on a domain controller by logging on to the local
domain of the EcoStruxure BMS server, using the local administrator and local
reports administrator accounts.
For more information, see section 18.11 “Administration Accounts in EcoStruxure
BMS Server Local Domain” on page 303.

IT 04-40008-03-en, June 2022

292
 18 Domains
18.2 Log On Methods

18.2 Log On Methods

The EcoStruxure Building Operation software provides two methods to log on to
the system: as a Windows user or as an EcoStruxure Building Operation user.

18.2.1 Log On as a Windows User

If you are logged on with a Windows user account that is mapped to the Windows
Active Directory user account group that you belong to, you can select an
EcoStruxure BMS server and log on in a single sign-on. For more information,
see the Logging on to WorkStation using your Windows user account topic on
WebHelp.
You can also log on using another Windows account that is mapped. For more
information, see the Logging on to WorkStation as another Windows User topic
on WebHelp.

18.2.2 Log On as an EcoStruxure Building

Operation User
When logging on as an EcoStruxure Building Operation user, you authenticate
yourself with an EcoStruxure Building Operation account user name and
password. For more information, see the Logging on to WorkStation as an
EcoStruxure Building Operation User topic on WebHelp.
You also select which EcoStruxure Building Operation domain and EcoStruxure
BMS server that you want to access. For more information, see section 16.3
“User Accounts and User Account Groups” on page 251.
With an EcoStruxure Building Operation user account, you can also connect
directly to the local domain of an EcoStruxure BMS server. For more information,
see section 18.11 “Administration Accounts in EcoStruxure BMS Server Local
Domain” on page 303.

18.2.3 Password Administration

As a WorkStation administrator, you can change users’ passwords, force users to
change their passwords at next logon, or enable and disable the possibility for
users to change their passwords.
For more information, see section 20.1 “Password Administration” on page 343.

04-40008-03-en, June 2022 IT

293
18 Domains
18.3 Creating and Configuring a Domain

18.3 Creating and Configuring a Domain

You create a domain to group EcoStruxure BMS servers, users, and user groups
in one domain so that all users and user groups of the domain have access to all
EcoStruxure BMS servers within the domain. You can connect the domain to a
Windows Active Directory domain to make user accounts from the Windows
Active Directory accessible to the EcoStruxure Building Operation software, and
to allow users to log on to WorkStation with their Windows user account. You
cannot directly add an automation server to a domain in an Enterprise Central.
For more information, see section 18.1 “Domains” on page 289.

To create and configure a domain

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Domain.
4. In the Domain Control Panel, click Add.
5. In the Create Object wizard, in the Name box, type a name for the domain.
Do not name an EcoStruxure Building Operation domain with the same
name as any Windows domain in your network. An EcoStruxure Building
Operation domain and a Windows domain in your network that are named in
the same way can cause conflicts when you use an integrated Windows log
on for the EcoStruxure Building Operation domains.
6. In the Description box, type a description for the domain.
7. Click Next.
8. In the Authentication page, in the Windows domain name box, type the
name of a Windows Active Directory domain to connect the domain to a
Windows domain.
9. Click Next.
10. In the Domain Members page, in the Available Servers box, select the
EcoStruxure BMS servers that you want to connect to the domain.
NOTE:
• The Domain Members page appears only if there are any
EcoStruxure BMS servers available to connect to the domain.
• You cannot directly add an automation server to a domain in an
Enterprise Central, you need to add an Enterprise Server to the
domain first.

11. Click the Add button .

12. Click Next.
13. In the Domain Policies page, in the Maximum logon attempts box, enter
the number of failed logon attempts allowed for users belonging to the
domain before their user accounts are temporarily disabled.
14. Click Create.

IT 04-40008-03-en, June 2022

294
 18 Domains
18.4 Editing the Windows Domain Name

18.4 Editing the Windows Domain Name

In order for members of the Windows Active Directory to be mapped into the
EcoStruxure Building Operation user management system, you edit the Windows
domain name to match the Windows domain name established by the customer’s
IT department.
For more information, see section 18.1 “Domains” on page 289.

To edit the Windows domain name

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Domain.
4. In the Domains box, select the domain that you want to edit.
5. Click Summary.
6. In the Summary tab, in the Windows domain name box, type the name of
the Windows Active Directory domain you want to connect to.

7. Click the Save button .

04-40008-03-en, June 2022 IT

295
18 Domains
18.5 Editing the Description of a Domain

18.5 Editing the Description of a Domain

You edit the description of a domain to specify what the domain is used for.
For more information, see section 18.1 “Domains” on page 289.

To edit the description of a domain

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Domain.
4. In the Domain Control Panel, in the Domains box, select the domain for
which you wish to edit the description.
5. Click Summary.
6. In the Summary tab, in the Description box, type a description for the
domain.

7. Click the Save button .

IT 04-40008-03-en, June 2022

296
 18 Domains
18.6 Editing the Maximum Logon Attempts

18.6 Editing the Maximum Logon Attempts

You edit the maximum logon attempts to increase or decrease the number of
times a user can fail logging on to the system before the user account is locked.
Domain settings, such as Maximum Logon Attempts, apply to every user that
belongs to the domain.
For more information, see section 18.1 “Domains” on page 289.

To edit the maximum logon attempts

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Domain.
4. In the Domain Control Panel, in the Domains box, select the domain that
you want to edit.
5. Click Policies.
6. In the Policies tab, in the Maximum logon attempts box, enter a new
number.
7. On the File menu, click the Save.

04-40008-03-en, June 2022 IT

297
18 Domains
18.7 Assigning an Automation Server to a Domain

18.7 Assigning an Automation Server to a

Domain
You assign an automation server to a domain in the live system to extend your
current domain.
For more information, see section 18.1 “Domains” on page 289.

To assign an automation server to a domain

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Domains.
4. In Domain Control Panel, in the Domains list, select the domain you are
adding an automation server to.
5. Click the Domain members tab.

6. In the Available Servers list, select a server and click the Add button .

7. Click the Save button .

IT 04-40008-03-en, June 2022

298
 18 Domains
18.8 Removing an Automation Server from a Domain

18.8 Removing an Automation Server from a

Domain
You remove an automation server from a domain, for example, limit the
EcoStruxure BMS to only hold automation servers in use.
For more information, see section 18.1 “Domains” on page 289.

To remove an automation server from a domain

1. In WorkStation, in the System Tree pane, select the automation server you
want to configure.
2. Click the Control Panel tab.
3. Click Domains.
4. In the Domain Control Panel, in the Domains list, select a domain.
5. Click Domain members.
6. In the Domain Members tab, in the Selected Servers list, select the SmarX

server , and click the Remove button .

7. On the File menu, click Save.

04-40008-03-en, June 2022 IT

299
18 Domains
18.9 Deleting a Domain

18.9 Deleting a Domain

You delete a domain that is not anymore necessary in the EcoStruxure BMS.
For more information, see section 18.1 “Domains” on page 289.
NOTE:
• You cannot delete the default local domain that was installed with the
system.
• You cannot restore a domain that you have deleted.

To delete a domain
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Domain.
4. In the Domain Control Panel, in the Domain list, select the domain you are
deleting.

5. Click the Delete button .

6. Click Yes.
7. In the Confirm Delete dialog box, click Yes.

IT 04-40008-03-en, June 2022

300
 18 Domains
18.10 Unify Domains in the Server Structure Workflow

18.10 Unify Domains in the Server Structure

Workflow
Use this workflow to unify domains and to make sure all the servers have the
same domain after you add an Enterprise Central to your system. Related
information can be found in the sections after the flowchart.

Figure: Unify domains in the server structure workflow

Log On to the Enterprise Server

Log on to the Enterprise Server that you want to add to the Enterprise Central.
For more information, see the Log on to WorkStation or WebStation topic on
WebHelp.

04-40008-03-en, June 2022 IT

301
18 Domains
18.10 Unify Domains in the Server Structure Workflow

Export the Domain

Export the domain you want to use from the Enterprise Server. For more
information, see the Import and Export of User Management Solutions topic on
WebHelp.

Delete the Domain

Delete the domain from the Enterprise Server to avoid conflict. For more
information, see section 18.9 “Deleting a Domain” on page 300.

Log On to the Enterprise Central

Log on to your Enterprise Central in order to import your domain and add the
servers. For more information, see the Log on to WorkStation or WebStation
topic on WebHelp.

Import the Domain

Import the domain that you want to use to the Enterprise Central. For more
information, see the Import and Export of User Management Solutions topic on
WebHelp.

Add the Enterprise Server

Add the Enterprise Server to the Enterprise Central. For more information, see
the Adding an Existing Enterprise Server to an Enterprise Central topic on
WebHelp.

Add the Enterprise Server to your domain

Add the Enterprise Server to the domain of the Enterprise Central. For more
information, see the Adding an Existing Enterprise Server to an Enterprise
Central topic on WebHelp.

Add your Automation Servers to the domain

Add your automation servers to the domain of the Enterprise Server. For more
information, see section 18.7 “Assigning an Automation Server to a Domain” on
page 298.

IT 04-40008-03-en, June 2022

302
 18 Domains
18.11 Administration Accounts in EcoStruxure BMS Server Local Domain

18.11 Administration Accounts in EcoStruxure

BMS Server Local Domain
You can manage user accounts on a domain controller by logging on to the local
domain of the EcoStruxure BMS server, using the local administrator and local
reports administrator accounts.

18.11.1 Admin Account

Each EcoStruxure BMS server has a local administrator account, named admin.
This account is preferably used to log on to the EcoStruxure BMS server the first
time to create a new domain with an administration account. To manage and
administrate the new domain, it is recommended that you log on to the domain
with your domain administration account.
The local administrator account cannot be changed or deleted.

18.11.2 Reports Administrator Account

SystemReportsService is the user account for the Reporting Agent service. The
account allows the Reporting Agent service to log on to the Enterprise Server.
This user account is set up during the installation of the Enterprise Server and
WorkStation and does not require any configuration.
The SystemReportsService is disabled in Enterprise Central and needs to be
configured. The password also needs to be set before the Report Server is used
with Enterprise Central.
For more information, see the WebReports User Accounts topic on WebHelp.

04-40008-03-en, June 2022 IT

303
19 Software Permissions

Topics
Software Permissions
Path Permissions
Path Permissions Rules
Property Permissions
Assigning Path Permissions to User Accounts or User
Account Groups
Editing Path Permissions of User Accounts or User Account
Groups
Removing Path Permissions from User Accounts or User
Account Groups
Command Permissions
Command Permissions Rules
Assigning Command Permissions to User Account Groups
Editing Command Permissions of User Account Groups
Removing Command Permissions from User Account
Groups
Extended Software Permissions
Relative Path Permissions
Relative Path Permissions Rules
Creating Relative Path Templates
Editing Relative Path Permissions Templates
 Deleting Relative Path Templates
19 Assigning Relative Path Permissions to User Accounts or
User Account Groups
Removing Relative Path Permissions from User Accounts or
User Account Groups
Type Permissions
Type Permissions Rules
Creating Type Permissions Templates
Editing Type Permissions Templates
Removing Path Permissions Templates
Assigning Type Permissions to User Accounts or User
Account Groups
Removing Type Permissions from User Accounts or User
Account Groups
Software Permissions Management
Software Permissions, User Accounts, and User Account
Groups
Software Permissions Rules Management
 19 Software Permissions
19.1 Software Permissions

19.1 Software Permissions

Software permissions are used to manage privileges that user account groups
and user accounts own to objects in Building Operation software. In the
EcoStruxure Building Operation software, you can assign two types of software
permissions to user account groups and user accounts: path permissions and
command permissions. You can also assign extended permissions to all the
instances of folder structure or of a custom type.

19.1.1 Path Permissions

Path permissions are used to give a user account group or a user account
access to the objects defined in the path. Path permissions can also be set on
specific properties. The permissions configured on a path apply to all path sub-
levels unless you configure new permissions for the path sub-level.
For more information, see section 19.2 “Path Permissions” on page 309.

19.1.2 Command Permissions

Command permissions grant a specific set of permissions to a user account or a
user account group to commands in the EcoStruxure Building Operation
database. You use command permissions to configure exceptions from path
permissions.
For more information, see section 19.8 “Command Permissions ” on page 315.

19.1.3 Extended Software Permissions

Extended Permissions are used to manage privileges of a user account group or
a user account with respect to the instances of a folder structure or to the
instances of custom type.
There are two types of extended software permissions:
• Relative path permissions. For more information, see section 19.14 “Relative
Path Permissions” on page 322.
• Type permissions. For more information, see section 19.21 “Type
Permissions” on page 329.

19.1.4 Relative Path Permissions

Relative path permissions for a folder structure grant a specific set of permissions
to a user account group or to a user account to all the folders accessible in a
predefined path and its folder structure. Relative path permissions enable a user
accounts group or a user account to reuse a specific path permission.
For more information, see section 19.14 “Relative Path Permissions” on page
322.

04-40008-03-en, June 2022 IT

307
19 Software Permissions
19.1 Software Permissions

19.1.5 Type Permissions

Extended permissions for a type grant a specific set of permissions to a user
accounts group or to a user account to all instances of this type. There are two
types of type permissions. Custom type permissions grant permissions for types
created by the users. In-build type permissions grant permissions for types
provided by default with the system.
For more information, see section 19.21 “Type Permissions” on page 329.

19.1.6 Software Permissions Management

Software permissions can be combined between them.
For more information, see section 19.28 “Software Permissions Management” on
page 336.

IT 04-40008-03-en, June 2022

308
 19 Software Permissions
19.2 Path Permissions

19.2 Path Permissions

Path permissions are used to give a user account group or a user account
access to the objects defined in the path. Path permissions can also be set on
specific properties. The permissions configured on a path apply to all path sub-
levels unless you configure new permissions for the path sub-level.
Path permissions grant a specific set of permissions to a user account or a user
account group to all the folders, sub-folders and objects contained in these
folders (such as alarms, values or graphics) of a certain folder structure in the
EcoStruxure Building Operations software.
The permissions defined on a path apply to all its sub-paths unless you configure
new permission for a sub-path. Path permissions provided at the top level of the
system are symbolized “/”. Path permissions provided to sub-levels of the system
are symbolized “/[sub-level name]. Parent server is not included in the path, for
instance “/Enterprise server” will only grant access to that specific server and not
sub-servers.

19.2.1 Path Permissions Rules

A user account or a user account group can be granted the following path
permissions: Read, Write, Create, Delete, Edit, Force and Command.
For more information, see section 19.3 “Path Permissions Rules” on page 310.

19.2.2 Property Permissions

Property permissions are used to give a user account group or a user account
access to the properties of objects defined in the path. The permissions
configured on the properties serve to refine permissions granted on the object
level.
For more information, see section 19.4 “Property Permissions” on page 311.

19.2.3 Relative Path Permissions

Relative path permissions for a folder structure grant a specific set of permissions
to a user account group or to a user account to all the folders accessible in a
predefined path and its folder structure. Relative path permissions enable a user
accounts group or a user account to reuse a specific path permission.
For more information, see section 19.14 “Relative Path Permissions” on page
322.

04-40008-03-en, June 2022 IT

309
19 Software Permissions
19.3 Path Permissions Rules

19.3 Path Permissions Rules

A user account or a user account group can be granted the following path
permissions: Read, Write, Create, Delete, Edit, Force and Command.
Path permissions configured on lower levels of the path overrule permissions
configured on higher levels.

Table: Software Permissions Rules

Property Description

Read Permits viewing and listing path content

Write Permits an administrator to change

configurations except for bindings,
programs, and graphics

Create Permits creating new objects on the path

Delete Permits deleting objects under the path.

Delete permissions are required on a folder
to delete its contents

Edit Permits editing objects on the path

Force Permits forcing values on the path

Command Permits the execution of commands on the

path. Command permissions can override
this permission for specific commands

Inherited Indicates that the permissions are inherited

from the parent folder

NOTE: You need delete permissions to rename, paste and duplicate folders
and objects in EcoStruxure Building Operation software.
NOTE: You can always edit graphic and program objects in the relevant
editor, however in order to save it on your server you need "Edit"
permissions. You can save your edits on your hard drive or export to a
location of your choice even if you don’t have “Edit” permissions.

Example
A user account group Janitors owns the permission Read to the /Trend_Logs
path and the permissions Read and Write to its sub-path
/Trend_Logs/Trend_Charts. Paul and Susan belonging to Janitors have a
permission to modify configurations of objects in /Trend_Log/Trend_Charts sub-
path, but can only view all the remining objects in /Trend_Logs path.

IT 04-40008-03-en, June 2022

310
 19 Software Permissions
19.4 Property Permissions

19.4 Property Permissions

Property permissions are used to give a user account group or a user account
access to the properties of objects defined in the path. The permissions
configured on the properties serve to refine permissions granted on the object
level.
There are three levels of property permissions:
• Inherit - Select to inherit permission to the property from the object.
• Read-only - Select to give read-only access to the property.
• Full control - Select to give full access to the property.
You to select the level of permission you want to assign to different properties.
For more information, see section 23.51 “Property Permissions Dialog Box” on
page 470.

04-40008-03-en, June 2022 IT

311
19 Software Permissions
19.5 Assigning Path Permissions to User Accounts or User Account Groups

19.5 Assigning Path Permissions to User

Accounts or User Account Groups
You assign path permissions to user accounts or to user account groups to
control access and user operations in the EcoStruxure Building Operation
software.
NOTE:
• To facilitate the administration of users and software permissions, it is
recommended that you assign software permissions to groups rather than
to individual user accounts. For more information, see section 19.29
“Software Permissions, User Accounts, and User Account Groups” on
page 337.
For more information, see section 19.2 “Path Permissions” on page 309.

To assign path permissions to a user account or a user

account group
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the account management control panel, in the Domain list box, select the
domain the user account or the user account group belongs to.
5. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group, you want to assign path
permissions.
6. Click Software permissions.
7. To the Permissions tab, to the Path list, drag the folder or object to which
you want to grant the user account or the user account group access to.

TIP: Select to add the the system's top level path.

8. Select the path you created.
9. In the permissions column, select a set of permissions.

10. In the Properties column click on the Property Permissions icon

11. In the Property Permissions dialog box, select the level of permission you
want to assign to various properties. For more information, see section
23.51 “Property Permissions Dialog Box” on page 470.
12. Click OK.

TIP: The Property Permissions icon is highlighted, if you

introduced changes by chosing a level different from Inherit in the
Property Permissions dialog box.
13. On the File menu, click Save.

IT 04-40008-03-en, June 2022

312
 19 Software Permissions
19.6 Editing Path Permissions of User Accounts or User Account Groups

19.6 Editing Path Permissions of User

Accounts or User Account Groups
You edit the path permissions of an individual user account or of a user
accountgroup to modify the access the user account or the user account group is
granted to EcoStruxure Building Operation software.
For more information, see section 19.2 “Path Permissions” on page 309.

To edit the path permissions of a user account or a user

account group
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the account management control panel, in the Domain list box, select the
domain the user account or the user account group belongs to.
5. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group, you want to edit path
permissions.
6. Click Software permissions.
7. In the Permissions tab, in the Path list, select the path for which you want
to edit the permissions.
8. In the permissions column, select a set of permission.

9. In the Properties column click on the Property Permissions icon

10. In the Property Permissions dialog box, select the level of permission you
want to assign to various properties. For more information, see section
23.51 “Property Permissions Dialog Box” on page 470.
11. Click OK.

TIP: The Property Permissions icon is highlighted, if you

introduced changes by chosing a level different from Inherit in the
Property Permissions dialog box.

12. Click the Save button .

04-40008-03-en, June 2022 IT

313
19 Software Permissions
19.7 Removing Path Permissions from User Accounts or User Account Groups

19.7 Removing Path Permissions from User

Accounts or User Account Groups
You remove a permission of an individual user account to a folder or an object
when the user account no longer is to access the folder or object.
For more information, see section 19.2 “Path Permissions” on page 309.

To remove path permissions from a user account or user

account groups
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the account management control panel, in the Domain list box, select the
domain the user account or the user account group belongs to.
5. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group, whose path permissions you
want to remove.
6. Click Software permissions.
7. In the Permissions tab, in the Path list, select the path for which you want
to remove the permissions.
8. Click the Remove button.

9. Click the Save button .

IT 04-40008-03-en, June 2022

314
 19 Software Permissions
19.8 Command Permissions

19.8 Command Permissions

Command permissions are used to control the operations the members of a user
account group can perform on a category of objects in the EcoStruxure Building
Operation database. You use command permissions to configure exceptions
from path permissions.

19.8.1 Command Permissions Rules

You use command permissions to configure exceptions from path permissions.
You can set the following permissions for a command: no setting, deny, allow.
For more information, see section 19.9 “Command Permissions Rules” on page
316.

04-40008-03-en, June 2022 IT

315
19 Software Permissions
19.9 Command Permissions Rules

19.9 Command Permissions Rules

You use command permissions to configure exceptions from path permissions.
You can set the following permissions for a command: no setting, deny, allow.
• No Setting: No Setting is the default command permission setting. No
Setting means that the Command property in the path permission, for the
folder where the object is located, decides whether the user has permission
to modify the object or not.
• Deny: Users are not allowed to use the command.
• Allow: Users are allowed to use the command.

Examples
You allow a user account group only to add comments to trend log records. All
other command permissions for trend logs have the Deny permission. Users with
the Deny command permission can comment on existing records but are not
allowed to perform other actions such as adding records or clearing the trend log.
This assumes that the users have path permission to access the trend logs.
In another example, the user account group has the path permissions read, write,
create, delete, edit, force, and command to a folder that contains BACnet objects.
To prevent the users in the user account group from updating the BACnet
firmware, you use the Deny command permission for this action. All other
command permissions are changed to No Setting. Due to the full set of path
permissions, the users can perform all commands on BACnet devices, but not
update the firmware.

Figure: The user account group has full permission to open and modify BacNet objects,
beside performing firmware update.

In afinal example, the user account group has the path permission Read to the
Enterprise Server. To enable the users in the user account group to perform all
commands on trend logs in the system, you change all the command
permissions on the Trends category to Allow.

IT 04-40008-03-en, June 2022

316
 19 Software Permissions
19.9 Command Permissions Rules

A user account can be a member of several user account groups with different
permissions. The priority between different permissions follow a set of permission
rules. You can use these permission rules to manage the type of data and
commands the user has access to within a workspace, panel, or domain. For
more information, see section 19.30 “Software Permissions Rules Management”
on page 339.

04-40008-03-en, June 2022 IT

317
19 Software Permissions
19.10 Assigning Command Permissions to User Account Groups

19.10 Assigning Command Permissions to

User Account Groups
You assign command permissions to user account groups to control access and
user operations in the EcoStruxure Building Operation software.
For more information, see section 19.9 “Command Permissions Rules” on page
316.

To assign command permissions to a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the account management control panel, in the Domain list box, select the
domain the user account or the user account group belongs to.
5. In the User Account Groups list box, select the user account group, you
want to assign command permissions to.
6. In the User Account Groups area, click Software permissions.
7. In the Permissions tab, in the Command Permissions area, in the
Category column, select a category that you want to configure permissions
for.
8. In the Command column, select a command.
9. In the Permission list for the command, select a permission.

10. Click the Save button .

IT 04-40008-03-en, June 2022

318
 19 Software Permissions
19.11 Editing Command Permissions of User Account Groups

19.11 Editing Command Permissions of User

Account Groups
You editcommand permissions of user account groups to modify access and user
operations in the EcoStruxure Building Operation software.
For more information, see section 19.9 “Command Permissions Rules” on page
316.

To edit command permissions of a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the account management control panel, in the Domain list box, select the
domain the user account group belongs to.
5. In the User Account Groups list box, select the user account group, you
want to edit command permissions of.
6. In the User Account Groups area, click Software permissions.
7. In the Permissions tab, in the Command Permissions area, in the
Category column, select a category that you want to edit permissions for.
8. In the Command column, select a command.
9. In the Permission list for the command, select a permission.

10. Click the Save button .

04-40008-03-en, June 2022 IT

319
19 Software Permissions
19.12 Removing Command Permissions from User Account Groups

19.12 Removing Command Permissions from

User Account Groups
You remove a user account goup's path permission to remove the permission to
a folder or an object the user account group no longer is to have permissions to.
For more information, see section 19.29 “Software Permissions, User Accounts,
and User Account Groups” on page 337.
For more information, see section 19.9 “Command Permissions Rules” on page
316.

To remove command permissions from a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the account management control panel, in the Domain list box, select the
domain the user account group belongs to.
5. In the User Account Groups list box, select the user account group, whose
command permissions you want to remove.
6. Click Software permissions.
7. In the Permissions tab, in the Command Permissions area, in the
Category column, select a category, whose command permisions you want
to remove.
8. In the Command column, select a command.
9. In the Permission list for the command, select No Setting.

10. Click the Save button .

IT 04-40008-03-en, June 2022

320
 19 Software Permissions
19.13 Extended Software Permissions

19.13 Extended Software Permissions

Extended Permissions are used to manage privileges of a user account group or
a user account with respect to the instances of a folder structure or to the
instances of custom type.
There are two types of extended software permissions:
• Relative path permissions. For more information, see section 19.14 “Relative
Path Permissions” on page 322.
• Type permissions. For more information, see section 19.21 “Type
Permissions” on page 329.

04-40008-03-en, June 2022 IT

321
19 Software Permissions
19.14 Relative Path Permissions

19.14 Relative Path Permissions

Relative path permissions for a folder structure grant a specific set of permissions
to a user account group or to a user account to all the folders accessible in a
predefined path and its folder structure. Relative path permissions enable a user
accounts group or a user account to reuse a specific path permission.
Furthermore, you can add and delete permissions for this folder structure.

Example
The same set of objects and properties (values, trends, alarms, graphics etc.) is
defined in 100 rooms in your building. You define a relative path template that
models the folder structure of the rooms in the building, and you define
permissions to this folder structure. You define a relative path template by
choosing one example of the folder structure. All similar folder structures
following the same pattern will inherit permissions defined on the template.
Finally, you also define permissions for specific user accounts and user account
groups.

19.14.1 Relative Path Permissions Rules

You set permissions on a relative path twice.
First, you set permissions on the objects in the template. Objects in the template
can be granted the following path permissions: Read, Write, Create, Delete, Edit,
Force and Command.
Second, you set permissions for user accounts and user account groups. A user
account or a user account group can be granted the following path permissions:
Read, Write, Create, Delete, Edit, Force and Command.
For more information, see section 19.15 “Relative Path Permissions Rules” on
page 323.

IT 04-40008-03-en, June 2022

322
 19 Software Permissions
19.15 Relative Path Permissions Rules

19.15 Relative Path Permissions Rules

You set permissions on a relative path twice.
First, you set permissions on the objects in the template. Objects in the template
can be granted the following path permissions: Read, Write, Create, Delete, Edit,
Force and Command.
Second, you set permissions for user accounts and user account groups. A user
account or a user account group can be granted the following path permissions:
Read, Write, Create, Delete, Edit, Force and Command.

Table: Software Permissions Rules

Property Description

Read Permits viewing and listing path content

Write Permits an administrator to change

configurations except for bindings,
programs, and graphics

Create Permits creating new objects on the path

Delete Permits deleting objects under the path.

Delete permissions are required on a folder
to delete its contents

Edit Permits editing objects on the path

Force Permits forcing values on the path

Command Permits the execution of commands on the

path. Command permissions can override
this permission for specific commands

Inherited Indicates that the permissions are inherited

from the parent folder

NOTE: You need delete permissions to rename, paste and duplicate folders
and objects in EcoStruxure Building Operation software.
NOTE: You can always edit graphic and program objects in the relevant
editor, however in order to save it on your server you need "Edit"
permissions. You can save your edits on your hard drive or export to a
location of your choice even if you don’t have “Edit” permissions.

04-40008-03-en, June 2022 IT

323
19 Software Permissions
19.16 Creating Relative Path Templates

19.16 Creating Relative Path Templates

You create a relative path template to facilitate the process of assigning path
permissions.
For more information, see the Concept Title topic on WebHelp.

To create a relative path template

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Relative path permissions.
4. In the File menu, click New and then click Relative path permissions.
5. In the Create Object dialog box, in the Name box, type the name of your
path permission.
6. In the Path box, enter the path.
7. In the Description box, type a description.
8. Click Create.
9. In the System Tree pane, select the relative path permission you just
created.
10. In the Relative to box, browse to the path you want your permission to be
relative to.
11. Select +.
12. In the Select Object window, select the object you want to add to the
permission path.
13. In the rules table, choose the permission level for the path.

14. Click the Save button .

You can assign the created type permissions to user accounts or user account
groups.

IT 04-40008-03-en, June 2022

324
 19 Software Permissions
19.17 Editing Relative Path Permissions Templates

19.17 Editing Relative Path Permissions

Templates
You modify a relative path permission by adding or withdrawing permissions for
this folder structure. The changes will be accounted in all the instance.
For more information, see the Concept Title topic on WebHelp.

To edit a relative path permissions template

1. In Workstation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Relative path permissions.
4. In the Tree Pane select the relative path permissions you want to edit.
5. In the permissions column, select permissions that you want to assign and
unselect permissions you want to withdraw.

6. Click the Save button .

You modified permissions that user accounts and user account groups have to a
folder structure.

04-40008-03-en, June 2022 IT

325
19 Software Permissions
19.18 Deleting Relative Path Templates

19.18 Deleting Relative Path Templates

You delete relative path template to restructure your policy of permission
assignment.
For more information, see the Concept Title topic on WebHelp.

To delete a relative path template

1. In Workstation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Relative path permissions.
4. In the List View tab, in the Name column, select the relative path you want
to delete.
5. In the Edit menu, select Delete.
6. In the Confirm Delete dialog box, click Yes.
NOTE: By deleting relative path template, you removes all its
occurences in user accounts and user account groups permissions.
By applying a well designed premission policy you improve the ergonomy of your
system.

IT 04-40008-03-en, June 2022

326
 19 Software Permissions
19.19 Assigning Relative Path Permissions to User Accounts or User Account Groups

19.19 Assigning Relative Path Permissions to

User Accounts or User Account Groups
You assign relative path permissions to grant user accounts or user account
groups access to a specific path structure in the EcoStruxure Building Operation
software.

To assign a relative path permissions to user accounts or user

account groups
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the User Accounts list or the User Account Groups list, select the user
account or the user account group, you want to assign the relative path
permission to.
5. Click Software permissions.
6. In the Path Permissions pane, browse to the path you want and click +.
7. In the permissions column, select permissions that you want to assign.
8. In the Relative path permissions column, browse to the relative path
permissions you want to use.

9. Click the Save button .

You can edit and remove relative path permissions from user accounts and user
account groups.

04-40008-03-en, June 2022 IT

327
19 Software Permissions
19.20 Removing Relative Path Permissions from User Accounts or User Account Groups

19.20 Removing Relative Path Permissions

from User Accounts or User Account
Groups
You remove relative path permissions from user accounts or user account groups
to modify users access to spacific folder structures.
For more information, see the Concept Title topic on WebHelp. For more
information, see section 19.15 “Relative Path Permissions Rules” on page 323.

To remove relative path permissions from user accounts or

user account groups
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group you want to remove the relative
path permissions from.
5. Click Software permissions.
6. In the Path Permissions pane, browse to the path you want to remove.
7. In the Relative path permissions column erase the url.

8. Click the Save button

User accounts or user account groups are no longer granted permissions to a
specific folder structure.

IT 04-40008-03-en, June 2022

328
 19 Software Permissions
19.21 Type Permissions

19.21 Type Permissions

Extended permissions for a type grant a specific set of permissions to a user
accounts group or to a user account to all instances of this type. There are two
types of type permissions. Custom type permissions grant permissions for types
created by the users. In-build type permissions grant permissions for types
provided by default with the system.

19.21.1 Custom Type Permissions

Custom type permissions are type permissions for a type created by a user.

19.21.2 In-built Type Permissions

In-built type permissions are type permissions for a type provided by default with
the system.

19.21.3 Type Permission Rules

You set permissions on a type twice.
First, you set permissions on the type of object. Types can be granted the
following path permissions: Read, Write, Create, Delete, Edit, Force, Command
and Inherited. You need to assign at least Read permissions on the type.
Second, you set permissions for user accounts and user account groups. A user
account or a user account group can be granted or refused permissions to the
type.
For more information, see section 19.22 “Type Permissions Rules” on page 330.

04-40008-03-en, June 2022 IT

329
19 Software Permissions
19.22 Type Permissions Rules

19.22 Type Permissions Rules

You set permissions on a type twice.
First, you set permissions on the type of object. Types can be granted the
following path permissions: Read, Write, Create, Delete, Edit, Force, Command
and Inherited. You need to assign at least Read permissions on the type.
Second, you set permissions for user accounts and user account groups. A user
account or a user account group can be granted or refused permissions to the
type.

Table: Software Permissions Rules

Property Description

Read Permits viewing and listing path content

Write Permits an administrator to change

configurations except for bindings,
programs, and graphics

Create Permits creating new objects on the path

Delete Permits deleting objects under the path.

Delete permissions are required on a folder
to delete its contents

Edit Permits editing objects on the path

Force Permits forcing values on the path

Command Permits the execution of commands on the

path. Command permissions can override
this permission for specific commands

Inherited Indicates that the permissions are inherited

from the parent folder

NOTE: You need delete permissions to rename, paste and duplicate folders
and objects in EcoStruxure Building Operation software.
NOTE: You can always edit graphic and program objects in the relevant
editor, however in order to save it on your server you need "Edit"
permissions. You can save your edits on your hard drive or export to a
location of your choice even if you don’t have “Edit” permissions.

IT 04-40008-03-en, June 2022

330
 19 Software Permissions
19.23 Creating Type Permissions Templates

19.23 Creating Type Permissions Templates

You create a type permissions template to grant user accounts or user account
groups access to a specific type.
For more information, see section 19.21 “Type Permissions” on page 329.

To create a type permissions template

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Type permissions.
4. In the File menu, choose New and then select Type permissions.
5. In the Create Object dialog box, in the Name box, type the name of your
type permissions.
6. In the Path box, enter the path.
7. In the Description box, type a description.
8. Click Create.
9. In the System Tree pane, select the type permissions you just created.
10. In the Relative to box, select an instance of the type you want your
permission to be relative to.
11. In the Type name box, verify the name of your type.
12. Select +.
13. In the Select Object window, select the object you want to add to the
permission path.
14. In the rules table, choose the permission level for the type.

15. Click the Save button .

You can assign the created type permissions to user accounts or user account
groups.

04-40008-03-en, June 2022 IT

331
19 Software Permissions
19.24 Editing Type Permissions Templates

19.24 Editing Type Permissions Templates

You edit type permissions template to change permissions to this type.
For more information, see section 19.22 “Type Permissions Rules” on page 330.

To edit a type permissions template

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Type permissions.
4. In the System Tree pane, select the type permissions you want to edit.
5. In the Relative object list, choose the object you want to edit.
6. In the rules table, choose permissions for the type.

7. Click the Save button .

A user account or a user account group is now granted a new set of permissions
for a given type.

IT 04-40008-03-en, June 2022

332
 19 Software Permissions
19.25 Removing Path Permissions Templates

19.25 Removing Path Permissions Templates

You remove path permissions templates to disable all user accounts and user
account groups from accessinga specific folder structure.

To remove a path permissions template

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Type permissions.
4. In the System Tree pane, select the type permissions you want to remove.
5. In the Edit menu, select Delete.
The template of a path permission is deleted.

04-40008-03-en, June 2022 IT

333
19 Software Permissions
19.26 Assigning Type Permissions to User Accounts or User Account Groups

19.26 Assigning Type Permissions to User

Accounts or User Account Groups
You assign type permissions to grant user accounts or user account groups
access to a specific type in the EcoStruxure Building Operation software.
For more information, see section 19.21 “Type Permissions” on page 329.

To assign type permissions to user accounts or user account

groups
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group, you want to assign the type
permission to.
5. Click Software permissions.
6. In the Type Permissions pane, click +.
7. Browse to the type you want to assign permissions to and click Select.

8. Click the Save button .

NOTE: You need at least Read permission on the path where the
instance of the type belongs to.
Type permissions are assign to the user account or the user account group.

IT 04-40008-03-en, June 2022

334
 19 Software Permissions
19.27 Removing Type Permissions from User Accounts or User Account Groups

19.27 Removing Type Permissions from User

Accounts or User Account Groups
You remove type permissions from a user account or a user account group to
withdraw their permissions to a specific type.
For more information, see section 19.22 “Type Permissions Rules” on page 330.

To remove type permissions from a user account or a user

account group
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. In the Control Panel tab, in the User Management list, select the user
account, or the user account group, you what to assign the type permissions
to.
3. Click Software permissions.
4. In the Type Permissions pane, select the type permissions you want to
remove.
5. Click the Delete button.
Type permissions are removed from the user account or the user account
groups.

04-40008-03-en, June 2022 IT

335
19 Software Permissions
19.28 Software Permissions Management

19.28 Software Permissions Management

Software permissions can be combined between them.

19.28.1 Software Permissions, User Accounts and

User Account Groups Management
Software permissions can be assigned to individual user accounts and to user
account groups.
For more information, see section 19.29 “Software Permissions, User Accounts,
and User Account Groups” on page 337.

19.28.2 Software Permissions Rules Management

You manage software permissions by combining various types of permissions.
For more information, see section 19.9 “Command Permissions Rules” on page
316.

IT 04-40008-03-en, June 2022

336
 19 Software Permissions
19.29 Software Permissions, User Accounts, and User Account Groups

19.29 Software Permissions, User Accounts,

and User Account Groups
Software permissions can be assigned to individual user accounts and to user
account groups.
Path permissions can be assigned to both, individual user accounts and user
account groups. Command permissions can be assigned to user account groups
only and cannot be assigned to individual user accounts. If you want to assign
command permissions to individual user account, you need to create a group
with one individual. You assign command permissions to modify specific
permissions that user account groups possess to specific objects on the given
path.
Relative path permissions and type permissions can be assigned to both,
individual user accounts and user account groups.
If no software permissions are configured for a user account or user account
group, the user has no access to EcoStruxure Building Operation software. By
default, new user accounts and new user account groups have no permissions to
access EcoStruxure Building Operation software. Changes to the software
permissions of a user account group or user account are applied the next time
the user logs on.
You can also combine software permissions with other general policies for the
user accounts that are members to the user account groups. For example, you
can enable or disable the ability of the group members to change their passwords
or to choose the workspace.
For optimal efficiency, assign software permissions to user account groups rather
than individual user accounts, wherever possible. Using this approach, you can
associate user accounts to at least one user account group for controlled
permission to EcoStruxure Building Operation applications. A user account group
can comprise both user accounts and other user account groups. You group user
accounts and user account groups with similar interests. For instance, you can
group software permissions with user accounts based on common tasks and
responsibilities

Example
You create a user account for Paul and associate him with the two user account
groups: Administrators and Janitors. You associate Paul with those two user
account groups. You grant Administrators and Janitors certain software
permissions. Paul inherits software permissions of both user account groups.

04-40008-03-en, June 2022 IT

337
19 Software Permissions
19.29 Software Permissions, User Accounts, and User Account Groups

Figure: Users inherit the user account group permissions of which they are members

IT 04-40008-03-en, June 2022

338
 19 Software Permissions
19.30 Software Permissions Rules Management

19.30 Software Permissions Rules

Management
You manage software permissions by combining various types of permissions.
By using a well-planned strategy of assigning software permissions, you can
optimize performances of the users. You can also apply your policies to control
exploitation of the EcoStruxure BMS.

Table: Software Permissions Rules

Property Description

Read Permits viewing and listing path content

Write Permits an administrator to change

configurations except for bindings,
programs, and graphics

Create Permits creating new objects on the path

Delete Permits deleting objects under the path.

Delete permissions are required on a folder
to delete its contents

Edit Permits editing objects on the path

Force Permits forcing values on the path

Command Permits the execution of commands on the

path. Command permissions can override
this permission for specific commands

Inherited Indicates that the permissions are inherited

from the parent folder

NOTE: You need delete permissions to rename, paste and duplicate folders
and objects in EcoStruxure Building Operation software.
NOTE: You can always edit graphic and program objects in the relevant
editor, however in order to save it on your server you need "Edit"
permissions. You can save your edits on your hard drive or export to a
location of your choice even if you don’t have “Edit” permissions.
Building Operation software uses basic rules to determine software permissions
priorities.
• Command permissions of a user account are inherited from the most
advanced permissions in any group the user belongs to. The command
permission Allow overrules Deny, and Deny overrules No Setting.
Example. Paul belongs to Janitors and to Administrators. Janitors does not
have permission to accept an alarm, but Administrators have. Paul inherits
the permission to accept the alarm from Administrators.
• Relative path permissions configured for an individual user account overrule
permissions inherited from user account groups.
• Type permissions overwrite path permissions.

04-40008-03-en, June 2022 IT

339
20 Login Configuration

Topics
Password Administration
Editing a User Account Password
Allowing Users to Change their Password
Changing Your Password
Changing the Password for Local Administrator Accounts
Turning off Remember Me On This Computer
Forcing a User to Change the Password at Next Logon
Preventing Users from Changing Their Passwords
Administrator Password Reset
Password Reset Workflow
Connecting to an Enterprise Server or Enterprise Central
Setting an EcoStruxure PCT Server in Password Reset
Mode
Setting an EcoStruxure BMS Server to Password Reset
Mode
Copying the Session ID when Resetting the Password
Resetting the Password using WorkStation
 20 Login Configuration
20.1 Password Administration

20.1 Password Administration

As a WorkStation administrator, you can change users’ passwords, force users to
change their passwords at next logon, or enable and disable the possibility for
users to change their passwords.
Passwords are managed at the user account group level. EcoStruxure Building
Operation software applies password changes to all user accounts that belong to
the user account group.
NOTE:
• If you are an administrator and have forgotten your password, contact the
EcoStruxure BMS support team.

04-40008-03-en, June 2022 IT

343
20 Login Configuration
20.2 Editing a User Account Password

20.2 Editing a User Account Password

You edit the password for a user account to help users administrate their
accounts.
For more information, see section 20.1 “Password Administration” on page 343.

To edit a user account password

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. In the User Management pane, click Account management.
4. In Domain Control Panel, in the Domain list box, select the domain the
user account belongs to.
5. In the User Accounts list box, select the user account for which you wish to
change the password.
6. Click Summary.
7. On the Summary tab, in the Password box, type the new password.
8. In the Confirm Password box, type your new password again.

9. Click the Save button .

IT 04-40008-03-en, June 2022

344
 20 Login Configuration
20.3 Allowing Users to Change their Password

20.3 Allowing Users to Change their

Password
You allow a group of users to change their password. The default setting is that
all users can change their password.
For more information, see section 19.29 “Software Permissions, User Accounts,
and User Account Groups” on page 337.

To allow users to change their password

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain Control Panel, in the Domain list, select the domain the
user account group belongs to.
5. In the User Account Groups list, select a user account group.
6. Click Policies.
7. In the Policies tab, select the May change Password box.

8. Click the Save button .

04-40008-03-en, June 2022 IT

345
20 Login Configuration
20.4 Changing Your Password

20.4 Changing Your Password

You change your EcoStruxure Building Operation user password on a regular
basis to keep your information secure.

To change your password

1. In WorkStation, on the File menu, click Change Password.
2. In the Change Password dialog box, in the Old Password box, type your
current password.
3. In the New password box, type your new password.
4. In the Confirm password box, type your new password again.
5. Click OK.

IT 04-40008-03-en, June 2022

346
 20 Login Configuration
20.5 Changing the Password for Local Administrator Accounts

20.5 Changing the Password for Local

Administrator Accounts
You change the password for the local administrator (admin) accounts on the
EcoStruxure BMS servers to prevent unauthorized access.
For more information, see section 20.1 “Password Administration” on page 343.

To change the password for local administrator accounts

1. In WorkStation, in the Search box, type “admin” to search for the local
administrator account on all EcoStruxure BMS servers in your EcoStruxure
BMS.

2. Click the Search button .

3. In the Search view, select the local administrator accounts you want to
change the password for.
4. On the File menu, click Properties.
5. Click the Basic tab.
6. In the Password box, type the new password.
7. In the Confirm Password box, type the password again.
8. On the File menu, click Save.

04-40008-03-en, June 2022 IT

347
20 Login Configuration
20.6 Turning off Remember Me On This Computer

20.6 Turning off Remember Me On This

Computer
You turn off Remember me on this computer to clear the information you have
stored in the Building Operation WorkStation window. For example, you want to
be able to use different accounts when logging on, or log on to different
EcoStruxure BMS server in the domain.
For more information, see section 18.2 “Log On Methods” on page 293.

To turn off Remember me on this Computer

1. In WorkStation, on the File menu, select Log Off.
2. In the Building Operation WorkStation window, clear Remember me on
this computer.
3. Log on again to activate the change.

IT 04-40008-03-en, June 2022

348
 20 Login Configuration
20.7 Forcing a User to Change the Password at Next Logon

20.7 Forcing a User to Change the Password

at Next Logon
You force a user to change the password at next logon to increase the security,
for example, when distributing a user account to a new user.
For more information, see section 20.1 “Password Administration” on page 343.

To force a user to change the password at next logon

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list box, select the domain the user account belongs to.
5. In the User Accounts list, select the user account.
6. Click Summary.
7. In the Force password change box, select True to force the user to
change the password at next logon.

8. Click the Save button .

The Force password change box is automatically set to False when the user
changes their password.

04-40008-03-en, June 2022 IT

349
20 Login Configuration
20.8 Preventing Users from Changing Their Passwords

20.8 Preventing Users from Changing Their

Passwords
You prevent a group of users from changing their passwords.
For more information, see section 20.1 “Password Administration” on page 343.

To prevent users from changing their passwords

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list box, select the domain the user account group belongs
to.
5. In the User Account Groups list box, select the user account group.
6. Click Policies.
7. In the Policies tab, clear the May change Password box.

8. Click the Save button.

IT 04-40008-03-en, June 2022

350
 20 Login Configuration
20.9 Administrator Password Reset

20.9 Administrator Password Reset

You can reset the administrator password on your EcoStruxure Building
Operation servers if you, for example, have locked yourself out.
Your local Schneider Electric Buildings support team provides you with a
temporary password for logging on to EcoStruxure BMS so that you can change
your administrator password.
For more information, see section 20.10 “Password Reset Workflow” on page
352.

04-40008-03-en, June 2022 IT

351
20 Login Configuration
20.10 Password Reset Workflow

20.10 Password Reset Workflow

You can reset the administrator password on your EcoStruxure Building
Operation servers. Related information can be found in the sections after the
flowchart.

Figure: Password Reset Workflow

Set the server in password reset mode

In Device Administrator, set the Enterprise Server, Enterprise Central and
automation server in reset mode.
For more information, see section 20.13 “Setting an EcoStruxure BMS Server to
Password Reset Mode” on page 356.
In Project Configuration Tool, set the Project Configuration Tool server in reset
mode.
For more information, see section 20.12 “Setting an EcoStruxure PCT Server in
Password Reset Mode ” on page 355.

Copy the session ID

In WorkStation, copy the session ID that you need to get a temporary password.
For more information, see section 20.14 “Copying the Session ID when Resetting
the Password” on page 357.

Send the session ID to Schneider Electric Buildings support team

Contact your local Schneider Electric Buildings support team and send them the
session ID.

IT 04-40008-03-en, June 2022

352
 20 Login Configuration
20.10 Password Reset Workflow

Create a new password

Log on to the server using the temporary password supplied by Schneider
Electric Buildings support team and create the new password.
For more information, see section 20.15 “Resetting the Password using
WorkStation” on page 358.

04-40008-03-en, June 2022 IT

353
20 Login Configuration
20.11 Connecting to an Enterprise Server or Enterprise Central

20.11 Connecting to an Enterprise Server or

Enterprise Central
You connect to an Enterprise Server or Enterprise Central so that you can set the
servers to reset mode.
For more information, see section 20.9 “Administrator Password Reset” on page
351.
IMPORTANT:
•
– To set an Enterprise Server or Enterprise Central to reset mode you
must run Device Administrator as an administrator. Refer to Windows
how to run a program as an administrator.
– Device Administrator must run on the same computer as Enterprise
Server or Enterprise Central.

To connect to an Enterprise Server or Enterprise Central

1. In Device Administrator, click Servers and then click Add server.
2. In the EBO server type list, select Enterprise Server or Enterprise Central.
3. Enter something in the Password box. The server is added even with an
incorrect password.
4. Click OK.

IT 04-40008-03-en, June 2022

354
 20 Login Configuration
20.12 Setting an EcoStruxure PCT Server in Password Reset Mode

20.12 Setting an EcoStruxure PCT Server in

Password Reset Mode
You set an EcoStruxure PCT Server to password reset mode so that you can
create a new password if the old one was forgotten.
For more information, see section 20.10 “Password Reset Workflow” on page
352.

To set an EcoStruxure PCT server in password reset mode

1. In the Project Configuration Tool, select the server.
2. Right-click the server and click Set the server in password reset mode.
The PCT server is now in password reset mode for 24 hours.

04-40008-03-en, June 2022 IT

355
20 Login Configuration
20.13 Setting an EcoStruxure BMS Server to Password Reset Mode

20.13 Setting an EcoStruxure BMS Server to

Password Reset Mode
You set an EcoStruxure BMS server to password reset mode so that you can
create a new password if the old one was forgotten.
For more information, see section 20.10 “Password Reset Workflow” on page
352.
NOTE: To set an Enterprise Server or Enterprise Central to password reset
mode, the servers must run on the same computer as Device Administrator.
You must also add the Enterprise Server or Enterprise Central manually. For
more information, see section 20.11 “Connecting to an Enterprise Server or
Enterprise Central” on page 354.
To set an automation server to password reset mode, you must be
connected using the USB port. For more information, see the Connecting to
an Automation Server Using the USB Device Port topic on WebHelp.

To set an EcoStruxure BMS Server in password reset mode

1. In Device Administrator, select the server.
2. In the toolbar, click Edit Connection Password.
3. Click Reset password.
The EcoStruxure Building Operation server is now in password reset mode for 24
hours.

IT 04-40008-03-en, June 2022

356
 20 Login Configuration
20.14 Copying the Session ID when Resetting the Password

20.14 Copying the Session ID when Resetting

the Password
You copy the session ID so that you can send it to your local Schneider Electric
Buildings support team to receive a temporary password.
IMPORTANT: The session ID is unique for the for this session of
WorkStation. You cannot close WorkStation until the password has been
reset. If you close WorkStation, before the password has been reset, a new
session ID is generated that cannot be used with the temporary password
provided by your local Schneider Electric Buildings support team.
For more information, see section 20.9 “Administrator Password Reset” on page
351.

To copy the Session ID when resetting the password

1. In WorkStation, enter the address to the server.
2. In the User box, type admin.
3. Shift-click on the green color in the Schneider logotype "S".

4. In the session ID dialog box, click the Copy button to copy the text
string that is the session ID.
Contact your local Schneider Electric Buildings support team and send them the
session ID.

04-40008-03-en, June 2022 IT

357
20 Login Configuration
20.15 Resetting the Password using WorkStation

20.15 Resetting the Password using

WorkStation
When you have received the temporary password, you can reset the password
on the EBO server.
For more information, see section 20.9 “Administrator Password Reset” on page
351.

To reset the password using WorkStation

1. In WorkStation, in the User name box, type admin.
2. In the Password box, paste the temporary password.
3. Click Log on.
4. In the Change Password dialog box, in the Old password box, paste the
temporary password.
5. In the New password box, type the password you want to use.
6. In the Confirm password box, type the new password agian.

IT 04-40008-03-en, June 2022

358
21 Workspaces

Topics
Workspace Management
Predefined Workspaces
Workspace Components and Customization
Workspace Customization
Workspace Path, Object, and Command Customization
Workspace Content References
Creating a Workspace
Editing the Layout of a Workspace
Editing the Description of a Workspace
Adding a Component to a Workspace
Removing a Component from a Workspace
Editing a Workspace Component
Adding a Workspace to a User Account Group
Removing a Workspace from a User Account Group
Reviewing the Workspace Memberships for a User Account
Group
Panel Components
Creating a Panel
Editing a Panel
Customized Navigation
 Customized Navigation Workflow
21 WebStation in Kiosk Mode
 21 Workspaces
21.1 Workspace Management

21.1 Workspace Management

The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted different tasks for user accounts or user
account groups.
You can create different workspaces for different user categories and link them to
user account groups. A user has access to all workspaces linked to the user
account groups in which the user is a member. This way, users can easily switch
workspaces during a work session. For example, Paul, a member of the
Administrators and Janitors user account groups, has access to the Administrator
workspace and Janitor workspace.

Figure: Users gain access to the workspaces linked to their user account groups

If a user account or user account group is assigned to more than one workspace,
WorkStation asks you to select a default workspace at the first log on. The next
time you log on to the EcoStruxure BMS on the same computer, your default
workspace is automatically displayed. Once logged in, you can change your
default workspace settings.

21.1.1 Predefined Workspaces

Some workspace layouts are included in the EcoStruxure Building Operation
software and cannot be deleted or edited. Those workspaces are located in the
local domain of the EcoStruxure BMS server.
For more information, see section 21.2 “Predefined Workspaces” on page 363.

04-40008-03-en, June 2022 IT

361
21 Workspaces
21.1 Workspace Management

21.1.2 Workspace Components and Customization

A workspace consists of panes, windows, and a work area that can be
customized to suit a user's specific needs. Dialog boxes are presented on top of
the workspace.
For more information, see section 21.3 “Workspace Components and
Customization” on page 364.

21.1.3 WebStation in Kiosk Mode

You can configure to run WebStation in Internet Explorer in kiosk mode if you
want to limit the users’ access to toolbar and shortcuts in Internet Explorer.
For more information, see section 21.21 “WebStation in Kiosk Mode” on page
385.

IT 04-40008-03-en, June 2022

362
 21 Workspaces
21.2 Predefined Workspaces

21.2 Predefined Workspaces

Some workspace layouts are included in the EcoStruxure Building Operation
software and cannot be deleted or edited. Those workspaces are located in the
local domain of the EcoStruxure BMS server.

Table: Predefined Workspaces

Predefined Workspaces Description

System Default Workspace The System Default Workspace displays if

there is no workspace available for users
that log on to WorkStation. For example,
the EcoStruxure Building Operation
software uses this workspace when the
user account group the user belongs to has
no workspaces associated with it, or the
user's default workspace is deleted by the
system administrator.

Administration Workspace The Administration Workspace displays if

there is no other workspace available for
administrators logging on to WorkStation.
The purpose of the Administration
workspace is to ensure that users with
administrator rights always have access to
all properties and functions.

Engineering Workspace In addition to the System Default

Workspace and Administration Workspace
that are installed when an EcoStruxure
Building Operation software is installed,
you also have the option to install a
predefined engineering workspace. The
purpose of the Engineering workspace is to
configure WorkStation, view events and
alarms.

04-40008-03-en, June 2022 IT

363
21 Workspaces
21.3 Workspace Components and Customization

21.3 Workspace Components and

Customization
A workspace consists of panes, windows, and a work area that can be
customized to suit a user's specific needs. Dialog boxes are presented on top of
the workspace.

Figure: Workspace components

WorkStation positions panes at the edges of the main window. You can lock,
release, and move these components to another location. You can also display
and stack several panes on top of each other.
The EcoStruxre Building Operation software provides several predefined
workspace panes, which are accessible through the View menu:
• System Tree pane
• Watch
• Events
• Alarms

IT 04-40008-03-en, June 2022

364
 21 Workspaces
21.3 Workspace Components and Customization

21.3.1 Workspace Customization

You customize the workspace layout to control access and meet the specific
requirements of a user account group. For example, you hide or show panes and
toolbars. You can save a workspace layout on the EcoStruxure BMS server. In
this case, the layout becomes the default workspace layout for all users in the
user account group the workspace belongs to. Workspaces are task oriented,
which means that a user can switch workspaces during a single WorkStation
session.
For more information, see section 21.4 “Workspace Customization” on page 366.

21.3.2 Workspace Content References

Workspace content references are used to customize the workspace by referring
the content you want to display in the workspace panes and Work Area window.
For more information, see section 21.6 “Workspace Content References” on
page 369.

21.3.3 Panel Components

You use a panel to combine different viewable windows, for example, a graphic,
trend chart, report, or another panel into a seamless view. A panel consists of
one or several panes and one work area. The panel is available through the
System Tree pane and opens as a window in the work area of the current
workspace.
For more information, see section 21.16 “Panel Components” on page 380.

04-40008-03-en, June 2022 IT

365
21 Workspaces
21.4 Workspace Customization

21.4 Workspace Customization

You customize the workspace layout to control access and meet the specific
requirements of a user account group. For example, you hide or show panes and
toolbars. You can save a workspace layout on the EcoStruxure BMS server. In
this case, the layout becomes the default workspace layout for all users in the
user account group the workspace belongs to. Workspaces are task oriented,
which means that a user can switch workspaces during a single WorkStation
session.
You can configure a workspace to contain a limited number of views to which
users have access. Specifically, you can add, edit, move, or remove the following
panes and windows:
• Advanced Schedule Pane
• Alarms Pane
• Basic Schedule Pane
• Calendar Pane
• Events Pane
• Function Block Program Pane
• Graphic Pane
• Multi Trend Log List Pane
• Navigation Pane
• Panel Pane
• System Tree Pane
• Trend Chart Pane
• Trend Log List Pane
• Watch Pane
• Work Area Window
For example, you can create a workspace that displays an Alarms pane and a
graphic in the work area representing a building.

21.4.1 Customized Navigation

You use the Navigation Pane to build a customized structure for navigation. The
Navigation pane can be used in a workspace or a panel.
For more information, see section 21.19 “Customized Navigation” on page 383.

IT 04-40008-03-en, June 2022

366
 21 Workspaces
21.4 Workspace Customization

21.4.2 Workspace Path, Object, and Command

Customization
Software permissions limit the paths, objects, and commands that are available
in a workspace. For example, a user with No Access permissions for a particular
path cannot see any of the path objects displayed in the System Tree pane. A
user with Read permissions for a path can see the path objects but cannot issue
any commands because the objects are not made available.
For more information, see section 21.5 “Workspace Path, Object, and Command
Customization” on page 368.

04-40008-03-en, June 2022 IT

367
21 Workspaces
21.5 Workspace Path, Object, and Command Customization

21.5 Workspace Path, Object, and Command

Customization
Software permissions limit the paths, objects, and commands that are available
in a workspace. For example, a user with No Access permissions for a particular
path cannot see any of the path objects displayed in the System Tree pane. A
user with Read permissions for a path can see the path objects but cannot issue
any commands because the objects are not made available.
For more information, see section 19.1 “Software Permissions” on page 307.
Workspaces and software permissions are linked to user account groups. User
accounts inherit the workspaces and permissions of all user account groups in
which the user account is a member. For more information, see section 19.29
“Software Permissions, User Accounts, and User Account Groups” on page 337.

IT 04-40008-03-en, June 2022

368
 21 Workspaces
21.6 Workspace Content References

21.6 Workspace Content References

Workspace content references are used to customize the workspace by referring
the content you want to display in the workspace panes and Work Area window.
When you add a content reference to a workspace, you refer the object in one of
the following ways:
• System absolute: This option creates a path that refers to a specific object or
property in the system. The full address is enclosed in the path and the path
starts from the root level of the system. For example, the path /Server
1/University X/Building A/Graphic1 refers to a graphic named Graphic1 in the
folder Building A under the folder University X on Server 1. This option
means that the content of the workspace will be the same regardless of
which server you are logged on to.
• Server absolute: This option creates a path that refers to a specific object or
property on a server. The address to the server is enclosed in the path and
the path starts from the root level of the server the user is logged on to. For
example, the reference ~/Building A/Alarm View1 refers to an Alarm View in
the folder Building A on the server the used is logged on to. This option
means that the content of the workspace depends on the server you are
logged on to.
• Relative: This option creates a path that is relative to the target. The path
starts from the current location and is relative to that location. Relative paths
behave like the server absolute option when it comes to workspace
components. For example, ../../Graphics/Graphic1 refers to a graphic named
Graphic1 in the Graphics folder one level up. This option means that the
content of the workspace depends on the server you are logged on to.

04-40008-03-en, June 2022 IT

369
21 Workspaces
21.7 Creating a Workspace

21.7 Creating a Workspace

You create a customized workspace so that the WorkStation windows and panes
are tailored to meet the operational needs of a user or a user account group.
NOTE: You need to log off from the EcoStruxure BMS server for the
changes to take effect.
For more information, see section 21.3 “Workspace Components and
Customization” on page 364.

To create a workspace
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain box, select the domain where you want to create the
workspace.
5. In the Workspaces area, click Add.
6. In the Create Object dialog box, in the Name box, type a name for the
workspace.
7. In the Description box, type a description for the workspace.
8. Click Next.
9. In the Workspace Configuration page, select Visible to display the
standard toolbars and menus in the workspace.
10. In the Root path (Applies to Address Bar and System Tree) box, type the
path to the folder that you want to be the root folder for the System Tree and
the Address bar.

11. Click the Add button to add panes to the workspace.

12. In the Create Object dialog box, in the object type list, select the type of
pane you want to add to the Work area.
13. In the Name box, type a name for the pane.
14. In the Description box, type a description for the pane.
15. Click Next.
16. In the Pane Configuration page, in the Default dock position box, select
the location of the pane for display in the WorkStation window.
17. In the Default visibility box, select Hidden to make the pane available only
from the View menu and not open in the Work area.
18. In the Display name box, type the name to be displayed on the pane.
19. In the Initial path box, enter the path to the object you want to display in the
pane.
20. Click Create.
Continued on next page

IT 04-40008-03-en, June 2022

370
 21 Workspaces
21.7 Creating a Workspace

21. In the Workspace wizard, click Create.

04-40008-03-en, June 2022 IT

371
21 Workspaces
21.8 Editing the Layout of a Workspace

21.8 Editing the Layout of a Workspace

You edit the layout of a workspace to arrange the panes in the Work area to meet
the operational needs of a user or a user group.
For more information, see section 21.3 “Workspace Components and
Customization” on page 364.

To edit the layout of a workspace

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain Control Panel, in the Domain box, select the domain the
workspace belongs to.
5. In the Workspaces box, select the workspace you want to edit.
6. Click Edit Layout.
7. In the workspace, resize the frames and adjust the dock positions of the
panes.
8. On the File menu, click Save to save and exit the layout editor.

IT 04-40008-03-en, June 2022

372
 21 Workspaces
21.9 Editing the Description of a Workspace

21.9 Editing the Description of a Workspace

You edit the description of a workspace to specify what the workspace is used
for.
For more information, see section 21.1 “Workspace Management” on page 361.

To edit the description of a workspace

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain Control Panel, in the Domain box, select the domain the
workspace belongs to.
5. In the Workspaces list, select the workspace.
6. Click Summary.
7. In the Summary tab, in the Description box, type a new description for the
workspace.

8. Click the Save button .

04-40008-03-en, June 2022 IT

373
21 Workspaces
21.10 Adding a Component to a Workspace

21.10 Adding a Component to a Workspace

You add a component to a workspace to extend the content and usage of the
workspace.
NOTE: You need to log off from the EcoStruxure BMS server for the
changes to take effect.
For more information, see section 21.1 “Workspace Management” on page 361.

To add a component to a workspace

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Account Management Control Panel, in the Domain box, select the
domain the workspace belongs to.
5. In the Workspaces list, select the workspace.
6. Click Content.
7. Click Add.
8. In the Create Object wizard, select the type of component you want to add
to the workspace.
9. In the Name box, type a name for the component.
10. In the Location box, change the location of the component you are adding if
you do not want to save the component at the default location.
11. In the Description box, type a description for the component.
12. Click Next.
13. In the Default dock position box, select the dock position of the
component.
14. In the Default visibility box, select Visible to display the graphic in the
workspace.
15. In the Display name box, type the name to be displayed on the pane.
16. In the Initial path box, select the System Tree location of the component to
add to the workspace.
17. Click Create.

IT 04-40008-03-en, June 2022

374
 21 Workspaces
21.11 Removing a Component from a Workspace

21.11 Removing a Component from a

Workspace
You remove a component from a workspace to reduce components and the
usage of the workspace.
NOTE: You need to log off from the EcoStruxure BMS server for the
changes to take effect.
For more information, see section 21.1 “Workspace Management” on page 361.

To remove a component from a workspace

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain box, select the domain the workspace belongs to.
5. In the Workspaces list, select the workspace you want to configure.
6. Click Content.
7. In the Components list, select the component you want to remove from the
workspace.

8. Click the Remove button .

9. On the File menu, click Save.

04-40008-03-en, June 2022 IT

375
21 Workspaces
21.12 Editing a Workspace Component

21.12 Editing a Workspace Component

You edit the workspace components to adapt the usage of the workspace.
NOTE: You need to log off from the EcoStruxure BMS server for the
changes to take effect.
For more information, see section 21.1 “Workspace Management” on page 361.

To edit a workspace component

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In Domain Manager, in the Domain box, select the domain the workspace
belongs to.
5. In the Workspaces list, select the workspace.
6. Click Content.
7. In the Content list, select the component you want to edit.

8. Click the Edit button .

9. In the properties pane, edit the workspace component properties.
10. Click OK.
11. On the File menu, click Save.

IT 04-40008-03-en, June 2022

376
 21 Workspaces
21.13 Adding a Workspace to a User Account Group

21.13 Adding a Workspace to a User Account

Group
You add a workspace to a user account group to make the workspace available
to the users that are members of the user account group.
For more information, see section 21.3 “Workspace Components and
Customization” on page 364.

To add a workspace to a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain Control Panel, in the Domain list, select the domain the
user account group belongs to.
5. In the User Account Groups list, select the user account group you want to
add a workspace to.
6. Click Workspaces.
7. In the Available Workspaces list, select the workspace you want to add to

the user account group and click the Add button .

8. Click the Save button .

04-40008-03-en, June 2022 IT

377
21 Workspaces
21.14 Removing a Workspace from a User Account Group

21.14 Removing a Workspace from a User

Account Group
You remove a workspace from a user account group so that it no longer is
available to the users belonging to the user account group.
For more information, see section 21.1 “Workspace Management” on page 361.

To remove a workspace from a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Account Management Control Panel, in the Domain box, select the
domain the workspace belongs to.
5. In the Workspaces list, select the workspace.
6. Click User Account Groups.
7. In the Members tab, in the Selected User Account Groups list, select the
user account group you want to remove the workspace from, and click the

Remove button .
8. On the File menu, click Save.

IT 04-40008-03-en, June 2022

378
 21 Workspaces
21.15 Reviewing the Workspace Memberships for a User Account Group

21.15 Reviewing the Workspace Memberships

for a User Account Group
You review the workspace memberships for a user account group to determine if
the user account group, for example, needs additional workspaces.
For more information, see section 21.1 “Workspace Management” on page 361.

To review the workspace memberships for a user account

group
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Workspaces.

04-40008-03-en, June 2022 IT

379
21 Workspaces
21.16 Panel Components

21.16 Panel Components

You use a panel to combine different viewable windows, for example, a graphic,
trend chart, report, or another panel into a seamless view. A panel consists of
one or several panes and one work area. The panel is available through the
System Tree pane and opens as a window in the work area of the current
workspace.

Figure: Example of panel components

In the procedure when creating a panel, you link existing objects to the panes or
workspace that is added within the panel. Therefore, you have to first create the
object, for example a trend chart, before you add or rather link in the object into
the panel. You can define whether to show or hide a pane's toolbar.
NOTE:
• A panel cannot contain a System Tree pane.
• A maximum of six levels of panels are allowed in a single pane. However,
the recommendation for a good user experience is to only use three
levels.
In a graphic or in the content of a pane or work area, you can create links that
point to a panel. By using panels, you streamline the information you want to
present to the user. For example, you have a graphic that represents a room. In
the room illustration, you add a fan symbol to which you link a panel containing
panes and a work area that displays the current room airflow and temperature.
You can use a navigation pane to build a customized structure for navigation.
The navigation pane can be used in a panel. For more information, see section
21.19 “Customized Navigation” on page 383.

IT 04-40008-03-en, June 2022

380
 21 Workspaces
21.17 Creating a Panel

21.17 Creating a Panel

You create panels to customize framing in a workspace. For example, panels can
display particular graphics or menus that are visible as frames in the WorkStation
Work area.
For more information, see section 21.16 “Panel Components” on page 380.

To create a panel
1. In WorkStation, in the System Tree pane, select in the folder where you
want to create the panel.
2. On the File menu, point to New and then click Panel.
3. In the Create Object wizard, in the Name box, type a name for the panel.
4. In the Description box, type a description for the panel.
5. Click Next.

6. In the Panel Configuration page, click the Add button to add an

object to the panel.you add an object to the panel.
7. In the Create Object wizard, in the object type list, select the type of panel
component you want to add.
8. In the Name box, type a name for the component.
9. In the Description box, type a description for the panel component.
10. Click Next.
11. In the Pane Configuration page, in the Show toolbar box, select Yes to
show the toolbar of the component.
12. In the Default dock position box, select where the component should be
located.
13. In the Default visibility box, select Visible to show the component in the
panel by default.
14. In the Display name box, type the name to be displayed on the pane.
15. In the Initial path box, enter the path to the object you are adding to the
panel.
16. Click Create.
17. In the Work area initial path box, enter the initial object that displays when
viewing this panel.
18. In the Show toolbars box, select Yes to display the toolbar for the object
listed in the initial path.
19. Click Create.

04-40008-03-en, June 2022 IT

381
21 Workspaces
21.18 Editing a Panel

21.18 Editing a Panel

You edit the properties of the panel and the components included in the panel to
rearange its appearance.
For more information, see section 21.16 “Panel Components” on page 380.

To edit a panel
1. In WorkStation, in the System Tree pane, select the panel you want to edit.
2. On the File menu, click Properties.
3. In the Panel properties, edit the properties of the panel.
4. Click OK.
5. Click Close.

IT 04-40008-03-en, June 2022

382
 21 Workspaces
21.19 Customized Navigation

21.19 Customized Navigation

You use the Navigation Pane to build a customized structure for navigation. The
Navigation pane can be used in a workspace or a panel.
The content of a navigation pane is a referenced menu object. The objects in a
navigation pane have the same context menus as they do in the System Tree
pane. The navigation pane is static and only displays objects that were added to
the menu object.
Navigation Pane components are not shown in WebStation in this version.

04-40008-03-en, June 2022 IT

383
21 Workspaces
21.20 Customized Navigation Workflow

21.20 Customized Navigation Workflow

Use this workflow to create a customized navigation pane in a workspace or
panel.

Figure: Create a customized navigation pane flow chart

Create a menu
Create a menu object to be used in the navigation pane.
For more information, see the Creating a Menu topic on WebHelp.

Create a workspace or a panel

Create the workspace or panel where you want to add the navigation pane.
For more information, see section 21.7 “Creating a Workspace” on page 370.
For more information, see section 21.17 “Creating a Panel ” on page 381.

Add a navigation pane to the workspace or panel with the menu as

initial path
Add a navigation pane to the workspace or panel and use the menu as initial
path.
For more information, see section 21.10 “Adding a Component to a Workspace”
on page 374.
For more information, see section 21.17 “Creating a Panel ” on page 381.

IT 04-40008-03-en, June 2022

384
 21 Workspaces
21.21 WebStation in Kiosk Mode

21.21 WebStation in Kiosk Mode

You can configure to run WebStation in kiosk mode when you want to limit the
users’ access to a web browser.

21.21.1 Kiosk Mode

You can display WebStation in kiosk mode with web browsers that supports kiosk
mode. Refer to the browser documentation on how to use kiosk mode.
When kiosk mode is used, the toolbar, menus, and right-click menu, are disabled
in the web browser. Most keyboard shortcuts, such as alt + F4 to close Internet
Explorer, still work.
Use the guest log on if you want the user to get immediate access to WebStation
in kiosk mode. For more information, see the Guest Logon in WebStation topic on
WebHelp.

21.21.2 Remove the Toolbars from WebStation

You can remove the toolbars from WebStation in both kiosk mode and without
kiosk mode.
Use the syntax /?kiosk=1#/ to remove all toolbars.
The text string /?kiosk=1#/ must be placed after the server address.
For example, you want to run this automation server without any toolbars:
https://10.142.0.227/#%2FAutomation%20Server
You add the /?kiosk=1#/
https://10.142.0.227/?kiosk=1#/Automation%20Server
NOTE: The /?kiosk=1#/ does not configure the browser to run in kiosk
mode. It only removes the toolbars.

04-40008-03-en, June 2022 IT

385
22 Audit Trails

Topics
WorkStation Account Management
Audit Trailing of User Activity
Disabling Audit Trail for a Group of Users
Enabling Audit Trail for a Group of Users
Viewing an Audit Trail Log
WorkStation Account Validation
 22 Audit Trails
22.1 WorkStation Account Management

22.1 WorkStation Account Management

As a WorkStation administrator, you can change passwords, track user activities,
validate accounts, and set up user and user and user group accounts.

22.1.1 Audit Trailing of User Activity

An audit trail tracks all actions of a user that has logged on to the system. For
example, you can view when a user logged on or off WorkStation, what
commands the user made, and if the user changed or removed an object. Not all
user actions are logged. For example, the system does not log user interface
navigation and workspace switching.
For more information, see section 22.2 “Audit Trailing of User Activity” on page
390.

22.1.2 WorkStation Account Validation

All user account information is stored centrally in the EcoStruxure Building
Operation user database, which contains information about software
permissions, user account memberships, workspaces, and domains.
For more information, see section 22.6 “WorkStation Account Validation” on page
394.

04-40008-03-en, June 2022 IT

389
22 Audit Trails
22.2 Audit Trailing of User Activity

22.2 Audit Trailing of User Activity

An audit trail tracks all actions of a user that has logged on to the system. For
example, you can view when a user logged on or off WorkStation, what
commands the user made, and if the user changed or removed an object. Not all
user actions are logged. For example, the system does not log user interface
navigation and workspace switching.
For each user action, the system logs the following information:
• User name and domain name
• Date and time of the logged action
• Path of the object that was changed
• Type of action, such as Object created
• Old values and new values
The audit trailing log shown in WorkStation is simple a filtered Event view that
shows user related events. You can limit the number of events that are shown in
the Audit trail log:
• Select a time span
• Select how many of the most recent events to view.
NOTE:
• The system retains a user's historic audit trail even if the user is deleted
from the system.
• Audit trailing is enabled by default.

Audit Trail Configuration at the User Account Group Level

Audit trailing is enabled and disabled at the user account group level in the user
account group policies. The default setting is that audit trail is enabled.
A user inherits the settings from all user account groups the user is a member of.
To activate audit trailing for a user, enable audit trailing for one of the user
account groups the user is a member of. To disable audit trail logging for a user,
you must disable audit trail logging for all user account groups that the user is a
member of.
In addition, you can enable audit trailing as a policy in a user account group.

Figure: The Policies tab with audit trailing enabled

IT 04-40008-03-en, June 2022

390
 22 Audit Trails
22.3 Disabling Audit Trail for a Group of Users

22.3 Disabling Audit Trail for a Group of

Users
You disable audit trail for a group of users that do not need auditing, such as
users who can only view the objects in the system. To disable audit trail for a
user, you must disable audit trail for all user account groups the user is, directly
or indirectly, a member of. Audit trail is by default enabled.
NOTE:
• The system retains a user's historic audit trail even if the user is deleted
from the system.
• Audit trailing is enabled by default.
For more information, see section 22.2 “Audit Trailing of User Activity” on page
390.

To disable audit trail for a group of users

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain Control Panel, in the Domain list, select the domain the
user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Policies.
7. Clear the Enable Audit Trailing box.

8. Click the Save button .

04-40008-03-en, June 2022 IT

391
22 Audit Trails
22.4 Enabling Audit Trail for a Group of Users

22.4 Enabling Audit Trail for a Group of Users

You enable audit trail for a group of users to be able to trace their actions and
activities. To enable audit trail for a user, it is enough that audit trail is enabled for
one of the user account groups the user is a member of. The feature is by default
enabled.
For more information, see section 22.2 “Audit Trailing of User Activity” on page
390.

To enable audit trail for a group of users

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select a user account group.
6. Click Policies.
7. On the Policies tab, select Enable Audit Trailing.

8. Click the Save button .

IT 04-40008-03-en, June 2022

392
 22 Audit Trails
22.5 Viewing an Audit Trail Log

22.5 Viewing an Audit Trail Log

You open an audit trail log to view the activities of a specific user.
For more information, see section 22.2 “Audit Trailing of User Activity” on page
390.

To view an audit trail log

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management.
4. In Account Management Control Panel, in the Domain list, select the
domain the user account belongs to.
5. In the User Accounts list, select the user account.
6. Click Audit Trailing Events.

04-40008-03-en, June 2022 IT

393
22 Audit Trails
22.6 WorkStation Account Validation

22.6 WorkStation Account Validation

All user account information is stored centrally in the EcoStruxure Building
Operation user database, which contains information about software
permissions, user account memberships, workspaces, and domains.

Account Validation
When you log on to WorkStation you have to quote your user name and
password together with the domain and EcoStruxure BMS server you want to log
on to. The EcoStruxure Building Operation software confirms that you are using a
valid user account and verifies that correct password is used. The EcoStruxure
Building Operation software also authenticates access to workspaces associated
with your user account group memberships. After validation, the EcoStruxure
Building Operation software retrieves your software permissions and stores them
in a user token, valid for this log on session.
NOTE: User name, password, and domain name are case sensitive.

WorkStation User Token

A user token remains active as long as you are logged onto WorkStation. Any
changes to your software permissions during your current sessions take effect
the next time you log on.

IT 04-40008-03-en, June 2022

394
23 User Management User
Interface

Topics
User Management System Tree Icons
Domain Properties
Profile Properties
Workspace Properties
Pane Properties
Panel Properties
Navigation Pane
Building Operation WorkStation Window
Domain Control Panel
Edit Permissions Dialog Box
Account Management Control Panel
Select Default Workspace Window
Change Password Dialog Box
Domain Wizard – Authentication Page
Domain Wizard – Domain Members Page
Domain Wizard – Domain Policies Page
Domain – Summary Tab
Domain – Policies Tab
 Domain – Domain Members Tab
23 User Account – Summary Tab
User Account – Group Membership Tab
User Account – Profile Tab
User Account – Software Permissions Tab
User Account – Audit Trailing Events Tab
User Account Group Properties
User Account Properties
Guest Account Properties
User Account Group Wizard – Users Belonging to this Group
Page
User Account Group Wizard – Workspaces Belonging to this
Group Page
User Account Group Wizard – Windows Group Name and
Group Policies Page
User Account Group – Summary Tab
User Account Group – Policies Tab
User Account Group – Group Membership Tab
User Account Group – Software Permissions Tab
User Account Group – Workspaces Tab
User Account Wizard – General Page
User Account Wizard – Member Of Page
User Account Management Folder Properties
Workspace Wizard – Workspace Configuration Page
Workspace Wizard – Pane Configuration Page
Workspace – Summary Tab
Workspace – Content Tab
Workspace – Members Tab
Edit Layout Workspace
Panel Wizard – Panel Configuration Page
 Domains Properties
23 Local Properties
Work Area Window Properties
Create Work Area Window Wizard – Name Page
Windows User Group Dialog Box
Property Permissions Dialog Box
 23 User Management User Interface
23.1 User Management System Tree Icons

23.1 User Management System Tree Icons

Use the User Management System Tree icons to get information on the objects in
the System Tree pane.

Table: User Management Icons

Icon Description

Panel
Indicates the object is a panel. For more
information, see section 21.16 “Panel
Components” on page 380.

Folder of User Accounts

Indicates that the folder contains user
accounts. For more information, see
section 16.3 “User Accounts and User
Account Groups” on page 251.

User Account
Indicates that the object is a user account.
For more information, see section 16.3
“User Accounts and User Account Groups”
on page 251.

Domain
Indicates that the object is a domain. For
more information, see section 18.1
“Domains” on page 289.

User Account Groups

Indicates that the object is a user account
group. For more information, see section
16.3 “User Accounts and User Account
Groups” on page 251.

Workspace
Indicates that the object is a workspace.
For more information, see section 21.1
“Workspace Management” on page 361.

04-40008-03-en, June 2022 IT

399
23 User Management User Interface
23.2 Domain Properties

23.2 Domain Properties

Use the Domain properties to configure the properties of a domain.

Figure: Domain properties

Table: Domain Properties

Component Description

Maximum logon attempts Select the maximum number of failed logon

attempts that a user can make before
WorkStation is temporarily locked.

Password Type the password EcoStruxure BMS

servers internally use to enhance the
EcoStruxure BMS server communication
security in the domain.

Confirm Password Type the password EcoStruxure BMS

servers internally use to enhance the
EcoStruxure BMS server communication
security in the domain.

IT 04-40008-03-en, June 2022

400
 23 User Management User Interface
23.2 Domain Properties

Continued
Component Description

Windows domain name Type the name of the Windows domain

where the Windows Active directory is
located from which you want to map user
account groups. For more information, see
section 17.1 “Windows Active Directory
User Groups” on page 271.

04-40008-03-en, June 2022 IT

401
23 User Management User Interface
23.3 Profile Properties

23.3 Profile Properties

Use the Profile properties to edit the information about the user the account
belongs to.

Figure: Profile properties

Table: Profile Properties

Component Description

First name Type the first name of the user.

Middle name Type the middle name of the user.

Last name Type the last name of the user.

Home email address Type the email address of the user.

Work email address Type the work email address of the user.

IT 04-40008-03-en, June 2022

402
 23 User Management User Interface
23.4 Workspace Properties

23.4 Workspace Properties

Use the Workspace properties to configure the properties of a workspace.

Figure: Workspace properties

Table: Workspace Properties

Component Description

Add
Click to add a pane to the workspace. For
more information, see the Create Object
Wizard – Naming the Object Page topic on
WebHelp.

Edit
Click to edit a workspace pane. For more
information, see section 23.5 “Pane
Properties” on page 405.

Remove
Click to remove a workspace pane.

Menu Select Visible to show the menu in the

workspace.

04-40008-03-en, June 2022 IT

403
23 User Management User Interface
23.4 Workspace Properties

Continued
Component Description

Toolbar Select Visible to show the toolbar in the

workspace.

Address bar Select Visible to show the address bar in

the workspace.

Status bar Select Visible to show the status bar in the

workspace.

Search bar Select Visible to show the search bar in the

workspace.

History bar Select Visible to show the history bar in the

workspace.

Root path Enter the path for the workspace

component.

IT 04-40008-03-en, June 2022

404
 23 User Management User Interface
23.5 Pane Properties

23.5 Pane Properties

Use the Pane properties to configure the settings of the pane.

Figure: Pane properties

Table: Pane Properties

Component Description

Show toolbar Select Yes to show the toolbars for the

pane component.

Default dock position Select where to place the pane in the

workspace.

Default visibility Select Hidden to hide the pane.

Dipslay name Type the pane name that is to be displayed.

Display name is available only in
Workstation.

Initial path Enter the path to the pane component.

04-40008-03-en, June 2022 IT

405
23 User Management User Interface
23.6 Panel Properties

23.6 Panel Properties

Use the Panel properties to configure the properties of a panel.

Figure: Panel properties

Table: Panel Properties

Component Description

Work area initial path Enter the path, for example a graphical link,
that points to the panel.

Show toolbars Select Yes to show the toolbars of the

panel.

Add
Click to add a pane component to the
panel. For more information, see the
Create Object Wizard – Naming the Object
Page topic on WebHelp.

Edit
Click to edit a pane component. For more
information, see section 23.5 “Pane
Properties” on page 405.

IT 04-40008-03-en, June 2022

406
 23 User Management User Interface
23.6 Panel Properties

Continued
Component Description

Remove
Click to remove a panel component.

04-40008-03-en, June 2022 IT

407
23 User Management User Interface
23.7 Navigation Pane

23.7 Navigation Pane

Use the Navigation pane to create a customized structure for navigation.

Figure: Navigation pane

Table: Navigation Pane

Component Description

Displays menus and sub menus in the

navigation structure.

IT 04-40008-03-en, June 2022

408
 23 User Management User Interface
23.8 Building Operation WorkStation Window

23.8 Building Operation WorkStation Window

Use the Building Operation WorkStation window to log on to WorkStation.

Figure: Building Operation WorkStation

Table: Building Operation WorkStation

Component Description

User name Type the user name of your EcoStruxure

Building Operation user account. For more
information, see section 16.3 “User
Accounts and User Account Groups” on
page 251.

Password Type the password of your EcoStruxure

Building Operation user account or of your
Windows user account.

04-40008-03-en, June 2022 IT

409
23 User Management User Interface
23.8 Building Operation WorkStation Window

Continued
Component Description

Domain Type the name of the EcoStruxure Building

Operation domain that you want to log on
to. If you do not enter a domain, you are
logged on to the local domain. For more
information, see section 18.1 “Domains” on
page 289.

Server Select the Server hypertext transfer

protocol option for communication with the
EcoStruxure BMS server.
Enter an EcoStruxure BMS server name or
an IP address for the EcoStruxure BMS
server you want to log on to.

Log on as Click to log on to WorkStation with your

Windows user account. For more
information, see section 16.3 “User
Accounts and User Account Groups” on
page 251.

Remember me on this computer Select to save the entered information. The

information is automatically filled in the next
time you log on.

Log on Click to log on to WorkStation.

Click here to learn more about Building Click to open the WebHelp home page. For
Operation more information, see the WebHelp
Overview topic on WebHelp.

IT 04-40008-03-en, June 2022

410
 23 User Management User Interface
23.9 Domain Control Panel

23.9 Domain Control Panel

Use the Domain Control Panel to create and configure domains.

Table: Domain Control Panel

Component Description

Server Displays the EcoStruxure BMS server that

acts as domain controller.

Domains Select a domain to edit.

Add Click to create a new domain. For more

information, see the New Object Wizard
âM M Naming the Object Page topic on
WebHelp.

Delete Click to delete a domain.

List domains Click to view all domains in the List View.

Unit Conversion Exceptions Click to enter unit conversion exceptions for

the selected domain.

Account management Click to open the Account Management

Control Panel. For more information, see
section 23.11 “Account Management
Control Panel” on page 414.

Summary Click to open the Summary tab for the

domain. For more information, see section
23.17 “Domain – Summary Tab” on page
422.

Policies Click to open the Policies tab where you

edit the policies of the domain. For more
information, see section 23.18 “Domain –
Policies Tab” on page 423.

Domain members Click to open the Domain members tab

where you add and remove EcoStruxure
BMS servers from the domain. For more
information, see section 23.19 “Domain –
Domain Members Tab” on page 424.

04-40008-03-en, June 2022 IT

411
23 User Management User Interface
23.10 Edit Permissions Dialog Box

23.10 Edit Permissions Dialog Box

Use the Edit Permissions dialog box to grant or limit the permissions users or
user groups have to a path.

Figure: Edit Permissions dialog box

Table: Edit Permissions Dialog Box

Component Description

Path Displays the path of the selected object.

Quick filter Use the quick filter to filter on the user or

user group whose permissions you want to
configure or on a specific path permission.
For more information, see the Quick Filter
topic on WebHelp.

Name Select the user account or user account

group whose path permissions you want to
configure.

Permission Select the specific path permissions. For

more information, see section 19.30
“Software Permissions Rules
Management” on page 339.

Account type: Users Select the user account whose path

permission you want to configure.

Account type: Groups Select the user account group whose path
permission you want to configure.

IT 04-40008-03-en, June 2022

412
 23 User Management User Interface
23.10 Edit Permissions Dialog Box

Continued
Component Description

Add users and groups Click to open the Users and Groups dialog
box where you select the user accounts or
user account groups that you want to grant
permissions or whose permissions you
want to limit. For more information, see the
Users and Groups Dialog Box topic on
WebHelp.

04-40008-03-en, June 2022 IT

413
23 User Management User Interface
23.11 Account Management Control Panel

23.11 Account Management Control Panel

Use the Account Management Control Panel to create and configure user
account groups, user accounts, and workspaces.

Figure: Account management control panel

Table: Account Management Control Panel

Component Description

Server Displays the selected EcoStruxure BMS

server.

Domain Select a domain. The domain you logged

onto is the default domain.

User Accounts Select a user account.

Add (user account) Click to add a new user account. For more
information, see the New Object Wizard
âM M Naming the Object Page topic on
WebHelp.

Delete (user account) Click to delete a user account. For more

information, see the Confirm Delete Dialog
Box topic on WebHelp.

List users Click to open the user accounts list view

where you can select a user account. For
more information, see the List View topic
on WebHelp.

IT 04-40008-03-en, June 2022

414
 23 User Management User Interface
23.11 Account Management Control Panel

Continued
Component Description

Summary (user account) Click to open the user accounts Summary

tab with information about the user
account, such as expiration date an the
password for the user account. For more
information, see section 23.20 “User
Account – Summary Tab” on page 425.

Group membership (user account) Click to open the Group Membership tab
where you can edit the group membership
of the selected user account. For more
information, see section 23.21 “User
Account – Group Membership Tab” on
page 426.

Software permissions (user account) Click to open the Software Permissions tab
where you can edit or assign individual
software permissions to the selected user
account. For more information, see section
23.23 “User Account – Software
Permissions Tab” on page 429.

Audit trailing events Click to open the Audit Trailing Events tab
where you can view the user triggered
events for the selected user account. For
more information, see section 23.24 “User
Account – Audit Trailing Events Tab” on
page 431.

User Account Groups Select a user account group.

Add (user account groups) Click to add a new user account group. For
more information, see the New Object
Wizard âM M Naming the Object Page
topic on WebHelp.

Delete (user account group) Click to delete a user account group. For
more information, see the Confirm Delete
Dialog Box topic on WebHelp.

List groups (user account groups) Click to open the user account groups list
view where you can select a user account
group. For more information, see the List
View topic on WebHelp.

Summary (user account groups) Click to open the user account groups
Summary tab where you can edit the
description of the group. For more
information, see section 23.31 “User
Account Group – Summary Tab” on page
443.

Group membership (user account Click to open the Group Membership tab
groups) where you can edit the groups membership
in other groups, and add and remove user
accounts. For more information, see
section 23.33 “User Account Group –
Group Membership Tab” on page 446.

04-40008-03-en, June 2022 IT

415
23 User Management User Interface
23.11 Account Management Control Panel

Continued
Component Description

Software permissions Click to open the Software Permissions tab

where you can edit the software
permissions of the user account group. For
more information, see section 23.34 “User
Account Group – Software Permissions
Tab” on page 448.

Workspaces (user account groups) Click to open the Workspaces tab where
you edit the workspace membership
settings for a user account group. For more
information, see section 23.35 “User
Account Group – Workspaces Tab” on
page 451.

Policies Click to open the Policies tab where you

can edit the policies of the user account
group. For more information, see section
23.32 “User Account Group – Policies Tab”
on page 444.

Workspaces Select a workspace.

Add (workspaces) Click to add a new workspace. For more

information, see the New Object Wizard
âM M Naming the Object Page topic on
WebHelp.

Delete (workspaces) Click to delete a workspace. For more

information, see the Confirm Delete Dialog
Box topic on WebHelp.

List workspaces Click to open the Workspace menu where

you can select a workspace. For more
information, see the List View topic on
WebHelp.

Summary (workspaces) Click to open the workspace Summary tab

where you can edit the description of the
workspace. For more information, see
section 23.41 “Workspace – Summary Tab”
on page 459.

User account groups (workspaces) Click to open the workspace Members tab
where you edit the group membership of
the workspace. For more information, see
section 23.43 “Workspace – Members Tab”
on page 462.

Content Click to open the Content tab where you

edit the content of the workspace. For more
information, see section 23.42
“Workspace – Content Tab” on page 460.

Edit layout Click to open the view where you edit the
layout of the workspace. For more
information, see section 23.44 “Edit Layout
Workspace” on page 463.

IT 04-40008-03-en, June 2022

416
 23 User Management User Interface
23.12 Select Default Workspace Window

23.12 Select Default Workspace Window

Use the Select Default Workspace window to select the workspace you want to
open by default when you log on to WorkStation.

Figure: Select default workspace window

Table: Select Default Workspace Window

Component Description

Select Default Workspace Select a default workspace in the list of

workspaces available to you.

04-40008-03-en, June 2022 IT

417
23 User Management User Interface
23.13 Change Password Dialog Box

23.13 Change Password Dialog Box

Use the Change Password dialog box to change your password.

Figure: Change Password dialog box

Table: Change Password Dialog Box

Component Description

Old password Type your old password.

New password Type your new password. For more

information, see the Password Policy topic
on WebHelp.

Confirm password Type your new password again.

IT 04-40008-03-en, June 2022

418
 23 User Management User Interface
23.14 Domain Wizard – Authentication Page

23.14 Domain Wizard – Authentication Page

Use the Authentication page to map the EcoStruxure Building Operation
domain to a Windows Active Directory domain.

Figure: Authentication page

Table: Authentication Page

Component Description

Windows domain name Type the name of the Windows domain

where the Windows Active directory is
located from which you want to map user
account groups. For more information, see
section 17.1 “Windows Active Directory
User Groups” on page 271.

04-40008-03-en, June 2022 IT

419
23 User Management User Interface
23.15 Domain Wizard – Domain Members Page

23.15 Domain Wizard – Domain Members

Page
Use the Domain Members page to add an automation server to the domain.

Figure: Domain members page

Table: Domain Members Page

Component Description

Available Servers List of all available automation servers.

Servers that are members of this List of all automation servers in the domain.
Domain

Add All
Click to add all available automation
servers to the domain.

Add
Click to add an automation server to the
domain.

Remove
Click to remove an automation server from
the domain.

Remove All
Click to remove all automation servers from
the domain.

IT 04-40008-03-en, June 2022

420
 23 User Management User Interface
23.16 Domain Wizard – Domain Policies Page

23.16 Domain Wizard – Domain Policies Page

Use the Domain Policies page to enter domain polices that are applicable to all
user accounts in the domain.

Figure: Domain policies page

Table: Domain Policies page

Component Description

Maximum logon attempts Select the maximum number of failed logon

attempts that a user can make before
WorkStation is temporarily locked.

04-40008-03-en, June 2022 IT

421
23 User Management User Interface
23.17 Domain – Summary Tab

23.17 Domain – Summary Tab

Use the Summary tab to edit the description and domain controller password for
a domain.

Figure: Summary tab

Table: Summary Tab

Component Description

Description Type a description of the object.

Windows domain name Type the name of the Windows domain

where the Windows Active directory is
located from which you want to map user
account groups. For more information, see
section 17.1 “Windows Active Directory
User Groups” on page 271.

Domain Controller Displays the path and name of the domain

controller.

IT 04-40008-03-en, June 2022

422
 23 User Management User Interface
23.18 Domain – Policies Tab

23.18 Domain – Policies Tab

Use the Policies tab to edit the policies for the domain. For example, the number
of failed logon attempts a user can make before the account is temporarily
locked.

Figure: Policies tab

Table: Policies tab

Component Description

Maximum logon attempts Enter the maximum number of failed logon

attempts a user can make before the user´s
account is temporarily locked.

04-40008-03-en, June 2022 IT

423
23 User Management User Interface
23.19 Domain – Domain Members Tab

23.19 Domain – Domain Members Tab

Use the Domain Members tab to add and remove EcoStruxure BMS servers to
and from the domain.

Figure: Domain members tab

Table: Domain Members Tab

Component Description

Available Servers List of all available EcoStruxure BMS

servers.

Servers that are members of this List of all EcoStruxure BMS servers in the
Domain domain.

Add All
Click to add all available EcoStruxure BMS
servers to the domain.

Add
Click to add an EcoStruxure BMS server to
the domain.

Remove
Click to remove an EcoStruxure BMS
server from the domain.

Remove All
Click to remove all EcoStruxure BMS
servers from the domain.

IT 04-40008-03-en, June 2022

424
 23 User Management User Interface
23.20 User Account – Summary Tab

23.20 User Account – Summary Tab

Use the Summary tab to edit the basic settings for a user account. For example,
you can enable or disable the user account, or change the password for the
account.

Figure: Summary tab

Table: Summary Tab

Component Description

Expires on Enter an expiration date and time for the

user account. By default, there is no
expiration date for the account.

Disabled Select True to disable the user account.

Force password change Select True to force the user to change

password after the initial logon.

Password Type the password again.

Confirm password Type the password again.

04-40008-03-en, June 2022 IT

425
23 User Management User Interface
23.21 User Account – Group Membership Tab

23.21 User Account – Group Membership Tab

Use the Group Membership tab to edit the group membership settings for a user
account.

Figure: Group membership tab

Table: Group Membership Tab

Component Description

Available User Account Groups Lists available user account groups the
account can be a member of.

Selected User Account Groups Lists the user account groups the account
is a member of.

Add all
Click to connect all available user account
groups to the user account.

Add
Click to connect a user account group to
the user account.

IT 04-40008-03-en, June 2022

426
 23 User Management User Interface
23.21 User Account – Group Membership Tab

Continued
Component Description

Remove
Click to remove a user account group from
the user account.

Remove all
Click to remove all user account groups
from the user account.

Workspace Workspaces the user account has access

to.

Owner The user account groups a workspace is a

member of.

04-40008-03-en, June 2022 IT

427
23 User Management User Interface
23.22 User Account – Profile Tab

23.22 User Account – Profile Tab

Use the Profile tab to edit the information about the user the account belongs to.

Figure: Profile tab

Table: Profile Tab

Component Description

First name Type the first name of the user.

Middle name Type the middle name of the user.

Last name Type the last name of the user.

Home email address Type the email address of the user.

Work email address Type the work email address of the user.

IT 04-40008-03-en, June 2022

428
 23 User Management User Interface
23.23 User Account – Software Permissions Tab

23.23 User Account – Software Permissions

Tab
Use the Software Permissions tab to enter individual path permissions for a
user account.
NOTE:
• To simplify the task of administering software permissions, it is
recommended that you assign software permissions to user account
groups rather than user accounts.

Figure: Software permissions tab

Table: Software Permissions Tab

Component Description

Add
Click to add a path to the list of paths the
user account can access.

Add System
Click to add the the system's top level path.

Path Displays the paths that have been defined

for the user account.

04-40008-03-en, June 2022 IT

429
23 User Management User Interface
23.23 User Account – Software Permissions Tab

Continued
Component Description

Permissions Click to assign a permission level to a path

you have selected. For more information,
see section 19.30 “Software Permissions
Rules Management” on page 339.

Properties The access to the Property Permissions

dialog box where you define the level of
permissions to object properties for the
user account.

Property Permissions
Click to access the Property Permissions
dialog box. For more information, see
section 19.4 “Property Permissions” on
page 311.

Relative path permissions Browse to a folder structure to grant a

specific set of permissions to a user
account to all the folders accessible in a
predefined path and its folder structure.

Owner Displays the user account the path has

been added to. Owner can be one or more
user account groups the user account is a
member of or the user account.

Add
Click to add a path to the type permission
object the user account group can access.

Delete
Click to remove a path from the list of paths
the user account can access. For more
information, see the Confirm Delete Dialog
Box topic on WebHelp.

Type permission Displays the type permissions that have

been defined for the user account2020.

IT 04-40008-03-en, June 2022

430
 23 User Management User Interface
23.24 User Account – Audit Trailing Events Tab

23.24 User Account – Audit Trailing Events

Tab
Use the Audit Trailing Events tab to monitor the events triggered by the actions
of a user.

Figure: Audit trailing events tab

Table: Audit Trailing Events Tab

Component Description

Pause
Click to pause the reading of events.

Event filter
Click to select the conditions for the event
display. For more information, see the
Select Conditions Dialog Box – Events
Filter Properties topic on WebHelp.

Favorites
Click to open the Favorites menu where
you select, add, and manage favorites.
For more information, see the Favorites
Menu topic on WebHelp.

Click to open the event time filter where you

select the time and date period for the
events you want to display.
For more information, see the Applying an
Event Time Filter topic on WebHelp.

Quick filter Enter a word to filter on. For more

information, see the Quick Filter topic on
WebHelp..

04-40008-03-en, June 2022 IT

431
23 User Management User Interface
23.25 User Account Group Properties

23.25 User Account Group Properties

Use the User Account Group properties dialog box to configure the properties
of a user account group.

Figure: User account group properties

Table: User Account Group Properties

Component Description

Allow members to close WorkStation Select to let users log off and close
WorkStation.

Log user actions of group members Select to enable audit trailing for users
belonging to this group.

Allow members to access Automation Select to enable users to access the Web
Server Devi ce Configuration Configuration where you configure the
settings of an automation server.

Allow members to access security Select to enable users to access security

configuration configuration.

IT 04-40008-03-en, June 2022

432
 23 User Management User Interface
23.25 User Account Group Properties

Continued
Component Description

Windows group name Select the Windows Active Directory user

account group that you want to map to this
EcoStruxure Building Operation user
account group. For more information, see
section 17.1 “Windows Active Directory
User Groups” on page 271.

Automatic logoff inactivity time Select the time the logged on user account
can be idle before it is automatically logged
off from WorkStation.

Log off to guest account Select to automatically log on to the guest

account when a user that belongs to the
user account group is manually or
automatically logged off from WorkStation.
For more information, see section 16.15
“Automatic Logoff to Guest Account” on
page 265.

04-40008-03-en, June 2022 IT

433
23 User Management User Interface
23.26 User Account Properties

23.26 User Account Properties

Use the User Account properties dialog box to configure the properties of a user
account.

Figure: User account properties

Table: User Account Properties

Component Description

Click to create a new user profile. For more

information, see the Create Object
Wizard – Naming the Object Page topic on
WebHelp.

Click to edit a user profile. For more

information, see section 23.3 “Profile
Properties” on page 402.

Click to remove a user profile.

Disabled Select True to disable the user account.

Force password change Select True to force the user to change

password after the initial logon.

IT 04-40008-03-en, June 2022

434
 23 User Management User Interface
23.26 User Account Properties

Continued
Component Description

Password Type the password again.

Confirm Password Type the password again.

Expires on Enter an expiration date and time for the

user account. By default, there is no
expiration date for the account.

Password never expires Select True to disable password's

expiration date.

System of measurement Displays the system of measurement for

the user account.

04-40008-03-en, June 2022 IT

435
23 User Management User Interface
23.27 Guest Account Properties

23.27 Guest Account Properties

Use the Guest Account Properties dialog box to view or edit the properties of the
user account.

Figure: Guest Account Properties

Table: Guest Account Properties

Property Description

Add
Click to add a user profile to the user
account. For more information, see section
16.3 “User Accounts and User Account
Groups” on page 251.

Edit
Click to edit the selected user profile. For
more information, see section 16.3 “User
Accounts and User Account Groups” on
page 251.

IT 04-40008-03-en, June 2022

436
 23 User Management User Interface
23.27 Guest Account Properties

Continued
Property Description

Remove
Click to remove the selected user profile.
For more information, see section 16.3
“User Accounts and User Account Groups”
on page 251.

Expires on Enter the date and time the Guest user

account is to expire.

Disabled Select True to disable the Guest user

account.

System of measurement Select the measurement system to be used

when the Guest user account is logged on.
For more information, see the Changing the
WorkStation Measurement System topic on
WebHelp.

04-40008-03-en, June 2022 IT

437
23 User Management User Interface
23.28 User Account Group Wizard – Users Belonging to this Group Page

23.28 User Account Group Wizard – Users

Belonging to this Group Page
Use the Users Belonging to this Group page to add users to the group.

Figure: Users belonging to this group page

Table: Users Belonging to this Group Page

Component Description

Available User Accounts Lists available user accounts.

Selected User Accounts Lists user accounts that are members of

the user account group.

Add all
Click to add all user accounts to the user
account group.

Add
Click to add a user account to the user
account group.

Remove
Click to remove a user account from the
user account group.

Remove all
Click to remove all user accounts from the
user account group.

IT 04-40008-03-en, June 2022

438
 23 User Management User Interface
23.29 User Account Group Wizard – Workspaces Belonging to this Group Page

23.29 User Account Group Wizard –

Workspaces Belonging to this Group
Page
Use the Workspaces Belonging to this Group page to add workspaces to the
group.

Figure: Workspaces belonging to this group page

Table: Workspaces Belonging to this Group Page

Component Description

Select from Select a user account group with

workspaces you want to include in the user
account group.

Selected Workspaces Lists available workspaces.

Available Workspaces Lists the workspaces that are added to the

user account group.

Add all
Click to add all available workspaces to the
user account group.

Add
Click to add a workspace to the user
account group.

Remove
Click to remove a workspace from the user
account group.

04-40008-03-en, June 2022 IT

439
23 User Management User Interface
23.29 User Account Group Wizard – Workspaces Belonging to this Group Page

Continued
Component Description

Remove all
Click to remove all workspaces from the
user account group.

IT 04-40008-03-en, June 2022

440
 23 User Management User Interface
23.30 User Account Group Wizard – Windows Group Name and Group Policies Page

23.30 User Account Group Wizard – Windows

Group Name and Group Policies Page
Use the Windows Group Name and Group Policies page to map a Windows
Active Directory and enter policies for the group.

Figure: Windows group name and group policies page

Table: Windows Group Name and Group Policies Page

Component Description

User Interactivity Select to let users log off and close

WorkStation.

Audit Trailing Select to enable audit trailing for users

belonging to this group.

Password Select to allow members of this user

account group to change their password.
Not applicable if the user account group is
mapped to a Windows Active Directory
user account group.

Web Configuration Select to enable users to access the Web

Configuration where you configure the
settings of an automation server. For more
information, see the Automation Server
Device Configuration in WebStation topic
on WebHelp.

04-40008-03-en, June 2022 IT

441
23 User Management User Interface
23.30 User Account Group Wizard – Windows Group Name and Group Policies Page

Continued
Component Description

Personal Favorites Select to enable the user account group

members to create personal favorites and a
personal overview of their system

Personal Dashboards Select to enable the user account group

members to create personal dashboard.

Automatic Logoff Select to log off users in this group after a

defined time of inactivity. For more
information, see section 16.12 “Automatic
Logoff” on page 262.

Log Off To Guest Account Select to logoff users in this group to the
guest account after a defined time of
inactivity. For more information, see section
16.15 “Automatic Logoff to Guest Account”
on page 265.

IP Address Allow List Type the list of IP addresses that are

allowed for the group members to log on
from. For more information, see section
17.13 “Syntax for IP Address Allow List” on
page 285.

Activation Schedule Browse to the multistate schedule

regulating the user account group
members access hours.

Schedule Value When Active Choose the value corresponding to the

user account group members access
hours.

Windows Group Name Select the Windows Active Directory user

account group that you want to map to this
EcoStruxure Building Operation user
account group. For more information, see
section 17.1 “Windows Active Directory
User Groups” on page 271.

Zoning Select to allow the user account group

members to perform zoning actions.

Change Control Select to enable user account group

members to add comments and sign
changes made in the system.

User Settings Select to enable user account group

members to display invalid objects in
WorkStation.

User Settings Select to enable user account group

members to receive session notifications in
WorkStation.

IT 04-40008-03-en, June 2022

442
 23 User Management User Interface
23.31 User Account Group – Summary Tab

23.31 User Account Group – Summary Tab

Use the Summary tab to edit the description of a user account group.

Figure: Summary tab

Table: Summary Tab

Component Description

Description Type a description of the object.

Windows Domain Displays the name of the Windows domain

this user account group is mapped to.

Windows group name Select the Windows Active Directory user

account group that you want to map to this
EcoStruxure Building Operation user
account group. For more information, see
section 17.1 “Windows Active Directory
User Groups” on page 271.

04-40008-03-en, June 2022 IT

443
23 User Management User Interface
23.32 User Account Group – Policies Tab

23.32 User Account Group – Policies Tab

Use the Policies tab to edit the policy settings for a user account group.

Figure: Policies tab

Table: Policies Tab

Component Description

User Interactivity Select to let users log off and close

WorkStation.

Audit Trailing Select to enable audit trailing for users

belonging to this group.

Password Select to enable the user account group

members to change their passwords.

Web Configuration Select to enable users to access the Web

Configuration where you configure the
settings of an automation server. For more
information, see the Automation Server
Device Configuration in WebStation topic
on WebHelp.

Personal Favorites Select to enable the user account group

members to create personal favorites and a
personal overview of their system

IT 04-40008-03-en, June 2022

444
 23 User Management User Interface
23.32 User Account Group – Policies Tab

Continued
Component Description

Personal Dashboards Select to enable the user account group

members to create personal dashboard.

Semantic permissions Select to enable the members of this user

group to use semantic. For more
information, see the Semantic Overview
topic on WebHelp.

Automatic Logoff Select to log off users in this group after a

defined time of inactivity. For more
information, see section 16.12 “Automatic
Logoff” on page 262.

Log Off To Guest Account Select to logoff users in this group to the
guest account after a defined time of
inactivity. For more information, see section
16.15 “Automatic Logoff to Guest Account”
on page 265.

IP Address Allow list Type the list of IP addresses that are

allowed for the group members to log on
from. For more information, see section
17.13 “Syntax for IP Address Allow List” on
page 285.

Activation Schedule Browse to the multistate schedule

regulating the user account group
members access hours.

Schedule Value When Active Enter the value the schedule has when it is
active.

Zoning Select to allow the user account group

members to perform zoning actions.

Change Control Select to enable user account group

members to add comments and sign
changes made in the system.

User Settings Select to enable user account group

members to display invalid objects in
WorkStation.

User Settings Select to enable user account group

members to receive session notifications in
WorkStation.

User Settings Select to enable user account group

members to only be able to use the classic
mode for Function Block Programs (i.e.,
Builder for Function Block will not be
available to the users).

04-40008-03-en, June 2022 IT

445
23 User Management User Interface
23.33 User Account Group – Group Membership Tab

23.33 User Account Group – Group

Membership Tab
Use the Group Membership tab to edit the group membership settings of a user
account group.

Figure: Group membership tab

Table: Group Membership Tab

Component Description

Available User Accounts Lists available user accounts that can be

added to the user account group.

Selected User Accounts Lists user accounts that have been added
to the user account group.

Available User Account Groups Lists user account groups that can be
added to the user account group.

Selected User Account Groups Lists user account groups that have been
added to the user account group.

IT 04-40008-03-en, June 2022

446
 23 User Management User Interface
23.33 User Account Group – Group Membership Tab

Continued
Component Description

Add all
Click to add all available user accounts or
user account groups to the list of selected
user accounts or user account groups.

Add
Click to add the user account or user
account group to the list of selected user
accounts or user account groups.

Remove
Click to remove the user account or user
account group from the list of selected user
accounts or user account groups.

Remove all
Click to remove all user accounts or user
account groups from the list of selected
user accounts or user account groups.

04-40008-03-en, June 2022 IT

447
23 User Management User Interface
23.34 User Account Group – Software Permissions Tab

23.34 User Account Group – Software

Permissions Tab
Use the Software Permissions tab to add software permissions to a user
account group by adding paths and assigning command permissions to the
group.

Figure: Software permissions tab

IT 04-40008-03-en, June 2022

448
 23 User Management User Interface
23.34 User Account Group – Software Permissions Tab

Table: Software Permissions Tab

Component Description

Add
Click to add a path to the list of paths the
user account group can access.

Add System
Click to add the the system's top level path.

Path Displays the paths that have been defined

for the user account group.

Permission Click to assign a permission level to a path

you have selected. For more information,
see section 19.30 “Software Permissions
Rules Management” on page 339.

Properties The access to the Property Permissions

dialog box where you define the level of
permissions to object properties for the
user account group.

Click to access the Property Permissions

dialog box. For more information, see
section 19.4 “Property Permissions” on
page 311.

Relative path permissions Browse to a folder structure to grant a

specific set of permissions to a user
account group to all the folders accessible
in a predefined path and its folder structure.

Owner Displays the user account group the path

has been added to. Owner can be one or
more user account groups the user account
is a member of or the user account.

Delete
Click to remove a path from the list of paths
the user account group can access. For
more information, see the Confirm Delete
Dialog Box topic on WebHelp.

Add
Click to add a path to the type permission
object the user account group can access

Delete
Click to remove a type permission from the
list of paths the user account group can
access. For more information, see the
Confirm Delete Dialog Box topic on
WebHelp.

Type permission Displays the type permissions that have

been defined for the user account group.

Category Click a category to display the commands

included in the category.

04-40008-03-en, June 2022 IT

449
23 User Management User Interface
23.34 User Account Group – Software Permissions Tab

Continued
Component Description

Command Displays all commands for the category.

Decription Displays the description of the command.

Permission Select a permission level for the command.

Category Displays categories included in the

category.

Command Displays all commands of the categories

included in the category

Permission Displays a permission level for the

command.

Owner Displays the user account groups the

commands have been added to.

IT 04-40008-03-en, June 2022

450
 23 User Management User Interface
23.35 User Account Group – Workspaces Tab

23.35 User Account Group – Workspaces Tab

Use the Workspaces tab to edit the workspace membership settings for a user
account group.

Figure: Workspaces tab

Table: Workspaces Tab

Component Description

Available Workspaces Lists workspaces that are available to add

to the user account group.

Selected Workspaces Lists workspaces that are available to add

to the user account group.

Add all
Click to add all available workspaces to the
user account group.

Add
Click to add a workspace to the user
account group.

Remove
Click to remove a workspace from the user
account group.

Remove all
Click to remove all workspaces from the
user account group.

04-40008-03-en, June 2022 IT

451
23 User Management User Interface
23.36 User Account Wizard – General Page

23.36 User Account Wizard – General Page

Use the General page to enter information about the user the account belongs
to, and a password for the account.

Figure: General page

Table: General Page

Component Description

First name Type the first name of the user.

Middle name Type the middle name of the user.

Last name Type the last name of the user.

Home email address Type the email address of the user.

Work email address Type the work email address of the user.

Expires on Enter an expiration date and time for the

user account. By default, there is no
expiration date for the account.

Password Type the password.

Confirm Password Type the password again.

IT 04-40008-03-en, June 2022

452
 23 User Management User Interface
23.37 User Account Wizard – Member Of Page

23.37 User Account Wizard – Member Of

Page
Use the Member Of page to make the user account a member of an existing user
account group.

Figure: Member of page

Table: Member of Page

Component Description

Select from Select a user account that is member of the

user account group you want to connect
your user account.

Available User Accounts Groups Lists available user account groups.

Selected User Accounts Groups Lists user account groups that are
connected to the user account group.

Add all
Click to add all user account groups to the
user account.

Add
Click to add a user account group to the
user account.

Remove
Click to remove a user account group from
the user account.

04-40008-03-en, June 2022 IT

453
23 User Management User Interface
23.37 User Account Wizard – Member Of Page

Continued
Component Description

Remove all
Click to remove all user account groups
from the user account.

IT 04-40008-03-en, June 2022

454
 23 User Management User Interface
23.38 User Account Management Folder Properties

23.38 User Account Management Folder

Properties
Use the User Account Management Folder Properties view or dialog box to
configure and view the general and object-reference properties. For more
information, see the General Information Properties – Basic Tab topic on
WebHelp.

Figure: User Account management folder properties

04-40008-03-en, June 2022 IT

455
23 User Management User Interface
23.39 Workspace Wizard – Workspace Configuration Page

23.39 Workspace Wizard – Workspace

Configuration Page
Use the Workspace configuration page to add, edit, and remove workspace
components.

Figure: Workspace configuration page

Table: Workspace Configuration Page

Component Description

Menu Select Visible to show the menu in the

workspace.

Address bar Select Visible to show the address bar in

the workspace.

Search bar Select Visible to show the search bar in the

workspace.

Toolbar Select Visible to show the toolbar in the

workspace.

Status bar Select Visible to show the status bar in the

workspace.

History bar Select Visible to show the history bar in the

workspace.

Root path (Applies to Address Bar and Enter the path to the workspace
System Tree) component.

Listed components Lists the standard components included in

the workspace. Select a component and
click the Add, Edit or Remove button.

IT 04-40008-03-en, June 2022

456
 23 User Management User Interface
23.39 Workspace Wizard – Workspace Configuration Page

Continued
Component Description

Click to add a new component to the

workspace. For more information, see the
Create Object Wizard – Naming the Object
Page topic on WebHelp.

Click to edit a component. The workspace

properties pane is displayed. For more
information, see section 23.5 “Pane
Properties” on page 405.

Click to remove a component.

04-40008-03-en, June 2022 IT

457
23 User Management User Interface
23.40 Workspace Wizard – Pane Configuration Page

23.40 Workspace Wizard – Pane

Configuration Page
Use the Pane configuration page to determine the layout of the component you
are adding to the workspace.

Figure: Pane configuration page

Table: Pane Configuration Page

Component Description

Show toolbar Select No to hide the component toolbar.

Default dock position Select a default dock position in the

workspace for the component.

Default visibility Select Hidden to hide the component.

Display name Type the pane name that is to be displayed.

Display name is available only in
WorkStation.

Initial path Click to change the location of the

component. For more information, see
section 23.39 “Workspace Wizard –
Workspace Configuration Page” on page
456.

IT 04-40008-03-en, June 2022

458
 23 User Management User Interface
23.41 Workspace – Summary Tab

23.41 Workspace – Summary Tab

Use the Summary tab to edit the description of the workspace.

Figure: Summary tab

Table: Summary Tab

Component Description

Name Displays the name of the workspace.

Description Displays the description of the workspace.

Location Displays the location of the workspace.

04-40008-03-en, June 2022 IT

459
23 User Management User Interface
23.42 Workspace – Content Tab

23.42 Workspace – Content Tab

Use the Content tab to edit the content and layout of a workspace.

Figure: Content tab

Table: Content Tab

Component Description

Menu Select Visible to show the menu in the

workspace.

Address bar Select Visible to show the address bar in

the workspace.

Search bar Select Visible to show the search bar in the

workspace.

Toolbar Select Visible to show the toolbar in the

workspace.

Status bar Select Visible to show the status bar in the

workspace.

History bar Select Visible to show the history bar in the

workspace.

Root path (Applies to Address Bar and Displays the path to the basic node of the
System Tree) workspace. For more information, see
section 21.6 “Workspace Content
References” on page 369.

IT 04-40008-03-en, June 2022

460
 23 User Management User Interface
23.42 Workspace – Content Tab

Continued
Component Description

Add
Click to open the Create Object Wizard,
where you add a new component to the
workspace. For more information, see the
Create Object Wizard – Naming the Object
Page topic on WebHelp.

Edit
Click to edit a pane. For more information,
see section 23.5 “Pane Properties” on page
405.

Remove
Click to remove a component.

04-40008-03-en, June 2022 IT

461
23 User Management User Interface
23.43 Workspace – Members Tab

23.43 Workspace – Members Tab

Use the Members tab to edit the workspace user account group associations.

Figure: Members tab

Table: Members tab

Component Description

Available User Account Groups Lists user account groups that are available
to be connected to the workspace.

Selected User Account Groups Lists user account groups that are
connected to the workspace.

Add all
Click to connect all available user account
groups to the workspace.

Add
Click to connect a user account group to
the workspace.

Remove
Click to disconnect a user account group
from the workspace.

Remove all
Click to disconnect all user account groups
from the workspace.

IT 04-40008-03-en, June 2022

462
 23 User Management User Interface
23.44 Edit Layout Workspace

23.44 Edit Layout Workspace

Use the Edit Layout Workspace to edit the layout of a workspace. You can also
move and resize panes and panels and save the changes.

Figure: Edit layout workspace

Table: Edit Layout Workspace

Button Description

Save
Click to store and close the workspace
layout.

04-40008-03-en, June 2022 IT

463
23 User Management User Interface
23.45 Panel Wizard – Panel Configuration Page

23.45 Panel Wizard – Panel Configuration

Page
Use the Panel Configuration page to add components to the panel.

Figure: Panel configuration page

Table: Panel Configuration Page

Component Description

Add
Click to add a new component to the panel.
For more information, see the Create
Object Wizard – Naming the Object Page
topic on WebHelp.

Edit
Click to edit the properties of a component.
For more information, see section 23.5
“Pane Properties” on page 405.

Remove
Click to remove a component from the
panel.

Work area initial path Click to enter the path for the Work area
component.

Show toolbars Select Yes to show the toolbars for the

Work area component.

IT 04-40008-03-en, June 2022

464
 23 User Management User Interface
23.46 Domains Properties

23.46 Domains Properties

Use the Domains properties to configure the EcoStruxure Building Operation
domains.

Figure: Domains properties

Table: Domains Properties

Component Description

Default Logon Domain Select the domain the user logs on to by

default. For more information, see section
18.1 “Domains” on page 289.

04-40008-03-en, June 2022 IT

465
23 User Management User Interface
23.47 Local Properties

23.47 Local Properties

Use the Local properties to configure the local EcoStruxure Building Operation
domain.

Figure: Local properties

Table: Local Properties

Component Description

Maximum logon attempts Enter the maximum number of failed logon

attempts a user can make before the user´s
account is temporarily locked.

IT 04-40008-03-en, June 2022

466
 23 User Management User Interface
23.48 Work Area Window Properties

23.48 Work Area Window Properties

Use the Work Area Window Properties view or dialog box to view or edit the path
of the default object to be presented in the Work Area.

Figure: Work Area Window properties

Table: Work Area Window Properties

Property Description

Initial path Displays the path of the default object

presented the Work Area Window. For
more information, see section 21.3
“Workspace Components and
Customization” on page 364.

04-40008-03-en, June 2022 IT

467
23 User Management User Interface
23.49 Create Work Area Window Wizard – Name Page

23.49 Create Work Area Window Wizard –

Name Page
Use the Name page to enter the path to the default object to be presented in the
Work Area Window.

Figure: Name page properties

Table: Name Page Properties

Property Description

Initial path Enter the path of the default object to be

presented the Work Area Window.
For more information, see section 21.3
“Workspace Components and
Customization” on page 364.

IT 04-40008-03-en, June 2022

468
 23 User Management User Interface
23.50 Windows User Group Dialog Box

23.50 Windows User Group Dialog Box

Use the Windows User Group dialog box to view or change the users added to
the group.

Figure: Windows User Group

Table: Windows User Group

Component Description

Quick filter Enter a word or a character to filter on. For

more information, see the Quick Filter topic
on WebHelp.

List Select the users you want to add to the

group. For more information, see section
17.1 “Windows Active Directory User
Groups” on page 271.

04-40008-03-en, June 2022 IT

469
23 User Management User Interface
23.51 Property Permissions Dialog Box

23.51 Property Permissions Dialog Box

Use the Property Permissions dialog box to select the level of permission you
want to assign to different properties.

Figure: Property permissions dialog box

Table: Property Permissions Dialog Box

Component Description

Inherit Select to inherit permission to the property

from the object.

Read-only Select to give read-only access to the

property.

IT 04-40008-03-en, June 2022

470
 23 User Management User Interface
23.51 Property Permissions Dialog Box

Continued
Component Description

Full control Select to give full access to the property.

Property Displays the list of properties specific for

the given object.

04-40008-03-en, June 2022 IT

471
24 Connect Agent

Topics
Connect Agent Overview
Configuring Connect Agent Settings
Transferring Crash Information
Applying Proxy Settings to the Connect Agent Service Log
On
Configuring Windows Firewall for Connect Agent
Getting Connect Agent Debug Information
 24 Connect Agent
24.1 Connect Agent Overview

24.1 Connect Agent Overview

Connect Agent is the service that runs along with the Enterprise Central and
Enterprise Servers attached to it to collect and transfer crash information of
EcoStruxure BMS servers (Enterprise Central, Enterprise Servers and
automation servers attached to Enterprise Servers).
To transfer the crash information, the Connect Agent service Log on needs to
meet the following conditions:
• sufficient user rights to access system folders and internet
• Internet proxy settings, if required
• Port number 22 available to access the following URL:
servercd.smartstruxure.schneider-electric.com
Connect Agent can collect and transfer crash information only when the site
administrator or the end-user provides consent to allow Schneider Electric to
receive system diagnostic and performance data of the system.
To enable the Connect Agent function, set Enable crash information transfer
to True. For more information, see section 24.2 “Configuring Connect Agent
Settings” on page 476.

04-40008-03-en, June 2022 IT

475
24 Connect Agent
24.2 Configuring Connect Agent Settings

24.2 Configuring Connect Agent Settings

You configure the Connect Agent Settings to enable the agent to transfer the
crash information of the EcoStruxure BMS servers to the Connect storage server.
For more information, see section 24.1 “Connect Agent Overview” on page 475.

To configure Connect Agent Settings

1. In WorkStation, in the System Tree pane, expand the System folder.
2. Expand the Connect Settings folder and select Connect Agent Settings.
3. On the File menu, click Properties.
4. In the Enable crash information transfer box, select True.
5. Click the Advanced tab.
6. In Maximum bandwidth box, select the maximum bandwidth at which the
crash information can be transfered. If '0' is selected, the crash information
is transfered at maximum bandwidth.

IT 04-40008-03-en, June 2022

476
 24 Connect Agent
24.3 Transferring Crash Information

24.3 Transferring Crash Information

The crash information is transfered within 30 minutes from the crash creation.
For Connect Agent to transfer the crash information, the Connect Agent service
Log on needs to meet the following conditions:
• Sufficient user rights to access system folders and internet
• Internet proxy settings, if required
• Port number 22 available to access the following URL:
servercd.smartstruxure.schneider-electric.com
To test whether Port number 22 is available to access the above URLs, use
PuTTY with SSH. These URLs do not respond to a ping but the address gets
resolved and with PuTTY you can then get to the Log On prompt.
The user (site administrator or end-user) needs to provide consent to collect the
information.
The Connect Agent settings need to be configured for the crash information to be
transferred. For more information, see section 24.2 “Configuring Connect Agent
Settings” on page 476.

24.3.1 Crash Information

Crash dump is generated only for Enterprise Server or Enterprise Central and
takes 2 to 3 minutes to produce. It is then zipped in the
C:\ProgramData\Schneider Electric EcoStruxure\Building Operation
x.y\Enterprise Server\db\Crash information folder. When the crash
information is successfully zipped, the .done file is created. After the .done file is
created, the Connect Agent service restarts the Enterprise Server. After few
minutes, the Connect Agent service then sends the zip file to the Connect
storage server. After successful transfer of the zip file, the Connect Agent service
deletes the zip file.
The actual crash dumps gets generated in the C:\ProgramData\Schneider
Electric EcoStruxure\Building Operation x.y\Enterprise Server\db\logs
folder.
You can find the crash information log file
SE.SBO.S2ConnectESCrashAgentLog at location C:\Program Files
(x86)\Schneider Electric EcoStruxure\Building Operation x.y\Enterprise
Server

04-40008-03-en, June 2022 IT

477
24 Connect Agent
24.4 Applying Proxy Settings to the Connect Agent Service Log On

24.4 Applying Proxy Settings to the Connect

Agent Service Log On
If the system needs proxy settings to browse the Internet, you need to apply the
same settings to the Connect Agent service log on to ensure that system and
crash information is available on Connect Agent server storage.
For more information, see section 24.1 “Connect Agent Overview” on page 475.

To apply proxy settings to the Connect Agent service log on

1. Run the command BITSADMIN in cmd.exe as administrator.
2. Restart the Connect Agent service.
For more information on BITSADMIN command, refer following links:
http://msdn.microsoft.com/en-us/library/aa362813(v=vs.85).aspx
http://myserverissick.com/2010/05/how-to-set-proxy-settings-for-the-
localsystem-and-networkservice-accounts

IT 04-40008-03-en, June 2022

478
 24 Connect Agent
24.5 Configuring Windows Firewall for Connect Agent

24.5 Configuring Windows Firewall for

Connect Agent
You configure Windows Firewall for Connect Agent to ensure that the system and
crash information is available on Connect storage server.
For more information, see section 24.1 “Connect Agent Overview” on page 475.

To configuring Windows Firewall for Connect Agent

1. On the Windows toolbar, select Start and then click Control Panel.
2. Click System and Security and then click Check firewall status.
3. Click Advanced settings and then click Outbound Rules.
4. Click New Rule.
5. Select Program and click Next.
6. Enter the SE.SBO.S2ConnectESAgent.exe program path. (For example,
C:\Program Files (x86)\Schneider Electric EcoStruxure\Building Operation
x.y\S2ConnectAgent\bin\SE.SBO.S2ConnectESAgent.exe). Click Next.
7. Select Allow the connection and click Next.
8. Select the profiles and click Next.
9. In the Name box, type the name for the rule.
10. Click Finish.

04-40008-03-en, June 2022 IT

479
24 Connect Agent
24.6 Getting Connect Agent Debug Information

24.6 Getting Connect Agent Debug

Information
You need debug information to analyse why the crash information is not available
on Connect storage server. Debug information is retrieved from the crash log
files.
For more information, see section 24.1 “Connect Agent Overview” on page 475.

To get Connect Agent Debug Information

1. In Windows, navigate to \Program Files (x86)\Schneider Electric
EcoStruxure\Building Operation x.y\S2ConnectAgent\bin.
2. Open SE.SBO.S2ConnectESAgent.exe.config or
SE.SBO.S2ConnectESCrashCollector.exe.config in notepad (Run as
administrator).
3. For the level value parameter, type DEBUG.
The detailed debug information is retrieved in the crash log files.

IT 04-40008-03-en, June 2022

480
25 Connect Agent User
Interface

Topics
Connect Agent Settings - Basic Tab
Connect Agent Settings - Advanced Tab
 25 Connect Agent User Interface
25.1 Connect Agent Settings - Basic Tab

25.1 Connect Agent Settings - Basic Tab

Use the Basic dialog box to configure the settings of Connect Agent to enable
transfer of crash information of the EcoStruxure BMS servers to the Connect
storage server.

Figure: Basic tab

Table: Basic Tab

Component Description

Enable crash information transfer Select True to enable the Connect Agent
service to transfer crash information to the
Connect storage server.

04-40008-03-en, June 2022 IT

483
25 Connect Agent User Interface
25.2 Connect Agent Settings - Advanced Tab

25.2 Connect Agent Settings - Advanced Tab

Use the Advanced tab to configure the advanced settings of Connect Agent.

Figure: Advanced tab

Table: Advanced Tab

Component Description

Maximum bandwidth Select the bandwidth at which the crash

information is to be transfered. If '0' is
selected, the crash information is
transfered at maximum bandwidth.

IT 04-40008-03-en, June 2022

484
26 Backup and Restore

Topics
Backup and Restore Overview
Comparison of Backup and Restore Methods
Retain Level
Configuring the Retain Level
Mass Editing the Retain Level of Properties
 26 Backup and Restore
26.1 Backup and Restore Overview

26.1 Backup and Restore Overview

You backup your EcoStruxure BMS server data so that it can be restored after
damage or loss due to hardware or software failures, security threats, or
application testing.
The EcoStruxure Building Operation software provides backup and restore
capabilities that preserve both configuration and historical data on an as-needed
or periodic basis.

26.1.1 Backup
Backup is the process of copying and storing data so that the copy can be used
to restore data if a loss occurs. You can also use a backup to revert to an older
version. In the EcoStruxure BMS, you can perform backups on an all
EcoStruxure BMS servers and their devices. EcoStruxure BMS server backups
should take place during non-business hours.
For more information, see section 27.1 “Backup” on page 497.

26.1.2 Restore
Restore is the process of restoring data to an original or former state. Using
Restore, you can revert to a previous snapshot of the EcoStruxure BMS server
data despite any configuration changes made since the last backup. In the
EcoStruxure BMS, Restore is a manual process designed to avoid the accidental
overwriting of current EcoStruxure BMS server data.
For more information, see section 30.1 “Restore” on page 549.

26.1.3 BACnet Backup and Restore

BACnet Backup uses a binary file format to back up an entire device. Specifically,
BACnet Backups comprise the entire contents of the selected device, such as
associated objects, properties, bindings, historical data, and related proprietary
configuration data.
For more information, see the BACnet Backup and Restore topic on WebHelp.

26.1.4 Archiving Overview

Archiving is the process of preserving historical data, which is comprised of
selected events and extended trend logs. For example, some facilities are
required to maintain archives to comply with government regulations. Another
example is in secure facilities where they must maintain records of who logged in
or who changed setpoints. Archiving is not a backup function because archive
data cannot be imported back into the system.
For more information, see the Archiving Overview topic on WebHelp.

04-40008-03-en, June 2022 IT

487
26 Backup and Restore
26.1 Backup and Restore Overview

26.1.5 Comparison of Backup and Restore Methods

There are two Backup and Restore methods:
• EcoStruxure Building Operation Backup and Restore
• BACnet Backup and Restore
You can select the backup and restore method that suits your EcoStruxure BMS
server data storage and retrieval requirements.
For more information, see section 26.2 “Comparison of Backup and Restore
Methods ” on page 489.

26.1.6 Retain Level

In the EcoStruxure BMS servers, variable values are primarily stored in flash
memory in order to have their values survive power fail and server shutdown.
However, values that are often collected are only stored in the SDRAM memory.
This is done to protect the flash memory in the automation server.
For more information, see section 26.3 “Retain Level ” on page 491.

26.1.7 Backup and Restore using WebStation

A subset of backup and restore features are available in WebStation.
For more information, see section 32.1 “Backup and Restore using WebStation”
on page 595.

IT 04-40008-03-en, June 2022

488
 26 Backup and Restore
26.2 Comparison of Backup and Restore Methods

26.2 Comparison of Backup and Restore

Methods
There are two Backup and Restore methods:
• EcoStruxure Building Operation Backup and Restore
• BACnet Backup and Restore
You can select the backup and restore method that suits your EcoStruxure BMS
server data storage and retrieval requirements.
The following table contrasts the EcoStruxure Building Operation and BACnet
backup and restore methods.

Table: Comparison of EcoStruxure Building Operation and BACnet Backup and

Restore
Method Purpose Description

EcoStruxure Building Backs up configuration data Use this method to back up

Operation Backup and historical data EcoStruxure BMS servers
that can include data from
b3, LonWorks, Network
8000, I/NET, MicroNet, and
Modbus devices.
The b3 devices are
automatically backed up
whenever an EcoStruxure
BMS server is backed up.
Therefore, b3 devices do
not need backing up using
the BACnet Backup method.

BACnet Backup Backs up configuration data Use this method to backup

primarily:
• External devices
• Routers
BACnet Backup and
Restore can also backup
and restore b3 devices that
are connected to either a
b3CX controller or external
router. However, BACnet
backup and restore cannot
backup b3 devices when the
devices are connected to an
automation server that
functions as a router. For
more information, see the
BACnet Backup and
Restore topic on WebHelp.

EcoStruxure Building Restores an EcoStruxure Use this method to restore

Operation Restore BMS server using EcoStruxure BMS servers
configuration data and that can include data from
historical data contained in a b3, LonWorks, Network
backup set 8000, I/NET, MicroNet, and
Modbus devices.

04-40008-03-en, June 2022 IT

489
26 Backup and Restore
26.2 Comparison of Backup and Restore Methods

Continued
Method Purpose Description

BACnet Restore Restores a device using Use this method to backup

configuration data contained primarily:
in a backup set (no historical
data) • External devices
• Routers

TIP: To restore archived data, use the Archiving feature rather than Restore
method. See For more information, see the Archiving Overview topic on
WebHelp.

IT 04-40008-03-en, June 2022

490
 26 Backup and Restore
26.3 Retain Level

26.3 Retain Level

In the EcoStruxure BMS servers, variable values are primarily stored in flash
memory in order to have their values survive power fail and server shutdown.
However, values that are often collected are only stored in the SDRAM memory.
This is done to protect the flash memory in the automation server.
Variables have a retain level that controls if the value of the variable is retained
after a restart of the server. There are three retain levels. The following table lists
the retain levels and whether a variable is retained after cold start, warm start, or
power failure.

Table: Retain Levels

Retain level Cold start Warm start Power failure

No

Warm start x x

Cold start x x x

In addition, the retain level also defines if and when a variable value is saved in
the configuration database. A new value of a variable can either be configured by
a user or by an application, for example Function Block or Script.
NOTE: Warm start retained variables are retained during a cold start of the
controller, if the user has configured or changed the initial property value.
Conversely, if the warm start retained variable is changed by a system
application, such as a program, the value are not retained during controller
cold starts.
User written variable values with warm start retained and cold start retained
levels are stored in the database. These variable values are part of a backup and
restore of the database.
Application written variable values with cold start retained levels are stored in the
database during certain activities, such as backup and export.

Table: Retain Levels for Certain Events and Activities

System Events and Retain level: No Retain level: Cold Retain level: Warm
Activities start start

Cold start command Default value a Variable retains last Variable retains last
value configured by value configured by
a user. a user.
Values configured Values configured
by an application are by an application are
retained. lost.

Warm start Default value a Variable retains last Variable retains last
command value configured by value configured by
a user. a user.
Values configured Values configured
by an application are by an application are
retained. retained.

04-40008-03-en, June 2022 IT

491
26 Backup and Restore
26.3 Retain Level

Continued
System Events and Retain level: No Retain level: Cold Retain level: Warm
Activities start start

Exporting & Default value a Variable retains last Variable retains last
Importing value configured by value configured by
a user. a user.
Values configured Values configured
by an application are by an application are
retained. lost.

Viewing Variable in Shows the last value Shows the last value Shows the last value
EcoStruxure configured by a user configured by a user configured by a user
Building Operation or application. or application. or application.
user interface

Backup & Restore Default value a Variable retains last Variable retains last
value configured by value configured by
a user. a user.
Values configured Values configured
by an application are by an application are
retained. lost.

Power loss and Default value a Variable retains last Variable retains last
restore value configured by value configured by
a user. a user.
Values configured Values configured
by an application are by an application are
retained. retained.

Upgrade Default value a Variable retains last Variable retains last

value configured by value configured by
a user. a user.
Values configured Values configured
by an application are by an application are
retained. lost.

a) Default value is the value the variable gets when it is created.

Function Block
Function block objects have their own backup function. The backup function in
Function Block overrides the retain level in EcoStruxure BMS. For more
information, see the Edit Block Dialog Box topic on WebHelp.

IT 04-40008-03-en, June 2022

492
 26 Backup and Restore
26.4 Configuring the Retain Level

26.4 Configuring the Retain Level

Configure the retain level to control what happen to values when different system
events occurs.
For more information, see section 26.3 “Retain Level ” on page 491.

To configure the retain level

1. In WorkStation, in the System Tree pane, click the value.

2. Click the Configure button .

3. Select Retain level.

4. In the Retain level box, select the retain level.

04-40008-03-en, June 2022 IT

493
26 Backup and Restore
26.5 Mass Editing the Retain Level of Properties

26.5 Mass Editing the Retain Level of

Properties
You mass edit the retain level of properties of an object to optimize your work.
For more information, see section 26.3 “Retain Level ” on page 491.

To mass edit retain level of properties

1. In Workstation, search for the properties you want to change the unit on.
2. In the Search View, select the properties you want to mass edit.
3. In the context menu click Choose Retain Level
4. In the Select Retain Level dialog box, select a retain level:
• No: does not retain the value of the property after a restart of the
server.
• Warm start: retains the value of the property after a warm restart of the
server.
• Cold start: retains the value of the property after both a cold and a
warm restart of the server.
Your retain level is now changed for all your selected properties.

IT 04-40008-03-en, June 2022

494
27 Backups

Topics
Backup
Types of Data
Backup Status
Checking the Backup Status of an EcoStruxure BMS Server
Manual Backups
Mass Backup
Backing Up EcoStruxure BMS Servers Manually
System Backup
Local Backup and Restore of EcoStruxure BMS Servers
Remote Backup and Restore of Automation Servers
Local Backup of EcoStruxure BMS Servers using Device
Administrator
Getting Backup set from an EcoStruxure BMS Server using
Device Administrator
 27 Backups
27.1 Backup

27.1 Backup
Backup is the process of copying and storing data so that the copy can be used
to restore data if a loss occurs. You can also use a backup to revert to an older
version. In the EcoStruxure BMS, you can perform backups on an all
EcoStruxure BMS servers and their devices. EcoStruxure BMS server backups
should take place during non-business hours.
Using WorkStation, you can back up data to the local drive of each installed
EcoStruxure BMS server. The EcoStruxure Building Operation software stores
the files by date in a predefined directory location on the server to which
WorkStation is connected. For more information, see section 28.1 “Backup Sets”
on page 515.

27.1.1 Types of Data

The EcoStruxure Building Operation backup function enables you to back up
different types of data.
For more information, see section 27.2 “Types of Data” on page 499.

27.1.2 Backup Sets

Backup sets are compressed backup files used for restoring data. The
EcoStruxure Building Operation software stores the local backup set for an
Enterprise Server or automation servers in the Local folder within the Backup
sets folder.
For more information, see section 28.1 “Backup Sets” on page 515.

27.1.3 Scheduled Backups

A scheduled backup is an automated way to back up data on an EcoStruxure
BMS server. You can back up EcoStruxure BMS servers individually using each
EcoStruxure BMS server’s local backup rule. You can also use backup rules to
synchronize the backups of all the EcoStruxure BMS servers on your network.
For more information, see section 29.1 “Scheduled Backups” on page 535.

27.1.4 Manual Backups

Manual Backup is a non-automated process of copying and storing data on a
selected EcoStruxure BMS server. You can use this option to create backups on
an as-needed basis. You can also manually restore the data at any time.
For more information, see section 27.5 “Manual Backups” on page 502.

04-40008-03-en, June 2022 IT

497
27 Backups
27.1 Backup

27.1.5 Mass Backup

Mass backup is a method of performing a manual, simultaneous backup of all the
EcoStruxure BMS servers in the network, which is useful for capturing data at a
critical point, such as prior to an upgrade. You can choose which EcoStruxure
BMS servers you want to back up along with the type of data for each.
For more information, see section 27.6 “Mass Backup” on page 504.

27.1.6 System Backup

Before upgrading the system, it is strongly recommended that you archive the
historical data and back up the EcoStruxure BMS servers to preserve the current
data and configurations. If you plan to upgrade WebReports, be sure to back up
the Reports database in SQL Server.
For more information, see section 27.8 “System Backup” on page 506.

27.1.7 Backup Status

Backup Status displays the statuses of an EcoStruxure BMS server: Ready,
Backing up, or Backup succeeded.
For more information, see section 27.3 “Backup Status” on page 500.

IT 04-40008-03-en, June 2022

498
 27 Backups
27.2 Types of Data

27.2 Types of Data

The EcoStruxure Building Operation backup function enables you to back up
different types of data.
The EcoStruxure Building Operation backup function provides two backup
options:
• Configuration only: This option makes a back up the configuration
database and and is useful for new installations. Configuration data includes
points, values, alarm objects, trend objects, programs, graphics, and custom
object type data.
The Configuration only option also includes the configuration properties of
variables, such as Unit. Depending on the retain level of the variable, some
configuration properties like Value are also included in a backup. For more
information, see section 26.3 “Retain Level ” on page 491.
• All data: This option makes a back up of the configuration database and the
historical data. Historical data is trend logs and event logs. The option All
data is useful for existing systems,
NOTE: Depending on the type of data, the system locks changes to the
database while a backup is in progress in different ways. For configuration
changes, the EcoStruxure Building Operation software queues up the
changes until the backup completes. For historical data changes, the
EcoBuilding Operation buffers the data based on the limits of the buffer size.

Impact on Configuration Values and Variables

When you back up an EcoStruxure BMS server specifying either Configuration
only or All data, the EcoStruxure Building Operation back up includes all the
configuration values that are specified for the EcoStruxure BMS server’s objects.
If you restore the EcoStruxure BMS server back up, the configuration values are
restored, which can overwrite any changes made since the last backup. For more
information, see section 26.3 “Retain Level ” on page 491.

Backup Strategy
When deciding on the frequency of EcoStruxure BMS server backups, you
should take into account the potential cost of recreating any historical or
configuration data that can change since the last backup. For example, you can
perform an All data backup back up an Automation server weekly if multiple
operators use their WorkStations frequently. As a precaution, you can perform a
Configuration only backup before installing a new application or modifying the
current configuration.

04-40008-03-en, June 2022 IT

499
27 Backups
27.3 Backup Status

27.3 Backup Status

Backup Status displays the statuses of an EcoStruxure BMS server: Ready,
Backing up, or Backup succeeded.
If a backup does not succeed, the system displays a default alarm informing you
of the backup or EcoStruxure BMS server issue. For more information, see the
Backup and Restore Alarms topic on WebHelp.

IT 04-40008-03-en, June 2022

500
 27 Backups
27.4 Checking the Backup Status of an EcoStruxure BMS Server

27.4 Checking the Backup Status of an

EcoStruxure BMS Server
You check the backup status of an EcoStruxure BMS server to view its backup
status and note the date and time of the last backup.
For more information, see section 27.3 “Backup Status” on page 500.

To check the backup status of an EcoStruxure BMS server

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup and Restore Manager.
4. View the EcoStruxure BMS server backup status or date and time of the last
successful backup.

04-40008-03-en, June 2022 IT

501
27 Backups
27.5 Manual Backups

27.5 Manual Backups

Manual Backup is a non-automated process of copying and storing data on a
selected EcoStruxure BMS server. You can use this option to create backups on
an as-needed basis. You can also manually restore the data at any time.
You log on to one of the following EcoStruxure BMS servers to initiate a manual
backup:
• Automation server or Enterprise Server to perform a local backup. For more
information, see section 27.9 “Local Backup and Restore of EcoStruxure
BMS Servers” on page 508.
• Enterprise Server to perform a remote backup of any automation servers
that are created under the Enterprise Server. For more information, see
section 27.10 “Remote Backup and Restore of Automation Servers” on page
509.
• Enterprise Central to perform a remote backup of any Enterprise Servers
that are created under the Enterprise Central. For more information, see
section 27.9 “Local Backup and Restore of EcoStruxure BMS Servers” on
page 508.

27.5.1 Backup Set Naming

For manual backups, the system initially names the backup set by combining the
EcoStruxure BMS server name with the localized date and time of the machine
running WorkStation. For scheduled backups, however, the system combines the
EcoStruxure BMS server name with the UTC time in the backup set name rather
than the local time.
TIP: The system also retains the UTC time of manually generated backups.
To view the UTC time rather than the localized time for a manual backup set,
select the Backup date property from the column selector of the Backup
Sets List view. For more information, see the Columns topic on WebHelp.
If you log on to the Enterprise Server in WorkStation to create a backup of the
automation server, the system automatically checks for identical backup set
names. If a name is found in the AS Archives folder, the system warns of a
potential duplication by highlighting the Backup set name prefix box or the
Backup set name suffix box in solid red. If you do not change the prefix or suffix,
the system displays a red box around the backup set in the Backup set name
column to indicate that there is an existing name. If you still do not change the
name, the system automatically appends an extended time stamp to prevent the
accidental overwriting. For more information, see the Duplicate Backup Set
Names in Multi-server Systems topic on WebHelp.

27.5.2 Local Backup and Restore of EcoStruxure

BMS Servers
In WorkStation, you can log on to an EcoStruxure BMS server directly to perform
manual backup and restore tasks.
For more information, see section 27.9 “Local Backup and Restore of
EcoStruxure BMS Servers” on page 508.

IT 04-40008-03-en, June 2022

502
 27 Backups
27.5 Manual Backups

27.5.3 Remote Backup and Restore of Automation

Servers
When you log on to an Enterprise Server, you can perform remote backups of
any automation server in the system. Whenever a backup occurs on the
automation server, the system overwrites the locally stored file on the automation
server with the new backup file. The Enterprise Server then retrieves and stores
this backup file in a separate directory on the computer that runs the Enterprise
Server.
For more information, see section 27.10 “Remote Backup and Restore of
Automation Servers” on page 509.

27.5.4 Local Backup of EcoStruxure BMS Servers

using Device Administrator
You can manually create backup sets using Device Administrator. The backup
sets can be saved at any location. One or many EcoStruxure BMS Servers can
be backed up at the same time.
For more information, see section 27.11 “Local Backup of EcoStruxure BMS
Servers using Device Administrator” on page 510.

04-40008-03-en, June 2022 IT

503
27 Backups
27.6 Mass Backup

27.6 Mass Backup

Mass backup is a method of performing a manual, simultaneous backup of all the
EcoStruxure BMS servers in the network, which is useful for capturing data at a
critical point, such as prior to an upgrade. You can choose which EcoStruxure
BMS servers you want to back up along with the type of data for each.
In smaller installations, a server group may include an Enterprise Server and one
or more automation servers. In larger installations, multiple server groups may
include an Enterprise Server with a distinct set of automation servers.
In an EcoStruxure BMS that has an Enterprise Central with attached Enterprise
Servers, you can do a mass backup of all the Enterprise Servers.

Figure: Mass backup of an Enterprise Server and automation servers

You log on to the Enterprise Server to create a mass backup. For more
information, see section 31.6 “Backup Options Dialog Box” on page 573.

IT 04-40008-03-en, June 2022

504
 27 Backups
27.7 Backing Up EcoStruxure BMS Servers Manually

27.7 Backing Up EcoStruxure BMS Servers

Manually
You back up multiple EcoStruxure BMS servers manually to copy and store data
that is frequently updated.
For more information, see section 27.5 “Manual Backups” on page 502.

To back up EcoStruxure BMS servers manually

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server.
2. On the Actions menu, click Backup.
3. In the Backup Options dialog box, in the Backup set name prefix box,
type some text at the beginning of the file name that helps identify the
backup set.
4. In the Backup set name suffix box, type some text at the end of the file
name that helps identify the backup set.
5. In the Include column, select the EcoStruxure BMS servers that you want to

include in the backup, or click the Select All button to include all the
listed EcoStruxure BMS servers in the backup.
6. In the Backup content column, select the type of data you want to back up
for each EcoStruxure BMS server:
• Select Configuration only to back up the configuration database and
custom object type data.
• Select All data to back up the configuration, historical data, and custom
object type data.
7. In the Backup set description column, type a brief description up to 255
characters to help identify the content of each backup.

8. Click the Synchronize Description button to add the same backup set
description entered for one EcoStruxure BMS server to all the other backup
sets.

9. Click the Synchronize Content button to add the same content type
chosen for one EcoStruxure BMS server to all the other backup sets.

10. Click the Synchronize All button to add both the backup set
description and the content type chosen for one EcoStruxure BMS server to
all the other backup sets.
11. Click Backup.
12. In the Backup Status dialog box, verify that the backups succeeded and
click Close.

04-40008-03-en, June 2022 IT

505
27 Backups
27.8 System Backup

27.8 System Backup

Before upgrading the system, it is strongly recommended that you archive the
historical data and back up the EcoStruxure BMS servers to preserve the current
data and configurations. If you plan to upgrade WebReports, be sure to back up
the Reports database in SQL Server.
The following diagram describes the recommended steps for archiving and
backing up a multi-server system running EcoStruxure Building Operation
software.

Figure: System archive and backup process overview

Table: System Archive and Backup Process Overview

Step Procedure Description

1 Archive system data Perform a manual archive of the system

historical data in the Enterprise Server or
Enterprise Central. (Archiving is not on
Automation servers.) For more information,
see the Manually Creating an Archive topic on
WebHelp.

2 Back up current EcoStruxure Create an All data backup for the Enterprise
BMS servers Central, Enterprise Server, and each
Automation server. The backups do not need
to follow any particular order. For more
information, see section 27.7 “Backing Up
EcoStruxure BMS Servers Manually” on page
505.

IT 04-40008-03-en, June 2022

506
 27 Backups
27.8 System Backup

Continued
Step Procedure Description

3 Save backup sets to an external Save the Enterprise Central, Enterprise

location Server, and Automation server backup sets
(.xbk) to a safe location on a file system that is
external to the Entrerprise Central or
Enterprise Server. For more information, see
section 28.3 “Backup Set Storage and
Protection” on page 519.

4 Back up current Reports For systems that include a Reports Server,

database back up the WebReports database. For more
information, see the Backing Up the
WebReports Database topic on WebHelp.
You can also back up the Reports database
folder to another location on the file system
(not the default source location in the
C:\Program Files\ directory).

04-40008-03-en, June 2022 IT

507
27 Backups
27.9 Local Backup and Restore of EcoStruxure BMS Servers

27.9 Local Backup and Restore of

EcoStruxure BMS Servers
In WorkStation, you can log on to an EcoStruxure BMS server directly to perform
manual backup and restore tasks.

27.9.1 Local Backup and Restore of a Standalone

Automation Server
In WorkStation, you can log on to an automation server to perform a manual
backup of the automation server data.
If you have multiple standalone automation servers, the Backup and Restore
processes on one automation server remain self-contained and, therefore,
separate from any another automation server on the network.
In a stand-alone system only one backup set is stored on the automation server.
If you import a backup set, the system overwrites the locally stored file with the
imported file. Therefore, you only see one backup file in the Restore Options
dialog box when you log on to an automation server.

27.9.2 Local Backup and Restore of an Enterprise

Server
In WorkStation, you can log on to an Enterprise Server to perform a manual
backup of the Enterprise Server data. If you have multiple Enterprise Servers, the
Backup and Restore processes on one Enterprise Server remain self-contained
and, therefore, separate from any another Enterprise Server on the network.

27.9.3 Local Backup and Restore of an Enterprise

Central
In WorkStation, you can log on to an Enterprise Central to perform a manual
backup of the Enterprise Central data. The Backup and Restore processes on
Enterprise Central are self-contained.

IT 04-40008-03-en, June 2022

508
 27 Backups
27.10 Remote Backup and Restore of Automation Servers

27.10 Remote Backup and Restore of

Automation Servers
When you log on to an Enterprise Server, you can perform remote backups of
any automation server in the system. Whenever a backup occurs on the
automation server, the system overwrites the locally stored file on the automation
server with the new backup file. The Enterprise Server then retrieves and stores
this backup file in a separate directory on the computer that runs the Enterprise
Server.
When you want to restore an automation server, the system displays only the
valid automation server backup files that are stored on the Enterprise Server.
In the event that the backup file on the automation server is damaged or lost, or
not the one you want to use, you can select a valid backup file to restore the
automation server. The restore operation overwrites the locally stored automation
server backup file located on the automation server with the selected backup file.
For more information, see section 30.4 “Restoring an Automation Server from the
Enterprise Server” on page 553.

04-40008-03-en, June 2022 IT

509
27 Backups
27.11 Local Backup of EcoStruxure BMS Servers using Device Administrator

27.11 Local Backup of EcoStruxure BMS

Servers using Device Administrator
You can manually create backup sets using Device Administrator. The backup
sets can be saved at any location. One or many EcoStruxure BMS Servers can
be backed up at the same time.
To be able to create backup sets of an Enterprise Server or an Enterprise
Central, you must run Device Administrator on the same computer as the
Enterprise Server or Enterprise Central. You must also run Device Administrator
as an administrator. Refer to Windows for information on how to run a program
as administrator.
NOTE:
• The attached automation servers of an Enterprise Server are not included
in the backup set of an Enterprise Server.
• The attached Enterprise Servers are not included in the backup set of an
Enterprise Central.
For more information, see section 27.12 “Getting Backup set from an
EcoStruxure BMS Server using Device Administrator ” on page 511.

IT 04-40008-03-en, June 2022

510
 27 Backups
27.12 Getting Backup set from an EcoStruxure BMS Server using Device Administrator

27.12 Getting Backup set from an EcoStruxure

BMS Server using Device Administrator
You can create backup sets from an EcoStruxure BMS server using Device
Administrator.
For more information, see section 27.11 “Local Backup of EcoStruxure BMS
Servers using Device Administrator” on page 510.

To get backup set from an EcoStruxure BMS server using

Device Administrator
1. In Device Administrator, click Servers and then select the EcoStruxure BMS
Server(s).
2. Click Get backup set.

04-40008-03-en, June 2022 IT

511
28 Backup Sets

Topics
Backup Sets
Location of Backup Sets
Backup Set Storage and Protection
Locating the Local Backup Path on the Enterprise Server or
Enterprise Central
Saving an Enterprise Server or Enterprise Central Backup
Set to Another Location
Saving an Automation Server Backup Set to Another
Location
Copying a Backup Set to the Enterprise Server or Enterprise
Central Local Directory
Backup Set Import from WorkStation
Importing a Backup Set to an Enterprise Server or Enterprise
Central
Importing a Backup Set to Automation Server
Automatic Purge of Backup Sets
Configuring Purge Settings on an Enterprise Server
Configuring Purge Settings on an Enterprise Central
Deleting a Backup Set from an Enterprise Server or
Enterprise Central
 28 Backup Sets
28.1 Backup Sets

28.1 Backup Sets

Backup sets are compressed backup files used for restoring data. The
EcoStruxure Building Operation software stores the local backup set for an
Enterprise Server or automation servers in the Local folder within the Backup
sets folder.

28.1.1 Backup Sets Location

Backup sets are stored in different locations for stand-alone systems and multi-
server systems.
For more information, see section 28.2 “Location of Backup Sets” on page 517.

28.1.2 Backup Sets and Server Name

The EcoStruxure Building Operation software associates each backup set with a
particular EcoStruxure BMS server name. Therefore, you should not rename an
EcoStruxure BMS server unless absolutely necessary. If you do rename an
EcoStruxure BMS server, the previous backup sets do not display in the Restore
Options dialog box. You can view all the backup sets that are stored locally on an
Enterprise Server. For more information, see section 28.4 “Locating the Local
Backup Path on the Enterprise Server or Enterprise Central” on page 521.
TIP: Going forward, you must create new backups for the renamed
EcoStruxure BMS server.

28.1.3 Backup Set Storage and Protection

EcoStruxure BMS servers store backup sets in their local directories. By design,
the average user may not easily locate these backup directories using a
Windows-based file system. For convenience, you can save backup sets stored
on EcoStruxure BMS servers to WorkStation. After saving the backup set, you
can also copy the file to another backup storage location.
For more information, see section 28.3 “Backup Set Storage and Protection” on
page 519.

28.1.4 Backup Set Import from WorkStation

You import a backup set from WorkStation to replace a lost or incomplete backup
set, or to add a backup set to a new EcoStruxure BMS server.
For more information, see section 28.8 “Backup Set Import from WorkStation” on
page 525.

04-40008-03-en, June 2022 IT

515
28 Backup Sets
28.1 Backup Sets

28.1.5 Automatic Purge of Backup Sets

An Enterprise Server stores multiple local and remote backup sets. As a result,
these sets can consume much needed space on the Enterprise Server. To
resolve this problem, you can configure the Enterprise Server to remove outdated
backup sets.
For more information, see section 28.11 “Automatic Purge of Backup Sets” on
page 529.

IT 04-40008-03-en, June 2022

516
 28 Backup Sets
28.2 Location of Backup Sets

28.2 Location of Backup Sets

Backup sets are stored in different locations for stand-alone systems and multi-
server systems.

28.2.1 Multi Server System

In a multi-server system with an Enterprise Server and one or more automation
servers, the backup sets are stored on the computer that runs the Enterprise
server. The automation server also store its own backup set.
In a multi-server system with an Enterprise Central and one or more attached
Enterprise Servers, the backup sets for the Enterprise Central are stored on the
computer running the Enterprise Central. The backup sets for the attached
Enterprise Servers are stored on the computers running the Enterprise Servers.
Using WorkStation, you can copy the backup set to a location other than the
EcoStruxure BMS server.
For more information, see section 28.7 “Copying a Backup Set to the Enterprise
Server or Enterprise Central Local Directory” on page 524.
In the Backup sets folder of the installation directory, two directories are created:
• AS Archives: Lists separate subfolders that reflect the name of each
automation server. Each subfolder contains the backup files for that
automation server.
• Local: Lists all the local backup files for the Enterprise Server and Enterprise
Central.

Figure: Location of backup sets

28.2.2 Stand-alone System

In a stand-alone system the backup set is saved in the Smart Struxure server
device. Using WorkStation, you can save the backup set to a location other than
the automation server.
For more information, see section 28.6 “Saving an Automation Server Backup
Set to Another Location” on page 523.

04-40008-03-en, June 2022 IT

517
28 Backup Sets
28.2 Location of Backup Sets

The automation server stores only one backup set at a time, so each new backup
operation overwrites the previous backup set.

IT 04-40008-03-en, June 2022

518
 28 Backup Sets
28.3 Backup Set Storage and Protection

28.3 Backup Set Storage and Protection

EcoStruxure BMS servers store backup sets in their local directories. By design,
the average user may not easily locate these backup directories using a
Windows-based file system. For convenience, you can save backup sets stored
on EcoStruxure BMS servers to WorkStation. After saving the backup set, you
can also copy the file to another backup storage location.
Saving a backup set to a storage location is a two-step process: saving the
backup set and then relocating the file to another location. First, you save the
backup set to WorkStation. Second, you copy the backup set from WorkStation
to another storage location on your network, such as a USB drive.

Figure: Copy backup set from an automation server to a network drive

Uniquely Named Storage Directory

To save time, you can create a uniquely named directory in which to store your
saved backup sets for a particular EcoStruxure BMS server. This unique folder
name can help you identify a particular Enterprise Server or automation server
backup set, such as AS-1 Final Configuration Backup. Using this method, you
can easily locate the backup set on your network.

Backup Set Renaming

Scheduled backup sets have a unique file name and extension based on the date
stamp and server name. However, you can rename the backup set, if necessary.
For more information, see section 29.1 “Scheduled Backups” on page 535.

04-40008-03-en, June 2022 IT

519
28 Backup Sets
28.3 Backup Set Storage and Protection

Backup Set Removal

You can remove backups sets in two ways:
• Manually: You can delete backups sets using a browser. For more
information, see section 28.14 “Deleting a Backup Set from an Enterprise
Server or Enterprise Central” on page 532.
• Periodically: You can configure the system to remove backup sets on a
regular basis. For more information, see section 28.11 “Automatic Purge of
Backup Sets” on page 529.

IT 04-40008-03-en, June 2022

520
 28 Backup Sets
28.4 Locating the Local Backup Path on the Enterprise Server or Enterprise Central

28.4 Locating the Local Backup Path on the

Enterprise Server or Enterprise Central
You locate the local backup folder on the Enterprise Server or Enterprise Central
to view the stored backup sets. The system displays the valid backup sets stored
in this folder in the Restore Options dialog box.
For more information, see section 28.3 “Backup Set Storage and Protection” on
page 519.

To locate a local backup path on the Enterprise Server or

Enterprise Central
1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Backup and restore manager.
4. In the Backup sets path box, view the local backup path on the Enterprise
server.

04-40008-03-en, June 2022 IT

521
28 Backup Sets
28.5 Saving an Enterprise Server or Enterprise Central Backup Set to Another Location

28.5 Saving an Enterprise Server or

Enterprise Central Backup Set to
Another Location
You save a backup set from an Enterprise Server or Enterprise Central to
another location, for example, a network drive or a USB memory.
For more information, see section 28.3 “Backup Set Storage and Protection” on
page 519.

To save an Enterprise Server or Enterprise Central backup set

to another location
1. On the Tools menu, select Control Panel.
2. On the Control Panel toolbar, select the Enterprise Server or Enterprise
Central.
3. Click Backup Sets.
4. In the List View, open the Local folder.
5. Select the Enterprise Server backup set that you want to save to a different
location.
6. On the Actions menu, click Save to.
7. In the Save As dialog box, enter a storage location and click Save.
8. Click Close.

IT 04-40008-03-en, June 2022

522
 28 Backup Sets
28.6 Saving an Automation Server Backup Set to Another Location

28.6 Saving an Automation Server Backup

Set to Another Location
You save a backup set from an automation server to another location so you can
store the backup set on, for example, a network drive or a USB memory.

To save a Automation server backup set to another location

1. In WorkStation, on the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the EcoStruxure BMS server.
3. Click Backup Sets.
4. In the List View, open the Local folder for an automation server or the AS
Archives folder for an Enterprise Server.
5. If connected to the Enterprise Server, open the automation server folder that
contains the backup set.
6. Select the backup set that you want to save to a different location.
7. On the Actions menu, click Save To.
8. In the Save As dialog box, enter a storage location and click Save.
9. Click Close.

04-40008-03-en, June 2022 IT

523
28 Backup Sets
28.7 Copying a Backup Set to the Enterprise Server or Enterprise Central Local Directory

28.7 Copying a Backup Set to the Enterprise

Server or Enterprise Central Local
Directory
You copy a backup set to the Local (db_backup) folder to restore the targeted
Enterprise Server or Enterprise Central.
For more information, see section 28.3 “Backup Set Storage and Protection” on
page 519.

To copy a backup set to the Enterprise Server or Enterprise

Central local directory
1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Backup and Restore Manager.
4. In the Backup sets path box, copy the entire backup sets path of the
Enterprise Server or Enterprise Central.
5. Open a browser, such as Windows Explorer.
6. In the browser Address box, paste the backup sets path and press Enter.
7. In the db_backup folder, open the LocalBackup folder.
8. Right click the backup set that you want to copy and click Copy.
9. Navigate to the db_backup folder of the Enterprise Server that you want to
restore.
10. Paste the backup set into the LocalBackup folder of the targeted Enterprise
Server.
NOTE: If the LocalBackup folder does not appear within the
db_backup folder, you can create one using the exact name,
LocalBackup.
You can now restore the Enterprise Server or Enterprise Central using this
backup set. For more information, see section 30.3 “Restoring the EcoStruxure
BMS Server” on page 552.

IT 04-40008-03-en, June 2022

524
 28 Backup Sets
28.8 Backup Set Import from WorkStation

28.8 Backup Set Import from WorkStation

You import a backup set from WorkStation to replace a lost or incomplete backup
set, or to add a backup set to a new EcoStruxure BMS server. The EcoStruxure
Building Operation software stores a local backup set for an Enterprise Server or
automation servers under the Local folder in the Backup Sets folder. However,
the system handles the storage of backup sets based on the type of EcoStruxure
BMS server. For example, an automation server stores only one backup set at a
time. Therefore, the system overwrites the previous backup file with the latest file.
If there is no file present, the EcoStruxure Building Operation software adds the
backup set to the Local folder.
In a multi-server system with an Enterprise server and automation servers, the
Enterprise Server retrieves and stores the latest backup set for each automation
server in a separate directory in the Backup Sets folder. In addition, the system
can store several backup sets for each automation server as well as multiple
backup sets for the Enterprise Server.
In a multi-server system with an Enterprise Central, the Enterprise Central does
not retrieve and store the backup set for each Enterprise Server on the computer
that runs the Enterprise Central. When you restore an Enterprise Server from an
Enterprise Central, you use the backup sets that are stored on the computers
running the Enterprise Servers.
IMPORTANT: When you back up the Enterprise Servers from an Enterprise
Central, the automation servers that are attached to the Enterprise Servers
are not backed up. To make a backup of Smart X server you start by backing
up the Smart X servers using the Enterprise Servers. When that is done, you
back up all the Enterprise Servers using the Enterprise Central.

Figure: Import backup set from WorkStation to an automation servers or Enterprise Server

04-40008-03-en, June 2022 IT

525
28 Backup Sets
28.8 Backup Set Import from WorkStation

Importing is a three-step process: logging onto the EcoStruxure BMS server,

importing the file, and then restoring the EcoStruxure BMS server. First, you log
onto an EcoStruxure BMS server in WorkStation. You then import the selected
backup set from a network storage area. Finally, you restore the EcoStruxure
BMS server.
You can only restore an EcoStruxure BMS server using a backup set that was
created with the same software version on the same EcoStruxure BMS server
(including service pack). To help identify the usable backup sets, the system
displays the compatible files in black text and the incompatible files in red text. If
you select an incompatible backup set to restore an EcoStruxure BMS server, no
backup set displays after importing.

IT 04-40008-03-en, June 2022

526
 28 Backup Sets
28.9 Importing a Backup Set to an Enterprise Server or Enterprise Central

28.9 Importing a Backup Set to an Enterprise

Server or Enterprise Central
You import a backup set from a network storage location to restore an Enterprise
Server or Enterprise Central, or to replace a lost or damaged backup set.
For more information, see section 28.8 “Backup Set Import from WorkStation” on
page 525.

To import a backup set to an Enterprise Server or Enterprise

Central
1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central.
2. On the Actions menu, click Restore.
3. In the Restore Options dialog box, click Import Backup Set.
4. Select a backup set that is stored on a file system and click Open.
5. Click Yes if you want to replace an existing backup set.
6. Click Close.
You can now restore the Enterprise Server or Enterprise Central with the
imported backup set.

04-40008-03-en, June 2022 IT

527
28 Backup Sets
28.10 Importing a Backup Set to Automation Server

28.10 Importing a Backup Set to Automation

Server
You import a backup set from a network storage location to restore a
replacement automation server, or to replace a lost or damaged backup set.
For more information, see section 28.8 “Backup Set Import from WorkStation” on
page 525.

To import a backup set to automation server

1. Log on to the automation server to which you want to import a backup set.
2. In WorkStation, in the System Tree pane, select the automation server.
3. On the Actions menu, click Restore.
4. In the Restore Options dialog box, click Import Backup Set.
5. In the Confirm Replace dialog box, click OK.
6. Select a valid backup set that is stored on a file system and click Open.
7. Click Close.
You can now restore the automation server with the imported backup set.

IT 04-40008-03-en, June 2022

528
 28 Backup Sets
28.11 Automatic Purge of Backup Sets

28.11 Automatic Purge of Backup Sets

An Enterprise Server or Enterprise Central stores multiple local and remote
backup sets. These sets can consume much needed space on the computer
running the Enterprise Server or Enterprise Central. To resolve this problem, you
can configure the Enterprise Server or Enterprise Central to remove outdated
backup sets.
You configure purge settings on an Enterprise Server, rather than automation
servers. For more information, see section 31.4 “Backup and Restore Manager
on the Enterprise Server” on page 570.
In a multi-server system with an Enterprise Central, you configure the purge
settings on both the Enterprise Central and the Enterprise Servers.

Purge Configuration on an Enterprise Server or an Enterprise

Central
You can set the maximum number of local and remote backups that you want to
store at a given time on the Enterprise Server or the Enterprise Central. The
system compares two values:
• the maximum number that you configured for the Enterprise Server or the
Enterprise Central
• the date stamp on each stored backup
Whenever a new backup is created, the most recent backup set replaces the
most outdated backup set. In other words, the system adds a file and then
deletes the oldest file to maintain the maximum number that you configured for
the Enterprise server or the Enterprise Central.

Local and Remote Purge Settings

You can manage automatic purging on an Enterprise Server or an Enterprise
Central by configuring a maximum number of files to store. There are two purge
settings:
• Local setting for the Enterprise Central or Enterprise Server: The local
setting, Number of local backup sets to store, manages the backups
stored on an Enterprise Central or Enterprise Server.
• Global setting for automation servers: The global setting, Number of AS
backup sets to store, manages all the backups stored on the automation
servers. You cannot configure each automation server separately because
the global setting affects all the automation servers created under the
Enterprise Server.
You can vary the number of local and remote backup sets that you store. For
example, you can configure the system to store a maximum of five local backup
sets for the Enterprise Server and two remote backup sets for each automation
server.

Enable/Disable Automatic Purging

By default, the EcoStruxure Building Operation software enables automatic
purging for both local (Enterprise Server and Enterprise Central) and remote
(automation servers) backup sets. However, you can disable this feature to
ensure that all manual and scheduled backup sets are automatically stored on
the Enterprise Server or Enterprise Central. For more information, see section
31.4 “Backup and Restore Manager on the Enterprise Server” on page 570.

04-40008-03-en, June 2022 IT

529
28 Backup Sets
28.12 Configuring Purge Settings on an Enterprise Server

28.12 Configuring Purge Settings on an

Enterprise Server
You purge outdated backup sets to help reduce the resource constraints on an
Enterprise Server. You cannot configure these settings on an automation server.
For more information, see section 28.11 “Automatic Purge of Backup Sets” on
page 529.

To configure purge settings on an Enterprise Server

1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. In the Backup and archiving area, click Backup and restore manager.
4. In the Number of Automation Server backup sets to store box, enter the
maximum number of backups that the Enterprise Server can store for each
automation server.
5. In the Number of local backup sets to store box, enter the maximum
number of backup sets that the system can store for the Enterprise Server.
6. On the File menu, click Save.

IT 04-40008-03-en, June 2022

530
 28 Backup Sets
28.13 Configuring Purge Settings on an Enterprise Central

28.13 Configuring Purge Settings on an

Enterprise Central
You purge outdated backup sets to help reduce the resource constraints on an
Enterprise Central.
For more information, see section 28.11 “Automatic Purge of Backup Sets” on
page 529.

To configure purge settings on an Enterprise Central

1. In WorkStation, on the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the Enterprise Central.
3. In the Backup and archiving area, click Backup and Restore Manager.
4. In the Number of local backup sets to store box, enter the maximum
number of backups that the Enterprise Central can store.

5. Click the Save button .

04-40008-03-en, June 2022 IT

531
28 Backup Sets
28.14 Deleting a Backup Set from an Enterprise Server or Enterprise Central

28.14 Deleting a Backup Set from an

Enterprise Server or Enterprise Central
You delete a backup set from the db_backup folder of the Enterprise Server or
Enterprise Central when you no longer need the backup set.
For more information, see section 28.1 “Backup Sets” on page 515.

To delete a backup set from the Enterprise Server or

Enterprise Central
1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Backup and Restore Manager.
4. In the Backup and Restore Manager, in the Backup sets path box, copy
the entire backup sets path of the Enterprise Server.
5. Open a browser, such as Windows Explorer.
6. In the browser Address box, paste the backup sets path and press Enter.
7. In the db_backup folder, open the ASArchives or LocalBackup folder.
8. Right-click on the backup set that you want to delete and click Delete.
9. Click Yes to remove the backup set.

IT 04-40008-03-en, June 2022

532
29 Scheduled Backups

Topics
Scheduled Backups
Backup Rules
Creating a Backup Rule
Editing a Backup Rule
Deleting a Backup Rule
Removing a Lead Rule from a Backup Rule
Backup Schedules
Editing a Backup Schedule
Synchronized Backups
Synchronizing EcoStruxure BMS Server Backups on a
Network
 29 Scheduled Backups
29.1 Scheduled Backups

29.1 Scheduled Backups

A scheduled backup is an automated way to back up data on an EcoStruxure
BMS server. You can back up EcoStruxure BMS servers individually using each
EcoStruxure BMS server’s local backup rule. You can also use backup rules to
synchronize the backups of all the EcoStruxure BMS servers on your network.
As part of the scheduled backup process, EcoStruxure Building Operation
software automatically generates unique file names and extensions based on the
UTC date stamp and version number. However, you can change the file name
after the automatic backup is completed. You can also enter a unique file name
when you back up an EcoStruxure BMS server manually. For more information,
see section 27.5 “Manual Backups” on page 502.

Figure: Backup on an Enterprise Server

29.1.1 Backup Rules

The EcoStruxure Building Operation scheduled backups are managed by backup
rules, which are conditions that govern behavior. Similar to a scheduled task, a
backup rule performs a backup on an EcoStruxure BMS server using three
pieces of data: when the backup occurs, what type of data will be backed up, and
a comment describing the purpose of the backup.

04-40008-03-en, June 2022 IT

535
29 Scheduled Backups
29.1 Scheduled Backups

For more information, see section 29.2 “Backup Rules” on page 537.

29.1.2 Backup Schedules

The EcoStruxure Building Operation database includes a digital schedule that is
combined with a default backup rule. Using this schedule and rule, the system
automatically backs up all data on an EcoStruxure BMS server every Sunday at
01:00. You can edit the schedule settings for this backup rule, but you cannot
delete the schedule and select another.
For more information, see section 29.7 “Backup Schedules” on page 542.

29.1.3 Synchronized Backups

A synchronized backup is a method of performing a recurring, simultaneous
backup of a selected number of EcoStruxure BMS servers. You can use a lead
and shadow relationship to automate all the EcoStruxure BMS server backups on
your network. Using this method, you configure and manage one lead backup
rule on one EcoStruxure BMS server, which other backup rules can reference.
For more information, see section 29.9 “Synchronized Backups” on page 544.

IT 04-40008-03-en, June 2022

536
 29 Scheduled Backups
29.2 Backup Rules

29.2 Backup Rules

The EcoStruxure Building Operation scheduled backups are managed by backup
rules, which are conditions that govern behavior. Similar to a scheduled task, a
backup rule performs a backup on an EcoStruxure BMS server using three
pieces of data: when the backup occurs, what type of data will be backed up, and
a comment describing the purpose of the backup.
The EcoStruxure Building Operation software automatically backs up all data on
an EcoStruxure BMS server every Sunday at 01:00. However, you can change
the backup rule settings. For example, you can change the type of data you want
to back up.
You can create your own backup rules to complete different tasks on different
EcoStruxure BMS servers. For example, you can create a backup rule that backs
up all data on the Enterprise Server twice a day rather than once a week based
on the default setting. In addition, you can set up another backup rule for one
EcoStruxure BMS server, which acts as the lead, to manage a recurring backup
for a group of EcoStruxure BMS servers. For more information, see section 31.9
“Backup Rules View” on page 577.

04-40008-03-en, June 2022 IT

537
29 Scheduled Backups
29.3 Creating a Backup Rule

29.3 Creating a Backup Rule

You create a backup rule on an EcoStruxure BMS server to schedule periodic
backups. You can also set up this backup rule to follow a shadow schedule that
references a lead schedule managed on another EcoStruxure BMS server.
For more information, see section 29.2 “Backup Rules” on page 537.

To create a backup rule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup rules.

4. In the Backup rules, click the Add backup rule button .

5. In the Create Object wizard, in the Name box, type a name for the backup
rule.
6. In the Description box, type a description for the backup rule and click
Next.
7. In the Configure Backup Rule page, in the Backup set description box,
type a comment up to 255 characters to help identify the content of the
backup.
8. In the Backup content box, select the type of data you want to back up:
• Select Configuration only to back up the configuration database and
custom object type data. For example, use this option to restore data to
a replaced server with the same name in the system.
• Select All data to back up the configuration, historical, and custom
object type data. For example, use this option to preserve the
configuration and historical data for a specified date and time.
9. In the Lead rule box, enter a backup rule that references a lead schedule
managed on another EcoStruxure BMS server.
10. In the Enabled box, select Yes to enable the backup rule.
11. Click Create.

IT 04-40008-03-en, June 2022

538
 29 Scheduled Backups
29.4 Editing a Backup Rule

29.4 Editing a Backup Rule

You edit a backup rule on an EcoStruxure BMS server to change the type of data
that you want to back up. You can also set up this backup rule to follow a shadow
schedule that references a lead schedule managed on another EcoStruxure BMS
server.
For more information, see section 29.2 “Backup Rules” on page 537.

To edit a backup rule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup rules.
4. In the Backup rules view, select a backup rule and then click the Edit

backup rule button .

5. In the Backup rule dialog box, in the Backup set description box, type or
modify the backup comment.
6. In the Backup content box, change the type of data you want to back up:
• Select Configuration only to back up the configuration database and
custom object type data. For example, use this option to restore data to
a replaced EcoStruxure BMS server with the same name in the system.
• Select All data to back up the configuration, historical, and custom
object type data. For example, use this option to preserve the
configuration and historical data for a specified date and time.
7. In the Lead rule box, enter a backup rule that references a lead schedule
managed on another EcoStruxure BMS server.
8. In the Enabled box, select Yes to enable the backup rule.
9. Click OK.
10. On the File menu, click Save.

04-40008-03-en, June 2022 IT

539
29 Scheduled Backups
29.5 Deleting a Backup Rule

29.5 Deleting a Backup Rule

You delete a backup rule to remove the rule from the EcoStruxure BMS server.
For more information, see section 29.2 “Backup Rules” on page 537.

To delete a backup rule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup Rules.
4. In the Backup rules view, select the backup rule and then click the

Remove backup rule button .

5. Click Yes to delete the backup rule from the EcoStruxure BMS server.
6. On the File menu, click Save.

IT 04-40008-03-en, June 2022

540
 29 Scheduled Backups
29.6 Removing a Lead Rule from a Backup Rule

29.6 Removing a Lead Rule from a Backup

Rule
You remove the lead and shadow relationship from an EcoStruxure BMS server
by deleting the lead rule reference.
For more information, see section 29.2 “Backup Rules” on page 537.

To remove a lead rule from a backup rule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. In the Backup and Archiving area, click Backup rules.
4. In the Backup rules view, select the backup rule and click the Edit backup

rule button .
5. In the Backup Rule dialog box, in the Lead rule box, delete the lead
backup rule, which removes the lead and shadow relationship for the
selected EcoStruxure BMS server.
6. Click OK.
7. On the File menu, click Save.

04-40008-03-en, June 2022 IT

541
29 Scheduled Backups
29.7 Backup Schedules

29.7 Backup Schedules

The EcoStruxure Building Operation database includes a digital schedule that is
combined with a default backup rule. Using this schedule and rule, the system
automatically backs up all data on an EcoStruxure BMS server every Sunday at
01:00. You can edit the schedule settings for this backup rule, but you cannot
delete the schedule and select another.
For more information, see section 29.8 “Editing a Backup Schedule” on page
543.
IMPORTANT: If the automatically scheduled backup occurs during a
Daylight Savings Time transition, the backup will not occur. To prevent loss
of data, change the scheduled backup to a time that does not conflict with
your region's Daylight Savings Time transition.

Figure: Backup on a standalone automation server

You can create a custom backup rule and then modify its schedule. For example,
you can create a backup rule that backs up all data on an automation server daily
at 02:00.
For more information, see section 29.3 “Creating a Backup Rule” on page 538.

IT 04-40008-03-en, June 2022

542
 29 Scheduled Backups
29.8 Editing a Backup Schedule

29.8 Editing a Backup Schedule

You edit a backup schedule, which is combined with a backup rule, to change the
frequency of the backup.
For more information, see section 29.7 “Backup Schedules” on page 542.

To edit a backup schedule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup rules.
4. In the Backup Rules view, in the Schedule column, click the schedule that
you want to modify.

5. Revise the schedule and then click the Save button .

04-40008-03-en, June 2022 IT

543
29 Scheduled Backups
29.9 Synchronized Backups

29.9 Synchronized Backups

A synchronized backup is a method of performing a recurring, simultaneous
backup of a selected number of EcoStruxure BMS servers. You can use a lead
and shadow relationship to automate all the EcoStruxure BMS server backups on
your network. Using this method, you configure and manage one lead backup
rule on one EcoStruxure BMS server, which other backup rules can reference.

Figure: Synchronized recurring backup – Lead/Shadow method

The system synchronizes all the shadow rules with the lead backup rule, and all
the shadow schedules with the lead schedule. For more information, see section
29.10 “Synchronizing EcoStruxure BMS Server Backups on a Network” on page
545.

IT 04-40008-03-en, June 2022

544
 29 Scheduled Backups
29.10 Synchronizing EcoStruxure BMS Server Backups on a Network

29.10 Synchronizing EcoStruxure BMS Server

Backups on a Network
You synchronize all EcoStruxure BMS server backups to increase efficiency by
centralizing the automated backup management on a single EcoStruxure BMS
server, rather than across multiple EcoStruxure BMS servers.
For more information, see section 29.9 “Synchronized Backups” on page 544.

To synchronize EcoStruxure BMS server backups on a

network
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup Rules.
4. In the Lead rule column, enter a backup rule that you want to use as the
lead rule for one or more EcoStruxure BMS servers in the list.
NOTE: When you select a lead rule, the backup rule on an
EcoStruxure BMS server becomes a shadow of the lead rule.

5. Click the Save button .

04-40008-03-en, June 2022 IT

545
30 Restore

Topics
Restore
Restored Data
Restoring the EcoStruxure BMS Server
Restoring an Automation Server from the Enterprise Server
Restoring an Enterprise Server from the Enterprise Central
Automation Server Replacement Using Restore
Automation Server Replacement Using Restore Workflow
Duplicate Automation Server from a Backup Set
Duplicating an Automation Server Using Restore
 30 Restore
30.1 Restore

30.1 Restore
Restore is the process of restoring data to an original or former state. Using
Restore, you can revert to a previous snapshot of the EcoStruxure BMS server
data despite any configuration changes made since the last backup. In the
EcoStruxure BMS, Restore is a manual process designed to avoid the accidental
overwriting of current EcoStruxure BMS server data.

30.1.1 Restored Data

Depending on what is contained in the backup file, you can restore different types
of data.
• Configuration only: the EcoStruxure Building Operation software restores
the configuration database and custom object type data. Any existing
historical data is lost when you select this option.
• All data: the EcoStruxure Building Operation software restores the
configuration, historical, and custom object types data.
For more information, see section 30.2 “Restored Data” on page 550.

30.1.2 Automation Server Replacement Using

Restore
Backup and Restore helps assure that automation server data can be restored to
a replacement automation server in the event of detected failure, or to the same
automation server in the event of data loss. As a precaution, you back up your
automation servers regularly so that you can use the most current backup to
restore the automation server data to a replacement automation server. You also
configure the new automation server to match the name and the network settings
of the replaced automation server so the system can identify this automation
server when online.
For more information, see section 30.6 “Automation Server Replacement Using
Restore” on page 555.

30.1.3 Duplicate Automation Server Using Restore

You can use the Restore function to re-use the configuration data from a backup
set in a new standalone automation server. Rather than manually configuring
your preferred automation server configuration, you can save time and configure
the standalone automation server from a backup set.
The backup set used can originate from an automation server that is or has been
part of a multi-server configuration.
For more information, see section 30.8 “Duplicate Automation Server from a
Backup Set” on page 559.

04-40008-03-en, June 2022 IT

549
30 Restore
30.2 Restored Data

30.2 Restored Data

Depending on what is contained in the backup file, you can restore different types
of data.
• Configuration only: the EcoStruxure Building Operation software restores
the configuration database and custom object type data. Any existing
historical data is lost when you select this option.
• All data: the EcoStruxure Building Operation software restores the
configuration, historical, and custom object types data.

Table: Types of Data and Content

Types of Data Content

Historical Includes Trend logs and Event logs stored on the EcoStruxure
BMS server.

Configuration Includes points, values, alarm objects, trend objects, programs,

graphics, and custom object type data stored on the EcoStruxure
BMS server.
Includes the configuration properties of variables, such as Unit.
Depending on the retain level of the variable; some configuration
properties like Value are also restored.

The EcoStruxure BMS server name is part of the restore data. Therefore, if you
rename the EcoStruxure BMS server after a backup, a restore process will revert
back to the previous EcoStruxure BMS server name.

Impact on Configuration Values and Variables

When you back up the EcoStruxure BMS server specifying either Configuration
only or All data, Building Operation includes all the configuration values that are
specified for the EcoStruxure BMS server’s objects. If you restore the
EcoStruxure BMS server, Building Operation restores these configuration values,
which can overwrite any changes made since the last backup.
Building Operation does not include most variable settings in a backup.
Consequently, Building Operation cannot restore these variable settings.
However, the system does back up the cold-start retained variables.

Restore from the Automation server

When you restore the automation server locally, the system retrieves the current
master backup set for that automation server. However, you cannot select a
particular backup set because the automation server stores only one backup set
at a time.

Restore from an Enterprise Server

Unlike the automation server, the Enterprise Server can store multiple local and
non-local backup sets. When you restore the Enterprise Server, you can select a
local backup set from a list of files to restore the Enterprise Server. In multiple
server sites, the Enterprise Server manages all the automation servers in its
group. In this configuration, the non-local backup sets are stored in separate
folders for each automation server.

IT 04-40008-03-en, June 2022

550
 30 Restore
30.2 Restored Data

When you restore the automation server from the Enterprise Server, you can
select a particular backup set from a list of files that are stored for that automation
server. This restore method provides greater flexibility. For more information, see
section 30.4 “Restoring an Automation Server from the Enterprise Server” on
page 553.

Restore from an Enterprise Central

The Enterprise Central can store multiple local and non-local backup sets. When
you restore the Enterprise Central, you can select a local backup set from a list of
files to restore the Enterprise Central.

Restore status
The EcoStruxure BMS server properties indicate if a restore was performed:
• Enterprise Server. For more information, see the Enterprise Server
Properties – Basic Tab topic on WebHelp.
• Automation server. For more information, see the SmartX Server
Properties – Basic Tab topic on WebHelp.

04-40008-03-en, June 2022 IT

551
30 Restore
30.3 Restoring the EcoStruxure BMS Server

30.3 Restoring the EcoStruxure BMS Server

You restore the EcoStruxure BMS server to revert back to a previous snapshot of
the EcoStruxure BMS server data.
For more information, see section 30.1 “Restore” on page 549.
IMPORTANT: If your system includes the Reports Server and the
Enterprise Server or Enterprise Central, stop the Reporting Agent service on
the Reports Server first to prevent report generation during a restore of the
Enterprise Server or Enterprise Central. For more information, see the
Stopping the Reporting Agent Windows Service topic on WebHelp.

To restore the EcoStruxure BMS server

1. Stop the Reporting Agent service on the Reports Server. For more
information, see the Stopping the Reporting Agent Windows Service topic
on WebHelp.
2. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server that you want to restore.
3. On the Actions menu, click Restore.
TIP: Take manual control of any output points that could potentially
damage equipment before restoring the EcoStruxure BMS server. If
you cannot disconnect the physical outputs, restore the EcoStruxure
BMS server using a trusted restore file that will turn off/on the outputs
predictably and safely.
4. In the Restore Options dialog box, in the Available restore points list,
select a backup set in black text, which indicates that the backup set is
compatible with the current version of the EcoStruxure BMS server.
5. Select the type of data you want to restore:
• Select Configuration only to restore only configuration and custom
object types' data.
• Select All data to restore the configuration, historical, and custom
object types data.
6. Click Restore.
7. Click Yes.
8. Click Close.
If your system includes the Reports Server, the Reporting Agent Windows
service restarts automatically.
9. If you restore an Enterprise Central or an Enterprise Server that is not using
the default ports, restart the server to restore the ports. For more
information, see section 15.8 “Restarting the Enterprise Server Windows
Service” on page 236.

IT 04-40008-03-en, June 2022

552
 30 Restore
30.4 Restoring an Automation Server from the Enterprise Server

30.4 Restoring an Automation Server from

the Enterprise Server
You log on to an Enterprise Server to restore an automation server.
For more information, see section 30.1 “Restore” on page 549.

To restore an Automation server from the Enterprise Server

1. In WorkStation, in the System Tree pane, select the automation server that
you want to restore.
2. On the Actions menu, click Restore.
TIP: Take manual control of any output points that could potentially
damage equipment before restoring the automation server. If you
cannot disconnect the physical outputs, restore the automation server
using a trusted restore file that will turn off/on the outputs predictably
and safely.
3. In the Restore Options dialog box, in the Available restore points list,
select a backup set in black text, which indicates that the backup set is
compatible with the current version of the automation server.
4. Select the type of data you want to restore:
• Select Configuration only to back up only configuration and custom
object types data.
• Select All data (Configuration and Historical) to back up the
configuration, historical, and custom object types data.
5. Click Restore.
6. Click Yes.
7. Click Close.
NOTE: After a restore, WorkStation may display several automation
server events in the Events pane that occurred while the restore was
taking place. However, these events are not part of the restored log
data.

04-40008-03-en, June 2022 IT

553
30 Restore
30.5 Restoring an Enterprise Server from the Enterprise Central

30.5 Restoring an Enterprise Server from the

Enterprise Central
You log on to an Enterprise Central to restore an Enterprise Server.
For more information, see section 30.1 “Restore” on page 549.

Restoring an Enterprise Server from the Enterprise Central

1. In WorkStation, in the System Tree pane, select the Enterprise Server that
you want to restore.
2. On the Actions menu, click Restore.
3. In the Restore Options dialog box, in the Available restore points list,
select a backup set in black text, which indicates that the backup set is
compatible with the current version of the Enterprise Server.
4. Select the type of data you want to restore:
• Select Configuration only to back up only configuration and custom
object types data.
• Select All data (Configuration and Historical) to back up the
configuration, historical, and custom object types data.
5. Click Restore.
6. Click Yes.
7. Click Close.

IT 04-40008-03-en, June 2022

554
 30 Restore
30.6 Automation Server Replacement Using Restore

30.6 Automation Server Replacement Using

Restore
Backup and Restore helps assure that automation server data can be restored to
a replacement automation server in the event of detected failure, or to the same
automation server in the event of data loss. As a precaution, you back up your
automation servers regularly so that you can use the most current backup to
restore the automation server data to a replacement automation server. You also
configure the new automation server to match the name and the network settings
of the replaced automation server so the system can identify this automation
server when online.

Supported cases of automation server replacements

The following cases of automation server replacements are supported using
restore:
• Replacing an automation server with an automation server of the same
automation server type
• Replacing Automation Server with a automation server
To replace Automation Server with a AS-P server, you first need to install the
server software on the new AS-P server before you can restore the configuration
data and historical data from the replaced Automation Server. For more
information, see the Uploading and Upgrading a SmartX Server topic on
WebHelp.

NOTICE
LOSS OF DATA
If you replace an Automation Server with an AS-P server, consider the
difference in RS-485 bias voltage between the two servers to avoid decreased
performance and reliability of the RS-485 network. For more information, see
the RS-485 Communications topic on WebHelp.
Failure to follow these instructions can result in loss of data.

NOTE: You can reuse an Automation Server terminal base (TB-AS-W1) for
an AS-P server module by removing the terminal block at the top of the
terminal base.

Automation server names

Typically, automation servers and WorkStations can acquire different identifiers
and user-assigned names. For example, automation server has a network
identifier, AS-000E00, which is used internally but is difficult to remember. For
convenience, you can also assign a descriptive automation server name, such as
Main Lobby-AS, to locate this automation server in Building Operation. You may
encounter these two names during configuration.

Network Device Protocols

If your network uses static IP addresses or DNS server names, you need to apply
a valid IP address or fully qualified domain name to a replacement automation
server. Specifically, you use the static IP address or fully qualified domain name
to locate the new automation server on the network. To reconfigure the default
TCP/IP settings on the new automation server to match those of the replaced
automation servers, you use the Automation Server Web Configuration utility.

04-40008-03-en, June 2022 IT

555
30 Restore
30.6 Automation Server Replacement Using Restore

If your network uses DHCP, a new automation server can automatically acquire
TCP/IP configuration information from a DHCP server. When acquired, you use
the fully qualified domain name rather than the IP address to locate the new
automation server on the network. By default, DHCP is turned off on automation
servers. To enable this and other network settings on the new automation server,
you use the Device Administrator. For more information, see the Automation
Server Device Administration topic on WebHelp.
IMPORTANT:
• Make sure that you have a valid automation server backup set before
performing a restore. A backup set can contain either configuration data
only, or both configuration and historical data.

Standalone automation server site

In a single automation server site, you log onto the automation server in
WorkStation to manage Backup and Restore operations. In this scenario, you
need to have a valid backup set to restore the automation server in case the
hardware fails or data is lost.
The automation server only stores one backup set at a time. Therefore, you
should create a backup set when the automation server is functioning properly
and then store this backup set in different location. You save and store a backup
set on your WorkStation PC or network drive. You then can import this backup
set to the automation server.

Multi-server Site
In a multi-server site, you can log onto an Enterprise Server in WorkStation to
manage backup and restore operations for all the automation servers in the
group. Unlike the automation server, which only stores one backup set at a time,
the Enterprise Server can store multiple backup sets for each automation server.
From the AS Archives folder, you can select a stored backup set that was created
when the automation server was functioning properly.
To store a backup set in another location, you save a selected backup set to a
folder on your WorkStation PC or network drive. You then log onto the new
automation server to import this backup set to the local directory. If you do not log
off from the Enterprise Server, the system uses the most current backup set
stored on the Enterprise Server hard drive instead of the newly imported file on
the automation server. Therefore, be sure to log onto the automation server
before restoring the automation server in WorkStation. For more information, see
section 28.6 “Saving an Automation Server Backup Set to Another Location” on
page 523.

30.6.1 Automation Server Replacement Using

Restore Workflow
Use the workflow to duplicate the automation server from a backup set.
For more information, see section 30.7 “Automation Server Replacement Using
Restore Workflow” on page 557.

IT 04-40008-03-en, June 2022

556
 30 Restore
30.7 Automation Server Replacement Using Restore Workflow

30.7 Automation Server Replacement Using

Restore Workflow
Use the workflow to duplicate the automation server from a backup set.

Figure: Duplicate automation server using restore flowchart

Copy automation server Backup Set to WorkStation

Save the most current backup set of the automation server that you want to
replace to WorkStation.
For more information, see section 28.6 “Saving an Automation Server Backup
Set to Another Location” on page 523.

Add new automation server to network and configure

communication settings
Add the new automation server to the network and configure the IP address.
For more information, see the Configuring a SmartX Server to Use DHCP topic
on WebHelp.
For more information, see the Configuring the SmartX Server IP Address topic on
WebHelp.

Log on to automation server using WorkStation

For more information, see the Logging on to WorkStation as an EcoStruxure
Building Operation User topic on WebHelp.

04-40008-03-en, June 2022 IT

557
30 Restore
30.7 Automation Server Replacement Using Restore Workflow

Import backup set

Import the backup set to the new automation server.
For more information, see section 28.10 “Importing a Backup Set to Automation
Server” on page 528.

Restore new automation server using the imported Backup Set

Restore the new automation server using the imported backup set.
For more information, see section 30.3 “Restoring the EcoStruxure BMS Server”
on page 552.
TIP: If the automation server does not go online, you can manually recreate
the automation server or restore the connections between the Enterprise
Server and the automation server. For more information, see the SmartX
Server Remains Offline After Restore topic on WebHelp.
The Restore process automatically renames the automation server and specifies
the objects and properties that the automation server uses to reestablish links
and go online.

IT 04-40008-03-en, June 2022

558
 30 Restore
30.8 Duplicate Automation Server from a Backup Set

30.8 Duplicate Automation Server from a

Backup Set
You can use the Restore function to re-use the configuration data from a backup
set in a new standalone automation server. Rather than manually configuring
your preferred automation server configuration, you can save time and configure
the standalone automation server from a backup set.
The backup set used can originate from an automation server that is or has been
part of a multi-server configuration.
To store a backup set in another location, you save a selected backup set to a
folder on your WorkStation PC or network drive.
For more information, see section 28.1 “Backup Sets” on page 515.

Protocol compatibility
The restore function to re-use configuration data from a backup set is supported
for all protocols supported by EcoStruxure Building Operation software, except
for BACnet and b3 BACnet.

LonWorks devices Neuron IDs deleted on duplicated automation

server
The LonWorks devices connected to the automation server are not the same as
the LonWorks devices that are to be connected to the duplicate. When you create
a duplicate from an automation server, all Neuron IDs in the duplicate are
deleted. This is also a way to avoid network conflicts.
After you created the duplicate, you add new Neuron IDs to the duplicate. You
then commission all LonWorks devices on the new automation server.
For more information, see the LonWorks Device Workflows topic on WebHelp.

Password deleted on duplicated EcoStruxure BMS device

When you duplicate a SpaceLogic device from a backup set all passwords are
deleted on the duplicate for security reasons. The only exception is the default
admin password. The administrator is forced to change the password at the first
logon at the duplicate. All users must be given new passwords by the
administrator.

Multi-server site
To create a new automation server in a multi-server configuration, using a locally
stored backup set, you need to make the backup set available for restore on the
multi-server system. You add a new automation server to the Enterprise Server
and select the backup set in the Create Object Wizard.
For more information, see the Creating an Automation Server from a Backup Set
topic on WebHelp.

Standalone automation server site

You use a locally stored backup set to duplicate another automation server
configuration in a standalone automation server. You then import the backup set
to a client and restore to the new standalone automation server.
For more information, see section 30.9 “Duplicating an Automation Server Using
Restore ” on page 562.

04-40008-03-en, June 2022 IT

559
30 Restore
30.8 Duplicate Automation Server from a Backup Set

30.8.1 Duplicate Automation Server from a Backup

Set Workflow
Use the following workflow to duplicate an automation server from a backup set.

Figure: Duplicate Automation Server using restore flowchart

Backup an automation server

Backup an automation server that has the configuration you want to use in the
new standalone automation server.
For more information, see section 27.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 505.

Copy backup set to local directory

Copy the backup set to a local directory.
For more information, see section 28.6 “Saving an Automation Server Backup
Set to Another Location” on page 523.

Log on to standalone automation server

Log on to a new standalone automation server.
For more information, see the Logging on to WorkStation as an EcoStruxure
Building Operation User topic on WebHelp.

Import backup set

Import the backup set.

IT 04-40008-03-en, June 2022

560
 30 Restore
30.8 Duplicate Automation Server from a Backup Set

For more information, see section 28.10 “Importing a Backup Set to Automation
Server” on page 528.

Restore automation server using Restore configuration with new IDs

Use the Restore configuration with new IDs function to duplicate the configuration
data from the imported backup set in the new standalone automation server. The
communication settings from the backup set are not duplicated.
For more information, see section 30.9 “Duplicating an Automation Server Using
Restore ” on page 562.
IMPORTANT: When you restore a standalone automation server, you are
logged off and need to log on manually after the restore is complete.

04-40008-03-en, June 2022 IT

561
30 Restore
30.9 Duplicating an Automation Server Using Restore

30.9 Duplicating an Automation Server Using

Restore
You duplicate an EcoStruxure BMS server from a backup set using Restore
when you want to reuse configuration data from a backup set in a standalone
automation server.
IMPORTANT: The locally stored backup set and the automation server
need to have the same password.
Restoring with new ID does not work if the database contains a BACnet
interface.
For more information, see section 30.8 “Duplicate Automation Server from a
Backup Set” on page 559.

To duplicate an automation server using restore

1. In WorkStation, in the System Tree pane, select the server where you want
to duplicate configuration data from a backup set.
2. On the Actions menu, click Restore.
3. In the Restore Options dialog box, in the Available restore points list,
select the backup set.
4. Select Restore configuration with new IDs checkbox to re-use the
configuration data from the backup set in a new standalone automation
server.
5. Click Restore.
6. Click Yes.
7. Click Close.

IT 04-40008-03-en, June 2022

562
31 Backup and Restore User
Interface

Topics
Backup and Restore Manager Properties (Enterprise
Central) – Basic Tab
Backup and Restore Manager Properties (Enterprise
Server) – Basic Tab
Backup and Restore Manager Properties (Automation
Servers) – Basic Tab
Backup and Restore Manager on the Enterprise Server
Backup and Restore Manager on an Automation Server
Backup Options Dialog Box
Create Object Wizard – Configure Backup Rule Page
Backup Rule Properties – Basic Tab
Backup Rules View
Backup Rules Toolbar
Backup Rules List
Digital Schedule Properties – Basic Tab
Backup Set Properties – Basic Tab
Backup Sets View
Backup Status Dialog Box
Control Panel – Backup and Archiving
 Backup Rule Dialog Box
31 Backup and Restore System Tree Icons
Restore Options Dialog Box
Restore Status Dialog Box
Backup and Restore Folder Properties
Save Backup Set Dialog Box
 31 Backup and Restore User Interface
31.1 Backup and Restore Manager Properties (Enterprise Central) – Basic Tab

31.1 Backup and Restore Manager

Properties (Enterprise Central) – Basic
Tab
Use the Basic tab to view the current backup and restore status of an Enterprise
Central. In addition, you can set the maximum number of local and remote
backup sets to store so the system can purge the outdated files.

Figure: Backup and Restore Manager properties for the Enteprise Central

Table: Backup and Restore Manager Properties (Enterprise Central) – Basic Tab
Component Description

Backup folder Displays the storage location of the backup

set.

Backup and restore status Displays the current status, such as

backing up.

Last backup Displays the date and time of the last

successful backup.

Purge local backup sets Select Yes to enable automatic purging of

local Enterprise Central backup files at the
next backup.

04-40008-03-en, June 2022 IT

565
31 Backup and Restore User Interface
31.1 Backup and Restore Manager Properties (Enterprise Central) – Basic Tab

Continued
Component Description

Number of local backup sets to store Enter the maximum number of backup sets
that the system can store for the Enterprise
Central.

IT 04-40008-03-en, June 2022

566
 31 Backup and Restore User Interface
31.2 Backup and Restore Manager Properties (Enterprise Server) – Basic Tab

31.2 Backup and Restore Manager

Properties (Enterprise Server) – Basic
Tab
Use the Basic tab to view the current backup and restore status of an Enterprise
Server. In addition, you can set the maximum number of local and remote backup
sets to store so the system can purge the outdated files.

Figure: Backup and Restore Manager properties for the Enteprise Server

Table: Backup and Restore Manager Properties (Enterprise Server) – Basic Tab
Component Description

Backup folder Displays the storage location of the backup

set.

Backup and restore status Displays the current status, such as

backing up.

Last backup Displays the date and time of the last

successful backup.

Purge AS backup sets Select Yes to enable automatic purging of

remote automation server backup files at
the next backup.

04-40008-03-en, June 2022 IT

567
31 Backup and Restore User Interface
31.2 Backup and Restore Manager Properties (Enterprise Server) – Basic Tab

Continued
Component Description

Purge local backup sets Select Yes to enable automatic purging of

local Enterprise Server backup files at the
next backup.

Number of remote AS backup sets to Enter the maximum number of backup sets
store that the system can store for each
automation server.

Number of local backup sets to store Enter the maximum number of backup sets
that the system can store for the Enterprise
Server.

IT 04-40008-03-en, June 2022

568
 31 Backup and Restore User Interface
31.3 Backup and Restore Manager Properties (Automation Servers) – Basic Tab

31.3 Backup and Restore Manager

Properties (Automation Servers) – Basic
Tab
Use the Basic tab to view the current backup and restore status of an automation
server.

Figure: Backup and Restore Manager for the automation server

Table: Backup and Restore Manager Properties (Automation Servers) – Basic

Tab
Component Description

Backup and restore Displays the current status, such as backing up.
status

Last backup Displays the date and time of the last successful backup.

Backup folder Displays the storage location of the backup set.

04-40008-03-en, June 2022 IT

569
31 Backup and Restore User Interface
31.4 Backup and Restore Manager on the Enterprise Server

31.4 Backup and Restore Manager on the

Enterprise Server
Use the Backup and Restore Manager to supervise the backup settings in the
EcoStruxure Building Operation software. You can also open this view in any
EcoStruxure BMS server to view current and past backup information.

Figure: Backup and Restore Manager on the Enterprise Server

Table: Backup and Restore Manager

Component Description

Status Displays the current backup status, such as

backing up.

Last backup Displays the date and time of the last

successful backup.

Backup sets path Displays the path to where the Enterprise

Server stores all EcoStruxure BMS server
backups.

Enable Automation Server purge Select to enable the Enterprise Server to

purge the oldest backup of the automation
server automatically when a new backup
for that automation server is stored.

Number of Automation Server backup sets Enter the maximum number of backups
to store that the Enterprise Server can store for
each automation server.

Enable purge of local backup sets Select to enable the Enterprise Server to
purge the oldest backup automatically
when a new backup is stored.

IT 04-40008-03-en, June 2022

570
 31 Backup and Restore User Interface
31.4 Backup and Restore Manager on the Enterprise Server

Continued
Component Description

Number of local backup sets to store Enter the maximum number of backups
that the system can store for the Enterprise
Server.

04-40008-03-en, June 2022 IT

571
31 Backup and Restore User Interface
31.5 Backup and Restore Manager on an Automation Server

31.5 Backup and Restore Manager on an

Automation Server
Use the Backup and Restore Manager to view the backup status of an
automation server.

Figure: Backup and Restore Manager on an automation server

Table: Backup and Restore Manager on an automation server

Component Description

Status Displays the current status, such as backing up.

Last backup Displays the date and time of the last successful backup.

IT 04-40008-03-en, June 2022

572
 31 Backup and Restore User Interface
31.6 Backup Options Dialog Box

31.6 Backup Options Dialog Box

Use the Backup Options dialog box to select the EcoStruxure BMS server and
the type of data that you want to back up. You can also enter a unique file name
for the backup set.

Figure: Backup Options dialog box

Table: Backup Options Dialog Box

Property Description

Backup set name prefix Type the text that you want to add to the
beginning of the file name to help identify
the backup set.

Backup set name suffix Type the text that you want to add to the
end of the file name to help identify the
backup set.

Click to include all the listed EcoStruxure

BMS servers in the backup operation. You
can also manually include or exclude an
EcoStruxure BMS server using the Include
check box.

Click to exclude all the EcoStruxure BMS

servers selected for the backup operation.

Click to add the same backup set

description entered for one EcoStruxure
BMS server to all the other backup sets,
such as Final Configuration.

04-40008-03-en, June 2022 IT

573
31 Backup and Restore User Interface
31.6 Backup Options Dialog Box

Continued
Property Description

Click to add the same content type chosen

for one EcoStruxure BMS server to all the
other backup sets, such as Configuration
only.

Click to add both the backup set desciption

and content type chosen for one
EcoStruxure BMS server to all the other
backup sets, such as Final Configuration
and Configuration only.

Server name Displays the name of the EcoStruxure BMS

server.

Include Select the EcoStruxure BMS servers that

you want to include in the backup.

Backup set name Displays the name of the backup set that
you entered.

Backup content Select the type of data that you want to

back up for the EcoStruxure BMS server:
• All data: Backs up both the historical
and configuration databases, which
are useful for existing systems. This
combined data option protects the
configuration, historical data, and
custom object type data for a specified
date and time.
• Configuration only: Backs up the
configuration database and custom
object type data, which are useful for
new installations. This data option
protects the configuration data for a
specified date and time.

Backup set description Type a backup comment up to 255

characters that helps identify the type,
content, or purpose of the scheduled
backup.

IT 04-40008-03-en, June 2022

574
 31 Backup and Restore User Interface
31.7 Create Object Wizard – Configure Backup Rule Page

31.7 Create Object Wizard – Configure

Backup Rule Page
Use the Configure Backup Rule page to define the type of data that you want to
back up and configure a lead rule.

Figure: Configure Backup Rule page

Table: Configure Backup Rules Page

Property Description

Name Displays the name of the backup rule.

Backup set Type a description up to 255 characters that helps to identify the
description type and contents of the scheduled backup.

Backup content Select the type of data that you want to back up.

Lead rule Enter a backup rule that can act as a lead backup rule.

Enabled Select Yes to enable the backup rule.

04-40008-03-en, June 2022 IT

575
31 Backup and Restore User Interface
31.8 Backup Rule Properties – Basic Tab

31.8 Backup Rule Properties – Basic Tab

Use the Basic tab to view the properties of the backup rule that you create. You
can also add a description to help identify the purpose of the backup rule.

Figure: Basic tab

Table: Basic Tab

Component Description

Backup content Select the type of data that you want to back up.

Backup set description Type a description up to 255 characters that helps to

identify the type and contents of the scheduled backup.

Enabled Select Yes to enable the backup rule.

Lead rule Enter a backup rule that can act as a lead backup rule.

IT 04-40008-03-en, June 2022

576
 31 Backup and Restore User Interface
31.9 Backup Rules View

31.9 Backup Rules View

Use the Backup rules view to add, edit, or remove backup rules. You can also
modify the backup schedule associated with the backup rule. In addition, you can
select a backup rule that can act as a lead rule.

Figure: Backup rules view

Table: Backup Rules View

Number Description

Use the Backup Rules toolbar to create, edit, or remove

backup sets. For more information, see section 31.10 “Backup
Rules Toolbar” on page 578.

Use the Backup Rules list to modify backup schedules or set

up lead rules. For more information, see section 31.11 “Backup
Rules List” on page 579.

04-40008-03-en, June 2022 IT

577
31 Backup and Restore User Interface
31.10 Backup Rules Toolbar

31.10 Backup Rules Toolbar

Use the Backup rules toolbar to add, edit, or remove backup rules.
Button Description

Add backup rule

Click to open the Create Object wizard where you create a backup
rule. For more information, see section 29.3 “Creating a Backup Rule”
on page 538.

Edit backup rule

Click to open the Backup rule dialog box where you modify a backup
rule. For more information, see section 29.4 “Editing a Backup Rule”
on page 539.

Remove backup rule

Click to delete a backup rule. For more information, see section 29.5
“Deleting a Backup Rule” on page 540.

IT 04-40008-03-en, June 2022

578
 31 Backup and Restore User Interface
31.11 Backup Rules List

31.11 Backup Rules List

Use the Backup rules list to select a lead rule or modify a backup schedule for a
backup rule.

Figure: Backup rules list view

Table: Backup Rules List View

Component Description

Name Displays the name of the backup rule.

Path Displays the location of the backup rule on the EcoStruxure BMS
server.

Lead rule Enter a backup rule that can act as a lead backup rule.

Schedule Click to open the Schedule Editor where you modify the backup
schedule contained in the backup rule. For more information, see
the Editing a Weekly Event topic on WebHelp.

04-40008-03-en, June 2022 IT

579
31 Backup and Restore User Interface
31.12 Digital Schedule Properties – Basic Tab

31.12 Digital Schedule Properties – Basic Tab

Use the Basic tab to view the schedule status information and to configure the
schedule.

Figure: Digital Schedule properties – Basic tab

Table: Digital Schedule Properties – Basic Tab

Component Description

Value Select the value associated with the event.

Previous transition Displays the date and time the value most recently changed.
time

Time since previous Displays the amount of time in minutes that has elapsed since
transition the value last changed, rounded to the next minute.

Next transition Displays what the Value property will be when it next changes.
valuea

Next transition timea Displays the date and time the value will change.

Time to next Displays the amount of time in minutes before the value changes.
transitiona

IT 04-40008-03-en, June 2022

580
 31 Backup and Restore User Interface
31.12 Digital Schedule Properties – Basic Tab

Continued
Component Description

Following transition Displays the subsequent value following the next transition value.
valuea

Following transition Displays the subsequent date and time following the next
timea transition time.

Time to following Displays the amount of time in minutes before the value changes
transitiona to the following transition value.

Remove past events Select True to enable the system to delete events older than 72
hours.

Effective period Enter the range of time a schedule is in service.

Default value Select the value of the schedule when there are no events in
effect.

Lead object Select a lead schedule to reference.

a) The schedule only looks 8 days into the future to obtain this value. If there is no transition in the
next 8 days, the maximum date and time will be displayed.

04-40008-03-en, June 2022 IT

581
31 Backup and Restore User Interface
31.13 Backup Set Properties – Basic Tab

31.13 Backup Set Properties – Basic Tab

Use the Basic tab to view a read-only summary of the current backup set
information.

Figure: Basic tab

Table: Basic Tab

Component Description

Server revision Displays the software version of the

EcoStruxure BMS server at the time the
backup took place.

Backup date Displays the date and time of the backup

set.

Backup content Select the type of data that you want to

back up.

Server type Displays the type of EcoStruxure BMS

server that can be restored using this
backup set.

IT 04-40008-03-en, June 2022

582
 31 Backup and Restore User Interface
31.14 Backup Sets View

31.14 Backup Sets View

Use the Backup sets view to browse a list of backup sets on an EcoStruxure
BMS server.

Figure: Backup Sets view

Table: Backup Sets View

Number Description

Use the List View toolbar to navigate in a list. For more

information, see the List View Toolbar topic on WebHelp.

Use the AS Archives folder to view the backup sets that

belong to automation servers.

Use the Local folder to view the backup sets that belong to an
Enterprise Server.

Use the Properties tab to to view the properties of a selected

object in a list.

04-40008-03-en, June 2022 IT

583
31 Backup and Restore User Interface
31.15 Backup Status Dialog Box

31.15 Backup Status Dialog Box

The Backup Status dialog box displays the progress and status of a manual
backup. Once the backup starts, the process cannot be stopped but you can
close this informational dialog box at any time.

Figure: Backup Status dialog box

Table: Backup Status Dialog Box

Component Description

Name Displays the name of the object.

Status Displays the current backup status.

Progress Displays the progress of the backup.

NOTE: The Backup Status dialog box does not appear during a scheduled
backup. However, you can open the Backup and Restore Manager from the
Control Panel on the Tools menu to view the current status of a scheduled
backup.

IT 04-40008-03-en, June 2022

584
 31 Backup and Restore User Interface
31.16 Control Panel – Backup and Archiving

31.16 Control Panel – Backup and Archiving

Use the Backup and Archiving options on the Control Panel to create new
backup rules, diagnose backup or restore issues, and view the current status of
an EcoStruxure BMS server.

Figure: Control Panel – Backup and archiving

Table: Control Panel – Backup and Archiving

Component Description

Backup Rules Click to open the Backup Rules view where you manage
backup rules. You can also modify the backup schedule
associated with the backup rule. For more information, see
section 31.9 “Backup Rules View” on page 577.

Backup Sets Click to open the Backup Sets view where you manage
backup sets. For more information, see section 31.14
“Backup Sets View” on page 583.

Backup and Restore Click to open the Backup and Restore Manager where you
Manager view current backup and restore statuses and configure
Purge settings for an Enterprise Server. For more
information, see section 31.4 “Backup and Restore Manager
on the Enterprise Server” on page 570.

Archiving Click to open the Archive Settings where you enable the
archiving function, set delay, and select the format of the
archive file. For more information, see the Archiving Settings
Properties – Basic Tab topic on WebHelp.

04-40008-03-en, June 2022 IT

585
31 Backup and Restore User Interface
31.17 Backup Rule Dialog Box

31.17 Backup Rule Dialog Box

Use the Backup Rule dialog box to change the type of data contained in the
backup. You can also add a comment to identify the content or purpose of the
backup. In addition, you can enable or disable the backup rule.

Figure: Backup Rule dialog box

Table: Backup Rule Dialog Box

Component Description

Name Displays the name of the backup rule.

Backup set description Type a description up to 255 characters that helps to

identify the type and contents of the scheduled backup.

Backup content Select the type of data that you want to back up.

Lead rule Enter a backup rule that can act as a lead backup rule.

Enabled Select Yes to enable the backup rule.

IT 04-40008-03-en, June 2022

586
 31 Backup and Restore User Interface
31.18 Backup and Restore System Tree Icons

31.18 Backup and Restore System Tree Icons

The following table describes the Backup and Restore icons in the System Tree.

Table: Backup and Restore System Tree Icons

Icon Description

Backup
Indicates one of the following backup and restore objects:
• Backup rule. For more information, see section 27.1 “Backup” on
page 497.
• Backup and Restore Manager. For more information, see section
31.4 “Backup and Restore Manager on the Enterprise Server” on
page 570.

Backup schedule
Indicates a backup schedule. For more information, see section 29.7
“Backup Schedules” on page 542.

04-40008-03-en, June 2022 IT

587
31 Backup and Restore User Interface
31.19 Restore Options Dialog Box

31.19 Restore Options Dialog Box

Use the Restore Options dialog box to select a backup set and the type of data
that you want to restore. You can also import a backup set from a network
storage location and restore the EcoStruxure BMS server, or duplicate an
EcoStruxure BMS server from a backup set using Restore when you want to
reuse configuration data from a backup set in a standalone automation server.

Figure: Restore Options dialog box

Table: Restore Options Dialog Box

Component Description

Name Displays the name of the backup set for the selected EcoStruxure
BMS server.

Created on Displays the date the backup set was created.

Description Displays a description of the backup set.

Server version Displays the server version.

Server type Displays the server type.

Configuration Select to restore only the configuration data and custom object type
only data. No historical data is restored.

All Data Select to restore the historical data, configuration data, and custom
(Configuration object type data.
and Historical)

Import Backup Click to import the backup set to an EcoStruxure BMS server. In a
Set multi-server configuration, you can import both automation server
and Enterprise Server backup sets to the Enterprise Server.

IT 04-40008-03-en, June 2022

588
 31 Backup and Restore User Interface
31.19 Restore Options Dialog Box

Continued
Component Description

Restore Select to duplicate the configuration data from the imported backup
configuration set in the new standalone automation server. The communication
with new IDs settings from the backup set will not be duplicated.
For more information, see section 30.8 “Duplicate Automation
Server from a Backup Set” on page 559.

04-40008-03-en, June 2022 IT

589
31 Backup and Restore User Interface
31.20 Restore Status Dialog Box

31.20 Restore Status Dialog Box

The Restore Status dialog box displays the progress and status of a restore.
Once the restore starts, the process cannot be stopped but you can close this
informational dialog box at any time.

Figure: Restore Status dialog box

IT 04-40008-03-en, June 2022

590
 31 Backup and Restore User Interface
31.21 Backup and Restore Folder Properties

31.21 Backup and Restore Folder Properties

Use the Backup and Restore Folder Properties view or dialog box to configure
and view the general properties.

Figure: Basic tab

04-40008-03-en, June 2022 IT

591
31 Backup and Restore User Interface
31.22 Save Backup Set Dialog Box

31.22 Save Backup Set Dialog Box

The Save Backup Set dialog box displays the destination and progress of saving
a backup set.

Figure: Save Backup Set dialog box

IT 04-40008-03-en, June 2022

592
32 Backup and Restore in
WebStation

Topics
Backup and Restore using WebStation
Backing up and Restoring using WebStation
 32 Backup and Restore in WebStation
32.1 Backup and Restore using WebStation

32.1 Backup and Restore using WebStation

A subset of backup and restore features are available in WebStation.
You can create backups of the server using WebStation. The backup can be
downloaded from the server.
The server can be restored using backups on the server, but you cannot upload a
backup to the server. Uploading backups must be done using WorkStation.
Scheduled backup and restoring downloaded backups must be done using
WorkStation.
For more information, see section 27.1 “Backup” on page 497.

04-40008-03-en, June 2022 IT

595
32 Backup and Restore in WebStation
32.2 Backing up and Restoring using WebStation

32.2 Backing up and Restoring using

WebStation
You can backup and restore the server from WebStation. You can also download
a backup.
For more information, see section 32.1 “Backup and Restore using WebStation”
on page 595.

To backup and restore

1. Click WebStation, click Workspace menu.
2. Click System.
3. Click Backup and restore.
4. In the Backup and restore dialog:
• Click Backup to create a manually initiated backup.
• Select a backup and click Restore to restore the server to the selected
backup.
• Select a backup and click Download to download the selected backup.

IT 04-40008-03-en, June 2022

596
33 Backup and Restore in
WebStation User Interface

Topics
Backup and Restore Dialog in WebStation
 33 Backup and Restore in WebStation User Interface
33.1 Backup and Restore Dialog in WebStation

33.1 Backup and Restore Dialog in

WebStation
Use the Backup and restore dialog box in WebStation to create, restore, and
download backups using WebStation.

Figure: Backup and restore dialog

Table: Backup and Restore dialog

Component Description

Backup and restore list Displays the backups on the server.

Backup Click to create a user initiated backup.

Restore Click to restore the server from the selected

backup.

Download Click to download the selected backup.

04-40008-03-en, June 2022 IT

599
Schneider Electric
www.se.com/buildings

© 2022 Schneider Electric. All rights reserved.

04-40008-03-en
June 2022