EcoStruxure Building Operation

IT
Reference Guide
04-30008-01-en
May 2019
EcoStruxure Building Operation
IT
Reference Guide
04-30008-01-en
May 2019
Copyright © 2019 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

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 ....................................................................... 42
3.2.7 Enterprise Central .................................................................... 42
3.2.8 Enterprise Server ..................................................................... 42
3.2.9 Software Administrator ............................................................. 43
3.2.10 Device Administrator ............................................................... 43
3.2.11 License Administrator .............................................................. 43

04-30008-01-en, May 2019 IT

5
 3.2.12 License Server ......................................................................... 43
3.2.13 WebReports ............................................................................. 43
3.2.14 Language Package ................................................................. 44
3.3 Installation Example ................................................................... 45
3.4 Version Numbers and Parallel Installations ................................ 47
3.5 Installing the License Administrator and the License Server ..... 49
3.6 Installing WorkStation and Client Tools ...................................... 51
3.7 Installing a Language Pack ....................................................... 53
3.8 Installing Enterprise Central ....................................................... 54
3.9 Installing the Enterprise Server .................................................. 56
3.10 Installing the Device Administrator ............................................ 59

4 Installation Repair ....................................................... 61

4.1 Installation Reparation ............................................................... 63
4.2 Repairing the License Administrator and the License Server .... 64
4.3 Repairing WorkStation and Client Tools Installation .................. 66
4.4 Repairing the Enterprise Server ................................................. 68
4.5 Repairing the Device Administrator Installation ......................... 70

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

6 Computer Maintenance .............................................. 81

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

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

8 Installation User interface ......................................... 101

8.1 Installation Wizard – Choose Components Page ..................... 103
8.2 Installation Wizard – Installation Type Page ............................. 105
8.3 Installation Wizard – License Server Configuration Page ........ 106

IT 04-30008-01-en, May 2019

6
 8.4 Server Installation Wizard – Configuration Page ...................... 107

9 Reports Installation ................................................... 109

9.1 WebReports Installation Overview ........................................... 111
9.1.1 WebReports Installer and WebReports Components ............ 111
9.1.2 Reports Server Configuration ................................................ 111
9.1.3 WebReports Installation WorkFlow ....................................... 111
9.1.4 Windows Roles and Features ................................................ 111
9.1.5 SQL Server ............................................................................. 112
9.1.6 SQL Server Installation Settings ............................................. 112
9.1.7 WebReports Uninstallation .................................................... 112
9.2 WebReports Installer and WebReports Components .............. 113
9.3 Reports Server Configuration ................................................... 117
9.4 WebReports Installation WorkFlow .......................................... 118
9.5 Windows Roles and Features .................................................. 120
9.6 SQL Server .............................................................................. 129
9.6.1 SQL Server Version ................................................................ 129
9.6.2 SQL Server Installation Settings ............................................ 129
9.6.3 SQL Server Memory Configuration ........................................ 129
9.7 SQL Server Installation Settings ............................................... 130
9.8 .NET Framework 4.7 ................................................................. 135
9.9 Configuring SQL Server Memory ............................................. 136
9.10 Starting a Windows Service ..................................................... 137
9.11 Installing WebReports .............................................................. 138
9.12 Detaching a WebReports Database ........................................ 140
9.13 Attaching a WebReports Database ......................................... 141
9.14 Transferring Reports Schedules ............................................. 142
9.15 Backing Up the WebReports Database ................................... 143
9.16 Restoring the WebReports Database ...................................... 144
9.17 WebReports Uninstall .............................................................. 145
9.18 Uninstalling WebReports ......................................................... 146
9.19 Reporting Agent ...................................................................... 147
9.19.1 Reporting Agent Log File ....................................................... 147
9.19.2 Reporting Agent Configuration File ........................................ 147
9.20 Reporting Agent Log File ......................................................... 148
9.21 Reporting Agent Configuration File .......................................... 149
9.22 Changing Reporting Agent Logging Information ..................... 151
9.23 Changing Events and Historical Records Information ............. 152
9.24 Starting the Reporting Agent Windows Service ...................... 153
9.25 Stopping the Reporting Agent Windows Service .................... 154

10 Reports Installation User Interface ........................... 155

10.1 Server Roles Dialog Box for Windows Server 2008 ................. 157
10.2 Features Dialog Box for Windows Server 2008 ........................ 158
10.3 Server Roles Dialog Box for Windows Server 2012 ................. 159
10.4 Features Dialog Box for Windows Server 2012 ........................ 160
10.5 WebReports Installer – End User License Agreement Page ... 161

04-30008-01-en, May 2019 IT

7
 10.6 WebReports Installer – Installation Type Page ........................ 162
10.7 WebReports Installer – Installation Type: Installation Path Page
................................................................................................. 163
10.8 WebReports Installer – System Check Page ........................... 164
10.9 WebReports Installer - Enterprise Server Page ....................... 165
10.10 WebReports Installer – SQL Server Page ................................ 166
10.11 WebReports Installer - SQL Server: Details Page .................... 167
10.12 WebReports Installer - SQL Configuration Page ...................... 168
10.13 WebReports Installer - Installation Page .................................. 169
10.14 WebReports Installer - Finish Page .......................................... 170
10.15 WebReports Installer – Installation Type: Upgrade Page ........ 171
10.16 WebReports Administrator - Enterprise Server Configuration
Dialog Box ............................................................................... 172

11 Licensing Introduction ............................................. 173

11.1 Licensing Overview ................................................................. 175
11.1.1 Licensing Model .................................................................... 175
11.1.2 License System ...................................................................... 175
11.1.3 License Management ............................................................ 175
11.1.4 Service and Maintenance ...................................................... 175
11.1.5 License Information ............................................................... 175
11.2 Licensing Model ...................................................................... 177
11.2.1 Client and Engineering Tool Licenses ................................... 177
11.2.2 Field Bus Device Licenses ..................................................... 177
11.2.3 SNMP Licenses ...................................................................... 177
11.2.4 Web Services Licenses ......................................................... 178
11.2.5 Licensing Enforcement .......................................................... 178
11.2.6 License Lifetime ..................................................................... 178
11.3 Field Bus Device Licenses ....................................................... 179
11.4 Licensing Enforcement ............................................................ 180
11.4.1 License Violation .................................................................... 180
11.5 License Information ................................................................. 181
11.5.1 Recommended Setup ............................................................ 181
11.5.2 Servers .................................................................................. 181
11.5.3 License Status ....................................................................... 181
11.6 License System ....................................................................... 183
11.6.1 License Activation Server ...................................................... 183
11.6.2 License Server ....................................................................... 183
11.6.3 License Administrator ............................................................ 183
11.6.4 Licenses ................................................................................ 184
11.7 License Management .............................................................. 185
11.7.1 License System Installation and Configuration ...................... 185
11.7.2 Network License Management .............................................. 186
11.7.3 Local License Management .................................................. 186
11.8 Service and Maintenance ....................................................... 187
11.8.1 License Service Maintenance ................................................ 187
11.8.2 License Maintenance ............................................................. 187

IT 04-30008-01-en, May 2019

8
 11.8.3 Diagnostics ............................................................................ 187
11.8.4 License Log File ..................................................................... 188
11.9 License Maintenance .............................................................. 189
11.9.1 Local License Removal .......................................................... 189
11.9.2 Network License Return ......................................................... 189
11.9.3 Lost License ........................................................................... 189
11.9.4 License Repair ....................................................................... 189
11.9.5 License Backup ..................................................................... 189
11.10 Licenses .................................................................................. 190
11.10.1 End User License Agreement ................................................ 191
11.10.2 Local Licenses ....................................................................... 191
11.10.3 Network Licenses ................................................................. 192
11.10.4 Time-Limited Licenses ........................................................... 192
11.10.5 Permanent License ................................................................ 192
11.10.6 License Selection Process ..................................................... 192
11.11 Viewing Activated Licenses .................................................... 193
11.12 Editing Registration Details ...................................................... 194
11.13 License Selection Process ....................................................... 195
11.14 Order Information Request ...................................................... 196
11.15 Lost License ............................................................................. 198
11.16 License Repair ......................................................................... 199
11.17 License Backup ....................................................................... 200
11.18 Backing Up Licenses .............................................................. 201
11.19 Restoring Licenses .................................................................. 202

12 Type of Licenses ....................................................... 203

12.1 Network Licenses ................................................................... 205
12.2 Network License Management ................................................ 209
12.2.1 Order Information Request .................................................... 209
12.2.2 Network Licenses Activation .................................................. 209
12.2.3 Enterprise Server Address Configuration .............................. 209
12.2.4 WorkStation and Client Tools Address Configuration ............ 210
12.3 Network Licenses Activation .................................................... 211
12.4 Network License Return ........................................................... 213
12.5 Activating Network Licenses ................................................... 215
12.6 Removing a Local License or Returning a Network License .... 216
12.7 Repairing a Network License .................................................. 217
12.8 Local Licenses ......................................................................... 218
12.9 Local License Management .................................................... 219
12.9.1 Local License Activation ........................................................ 219
12.10 Activating a Local License ...................................................... 220

13 Licensing Configuration and Diagnostics ................. 221

13.1 Enterprise Server Address Configuration ................................ 223
13.2 WorkStation and Client Tools Address Configuration .............. 225
13.3 Viewing Diagnostic Information ............................................... 226
13.4 Copying Diagnostics to the Clipboard .................................... 227

04-30008-01-en, May 2019 IT

9
 13.5 Showing the Licenses Log File ............................................... 228

14 License Server and License Administrator ............... 229

14.1 License Server ......................................................................... 231
14.1.1 Flexnet License Manager, License Server Manager ............. 231
14.2 Starting the License Server ...................................................... 232
14.3 Stopping the License Server .................................................... 233
14.4 Restarting the License Server .................................................. 234
14.5 Flexnet License Administrator, License Server Manager ........ 235
14.5.1 License Server Port Number .................................................. 236
14.5.2 FLEXnet License Administrator Port Number ........................ 237
14.6 Accessing Flexnet lmadmin ..................................................... 238
14.7 Changing the Flexnet lmadmin License Server Manager Port
Number .................................................................................... 239
14.8 License Administrator .............................................................. 240
14.8.1 Registration Details ................................................................ 240
14.8.2 License Server Address ........................................................ 240
14.9 Starting License Administrator ................................................. 241
14.10 License Server Address ........................................................... 242
14.11 Configuring the Address to the License Server ....................... 244
14.12 License Server Reset ............................................................... 245
14.13 Resetting the License Server ................................................... 246
14.14 Configuring License Server Recovery Settings ..................... 247
14.15 License Server Maintenance ................................................... 248
14.15.1 License Server Address Change ........................................... 248
14.15.2 License Server Reinstallation ................................................ 248
14.15.3 License Server Replacement ................................................. 248
14.15.4 License Server Reset ............................................................. 250

15 Licensing User Interface ........................................... 251

15.1 Registration Details View ......................................................... 253
15.2 Licenses View ......................................................................... 255
15.3 Licenses View Toolbar ............................................................. 256
15.4 Licenses View Icons ................................................................ 257
15.5 Licenses View Columns ........................................................... 258
15.6 Add License Dialog Box .......................................................... 259
15.7 License Activation Dialog Box ................................................. 260
15.8 License Progress Dialog Box ................................................... 262
15.9 License Server Address View .................................................. 263
15.10 Diagnostics View ..................................................................... 264
15.11 License Violation Bar ............................................................... 265
15.12 License Information Enterprise Server and SmartX Server ...... 266
15.13 License Information Enterprise Central .................................... 268

16 Software Administrator ............................................. 271

16.1 Software Administrator ............................................................ 273
16.1.1 Service ................................................................................... 273
16.1.2 Ports ...................................................................................... 273

IT 04-30008-01-en, May 2019

10
 16.1.3 Database Location ................................................................. 273
16.1.4 Enterprise Server and Enterprise Central System Logs ......... 273
16.2 Starting Software Administrator ............................................... 274
16.3 Configuring Server Port Settings .............................................. 275
16.4 Starting the Enterprise Central Windows Service .................... 276
16.5 Stopping the Enterprise Central Windows Service .................. 277
16.6 Starting the Enterprise Server or Enterprise Central Windows
Service ..................................................................................... 278
16.7 Stopping the Enterprise Server Windows Service ................... 279
16.8 Restarting the Enterprise Server Windows Service .................. 280
16.9 Enterprise Server and Enterprise Central System Logs ........... 281
16.10 Viewing the Enterprise Server or Enterprise Central System
Log ........................................................................................... 282
16.11 Resolving Enterprise Server or Enterprise Central Port
Conflicts ................................................................................... 283
16.12 Software Administrator – Enterprise Central View .................... 284
16.13 Software Administrator – Enterprise Server View ..................... 286

17 User Account Management ...................................... 289

17.1 User Account Management Overview ..................................... 291
17.1.1 User Accounts and User Account Groups ............................ 292
17.1.2 Domains ................................................................................ 292
17.1.3 Software Permissions ............................................................. 292
17.1.4 Log on Methods ..................................................................... 292
17.1.5 Workspace Management ....................................................... 292
17.1.6 Automatic Logoff .................................................................... 293
17.1.7 Guest User Account .............................................................. 293
17.1.8 Automatic Logoff to Guest Account ....................................... 293
17.1.9 Guest Log On in WebStation ................................................. 293
17.2 Opening the Account Management Control Panel .................. 294
17.3 User Accounts and User Account Groups .............................. 295
17.3.1 Windows Active Directory User Groups ................................ 296
17.3.2 WorkStation Account Management ....................................... 297
17.4 Creating a User Account ......................................................... 298
17.5 Editing a User Account Profile ................................................. 299
17.6 Renaming a User Account ...................................................... 300
17.7 Disabling a User Account ........................................................ 301
17.8 Enabling a Disabled User Account .......................................... 302
17.9 Setting an Expiration Date for a User Account ......................... 303
17.10 Removing the Expiration Date for a User Account ................... 304
17.11 Deleting a User Account .......................................................... 305
17.12 Automatic Logoff ...................................................................... 306
17.13 Setting the Automatic Logoff Time ........................................... 307
17.14 Guest User Account ................................................................ 308
17.15 Automatic Logoff to Guest Account ......................................... 309
17.16 1Configuring a User Account Group to Log off to the Guest User
Account ................................................................................... 310

04-30008-01-en, May 2019 IT

11
 18 User Account Groups ............................................... 311
18.1 Windows Active Directory User Groups ................................... 313
18.2 Creating a User Account Group .............................................. 315
18.3 Editing the Description of a User Account Group .................... 317
18.4 Adding a User Account to a User Account Group .................. 318
18.5 Removing a User Account from a User Account Group .......... 319
18.6 Reviewing the User Account Group Memberships for a User
Account ................................................................................... 320
18.7 Adding a User Account Group to a User Account Group ........ 321
18.8 Removing a User Account Group from another User Account
Group ....................................................................................... 322
18.9 Reviewing the User Account Group Memberships for a User
Account Group ........................................................................ 323
18.10 Preventing a Group of Users from Exiting WorkStation ............ 324
18.11 Enabling a Group of Users to Exit WorkStation ........................ 325
18.12 Deleting a User Account Group ............................................... 326

19 Domains .................................................................... 327

19.1 Domains ................................................................................... 329
19.1.1 Windows Active Directory Domain ......................................... 330
19.1.2 Server Local Domain ............................................................. 331
19.1.3 Administration Accounts in Server Local Domain .................. 331
19.2 Log On Methods ...................................................................... 332
19.2.1 Log On as a Windows User ................................................... 332
19.2.2 Log On as an EcoStruxure Building Operation User ............. 332
19.2.3 Password Administration ....................................................... 332
19.3 Guest Logon in WebStation ..................................................... 333
19.4 Creating and Configuring a Domain ........................................ 334
19.5 Editing the Windows Domain Name ......................................... 335
19.6 Editing the Description of a Domain ........................................ 336
19.7 Editing the Maximum Logon Attempts ..................................... 337
19.8 Assigning a SmartX Server to a Domain .................................. 338
19.9 Removing a SmartX Server from a Domain .............................. 339
19.10 Deleting a Domain ................................................................... 340
19.11 Administration Accounts in EcoStruxure BMS Server Local
Domain .................................................................................... 341
19.11.1 Admin Account ...................................................................... 341
19.11.2 Reports Administrator Account .............................................. 341

20 Software Permissions ............................................... 343

20.1 Software Permissions .............................................................. 345
20.1.1 Path Permissions ................................................................... 345
20.1.2 Command Permissions .......................................................... 345
20.1.3 Extended Software Permissions ............................................ 345
20.1.4 Relative Path Permissions ...................................................... 345
20.1.5 Type Permissions ................................................................... 346
20.1.6 Software Permissions Management ...................................... 346
20.2 Path Permissions ..................................................................... 347

IT 04-30008-01-en, May 2019

12
 20.2.1 Path Permissions Rules ......................................................... 347
20.2.2 Relative Path Permissions ...................................................... 347
20.3 Path Permissions Rules ............................................................ 348
20.4 Assigning Path Permissions to User Accounts or User Account
Groups ..................................................................................... 349
20.5 Editing Path Permissions of User Accounts or User Account
Groups ..................................................................................... 350
20.6 Removing Path Permissions from User Accounts or User Account
Groups ..................................................................................... 351
20.7 Command Permissions ........................................................... 352
20.7.1 Command Permissions Rules ................................................ 352
20.8 Command Permissions Rules .................................................. 353
20.9 Assigning Command Permissions to User Account Groups ... 355
20.10 Editing Command Permissions of User Account Groups ........ 356
20.11 Removing Command Permissions from User Account
Groups ..................................................................................... 357
20.12 Extended Software Permissions .............................................. 358
20.13 Relative Path Permissions ........................................................ 359
20.13.1 Relative Path Permissions Rules ............................................ 359
20.14 Relative Path Permissions Rules .............................................. 360
20.15 Creating Relative Path Templates ............................................ 361
20.16 Editing Relative Path Permissions Templates .......................... 362
20.17 Deleting Relative Path Templates ............................................ 363
20.18 Assigning Relative Path Permissions to User Accounts or User
Account Groups ....................................................................... 364
20.19 Removing Relative Path Permissions from User Accounts or User
Account Groups ....................................................................... 365
20.20 Type Permissions .................................................................... 366
20.20.1 Custom Type Permissions ..................................................... 366
20.20.2 In-built Type Permissions ....................................................... 366
20.20.3 Type Permission Rules .......................................................... 366
20.21 Type Permissions Rules ........................................................... 367
20.22 Creating Type Permissions Templates .................................... 368
20.23 Editing Type Permissions Templates ....................................... 369
20.24 Removing Path Permissions Templates ................................... 370
20.25 Assigning Type Permissions to User Accounts or User Account
Groups ..................................................................................... 371
20.26 Removing Type Permissions from User Accounts or User Account
Groups ..................................................................................... 372
20.27 Software Permissions Management ........................................ 373
20.27.1 Software Permissions, User Accounts and User Account Groups
Management ......................................................................... 373
20.27.2 Software Permissions Rules Management ............................. 373
20.28 Software Permissions, User Accounts, and User Account
Groups ..................................................................................... 374
20.29 Software Permissions Rules Management ............................... 376

21 Login Configuration .................................................. 377

21.1 Password Administration ......................................................... 379

04-30008-01-en, May 2019 IT

13
 21.2 Editing a User Account Password ........................................... 380
21.3 Allowing Users to Change their Password ............................... 381
21.4 Changing Your Password ........................................................ 382
21.5 Changing the Password for Local Administrator Accounts ..... 383
21.6 Turning off Remember Me On This Computer ......................... 384
21.7 Forcing a User to Change the Password at Next Logon .......... 385
21.8 Preventing Users from Changing Their Passwords ................. 386
21.9 Resetting the Administrator Password ..................................... 387

22 Workspaces .............................................................. 389

22.1 Workspace Management ........................................................ 391
22.1.1 Predefined Workspaces ........................................................ 391
22.1.2 Workspace Components and Customization ........................ 392
22.1.3 WebStation in Kiosk Mode ..................................................... 392
22.2 Predefined Workspaces .......................................................... 393
22.3 Workspace Components and Customization .......................... 394
22.3.1 Workspace Customization ..................................................... 395
22.3.2 Workspace Content References ............................................ 395
22.3.3 Panel Components ................................................................ 395
22.4 Workspace Customization ....................................................... 396
22.4.1 Customized Navigation .......................................................... 396
22.4.2 Workspace Path, Object, and Command Customization ..... 397
22.5 Workspace Path, Object, and Command Customization ........ 398
22.6 Workspace Content References .............................................. 399
22.7 Creating a Workspace ............................................................. 400
22.8 Editing the Layout of a Workspace .......................................... 402
22.9 Editing the Description of a Workspace ................................... 403
22.10 Adding a Component to a Workspace ..................................... 404
22.11 Removing a Component from a Workspace ............................ 405
22.12 Editing a Workspace Component ............................................ 406
22.13 Adding a Workspace to a User Account Group ...................... 407
22.14 Removing a Workspace from a User Account Group .............. 408
22.15 Reviewing the Workspace Memberships for a User Account
Group ....................................................................................... 409
22.16 Panel Components .................................................................. 410
22.17 Creating a Panel ..................................................................... 411
22.18 Editing a Panel ......................................................................... 412
22.19 Customized Navigation ............................................................ 413
22.20 Customized Navigation Workflow ............................................ 414
22.21 WebStation in Kiosk Mode ....................................................... 415
22.21.1 Kiosk Mode ............................................................................ 415
22.21.2 Remove the Toolbars from WebStation ................................. 415

23 Audit Trails ................................................................ 417

23.1 WorkStation Account Management ......................................... 419
23.1.1 Audit Trailing of User Activity ................................................. 419
23.1.2 WorkStation Account Validation ............................................. 419
23.2 Audit Trailing of User Activity ................................................... 420

IT 04-30008-01-en, May 2019

14
 23.3 Disabling Audit Trail for a Group of Users ............................... 422
23.4 Enabling Audit Trail for a Group of Users ................................ 423
23.5 Viewing an Audit Trail Log ....................................................... 424
23.6 WorkStation Account Validation ............................................... 425

24 User Management User Interface ............................ 427

24.1 User Management System Tree Icons ..................................... 431
24.2 Domain Properties ................................................................... 432
24.3 Profile Properties ...................................................................... 434
24.4 Workspace Properties ............................................................. 435
24.5 Pane Properties ....................................................................... 437
24.6 Panel Properties ....................................................................... 438
24.7 Navigation Pane ....................................................................... 440
24.8 Building Operation WorkStation Window ................................. 441
24.9 Domain Control Panel .............................................................. 443
24.10 Edit Permissions Dialog Box .................................................... 444
24.11 Account Management Control Panel ....................................... 446
24.12 Select Default Workspace Window .......................................... 449
24.13 Change Password Dialog Box ................................................. 450
24.14 Domain Wizard – Authentication Page ..................................... 451
24.15 Domain Wizard – Domain Members Page ............................... 452
24.16 Domain Wizard – Domain Policies Page .................................. 453
24.17 Domain – Summary Tab ........................................................... 454
24.18 Domain – Policies Tab ............................................................. 455
24.19 Domain – Domain Members Tab ............................................. 456
24.20 User Account – Summary Tab ................................................. 457
24.21 User Account – Group Membership Tab ................................. 458
24.22 User Account – Profile Tab ...................................................... 460
24.23 User Account – Software Permissions Tab .............................. 461
24.24 User Account – Audit Trailing Events Tab ................................ 462
24.25 User Account Group Properties .............................................. 463
24.26 User Account Properties .......................................................... 465
24.27 Guest Account Properties ........................................................ 467
24.28 User Account Group Wizard – Users Belonging to this Group
Page ........................................................................................ 469
24.29 User Account Group Wizard – Workspaces Belonging to this
Group Page ............................................................................. 470
24.30 User Account Group Wizard – Windows Group Name and Group
Policies Page ........................................................................... 472
24.31 User Account Group – Summary Tab ...................................... 474
24.32 User Account Group – Policies Tab ......................................... 475
24.33 User Account Group – Group Membership Tab ...................... 476
24.34 User Account Group – Software Permissions Tab ................... 478
24.35 User Account Group – Workspaces Tab ................................. 480
24.36 User Account Wizard – General Page ..................................... 481
24.37 User Account Wizard – Member Of Page ................................ 482
24.38 User Account Management Folder Properties ......................... 484
24.39 Workspace Wizard – Workspace Configuration Page ............. 485

04-30008-01-en, May 2019 IT

15
 24.40 Workspace Wizard – Pane Configuration Page ....................... 487
24.41 Workspace – Summary Tab ..................................................... 488
24.42 Workspace – Content Tab ....................................................... 489
24.43 Workspace – Members Tab ..................................................... 491
24.44 Edit Layout Workspace ............................................................ 492
24.45 Panel Wizard – Panel Configuration Page ............................... 493
24.46 Domains Properties ................................................................. 494
24.47 Local Properties ....................................................................... 495
24.48 Work Area Window Properties ................................................. 496
24.49 Create Work Area Window Wizard – Name Page .................... 497
24.50 Windows User Group Dialog Box ............................................ 498

25 Connect Agent .......................................................... 499

25.1 Connect Agent Overview ......................................................... 501
25.2 Configuring Connect Agent Settings ....................................... 502
25.3 Transferring Crash Information ................................................ 503
25.3.1 Crash Information .................................................................. 503
25.4 Applying Proxy Settings to the Connect Agent Service Log
On ............................................................................................ 504
25.5 Configuring Windows Firewall for Connect Agent ................... 505
25.6 Getting Connect Agent Debug Information ............................. 506

26 Connect Agent User Interface .................................. 507

26.1 Connect Agent Settings - Basic Tab ....................................... 509
26.2 Connect Agent Settings - Advanced Tab ............................... 510

27 Backup and Restore ................................................. 511

27.1 Backup and Restore Overview ................................................ 513
27.1.1 Backup .................................................................................. 513
27.1.2 Restore .................................................................................. 513
27.1.3 BACnet Backup and Restore ................................................. 513
27.1.4 Archiving Overview ................................................................ 513
27.1.5 Comparison of Backup and Restore Methods ....................... 514
27.1.6 Retain Level ........................................................................... 514
27.2 Comparison of Backup and Restore Methods ........................ 515
27.3 Retain Level ............................................................................ 517
27.4 Configuring the Retain Level .................................................... 519

28 Backups .................................................................... 521

28.1 Backup .................................................................................... 523
28.1.1 Types of Data ......................................................................... 523
28.1.2 Backup Sets ........................................................................... 523
28.1.3 Scheduled Backups .............................................................. 523
28.1.4 Manual Backups .................................................................... 523
28.1.5 Mass Backup ......................................................................... 524
28.1.6 System Backup ...................................................................... 524
28.1.7 Backup Status ........................................................................ 524
28.2 Types of Data ........................................................................... 525
28.3 Backup Status .......................................................................... 526

IT 04-30008-01-en, May 2019

16
 28.4 Checking the Backup Status of an EcoStruxure BMS Server .. 527
28.5 Manual Backups ...................................................................... 528
28.5.1 Backup Set Naming ............................................................... 528
28.5.2 Local Backup and Restore of EcoStruxure BMS Servers ...... 528
28.5.3 Remote Backup and Restore of SmartX Servers ................... 529
28.6 Mass Backup ........................................................................... 530
28.7 Backing Up EcoStruxure BMS Servers Manually ..................... 531
28.8 System Backup ........................................................................ 532
28.9 Local Backup and Restore of EcoStruxure BMS Servers ........ 534
28.9.1 Local Backup and Restore of a Standalone SmartX Server .. 534
28.9.2 Local Backup and Restore of an Enterprise Server ............... 534
28.9.3 Local Backup and Restore of an Enterprise Central .............. 534
28.10 Remote Backup and Restore of SmartX Servers ..................... 535

29 Backup Sets ............................................................. 537

29.1 Backup Sets ............................................................................ 539
29.1.1 Backup Sets Location ............................................................ 539
29.1.2 Backup Sets and Server Name .............................................. 539
29.1.3 Backup Set Storage and Protection ....................................... 539
29.1.4 Backup Set Import from WorkStation ..................................... 539
29.1.5 Automatic Purge of Backup Sets ........................................... 540
29.2 Location of Backup Sets .......................................................... 541
29.2.1 Multi Server System ............................................................... 541
29.2.2 Stand-alone System ............................................................... 541
29.3 Backup Set Storage and Protection ......................................... 543
29.4 Locating the Local Backup Path on the Enterprise Server or
Enterprise Central .................................................................... 545
29.5 Saving an Enterprise Server or Enterprise Central Backup Set to
Another Location ...................................................................... 546
29.6 Saving a SmartX Server Backup Set to Another Location ........ 547
29.7 Copying a Backup Set to the Enterprise Server or Enterprise
Central Local Directory ............................................................ 548
29.8 Backup Set Import from WorkStation ....................................... 549
29.9 Importing a Backup Set to an Enterprise Server or Enterprise
Central ..................................................................................... 551
29.10 Importing a Backup Set to SmartX Server ................................ 552
29.11 Automatic Purge of Backup Sets ............................................. 553
29.12 Configuring Purge Settings on an Enterprise Server ............... 554
29.13 Configuring Purge Settings on an Enterprise Central .............. 555
29.14 Deleting a Backup Set from an Enterprise Server or Enterprise
Central ..................................................................................... 556

30 Scheduled Backups ................................................. 557

30.1 Scheduled Backups ................................................................ 559
30.1.1 Backup Rules ......................................................................... 559
30.1.2 Backup Schedules ................................................................. 560
30.1.3 Synchronized Backups .......................................................... 560
30.2 Backup Rules ........................................................................... 561

04-30008-01-en, May 2019 IT

17
 30.3 Creating a Backup Rule ........................................................... 562
30.4 Editing a Backup Rule ............................................................. 563
30.5 Deleting a Backup Rule ........................................................... 564
30.6 Removing a Lead Rule from a Backup Rule ............................ 565
30.7 Backup Schedules ................................................................... 566
30.8 Editing a Backup Schedule ..................................................... 567
30.9 Synchronized Backups ............................................................ 568
30.10 Synchronizing EcoStruxure BMS Server Backups on a
Network .................................................................................... 569

31 Restore ..................................................................... 571

31.1 Restore .................................................................................... 573
31.1.1 Restored Data ........................................................................ 573
31.1.2 SmartX Server Replacement Using Restore .......................... 573
31.1.3 Duplicate SmartX Server Using Restore ................................ 573
31.2 Restored Data .......................................................................... 574
31.3 Restoring the EcoStruxure BMS Server ................................... 576
31.4 Restoring a SmartX Server from the Enterprise Server ............ 577
31.5 Restoring an Enterprise Server from the Enterprise Central .... 578
31.6 SmartX Server Replacement Using Restore ............................ 579
31.6.1 SmartX Server Replacement Using Restore Workflow ........... 580
31.7 SmartX Server Replacement Using Restore Workflow ............. 581
31.8 Duplicate SmartX Server from a Backup Set ........................... 583
31.8.1 Duplicate SmartX Server from a Backup Set Workflow .......... 584
31.9 Duplicating a SmartX Server Using Restore ........................... 586

32 Backup and Restore User Interface ......................... 587

32.1 Backup and Restore Manager Properties (Enterprise Central) –
Basic Tab ................................................................................. 589
32.2 Backup and Restore Manager Properties (Enterprise Server) –
Basic Tab ................................................................................. 591
32.3 Backup and Restore Manager Properties (SmartX Servers) –
Basic Tab ................................................................................. 593
32.4 Backup and Restore Manager on the Enterprise Server ......... 594
32.5 Backup and Restore Manager on a SmartX Server ................ 596
32.6 Backup Options Dialog Box ..................................................... 597
32.7 Create Object Wizard – Configure Backup Rule Page ............ 599
32.8 Backup Rule Properties – Basic Tab ....................................... 600
32.9 Backup Rules View .................................................................. 601
32.10 Backup Rules Toolbar ............................................................. 602
32.11 Backup Rules List .................................................................... 603
32.12 Digital Schedule Properties – Basic Tab .................................. 604
32.13 Backup Set Properties – Basic Tab ......................................... 606
32.14 Backup Sets View .................................................................... 607
32.15 Backup Status Dialog Box ....................................................... 608
32.16 Control Panel – Backup and Archiving .................................... 609
32.17 Backup Rule Dialog Box .......................................................... 610
32.18 Backup and Restore System Tree Icons .................................. 611

IT 04-30008-01-en, May 2019

18
 32.19 Restore Options Dialog Box ..................................................... 612
32.20 Restore Status Dialog Box ....................................................... 614
32.21 Backup and Restore Folder Properties .................................... 615

04-30008-01-en, May 2019 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 regulatory notices.
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-30008-01-en, May 2019 IT

25
1 About This Guide
1.2 How This Guide is Organized

1.2 How This Guide is Organized

This EcoStruxure Building Operation 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
regulatory notices.

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 BMS guides.

IT 04-30008-01-en, May 2019

26
 1 About This Guide
1.3 Safety Information

1.3 Safety Information

Important Information
Read these instructions carefully and look at the equipment to become familiar
with the device before trying to install, operate, service or maintain it. 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-30008-01-en, May 2019 IT

27
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 SmartX 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 help.sbo.schneider-electric.com 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-30008-01-en, May 2019 IT

31
2 Additional Information
2.1 Where to Find Additional Information

Figure: Search filters

IT 04-30008-01-en, May 2019

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 BMS 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 SmartX 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-30008-01-en, May 2019 IT

37
3 Installation
3.1 Installation Overview

NOTICE
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
SmartX 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 45.

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 63.

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 73.

3.1.7 System Upgrade Overview

A system upgrade can include an Enterprise Server, Reports Server, one or
more SmartX 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-30008-01-en, May 2019

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 93.

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 47.

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 16.1 “Software Administrator” on page 273.

04-30008-01-en, May 2019 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 SmartX 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.

NOTICE
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
11.10 “Licenses” on page 190.

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.

NOTICE
You have to have a valid Graphics Editor license to start the Graphics Editor.
For more information, see section 11.10 “Licenses” on page 190.

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.

IT 04-30008-01-en, May 2019

40
 3 Installation
3.2 Products

NOTICE
Ensure that you have a working and available Script license. A working license
is required to start Script. For more information, see section 11.10 “Licenses”
on page 190.

The installation of Script Editor is bundled into the WorkStation installation

package.
For more information, see the Script Editor Program Creation topic on WebHelp.

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.

NOTICE
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 11.10 “Licenses” on page 190.

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 Series 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.

NOTICE
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 11.10 “Licenses” on page 190.

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.

04-30008-01-en, May 2019 IT

41
3 Installation
3.2 Products

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.

NOTICE
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 11.10 “Licenses” on
page 190.

The installation of WorkPlace Tech is bundled into the WorkStation installation

package, and is specific to the particular version of WorkStation in that package.

NOTICE
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 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 SmartX servers.
Enterprise Server aggregates data that can be accessed by Enterprise Central.

IT 04-30008-01-en, May 2019

42
 3 Installation
3.2 Products

NOTICE
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 11.10 “Licenses” on page 190.

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 16.1 “Software Administrator” on page 273.

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.

3.2.11 License Administrator

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

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 14.1 “License Server” on page 231.
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.

04-30008-01-en, May 2019 IT

43
3 Installation
3.2 Products

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.

IT 04-30008-01-en, May 2019

44
 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
SmartX 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 12.8 “Local Licenses” on page 218.

NOTICE
• 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

04-30008-01-en, May 2019 IT

45
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 section 12.2 “Network License
Management” on page 209.
• 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.

IT 04-30008-01-en, May 2019

46
 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.

04-30008-01-en, May 2019 IT

47
3 Installation
3.4 Version Numbers and Parallel Installations

NOTICE
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.

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.

NOTICE
• 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.

IT 04-30008-01-en, May 2019

48
 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
Next.
4. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then click I Agree
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
Next.

NOTICE
• 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.

NOTICE
• 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
Next.
7. In the License Server Configuration page, in the License Server Address
box, type @ and then type the address to the license server.

NOTICE
• 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
Install.

04-30008-01-en, May 2019 IT

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

9. In the Installation Complete page, click Next

Next.

NOTICE
Click Show details to follow the progress of the installation.

10. Click Finish

Finish.
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 14.14 “Configuring License Server Recovery Settings ”
on page 247.

IT 04-30008-01-en, May 2019

50
 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.

NOTICE
• 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 11.10 “Licenses” on page 190.
• 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.

NOTICE
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
administrator.

3. Click Yes to confirm that you want to run the Workstation installation
package.
4. In the Installation wizard, click Next
Next.
5. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then click I Agree
Agree.

04-30008-01-en, May 2019 IT

51
3 Installation
3.6 Installing WorkStation and Client Tools

6. In the Installation Folder page, browse to the folder where you want to
install WorkStation and client tools and then click Next
Next.

NOTICE
• 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.

NOTICE
• 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\
Files\, WorkPlace
Tech Editor and its components are installed in the folder \Program
Files (x86)\
(x86)\.

7. In the Choose Components page, select the components that you want to
install and then click Next
Next.

NOTICE
Before selecting the WorkPlace Tech Editor component, be sure the
appropriate versions of Microsoft Visio and .NET 3.5 SP1 are installed.
For more information, see the WorkPlace Tech Editor topic on WebHelp.
For more information, see the System Upgrade Software Requirements
topic on WebHelp.

8. In the WorkStation Shortcut Selection page, select the shortcuts you want
to be created and then click Next
Next.
9. In the License Server Address box, type @ and then type the address to
the license server.

NOTICE
• 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

Install.
11. Click Next
Next.
12. Click Finish
Finish.

NOTICE
Click Show details to follow the progress of the installation.

IT 04-30008-01-en, May 2019

52
 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.

NOTICE
• 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
Yes.
3. In the Language Pack Setup screen, click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
5. Click Next
Next.

NOTICE
Click Show details to follow the progress of the installation.

6. Click Finish
Finish.
The language to display in WorkStation is determined by the operating system
language on which the WorkStation is installed.

04-30008-01-en, May 2019 IT

53
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.

NOTICE
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
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
Next.
4. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then, click I Agree
Agree.
5. In the Installation Folder - Program Files page, click Next
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.

NOTICE
The database folder path can contain up to 140 characters.

7. Click Next
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
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.

IT 04-30008-01-en, May 2019

54
 3 Installation
3.8 Installing Enterprise Central

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.
17. Click Next
Next.
18. In the License Server page, in the License Server address box, type @
and then type the address to the License Server.

NOTICE
• 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

Next.
20. In the Summary page revise the information and then, click Install
Install.
21. Click Next
Next.

NOTICE
Click Show details to follow the progress of the installation.

22. In the Installation Completed page, click Next

Next.
23. In the Enterprise Central Setup page, click Finish
Finish.

04-30008-01-en, May 2019 IT

55
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.

NOTICE
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 11.10 “Licenses” on page 190.

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.

NOTICE
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
administrator.

3. Click Yes to confirm that you want to run the installation package.
4. Click Next
Next.
5. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
6. Browse to the folder where you want to install the Enterprise Server and
then click Next
Next.

NOTICE
• 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.

NOTICE
• 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.

NOTICE
The database folder path can contain up to 140 characters.

IT 04-30008-01-en, May 2019

56
 3 Installation
3.9 Installing the Enterprise Server

8. Click Next
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.
12. Click Next
Next.
13. Select Local system to run the Enterprice Server service under the Local
system account.

NOTICE
• 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.

14. In the License Server Address box, type @ and then type the address to
the License Server.

NOTICE
• 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.

15. Click Next

Next.
16. Revise the information on the Summary page and then click Install
Install.
17. Click Next
Next.

NOTICE
Click Show details to follow the progress of the installation.

18. Click Finish

Finish.
19. In Windows, enable any anti-virus program.

04-30008-01-en, May 2019 IT

57
3 Installation
3.9 Installing the Enterprise Server

20. When the installation is completed, make sure that the HTTP port, HTTPS
port, and TCP port are not used exclusively by any other application.

NOTICE
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 16.11 “Resolving Enterprise Server or Enterprise
Central Port Conflicts” on page 283..

IT 04-30008-01-en, May 2019

58
 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
SmartX 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
Yes, to confirm that you want to run the Device Administrator
installation package.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
5. Browse to the folder where you want to install Device Administrator and
click Next
Next.

NOTICE
• 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.

NOTICE
• 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
Next.

NOTICE
Click Show details to follow the progress of the installation.

8. Click Finish
Finish.

04-30008-01-en, May 2019 IT

59
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.

NOTICE
Before repairing a License Server or Enterprise Server, you must stop related
Windows services.

04-30008-01-en, May 2019 IT

63
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 63.

NOTICE
• 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.

NOTICE
In Windows, open the Run dialog box and enter services.msc

2. In the Services console, right-click Building Operation x.x License Server

Server.
3. Select Stop
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
Next.
7. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
8. In the Program Files page, click Next
Next.
9. In the Choose Components page, select the components you want to
repair and then click Next
Next.
10. In the Installation Type page, select Repair current version to repair the
current License Administrator installation.
11. Click Next
Next.
12. In the License Server page, in the License Server Address box, type @
and then type the address to the license server.

NOTICE
• 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.

IT 04-30008-01-en, May 2019

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

13. Click Install

Install.
14. In the Installation Complete page, click Next
Next.

NOTICE
Click Show details to follow the progress of the installation.

15. Click Finish

Finish.

04-30008-01-en, May 2019 IT

65
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.

NOTICE
To repair an installation, you must have access to the installation package that
was used to install the product.

NOTICE
During the repair of WorkStation, additional language packages are removed.

For more information, see section 4.1 “Installation Reparation” on page 63.

To repair the WorkStation and client tool installation

1. Double-click on the WorkStation installation file to start the installation
wizard.

NOTICE
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
administrator.

2. Click Yes to confirm that you want to run the Workstation installation
package.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
5. In the Program Files page, click Next
Next.
6. In the Choose Components page, select the components that you want to
repair and then click Next
Next.

NOTICE
Before selecting the WorkPlace Tech Editor component, be sure the
appropriate versions of Microsoft Visio and .NET 3.5 SP1 are installed.
For more information, see the WorkPlace Tech Editor topic on WebHelp.
For more information, see the System Upgrade Software Requirements
topic on WebHelp.

7. In the WorkStation Shortcut Selection page, select the shortcuts you want
to be created and then click Next
Next.
8. In the WorkStation Installation Type page, select Repair current version
version.

IT 04-30008-01-en, May 2019

66
 4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

9. Click Next
Next.
10. In the License Server Configuration page, in the License Server Address
box, type @ and then type the address to the license server.

NOTICE
• 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

Install.
12. In the Installation Complete page, click Next
Next.

NOTICE
Click Show details to follow the progress of the installation.

13. Click Finish

Finish.

04-30008-01-en, May 2019 IT

67
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.

NOTICE
• 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 63.

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.

NOTICE
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
Next.
6. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
7. In the Installation Folder page, click Next
Next.
8. Accept the database folder or browse to select another installation folder
for the database and then click Next
Next.

NOTICE
The database folder path can contain up to 140 characters.

9. Click Next
Next.
10. In the Installation Type page, select Repair current version to repair the
current Enterprise Server installation.
11. Click Next
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.

IT 04-30008-01-en, May 2019

68
 4 Installation Repair
4.4 Repairing the Enterprise Server

15. Click Next

Next.
16. In the Windows Services page, select Local system to run the Enterprice
Server service under the Local system account.

NOTICE
• 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.

NOTICE
• 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

Next.
19. In the Summary page, revise the information and then click Install
Install.
20. In the Installation Complete page, click Next
Next.

NOTICE
Click Show details to follow the progress of the installation.

21. Click Finish

Finish.

04-30008-01-en, May 2019 IT

69
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.

NOTICE
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 63.

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
Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
5. CIn the Installation Folder page, click Next
Next.
6. In the Device Administrator Installation Type page, select Repair current
version
version.
7. Click Next
Next.
8. In the Installation Complete page, click Next
Next.

NOTICE
Click Show details to follow the progress of the installation.

9. Click Finish
Finish.

IT 04-30008-01-en, May 2019

70
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
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 28.7 “Backing Up EcoStruxure
BMS Servers Manually” on page 531.

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.

NOTICE
Before reinstalling a License Server or Enterprise Server, you must stop
related Windows services.

04-30008-01-en, May 2019 IT

73
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 73.

To reinstall the License Administrator and License Server

1. On the License Server, open the Service management console.

NOTICE
In Windows, open the Run dialog box and enter services.msc

2. Right-click Building Operation x.x License Server

Server.
3. Select Stop
Stop.
4. Double-click on the License Administrator installation file to start the
installation wizard.
5. Click Yes
Yes, to confirm that you want to run the License Administrator
installation package.
6. Click Next
Next.
7. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
8. Click Next
Next.
9. Select the components you want to reinstall and then click Next
Next.
10. Select Uninstall current version before reinstalling to reinstall the current
License Administrator installation.
11. Click Next
Next.
12. In the License Server Address box, type @ and then type the address to
the license server.

NOTICE
• 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

Install.
14. Click Next
Next.
15. Click Finish
Finish.

IT 04-30008-01-en, May 2019

74
 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.

NOTICE
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 11.10 “Licenses” on
page 190.

NOTICE
When reinstalling the WorkStation, additional language packages are
removed.

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

To reinstall WorkStation and client tool installation

1. Double-click on the WorkStation installation file to start the installation
wizard.

NOTICE
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
administrator.

2. Click Yes to confirm that you want to run Workstation installation pakage.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
5. In the Installation Folder page, click Next
Next.
6. Select the components that you want to reinstall and then click Next
Next.

NOTICE
Before selecting the WorkPlace Tech Editor component, be sure the
appropriate versions of Microsoft Visio and .NET 3.5 SP1 are installed.
For more information, see the WorkPlace Tech Editor topic on WebHelp.
For more information, see the System Upgrade Software Requirements
topic on WebHelp.

7. Select the shortcuts you want to be created and then click Next
Next.
8. Select Uninstall current version before reinstalling
reinstalling.

04-30008-01-en, May 2019 IT

75
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

9. Click Next
Next.
10. In the License Server address box, type @ and then type the address to
the license server.

NOTICE
• 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

Install.
12. Click Uninstall to remove the current installation.
13. Click Close
Close.

NOTICE
Click Show details to follow the progress of the installation.

14. Click Next

Next.
15. Click Finish
Finish.

IT 04-30008-01-en, May 2019

76
 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
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 28.7 “Backing Up EcoStruxure
BMS Servers Manually” on page 531.

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

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.

NOTICE
The Enterprise Server Windows Service is automatically stopped.

5. Click Next
Next.
6. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then click I Agree
Agree.
7. In the Installation Folder page, click Next
Next.
8. Accept the database folder or browse to select another installation folder
for the database and then click Next
Next..

NOTICE
The database folder path can contain up to 140 characters.

9. Click Next
Next.
10. In the Installation Type page, select Uninstall current version before
reinstalling
reinstalling.
11. Click Next
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.

04-30008-01-en, May 2019 IT

77
5 Reinstallation
5.4 Reinstalling the Enterprise Server

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
Next.
16. In the Windows Service page, select Local system to run the Enterprise
Server under the Local system account.

NOTICE
• 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.

NOTICE
• 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

Next.
19. Revise the information on the Summary page and then click Install
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.

NOTICE
Click Show details to follow the progress of the reinstallation.

23. Click Finish

Finish.
24. In Windows, enable any anti-virus program.

IT 04-30008-01-en, May 2019

78
 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 73.

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
Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
5. Click Next
Next.
6. In the Device Administrator Installation Type page, select Uninstall
current version before reinstalling
reinstalling.
7. Click Next
Next.
8. Click Uninstall to remove the current installation.
9. Click Close
Close.

NOTICE
Click Show details to follow the progress of the installation.

10. In the Installation Complete page, click Next

Next.
11. Click Finish
Finish.

04-30008-01-en, May 2019 IT

79
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-30008-01-en, May 2019 IT

83
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 28.8 “System Backup” on page 532.

Stop Enterprise Server Windows service

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

Stop License Server Windows service

If you are upgrading the License Server, stop the License Server Windows
service. For more information, see section 14.3 “Stopping the License Server” on
page 233.

Stop Reporting Agent Windows service

If your system includes WebReports, stop the Reports Agent Windows service.
For more information, see section 9.25 “Stopping the Reporting Agent Windows
Service ” on page 154.

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 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 section 9.24
“Starting the Reporting Agent Windows Service ” on page 153.

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-30008-01-en, May 2019

84
 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 56.

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-30008-01-en, May 2019 IT

85
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 section 9.25 “Stopping the Reporting Agent
Windows Service ” on page 154.

IT 04-30008-01-en, May 2019

86
 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 31.3 “Restoring
the EcoStruxure BMS Server” on page 576.

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 16.6 “Starting the Enterprise Server or
Enterprise Central Windows Service” on page 278.
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 28.8 “System Backup” on page 532.

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 53.

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-30008-01-en, May 2019 IT

87
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 section 9.12 “Detaching a
WebReports Database” on page 140.

Export Reports schedules

Use Task Scheduler to export all the Reports schedules to a USB memory
device. For more information, see section 9.14 “Transferring Reports
Schedules ” on page 142.

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-30008-01-en, May 2019

88
 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 section 9.13 “Attaching a WebReports Database” on
page 141.

04-30008-01-en, May 2019 IT

89
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 section 9.11 “Installing
WebReports” on page 138.

Import or recreate Reports schedules

Import or recreate the Reports schedules on the computer running WebReports.
For more information, see section 9.14 “Transferring Reports Schedules ” on
page 142.
The WebReports migration is now complete.

IT 04-30008-01-en, May 2019

90
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
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
12.6 “Removing a Local License or Returning a Network License” on page
216.

NOTICE
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 28.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 531.

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

04-30008-01-en, May 2019 IT

93
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
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
12.6 “Removing a Local License or Returning a Network License” on page
216.

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

To uninstall the License Administrator

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

NOTICE
Click Show details to follow the progress of the installation.

IT 04-30008-01-en, May 2019

94
 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
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
12.6 “Removing a Local License or Returning a Network License” on page
216.

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

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
Uninstall.
3. In the Building Operation x.y License Server Uninstall dialog box, click
Uninstall
Uninstall.
4. Click Close
Close.

NOTICE
Click Show details to follow the progress of the installation.

04-30008-01-en, May 2019 IT

95
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
Uninstall.
2. In the Language Pack x.y Uninstall dialog box, click Uninstall
Uninstall.
3. Click Close
Close.

IT 04-30008-01-en, May 2019

96
 7 Uninstallation
7.5 Uninstalling WorkStation

7.5 Uninstalling WorkStation

You uninstall WorkStation to permanently remove the application from your
computer.

NOTICE
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.

NOTICE
• Client tools are uninstalled together with the uninstallation of WorkStation.

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

To uninstall WorkStation
1. In Windows Control Panel, select Schneider Electric EcoStruxure Building
Operation WorkStation x.y and then click Uninstall
Uninstall.
2. In the WorkStation x.y Unistall dialog box, click Uninstall
Uninstall.

NOTICE
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
Close.

04-30008-01-en, May 2019 IT

97
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
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 28.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 531.

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

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
Uninstall.
3. In the Enterprise Central x.y Uninstall dialog box, click Uninstall
Uninstall.
4. Click Close
Close.

NOTICE
Click Show details to follow the progress of the installation.

IT 04-30008-01-en, May 2019

98
 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
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 28.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 531.

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

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
Uninstall.
3. In the Enterprise Server x.y Uninstall dialog box, click Uninstall
Uninstall.
4. Click Close
Close.

NOTICE
Click Show details to follow the progress of the installation.

04-30008-01-en, May 2019 IT

99
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 93.

To uninstall Device Administrator

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

NOTICE
Click Show details to follow the progress of the installation.

IT 04-30008-01-en, May 2019

100
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 SmartX
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-30008-01-en, May 2019 IT

103
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
SmartX 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 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-30008-01-en, May 2019

104
 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-30008-01-en, May 2019 IT

105
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-30008-01-en, May 2019

106
 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-30008-01-en, May 2019 IT

107
9 Reports Installation

Topics
WebReports Installation Overview
WebReports Installer and WebReports Components
Reports Server Configuration
WebReports Installation WorkFlow
Windows Roles and Features
SQL Server
SQL Server Installation Settings
.NET Framework 4.7
Configuring SQL Server Memory
Starting a Windows Service
Installing WebReports
Detaching a WebReports Database
Attaching a WebReports Database
Transferring Reports Schedules
Backing Up the WebReports Database
Restoring the WebReports Database
WebReports Uninstall
Uninstalling WebReports
Reporting Agent
Reporting Agent Log File
9 Reporting Agent Configuration File
Changing Reporting Agent Logging Information
Changing Events and Historical Records Information
Starting the Reporting Agent Windows Service
Stopping the Reporting Agent Windows Service
 9 Reports Installation
9.1 WebReports Installation Overview

9.1 WebReports Installation Overview

EcoStruxure Building Operation WebReports is installed using an installation
package. Before you install WebReports, you must ensure that the computer on
which you want to install WebReports (the Reports Server) meets the hardware
and software requirements for WebReports, and that you have installed or
enabled certain prerequisite items of software. These requirements are covered
in the installation workflow (introduced in this topic).

9.1.1 WebReports Installer and WebReports

Components
The WebReports Installer is a custom installer program that performs
installation, prevalidation, and configuration of WebReports components. The
WebReports Installer is delivered in an installation package, and the installation
package has the format WebReports-x.x.xxxxx.xxxx.exe. When you run the
installation package, the WebReports Installer and accompanying files are
placed in /Program Files (x86)/Schneider Electric EcoStruxure/Building
Operation WebReports Installation by default. The WebReports Installer will
automatically run to install the WebReports when you run the installation
package.
For more information, see section 9.2 “WebReports Installer and WebReports
Components” on page 113.

9.1.2 Reports Server Configuration

Install WebReports on the Reports Server, which is the computer where you
install SQL Server.
For more information, see section 9.3 “Reports Server Configuration” on page
117.

9.1.3 WebReports Installation WorkFlow

The WebReports installation workflow provides a guide to overall WebReports
installation.
For more information, see section 9.4 “WebReports Installation WorkFlow” on
page 118.

9.1.4 Windows Roles and Features

The WebReports installation requires you to select certain roles and services to
install on the Application Server and the Web Server (IIS), and to install .NET
Framework 3.5 and .NET Framework 4.x features. You install these roles and
features using the Server Manager in Windows Server 2008, Windows Server

04-30008-01-en, May 2019 IT

111
9 Reports Installation
9.1 WebReports Installation Overview

2012, Windows Server 2012 R2, or Windows Server 2016. For Windows 7,
Windows 8.1, and Windows 10, you configure the roles and features using
Control Panel. It is recommended that you install these roles and features before
you install SQL Server.
For more information, see section 9.5 “Windows Roles and Features” on page
120.

9.1.5 SQL Server

SQL Server provides the platform for the Reporting Services database and the
Reports database. You cannot install WebReports until you first create your
Reports Server by installing a supported version of SQL Server.
For more information, see section 9.6 “SQL Server” on page 129.

9.1.6 SQL Server Installation Settings

Before you can install WebReports successfully, it is imperative that the SQL
Server has been installed with a particular group of settings.
For more information, see section 9.7 “SQL Server Installation Settings” on page
130.

9.1.7 WebReports Uninstallation

To uninstall WebReports, 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 9.17 “WebReports Uninstall” on page 145.

IT 04-30008-01-en, May 2019

112
 9 Reports Installation
9.2 WebReports Installer and WebReports Components

9.2 WebReports Installer and WebReports

Components
The WebReports Installer is a custom installer program that performs
installation, prevalidation, and configuration of WebReports components. The
WebReports Installer is delivered in an installation package, and the installation
package has the format WebReports-x.x.xxxxx.xxxx.exe. When you run the
installation package, the WebReports Installer and accompanying files are
placed in /Program Files (x86)/Schneider Electric EcoStruxure/Building
Operation WebReports Installation by default. The WebReports Installer will
automatically run to install the WebReports when you run the installation
package.
Four WebReports components are installed:
• WebReports client
• WebReports Web services
• Reporting Agent Windows service
• Schneider Electric Report Pack
The installation also checks and configures the following applications:
• ASP.NET
• IIS
• SQL Server
• SQL Server Reporting Services
The illustration shows these installation components and identifies the tasks
performed by the WebReports Installer.

04-30008-01-en, May 2019 IT

113
9 Reports Installation
9.2 WebReports Installer and WebReports Components

Figure: WebReports installation components

WebReports Client
The WebReports client performs the following tasks:
• Sends requests for reports
• Administers the Reports Server
• Provides the user interface for viewing, customizing, and managing reports
During the installation, the WebReports Installer installs the WebReports client
on the computer where IIS is installed.

WebReports Service
Authenticate and GetReportNames comprise the WebReports service.
Authenticate provides a way for user logons to be authenticated against the user
account information stored on the Enterprise Server. GetReportNames provides
a way for report names to be retrieved from the Reports database. During the
installation, the WebReports Installer installs the WebReports service with the
WebReports client.

IT 04-30008-01-en, May 2019

114
 9 Reports Installation
9.2 WebReports Installer and WebReports Components

Reporting Agent
The Reporting Agent is a Windows service that performs reads of historical data,
such as extended trends, events, and alarms. During the installation, the
WebReports Installer prompts you to enter the number of seconds that you want
the Reporting Agent to perform these reads. It is recommended that you accept
the default value.
For more information, see section 9.19 “Reporting Agent” on page 147.

Report Pack
The installation installs the report pack that contains the Report Definition Layout
files for the default reports and Production reports. During the installation, the
WebReports Installer installs the report pack in the Reporting Services
database.
For more information, see the Report Packs topic on WebHelp.

ASP.NET and IIS

ASP.NET is the Web application framework used to develop the WebReports
Web site, Web client, and Web service. IIS provides the mechanism for
accessing WebReports using a Web browser. IIS also provides the mechanism
for accessing the WebReports Web site and Web service using URLs. Enabling
ASP.NET and IIS is a prerequisite for installing WebReports. During the
installation, the WebReports Installer verifies that the correct versions of
ASP.NET and IIS are enabled on your computer.

SQL Server
Microsoft SQL Server provides the platform for the Reports database and the
Reporting Services database, and must be installed as a prerequisite for
installing WebReports. If you are installing WebReports with version 1.5 (or later)
of Building Operation, ensure that you install a supported version of Microsoft
SQL Server. For more information, see section 9.6 “SQL Server” on page 129.
During the installation, the WebReports Installer verifies that SQL Server is
installed on the Reports server. The WebReports Installer also ensures that the
correct users and permissions are defined for access to the Reports database
and the Reporting Services database.

SQL Server Reporting Services and Reporting Services Database

SQL Server Reporting Services is the report generation environment for data
gathered from the Reporting Services database. Both the Reporting Services
component and the Reporting Services database are installed when you install
SQL Server. During the WebReports installation, the WebReports Installer
performs the following tasks:
• Verifies that Reporting Services is installed on the Reports server
• Creates the data source that identifies the location of the data
• Adds the RDLs to the Reporting Services database
• Synchronizes the data between the Reporting Services database and the
Reports database
• Configures Reporting Services to have access to the Reporting Services
database and the WebReports Web service

04-30008-01-en, May 2019 IT

115
9 Reports Installation
9.2 WebReports Installer and WebReports Components

Reports Database
The Reports database stores the trend, alarm, user account, and SmartX server
information that is used in WebReports. The data are used in conjunction with
the RDLs that reside in the Reporting Services database to create your reports.
During the installation, the WebReports Installer performs the following tasks:
• Creates the Reports database on the Reports server
• Installs the SQL .mdf and .ldf database files that comprise
StruxureWareReportsDB

NOTICE
If you are upgrading WebReports, it is recommended that you first back up the
Reports database. For more information, see section 9.15 “Backing Up the
WebReports Database” on page 143.

IT 04-30008-01-en, May 2019

116
 9 Reports Installation
9.3 Reports Server Configuration

9.3 Reports Server Configuration

Install WebReports on the Reports Server, which is the computer where you
install SQL Server.
For security reasons, consider using different computers for the Reports Server
and the Enterprise Server. If you follow this recommendation, you install the
Enterprise Server on one computer. Then, on a separate computer, you install
both SQL Server and WebReports. This is a recommendation not a requirement.
During the WebReports installation, you are prompted to enter the URL of the
Enterprise Server. You need to know the IP address of the Enterprise Server and
the port number to complete this part of the installation. It is from the Enterprise
Server that your report data are read and inserted into the Reports database. If
you do install WebReports on the same computer where the Enterprise Server is
installed, you need to choose a port other than the default port of 80 when you
enter the URL for the Enterprise Server. Using a port other than 80 avoids a
conflict with IIS, which uses port 80.

04-30008-01-en, May 2019 IT

117
9 Reports Installation
9.4 WebReports Installation WorkFlow

9.4 WebReports Installation WorkFlow

The WebReports installation workflow provides a guide to overall WebReports
installation.
The flowchart describes the basic steps in the correct order required for a
successful installation of WebReports. Each step in the flowchart is covered
under a sub-heading in this topic or described by way of the related links below.

Figure: Webreports overall installation flowchart

Check installation requirements

Details of the hardware and software requirements of the Reports Server are
contained in the Reports Server specification sheet. For more information, see
the Reports Server topic on WebHelp.

Configure Windows Roles and Features

Using the Server Manager in Windows Server 2008 R2, Windows Server 2012,
Windows Server 2012 R2, or Windows Server 2016, add the IIS server role,
select the role services, install .NET Framework 3.5, and .NET Framework 4.x
features.
For Windows Server 2008, add the IIS server role, select the role services, and
then add the .NET Framework 3.5.1 features.
For more information, see section 9.5 “Windows Roles and Features” on page
120.

Install SQL Server

Download SQL Server and then configure the installation settings for
WebReports.
For more information, see section 9.7 “SQL Server Installation Settings” on page
130.

IT 04-30008-01-en, May 2019

118
 9 Reports Installation
9.4 WebReports Installation WorkFlow

Install WebReports
Install WebReports on the same computer where you installed SQL Server.
For more information, see section 9.11 “Installing WebReports” on page 138.

04-30008-01-en, May 2019 IT

119
9 Reports Installation
9.5 Windows Roles and Features

9.5 Windows Roles and Features

The WebReports installation requires you to select certain roles and services to
install on the Application Server and the Web Server (IIS), and to install .NET
Framework 3.5 and .NET Framework 4.x features. You install these roles and
features using the Server Manager in Windows Server 2008, Windows Server
2012, Windows Server 2012 R2, or Windows Server 2016. For Windows 7,
Windows 8.1, and Windows 10, you configure the roles and features using
Control Panel. It is recommended that you install these roles and features before
you install SQL Server.
Server Manager is accessible from the Start screen or from the desktop (task
bar). You begin by adding the .NET Framework 3.5 features, the IIS server role
and selecting the role services, and then you add .NET Framework 4.x features.
The following figures show the features that must be selected when configuring
Roles and Features for Windows Server 2012, Windows Server 2012 R2, or
Windows Server 2016. For Windows 7, Windows 8.1, or Windows 10, you
configure the roles and features using Control Panel.
To install .NET Framework 3.5 on Windows 8.1 or Windows 10 and Windows
Server 2012, Windows Server 2012 R2, or Windows Server 2016, enter the
following source path:
dism /online /enable-feature /featurename:NetFX3 /all /Source:e:\sources\sxs
/LimitAccess

NOTICE
In this example, the Windows Server 2012 setup CD is in the e drive. Use the
appropriate drive in the path for your PC configuration.

Figure: .Net Framework 3.5 installation (Windows Server 2012)

IT 04-30008-01-en, May 2019

120
 9 Reports Installation
9.5 Windows Roles and Features

Figure: Web Server (IIS) server role selection (Windows Server 2012)

04-30008-01-en, May 2019 IT

121
9 Reports Installation
9.5 Windows Roles and Features

Figure: Features Selection (Windows Server 2012)

IT 04-30008-01-en, May 2019

122
 9 Reports Installation
9.5 Windows Roles and Features

Figure: Application Server role services selection (Windows Server 2012)

04-30008-01-en, May 2019 IT

123
9 Reports Installation
9.5 Windows Roles and Features

Figure: Windows Roles and Features successful installation page (Windows Server 2012)

For Windows Server 2008, you begin by adding the IIS server role and selecting
the role services, and then you add the .NET Framework 3.5.1 features. The
following figures show the settings that must be selected when configuring
windows roles and features.

IT 04-30008-01-en, May 2019

124
 9 Reports Installation
9.5 Windows Roles and Features

Figure: Web Server (IIS) server role selection

04-30008-01-en, May 2019 IT

125
9 Reports Installation
9.5 Windows Roles and Features

Figure: .NET Framework configuration

IT 04-30008-01-en, May 2019

126
 9 Reports Installation
9.5 Windows Roles and Features

Figure: Window roles and features - successful installation page

For Windows 7, Windows 8.1, and Windows 10, you can configure the roles and
features using Control Panel. In Control Panel, navigate to Programs
Programs, and select
Turn Windows features on or offoff. Select .NET Framework 3.5 (includes .NET
2.0 and 3.0)
3.0), .NET Framework 4.7 Advanced Services
Services, and Internet
Information Services
Services.

04-30008-01-en, May 2019 IT

127
9 Reports Installation
9.5 Windows Roles and Features

Figure: Configuration of roles and features for Windows 10

IT 04-30008-01-en, May 2019

128
 9 Reports Installation
9.6 SQL Server

9.6 SQL Server

Before you can install WebReports successfully, it is imperative that the SQL
Server has been installed with a particular group of settings.

9.6.1 SQL Server Version

Microsoft provides a number of versions of SQL Server. In order to install and
run WebReports with EcoStruxure Building Operation software, you need to
download and install Microsoft SQL Server 2008 R2, Microsoft SQL Server 2012,
Microsoft SQL Server 2014, or Microsoft SQL Server 2016.
The following Microsoft SQL Server editions are supported:
• Microsoft SQL Server 2008 R2 SP2, SP3, 64-bit (or Express with Advanced
Edition, 64-bit)
• Microsoft SQL Server 2012 Standard, 64-bit (or Express with Advanced
Edition, 64-bit), Microsoft SQL Server 2012 SP1, SP2, SP3
• Microsoft SQL Server 2014, 64-bit (Enterprise, Standard, or Express with
Advanced Services), SP1 or later
• Microsoft SQL Server 2016, 64-bit (Enterprise, Standard, or Express with
Advanced Services), SP1 or later
Do not install any other version of SQL Server.

NOTICE
Microsoft SQL Server 2012 SP1 (or later Service Pack) is required with the
Windows Server 2012 R2 operating system.

Before you install SQL Server, ensure that your logon account has administrative
privileges.

9.6.2 SQL Server Installation Settings

Before you can install WebReports successfully, it is imperative that the SQL
Server has been installed with a particular group of settings.
During the installation of SQL Server, the setup wizard prompts you to select
from a number of options. You must select the correct installation settings. For
more information, see section 9.7 “SQL Server Installation Settings” on page
130.

9.6.3 SQL Server Memory Configuration

You configure the SQL server memory to ensure that the reports do not take too
much time to get generated. The maximum SQL server memory can be 70% of
the system memory (RAM). For more information, see section 9.9 “Configuring
SQL Server Memory” on page 136.

04-30008-01-en, May 2019 IT

129
9 Reports Installation
9.7 SQL Server Installation Settings

9.7 SQL Server Installation Settings

Before you can install WebReports successfully, it is imperative that the SQL
Server has been installed with a particular group of settings.
The following figures show the settings that must be used when installing SQL
Server:

Figure: SQL feature selection

IT 04-30008-01-en, May 2019

130
 9 Reports Installation
9.7 SQL Server Installation Settings

Figure: SQL instance configuration (for SQL Express installation)

04-30008-01-en, May 2019 IT

131
9 Reports Installation
9.7 SQL Server Installation Settings

Figure: SQL server configuration

IT 04-30008-01-en, May 2019

132
 9 Reports Installation
9.7 SQL Server Installation Settings

Figure: SQL database engine configuration

04-30008-01-en, May 2019 IT

133
9 Reports Installation
9.7 SQL Server Installation Settings

Figure: SQL reporting services configuration

IT 04-30008-01-en, May 2019

134
 9 Reports Installation
9.8 .NET Framework 4.7

9.8 .NET Framework 4.7

You must install .NET Framework 4.7 before you can successfully install
WebReports.
You normally install .NET Framework 4.7 immediately after installing SQL Server,
and immediately before installing the WebReports installer. However, if you have
previously installed .NET Framework 4.7 for any reason, you need to repair the
.NET Framework 4.7 installation.

NOTICE
Even though you install .NET Framework 3.5.1 while adding Windows features,
you must also install .NET Framework 4.7 for successful WebReports and
EcoStruxure Building Operation software installation. For more information, see
section 9.5 “Windows Roles and Features” on page 120.

04-30008-01-en, May 2019 IT

135
9 Reports Installation
9.9 Configuring SQL Server Memory

9.9 Configuring SQL Server Memory

You configure the SQL server memory to ensure that the reports do not take
more time to get generated.

To configure SQL server memory

1. Open SQL Server Management Studio (type SQL in the Start menu Search
box).
2. Right-click the server and then click Properties
Properties.
3. In Maximum server memory (in MB) box, enter 70% of the system memory
(RAM).

4. Click OK
OK.
5. Restart the SQL server service. For more information, see section 9.10
“Starting a Windows Service” on page 137.

IT 04-30008-01-en, May 2019

136
 9 Reports Installation
9.10 Starting a Windows Service

9.10 Starting a Windows Service

You start a Windows service in Windows after an installation, upgrade, or
update.

To start a Windows service

1. On the Start menu, click Control Panel
Panel.
2. Click Administrative Tools
Tools.
3. Click Services
Services.
4. Right click on a service and then click Start
Start.

04-30008-01-en, May 2019 IT

137
9 Reports Installation
9.11 Installing WebReports

9.11 Installing WebReports

You install WebReports to provide the facility to run reports related to your
Building Management System. Install WebReports on the same computer where
you installed SQL Server 2012.
For more information, see section 9.4 “WebReports Installation WorkFlow” on
page 118.

To install WebReports
1. Double-click on the WebReports installation file to start the installation
wizard.
2. Make sure that you agree with the End User License Agreement (EULA)
and then click Accept
Accept.
3. In the Installation Type page, click Install
Install.
4. In the Installation path box, enter the path where you want to install
WebReports.

NOTICE
The complete installation path can have a maximum of 250 characters.

5. In the Virtual root box, type the name for the virtual directory path and then
click Next
Next.
6. In the System Check page, click Next
Next.

NOTICE
If any of the system checks fail, you will not be able to proceed with the
installation.

7. In the Enterprise Server page, in the Path box, type the path where the
Enterprise Server is installed.

NOTICE
In the Path box, the URL should be https://<Enterprise Server IP
address:HTTPS Port>

8. In the User name box, type the user name that is used to access the
Enterprise Server. The user name is your user account in WorkStation.

NOTICE
The user account must belong to the Reports Administrators user group.
For more information, see section 24.21 “User Account – Group
Membership Tab” on page 458.

9. In the Password box, type the password that is used to access the
Enterprise Server.

IT 04-30008-01-en, May 2019

138
 9 Reports Installation
9.11 Installing WebReports

10. Click Next

Next.
11. In the SQL Server page, select the SQL instance where you want to create
the WebReports database.
12. In the Details page, select the database type:
• Select New database if there is no existing database.
• Select Upgrade existing database if the database already exists.
13. In the Database path box, enter the path where you want to save the
WebReports database.
14. In the SSRS URL box, enter the SSRS URL to access the Report Server
Web service and Report Manager.
15. Click Next
Next.
16. In the SQL Configuration page, fixany errors and then click Configure
Configure.
17. Click Next
Next.
18. In the Finish page, confirm that WebReports is installed successfully.
Select Launch WebReports checkbox to launch WebReports after the
installation is complete.
19. Click Finish
Finish.

NOTICE
If you have a WebReports user account in WorkStation, you can now view and
use WebReports in WorkStation and in a web browser. However, before you
can use the full menu bar in WebReports, your user account must also belong
to the Reports Administrators user group. For more information, see the
WebReports User Accounts topic on WebHelp.

04-30008-01-en, May 2019 IT

139
9 Reports Installation
9.12 Detaching a WebReports Database

9.12 Detaching a WebReports Database

You detach a WebReports database to make the database available for
subsequent attachment (when installing or upgrading WebReports to another
operating system or computer).
For more information, see the Enterprise Server System Upgrade Workflow topic
on WebHelp.

To detach a WebReports database

1. On the computer running the current version of WebReports, stop the
Reporting Agent service by way of the Control Panel.
2. Ensure that any other applications that might be accessing the database
are closed.
3. Open SQL Server Management Studio (type SQL in the Start menu Search
box).
4. Expand the Databases folder.
5. Right-click the WebReports database, click Tasks
Tasks, and then click Detach
Detach.
6. Select Drop Connections and then click OK
OK.
7. Copy the database files StruxureWareReportsDB.mdf and
StruxureWareReportsDB.ldf in C:\Program Files (x86)\Schneider Electric
EcoStruxure\Building Operation WebReports\Database Files to a
convenient location, for later attachment.

NOTICE
Save the database files to an external device such as a USB memory
device.

You now attach the database at the computer where you want to install
WebReports. For more information, see section 9.13 “Attaching a WebReports
Database” on page 141.

IT 04-30008-01-en, May 2019

140
 9 Reports Installation
9.13 Attaching a WebReports Database

9.13 Attaching a WebReports Database

You attach a WebReports database to set up the database in the computer
where you want to install the next version of WebReports.
For more information, see the Enterprise Server System Upgrade Workflow topic
on WebHelp.

To attach a WebReports database

1. Ensure that you have detached the database from the computer where the
previous version of webreports was installed, and that you have saved all
the files in C:\Program Files (x86)\Schneider Electric
EcoStruxure\Building Operation WebReports\
WebReports\Database
Database Files to a
convenient location..

NOTICE
If you are attaching the database to a different computer, save the
database files to an external device such as a USB memory device.

2. At the computer where you want to install the next version of WebReports,
transfer the database files StruxureWareReportsDB.mdf and
StruxureWareReportsDB.ldf to C:\Program Files (x86)\Schneider Electric
EcoStruxure\Building Operation WebReports\Database Files Files.
3. Open SQL Server Management Studio (type SQL in the Start menu Search
box).
4. Right-click the Databases folder and then click Attach
Attach.
5. In the Attach Databases dialog box, click Add and then select the
detached database.
You should now install the next version of WebReports on the computer where
you attached the WebReports database. For more information, see section 9.11
“Installing WebReports” on page 138.

04-30008-01-en, May 2019 IT

141
9 Reports Installation
9.14 Transferring Reports Schedules

9.14 Transferring Reports Schedules

When upgrading WebReports and transferring a WebReports database from
one computer to another (or to a different operating system), you also need to
transfer any existing reports schedules to ensure that the schedules are
available in the 64-bit computer where you want to install the next version of
WebReports. Reports schedules are not stored in the WebReports database.
For more information, see the Enterprise Server System Upgrade Workflow topic
on WebHelp.

To transfer reports schedules

1. On the computer running the current version of WebReports, open Task
Scheduler by way of the Control Panel.
2. Right-click a schedule and select Export
Export.
3. Save the schedule to a USB memory device.
4. Repeat the export sequence until all schedules are transferred to the USB
memory device.
5. Transfer the USB memory device to the computer where you want to install
the next version of WebReports.
6. In the Task Scheduler, right-click the Task Scheduler Library folder and
click Import Task
Task.
7. Select and import a schedule.
8. Repeat the import sequence until all schedules are transferred to the 64-bit
computer. You will need to enter a network password.
9. At the WebReports Schedules page, make a minor change to each
schedule (for example, the start time) to associate the schedule with the
correct user account.

IT 04-30008-01-en, May 2019

142
 9 Reports Installation
9.15 Backing Up the WebReports Database

9.15 Backing Up the WebReports Database

You back up the WebReports database as a precaution to ensure that you do
not lose data, such as during a WebReports software upgrade.
For more information, see section 9.2 “WebReports Installer and WebReports
Components” on page 113.

To back up the WebReports database

1. In Windows Server 2012, open Start screen and then click SQL Server
Management Studio
Studio.
2. In the Connect to Server page, click Connect
Connect.
3. Expand the Databases folder.
4. Right-click StruxureWareReportsDB
StruxureWareReportsDB, point to Tasks
Tasks, and then click Back
Up
Up.
5. In the Back Up Database page, under Destination
Destination, ensure that an
appropriate backup destination is selected.

NOTICE
For information on how to add, remove, and view the contents of a
backup destination, see the Microsoft SQL Server product
documentation.

6. Click OK
OK.
7. Click OK again.

04-30008-01-en, May 2019 IT

143
9 Reports Installation
9.16 Restoring the WebReports Database

9.16 Restoring the WebReports Database

You restore the WebReports database to recover reports data from backup.
For more information, see section 9.2 “WebReports Installer and WebReports
Components” on page 113.

To restore the WebReports database

1. In Windows Server 2012, open Start screen, and then click SQL Server
Management Studio
Studio.
2. Click Connect
Connect.
3. Expand the Databases folder.
4. Right-click StruxureWareReportsDB and select Tasks
Tasks, then select
Restore
Restore, then select Database.
5. In the Restore Database dialog box, select the database set(s) that you
want to restore.
6. Click OK
OK.
7. Click OK
OK.

IT 04-30008-01-en, May 2019

144
 9 Reports Installation
9.17 WebReports Uninstall

9.17 WebReports Uninstall

To uninstall WebReports, 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
Uninstalling WebReports does not remove the Reports database.

04-30008-01-en, May 2019 IT

145
9 Reports Installation
9.18 Uninstalling WebReports

9.18 Uninstalling WebReports

You uninstall WebReports to remove the WebReports application from the
Reports Server. Uninstalling WebReports does not delete the WebReports
database.

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

IT 04-30008-01-en, May 2019

146
 9 Reports Installation
9.19 Reporting Agent

9.19 Reporting Agent

The Reporting Agent is a Windows service that performs reads of historical data,
such as extended trends, events, and alarms. During the installation, the
WebReports Installer prompts you to enter the number of seconds that you want
the Reporting Agent to perform these reads. It is recommended that you accept
the default value.

9.19.1 Reporting Agent Log File

The log file for the Reporting Agent contains error, warning, debugging, and
informational messages that can be used for identifying problems with the
Reporting Agent.
During the installation, you set the size of the file and specify the number of log
files you want to keep. The default values are recommended.
For more information, see section 9.20 “Reporting Agent Log File” on page 148.

9.19.2 Reporting Agent Configuration File

The Reporting Agent configuration file contains values for the following settings:
• The Reporting Agent failure retry interval
• The Reporting Agent log file
• The Reporting Agent event record
• The Reporting Agent total historical records
For more information, see section 9.21 “Reporting Agent Configuration File” on
page 149.

04-30008-01-en, May 2019 IT

147
9 Reports Installation
9.20 Reporting Agent Log File

9.20 Reporting Agent Log File

The log file for the Reporting Agent contains error, warning, debugging, and
informational messages that can be used for identifying problems with the
Reporting Agent.
During the installation, you set the size of the file and specify the number of log
files you want to keep. The default values are recommended.
The WebReports installation places the log file in the Program Files directory,
C:\Program Files (x86)\Schneider Electric EcoStruxure\Building Operation
WebReports\StruxureWare Reporting Agent. The file name is
StruxureWareReportingAgentLog.txt.
When you want to modify the log file values, you edit the Reporting Agent
configuration file. The file name is
SE.WebReports.StruxureWareReportingAgent.exe.config. The file resides in
C:\Program Files (x86)\Schneider Electric EcoStruxure\Building Operation
WebReports\StruxureWare Reporting Agent. For more information, see section
9.21 “Reporting Agent Configuration File” on page 149.
The log file size that you set depends on how much information you plan to log in
the file. The default size is recommended. Keep in mind that the larger the file
size, the longer it takes to open the file. You can also set the number of log files
that you want to save. When the maximum number of log files has been
reached, the oldest file is deleted to create space for the new file.

Log File Levels

You can control the type and amount of information that is stored in the log file
using the information levels. By default, the log file is set to Info. You can change
the default value by editing
SE.WebReports.StruxureWareReportingAgent.exe.config.

Table: Log File Levels

Level Description

Fatal When set to Fatal, the log file records fatal

errors only. Use Fatal to capture the least
amount of information about the Reporting
Agent.

Error When set to Error, the log file records all

errors including fatal errors.

Warn When set to Warn, the log file records all

fatal errors, errors, and warnings.

Info When set to Info, the log file records all

fatal errors, errors, warnings, and
informational messages about the
Reporting Agent. Info is the default setting.

Debug When set to Debug, the log file records all

fatal errors, errors, warnings, informational
messages, and debugging information
about the Reporting Agent. Use Debug to
capture the most information about the
Reporting Agent.

IT 04-30008-01-en, May 2019

148
 9 Reports Installation
9.21 Reporting Agent Configuration File

9.21 Reporting Agent Configuration File

The Reporting Agent configuration file contains values for the following settings:
• The Reporting Agent failure retry interval
• The Reporting Agent log file
• The Reporting Agent event record
• The Reporting Agent total historical records
The WebReports installation places the configuration file in the Program Files
directory, C:\Program Files (x86)\Schneider Electric EcoStruxure\Building
Operation WebReports\StruxureWare Reporting Agent. The file name is
SE.WebReports.StruxureWareReportingAgent.exe.config. The following table
shows the Reporting Agent, number of event records and historical records to
read, and log file settings that are in the file.

Table: Reporting Agent Configuration File Settings

Settings Description

HistoricalDataReadInterval Indicates how often you want the Reporting

Agent to perform Historical Read and send
the retrieved data to the Reports Server.
The default is recommended.

ASReadInterval Indicates how often you want the Reporting

Agent to read the Automation Server. The
default is recommended.

ASReadCount Indicates the number of data points to be

read by the Reporting Agent. The default is
recommended.

FailureRetryInterval Indicates how often you want the Reporting

Agent to retry reading the Enterprise
Server following a failed attempt to read
the Enterprise server. The default is
recommended.

DefaultLogLevel Indicates the information level for the log

file. The default is Info. For more
information, see section 9.20 “Reporting
Agent Log File” on page 148.

FileSize Indicates the size of the Reporting Agent

log file that stores error and informational
messages about the Reporting Agent. For
more information, see section 9.20
“Reporting Agent Log File” on page 148.

Number of log files Indicates the number of log files you want
to keep. For more information, see section
9.20 “Reporting Agent Log File” on page
148.

numEventRecordToRead Indicates the number of event records you

want to read. The default is recommended.

04-30008-01-en, May 2019 IT

149
9 Reports Installation
9.21 Reporting Agent Configuration File

Continued
Settings Description

maxTotalRecordsHistorical Indicates the maximum number of

historical records you want to read. The
default is recommended.

During the installation, the WebReports Installer prompts you to enter a value, in
seconds, for each Reporting Agent setting. The default values are
recommended. The installation also prompts for the log file values. The default
values are also recommended.
When you want to modify the Reporting Agent values or the log file values, you
edit the Reporting Agent configuration file. You need to enter the Reporting
Agent values in milliseconds. The following table shows the default, minimum,
and maximum values that you can enter.

Table: Reporting Agent Values

Setting Default Minimum Maximum

HistoricalDataReadI 300000 (5 minutes) 300000 (5 minutes) 86400000 (1 day)

nterval
(milliseconds)

ASReadInterval 600,000 (10 300,000 (5 minutes) 86,400,000 (1 day)

(milliseconds) minutes)

ASReadCount 500 500 (recommended) 1000

numEventRecordTo 50000 50000 150000

Read (recommended)

maxTotalRecordsHi 50000 50000 250000

storical (recommended)

FailureRetryInterval 60000 (1 minute) 60000 (1 minute) 86400000 (1 day)

(milliseconds)

Log file size 10 MB 1 MB 100 MB

Log file count 10 1 100

(Number of log files
to save)

IT 04-30008-01-en, May 2019

150
 9 Reports Installation
9.22 Changing Reporting Agent Logging Information

9.22 Changing Reporting Agent Logging

Information
You change the Reporting Agent log file size and the number of log files to have
the desired log files size and the number of log files you want to keep. You also
edit the file to change the information level. Before you edit the file, review the
values that are acceptable.
For more information, see section 9.20 “Reporting Agent Log File” on page 148.

To change the Reporting Agent log file information

1. Stop the Building Operation x.y WebReports Agent service from the
Microsoft Management Console.
2. In Windows, navigate to C:\Program Files (x86)\Schneider Electric
EcoStruxure\Building Operation WebReports\StruxureWare Reporting
Agent.
3. In the Folder Options dialog box, clear Hide extensions for known file
types from the folder option for the StruxureWare Reporting Agent folder.
4. In the StruxureWare Reporting Agent directory, open
SE.WebReports.StruxureWareReportingAgent.exe.config in notepad.
5. For the maximumFileSize parameter, type the number of megabytes for
the size of the Reporting Agent log file.

6. For the maxSizeRollBackups parameter, type the number of log files you
want to keep.
7. For the level parameter, type FATAL, ERROR, WARN, INFO or DEBUG.
8. Save the file.
9. Start the Building Operation x.y WebReports Agent service.

04-30008-01-en, May 2019 IT

151
9 Reports Installation
9.23 Changing Events and Historical Records Information

9.23 Changing Events and Historical

Records Information
You change the number of event records to read and maximum total number of
historical records to collect event and historical records. You also edit the file to
change the information level. Before you edit the file, review the values that are
acceptable.
For more information, see section 9.21 “Reporting Agent Configuration File” on
page 149.

To change the events and historical records information

1. Stop the Building Operation x.y WebReports Agent service from the
Microsoft Management Console.
2. In Windows, navigate to C:\Program Files (x86)\Schneider Electric
EcoStruxure\Building Operation WebReports\StruxureWare Reporting
Agent
Agent.
3. In the Folder Options dialog box, clear Hide extensions for known files
option from the folder option for the StruxureWare Reporting Agent folder.
4. In the StruxureWare Reporting Agent directory, open
SE.WebReports.StruxureWareReportingAgent.exe.config in notepad.
5. For the numEventRecordToRead parameter, type the number of event
records that you want to read.

6. For the maxTotalRecordsHistorical parameter, type the number of

historical records that you want to read.
7. Save the file.
8. Start the Building Operation x.y WebReports Agent service.

IT 04-30008-01-en, May 2019

152
 9 Reports Installation
9.24 Starting the Reporting Agent Windows Service

9.24 Starting the Reporting Agent Windows

Service
You start the Reporting Agent Windows service to resume collecting report data.
For more information, see section 9.3 “Reports Server Configuration” on page
117.

To start the Reporting Agent Windows service

1. On the Reports Server computer, open the Service management console.
2. Right-click Building Operation x.x WebReports Agent
Agent.
3. Select Start
Start.

04-30008-01-en, May 2019 IT

153
9 Reports Installation
9.25 Stopping the Reporting Agent Windows Service

9.25 Stopping the Reporting Agent Windows

Service
You stop the Reporting Agent Windows service to stop collecting report data.
For more information, see section 9.3 “Reports Server Configuration” on page
117.

To stop the Reporting Agent Windows service

1. On the Reports Server computer, open the Service management console.
2. Right-click Building Operation x.x WebReports Agent
Agent.
3. Select Stop
Stop.

IT 04-30008-01-en, May 2019

154
10 Reports Installation User
Interface

Topics
Server Roles Dialog Box for Windows Server 2008
Features Dialog Box for Windows Server 2008
Server Roles Dialog Box for Windows Server 2012
Features Dialog Box for Windows Server 2012
WebReports Installer – End User License Agreement Page
WebReports Installer – Installation Type Page
WebReports Installer – Installation Type: Installation Path
Page
WebReports Installer – System Check Page
WebReports Installer - Enterprise Server Page
WebReports Installer – SQL Server Page
WebReports Installer - SQL Server: Details Page
WebReports Installer - SQL Configuration Page
WebReports Installer - Installation Page
WebReports Installer - Finish Page
WebReports Installer – Installation Type: Upgrade Page
WebReports Administrator - Enterprise Server Configuration
Dialog Box
 10 Reports Installation User Interface
10.1 Server Roles Dialog Box for Windows Server 2008

10.1 Server Roles Dialog Box for Windows

Server 2008
Use the Server Roles dialog box to select the Web Server (IIS) role services.
The services are required for the WebReports installation, and it is
recommended that you install the services before you install SQL Server.

Figure: Server Roles dialog box

Table: Server Roles Dialog Box

Component Description

Web Server (IIS) Select to enable the IIS role services that
manage the WebReports Web site running
on a local or remote IIS 7.0 server.

04-30008-01-en, May 2019 IT

157
10 Reports Installation User Interface
10.2 Features Dialog Box for Windows Server 2008

10.2 Features Dialog Box for Windows Server

2008
Use the Features dialog box to select the .NET Framework 3.5.1 features for
installation. The features are required for the WebReports installation, and it is
recommended that you install the services before you install SQL Server.

Figure: Features dialog box

Table: Features Dialog Box

Component Description

.NET Framework 3.5.1 Features Select to install all .NET Framework 3.5.1.
Features.

.NET Framework 3.5.1 Select to install .NET Framework 3.5.1.

WCF Activation Select to install Windows Communication

Foundation (WCF) Activation components.

HTTP Activation Select to install HTTP Activation

(applications that use HTTP Activation can
start and stop dynamically in response to
work items transmitted over the network
using HTTP).

Non-HTTP Activation Select to install Non-HTTP Activation

(applications that use Non-HTTP Activation
can start and stop dynamically in response
to work items transmitted over the network
using either Message Queuing, TCP, or
named pipes).

IT 04-30008-01-en, May 2019

158
 10 Reports Installation User Interface
10.3 Server Roles Dialog Box for Windows Server 2012

10.3 Server Roles Dialog Box for Windows

Server 2012
Use the Server Roles dialog box to select the Web Server (IIS) role services.
The services are required for the WebReports installation, and it is
recommended that you install the services before you install SQL Server.

Figure: Server Roles dialog box

Table: Server Roles Dialog Box

Component Description

Web Server (IIS) Select to enable the IIS role services that
manage the WebReports Web site running
on a local or remote IIS 8.0 server.

04-30008-01-en, May 2019 IT

159
10 Reports Installation User Interface
10.4 Features Dialog Box for Windows Server 2012

10.4 Features Dialog Box for Windows Server

2012
Use the Features dialog box to select the .NET Framework 3.5 and .NET
Framework 4.x features for installation. The features are required for the
WebReports installation, and it is recommended that you install the services
before you install SQL Server.

Table: Features Dialog Box

Component Description

.NET Framework 3.5 Features Select to install all .NET Framework 3.5
Features.

.NET Framework 3.5 Select to install .NET Framework 3.5.

.NET Framework 4.x Features Select to install all .NET Framework 4.x
Features.

.NET Framework 4.x Select to install .NET Framework 4.x.

IT 04-30008-01-en, May 2019

160
 10 Reports Installation User Interface
10.5 WebReports Installer – End User License Agreement Page

10.5 WebReports Installer – End User

License Agreement Page
Use the End User License Agreement page to accept the licensing provisions
and to proceed with the WebReports installation.

Figure: End user license agreement page

Table: End User License Agreement Page

Component Description

Accept Click to accept the End User License

Agreement and to proceed with the
WebReports installation.

Quit Click to quit the WebReports installation.

04-30008-01-en, May 2019 IT

161
10 Reports Installation User Interface
10.6 WebReports Installer – Installation Type Page

10.6 WebReports Installer – Installation Type

Page
Use the Installation Type page to install WebReports.

Figure: Installation type dialog box

Table: Installation Type Dialog Box

Component Description

Install Click to install WebReports.

IT 04-30008-01-en, May 2019

162
 10 Reports Installation User Interface
10.7 WebReports Installer – Installation Type: Installation Path Page

10.7 WebReports Installer – Installation Type:

Installation Path Page
Use the Installation Type: Installation Path page to select the location where
you want to install WebReports.

Figure: Installation path page

Table: Installation Path page

Component Description

Installation path Select the path where you want to install

WebReports.

Virtual root Type the name for the virtual directory

path.

04-30008-01-en, May 2019 IT

163
10 Reports Installation User Interface
10.8 WebReports Installer – System Check Page

10.8 WebReports Installer – System Check

Page
Use the System Check page to determine if the recommended Operating
System, Internet Information Services, and required disk space are available.

Figure: System check page

Table: System Check page

Component Description

Operating system Displays whether WebReports supports

the installed operating system.

Disk space Displays whether the required space for

installing WebReport is available or not.

IIS Displays whether IIS is configured

correctly. For more information, see
section 9.5 “Windows Roles and Features”
on page 120.

IT 04-30008-01-en, May 2019

164
 10 Reports Installation User Interface
10.9 WebReports Installer - Enterprise Server Page

10.9 WebReports Installer - Enterprise Server

Page
Use the Enterprise Server page to connect to the Enterprise Server through
your computer.

Figure: Enterprise Server page

Table: Enterprise Server page

Component Description

Path Enter the path where Enterprise Server is

installed. The URL should be
https://<Enterprise Server IP
address:HTTPS Port>

User Name Enter the user name that is used to access

the Enterprise Server. The user name is
your user account in WorkStation. The user
account must belong to the Reports
Administrators user group. For more
information, see section 24.21 “User
Account – Group Membership Tab” on
page 458.

Password Enter the password that is used to access

the Enterprise Server.

Domain Displays the domain of the Enterprise

Server.

04-30008-01-en, May 2019 IT

165
10 Reports Installation User Interface
10.10 WebReports Installer – SQL Server Page

10.10 WebReports Installer – SQL Server

Page
Use the SQL Server page to select the existing instance of SQL to create
Reports database. WebReports Installer will detect all the existing instances of
SQL installed in the local machine.

Figure: SQL server page

Table: SQL Server page

Component Description

SQL Instance Select the SQL instance where you want to

create WebReports database.

Refresh Click to refresh the SQL instance list.

Authentication type Displays the authentication type used to

access SQL instance.

IT 04-30008-01-en, May 2019

166
 10 Reports Installation User Interface
10.11 WebReports Installer - SQL Server: Details Page

10.11 WebReports Installer - SQL Server:

Details Page
Use the SQL Server: Details dialog box to configure SQL Server.

Figure: SQL server: Details page

Table: SQL Server: Details page

Component Description

Database type Select New database if there is no existing

database. Select Upgrade existing
database if the database already exists.

Database name Displays the WebReports database name.

Database path Select the path where the WebReports

database files is to be created.

SSRS URL Keep the default SSRS URL to access the

Report Server Web service and Report
Manager. Change only the port number
that is used to access web service.

04-30008-01-en, May 2019 IT

167
10 Reports Installation User Interface
10.12 WebReports Installer - SQL Configuration Page

10.12 WebReports Installer - SQL

Configuration Page
Use the SQL Configuration page to check that the components are configured
correctly.

Figure: SQL configuration page

Table: SQL Configuration Page

Component Description

Configure Click to start the configuration again.

Configure button is enabled only when an
error occurs during configuration of
components. You can correct the error and
start the configuration again. For more
information, see the SQL Configuration
Failed topic on WebHelp.

IT 04-30008-01-en, May 2019

168
 10 Reports Installation User Interface
10.13 WebReports Installer - Installation Page

10.13 WebReports Installer - Installation Page

Use the Installation page to view the status of WebReports installation.

Figure: Installation dialog box

Table: Installation Dialog Box

Component Description

Next Click after successful installation of

WebReports.

04-30008-01-en, May 2019 IT

169
10 Reports Installation User Interface
10.14 WebReports Installer - Finish Page

10.14 WebReports Installer - Finish Page

Use the Finish page to view that WebReports is installed successfully and to
launch the WebReports.

Figure: Finish page

Table: Finish page

Component Description

Launch WebReports Select to launch WebReports after

installation is completed.

Finish Click to close the WebReports installer.

IT 04-30008-01-en, May 2019

170
 10 Reports Installation User Interface
10.15 WebReports Installer – Installation Type: Upgrade Page

10.15 WebReports Installer – Installation Type:

Upgrade Page
Use the Installation Type: Upgrade page to upgrade the WebReports installed
on your computer or server to the newer version.

Figure: Installation type: Upgrade page

Table: Installation Type: Upgrade Page

Component Description

Upgrade Click to upgrade your current installation to

a newer version.

04-30008-01-en, May 2019 IT

171
10 Reports Installation User Interface
10.16 WebReports Administrator - Enterprise Server Configuration Dialog Box

10.16 WebReports Administrator - Enterprise

Server Configuration Dialog Box
Use the Enterprise Server Configuration dialog box to configure the user name
and password for WebReports user account in the Reports Server.

Figure: WebReports Administrator - Enterprise Server configuration dialog box

Table: WebReports Administrator - Enterprise Server Configuration Dialog Box

Component Description

Enterprise Server path Displays the path where Enterprise Server

is installed.

User name Type the user name of the WebReports

user account. The user account should be
the member of Reports Administrators
group.

Password Type the password of the WebReports

user account.

IT 04-30008-01-en, May 2019

172
11 Licensing Introduction

Topics
Licensing Overview
Licensing Model
Field Bus Device Licenses
Licensing Enforcement
License Information
License System
License Management
Service and Maintenance
License Maintenance
Licenses
Viewing Activated Licenses
Editing Registration Details
License Selection Process
Order Information Request
Lost License
License Repair
License Backup
Backing Up Licenses
Restoring Licenses
 11 Licensing Introduction
11.1 Licensing Overview

11.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.

11.1.1 Licensing Model

EcoStruxure BMS uses a license model that allows scalable pricing. An
EcoStruxure BMS can be tailored with the features and size that is required by
that solution. When setting up a new EcoStruxure BMS, consider the size, the
extra features required, and the number of licenses to accommodate the size
and features. The license policy lets you make an initial investment that
corresponds to the required capacity and functionality at the beginning of the
project and then allows for further investment in the future to expand the
capacity or functionality.
For more information, see section 11.2 “Licensing Model” on page 177.

11.1.2 License System

When setting up a new EcoStruxure BMS, you need to consider the size of the
system, its structure, and the number of licenses to order and distribute.
For more information, see section 11.6 “License System” on page 183.

11.1.3 License Management

The EcoStruxure Building Operation license system consists of, for example, a
License Server, WorkStation with client tools, and the Enterprise Server. The
number of each component varies depending on the system size and
architecture.
For more information, see section 11.7 “License Management” on page 185.

11.1.4 Service and Maintenance

The EcoStruxure Building Operation license policy is strictly controlled and is
sensitive to any changes on the License Server, both hardware and software.
For more information, see section 11.8 “Service and Maintenance ” on page
187.

11.1.5 License Information

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

04-30008-01-en, May 2019 IT

175
11 Licensing Introduction
11.1 Licensing Overview

For more information, see section 11.5 “License Information” on page 181.

IT 04-30008-01-en, May 2019

176
 11 Licensing Introduction
11.2 Licensing Model

11.2 Licensing Model

EcoStruxure BMS uses a license model that allows scalable pricing. An
EcoStruxure BMS can be tailored with the features and size that is required by
that solution. When setting up a new EcoStruxure BMS, consider the size, the
extra features required, and the number of licenses to accommodate the size
and features. The license policy lets you make an initial investment that
corresponds to the required capacity and functionality at the beginning of the
project and then allows for further investment in the future to expand the
capacity or functionality.
The number of clients and engineering tools used in the system are licensed
individually.
Regardless of protocol, any field bus device that is hosted by an EcoStruxure
Building Operation Enterprise Server and that can be configured without the use
of some legacy tool requires a license to be available.
Licenses are required for the following operations:
• when starting, and running an Enterprise Central
• when starting, and running an Enterprise Server or when adding an
Enterprise Server under an Enterprise Central
• when adding, and running field bus devices under an Enterprise Server
• when sending SNMP notification from an Enterprise Central, an Enterprise
Server or a SmartX server
• when connecting to an Enterprise Central, an Enterprise Server or a SmartX
server using WorkStation or WebStation

11.2.1 Client and Engineering Tool Licenses

Client and engineering tool licenses are available for WorkStation, WorkStation
Pro, WebStation, and all EcoStruxure Building Operation Editors. WorkStation,
WorkStation Pro, WebStation, and all EcoStruxure Building Operation Editors are
licensed individually.

11.2.2 Field Bus Device Licenses

All field bus devices hosted by an EcoStruxure Building Operation Enterprise
Server need licenses.
For more information, see section 11.3 “Field Bus Device Licenses” on page
179.

11.2.3 SNMP Licenses

In order to use SNMP notifications on an EcoStruxure BMS server, the system
requires a SNMP license for each server. SNMP licenses are also available from
the system license pool. The licensing system compares the amount of
EcoStruxure BMS servers using SNMP with the available SNMP licenses and
determines if there is a license violation..

04-30008-01-en, May 2019 IT

177
11 Licensing Introduction
11.2 Licensing Model

For more information, see the SmartX Servers topic on WebHelp.

11.2.4 Web Services Licenses

Web Services is a way to translate information in XML format so that it can be
understood by EcoStruxure BMS servers and displayed in WorkStation. When
you create a Web Service interface, you can add XML elements from the server
providing the Web Service. The XML elements are then translated into values in
an EcoStruxure BMS server.
In order to use Web Services on an EcoStruxure BMS server, the system
requires a Web Services license for each server. Web Services licenses are also
available from the system license pool. The licensing system compares the
amount of EcoStruxure BMS servers using Web Services with the available Web
Services licenses and determines if there is a license violation..
For more information, see the Web Services topic on WebHelp.

11.2.5 Licensing Enforcement

License enforcement is the process of checking whether a software application
has a valid license available to it at runtime. In the EcoStruxure BMS, this is
accomplished by a license violation bar in WorkStation and WebStation if you do
not have enough licenses.
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 11.4 “Licensing Enforcement” on page 180.

11.2.6 License Lifetime

A license that is dedicated to a specific operation is permanent. This include
Enterprise Server licenses and all client licenses.

IT 04-30008-01-en, May 2019

178
 11 Licensing Introduction
11.3 Field Bus Device Licenses

11.3 Field Bus Device Licenses

All field bus devices hosted by an EcoStruxure Building Operation Enterprise
Server need licenses.
The hosting allocation is performed on a per site basis, and all licenses are
controlled by the Enterprise Server.
Any field bus device that is hosted by an EcoStruxure Building Operation
Enterprise Server and can be configured without the use of some legacy tool
requires a license to be available. The following field bus devices require a
license:
• BACnet IP devices
• MNB 1000 devices
• LonWorks devices
• Modbus TCP devices

04-30008-01-en, May 2019 IT

179
11 Licensing Introduction
11.4 Licensing Enforcement

11.4 Licensing Enforcement

License enforcement is the process of checking whether a software application
has a valid license available to it at runtime. In the EcoStruxure BMS, this is
accomplished by a license violation bar in WorkStation and WebStation if you do
not have enough licenses.
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.

11.4.1 License Violation

The first time you add an additional device to the Enterprise Server, other than a
SmartX server, in excess of the amount of licenses purchased, a license
violation bar is displayed. The license violation bar states the you have
exceeded the amount of licenses available, and urges you to purchase the
additional licenses required. The license violation bar appears every time you
log on to the system, and it 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 15.12 “License
Information Enterprise Server and SmartX Server” on page 266.

Figure: License violation bar in WorkStation

For more information, see section 15.11 “License Violation Bar” on page 265.

IT 04-30008-01-en, May 2019

180
 11 Licensing Introduction
11.5 License Information

11.5 License Information

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

11.5.1 Recommended Setup

It is recommended that you use one separate License server for every
Enterprise Central and Enterprise Server. It is easier to get an overview of your
licenses if you use a dedicated server for every Enterprise Central and
Enterprise Server.
If two or more Enterprise Servers gets their licenses from the same license
server, you cannot identify which Enterprise Server got the license.
Using a License Administrator on the same computer as the Enterprise Server or
Enterprise Central makes your system less vulnerable to network failure.
If you do not use the recommended setup you get the system alarm "Invalid
license server configuration".

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

Enterprise Central
The Enterprise Central displays all licenses for the Enterprise Central. The
License Information in Enterprise Central also displays information regarding all
Enterprise Servers attached to the Enterprise Server and for all SmartX 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.

Enterprise Server
Enterprise server displays all licenses for the Enterprise Server and the attached
SmartX servers.

SmartX server
SmartX server displays all licenses for the SmartX server.

11.5.3 License Status

Servers and devices
You can use License information to check the license status for:
• Enterprise Servers
• SmartX servers
• Fieldbus devices

04-30008-01-en, May 2019 IT

181
11 Licensing Introduction
11.5 License Information

• Smart Drivers
• SNMP Notifications

Status
The information displays the status of the licenses on the License Server that is
used by the Enterprise Central or the selected Enterprise Server. Licenses can
have the following status:
• Required
Required: Displays the number of licenses that are required for your
EcoStruxure BMS.
• Used
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. You also get a
license violation bar in WorkStation. For more information, see section 15.11
“License Violation Bar” on page 265.
• Available
Available: Displays the number of available licenses that are activated on
the License Server but not in use in your EcoStruxure BMS.
• Activated
Activated: Displays the total number of licenses that are activated on the
License server, used and unused.

IT 04-30008-01-en, May 2019

182
 11 Licensing Introduction
11.6 License System

11.6 License System

When setting up a new EcoStruxure BMS, you need to consider the size of the
system, its structure, and the number of licenses to order and distribute.
Place the License Server on a computer owned by the customer. When you
need to repair or move a network license, the request must come from the
License Server that was used to activate the license.
Locate the License Server and the Enterprise Server on the same computer to
avoid unexpected license problems caused by network problems. Use the
address @localhost so the Enterprise Server cannot connect to the License
server through the network.
Ensure that the License Server has access to the Internet and to the local area
network. The Internet access is only necessary when performing tasks that
require communication with the License Activation Server, hosted by Schneider
Electric, such as activating or returning licenses on your License Server. Instant
access to the local area network ensures that licensed WorkStations, client tools,
and Enterprise Servers can smoothly check out and check in licenses.

NOTICE
For security reasons, the Internet access can be disconnected when
communication with the License Activation Server is not needed.

11.6.1 License Activation Server

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

11.6.2 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 14.1 “License Server” on page 231.

11.6.3 License Administrator

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

04-30008-01-en, May 2019 IT

183
11 Licensing Introduction
11.6 License System

11.6.4 Licenses
EcoStruxure BMS uses two types of licenses: the network license and the local
license. Network licenses are the most common type of license in an
EcoStruxure BMS. With network licenses, only the number of licenses that are
used at the same time are required. The local license is often time limited and
used to test and run a system that is under construction.
For more information, see section 11.10 “Licenses” on page 190.

IT 04-30008-01-en, May 2019

184
 11 Licensing Introduction
11.7 License Management

11.7 License Management

The EcoStruxure Building Operation license system consists of, for example, a
License Server, WorkStation with client tools, and the Enterprise Server. The
number of each component varies depending on the system size and
architecture.
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. 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.

11.7.1 License System Installation and

Configuration
Schneider Electric recommends that you install the license server framework
before installing other EcoStruxure Building Operation software applications and
SmartX 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.

04-30008-01-en, May 2019 IT

185
11 Licensing Introduction
11.7 License Management

For more information, see section 3.3 “Installation Example” on page 45.

11.7.2 Network License Management

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.
For more information, see section 12.2 “Network License Management” on page
209.

11.7.3 Local License Management

A local license is activated from a license file with the extension .asr. Local
licenses must be activated to a dedicated WorkStation or Enterprise Server
computer. The local license cannot be distributed and shared between different
computers as the network license can.
For more information, see section 12.9 “Local License Management” on page
219.

IT 04-30008-01-en, May 2019

186
 11 Licensing Introduction
11.8 Service and Maintenance

11.8 Service and Maintenance

The EcoStruxure Building Operation license policy is strictly controlled and is
sensitive to any changes on the License Server, both hardware and software.

11.8.1 License Service Maintenance

The EcoStruxure Building Operation licenses are controlled by license policies
regarding the transaction of licenses. Therefore, it is important that a
replacement or reinstallation of the license server is carefully planned.
For more information, see section 14.15 “License Server Maintenance” on page
248.

11.8.2 License Maintenance

Before you move a network license, you have to return the license to the License
Activation Server. If the license is not correctly returned before changes are
made on the License Server, the license can become broken or lost.
For more information, see section 11.9 “License Maintenance” on page 189.

11.8.3 Diagnostics
In License Administrator, Diagnostics view, you can view information about all
local licenses and network licenses located on the License Server. This
information is essential for the product support service or when troubleshooting.
To forward the information to a troubleshooter who does not have access to your
system, paste the information in an e-mail message.

04-30008-01-en, May 2019 IT

187
11 Licensing Introduction
11.8 Service and Maintenance

Figure: Diagnostic list with information about all licenses located on the License server,
WorkStation or Enterprise Server.

11.8.4 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 13.5 “Showing the Licenses Log File ” on page
228.

IT 04-30008-01-en, May 2019

188
 11 Licensing Introduction
11.9 License Maintenance

11.9 License Maintenance

Before you move a network license, you have to return the license to the License
Activation Server. If the license is not correctly returned before changes are
made on the License Server, the license can become broken or lost.

11.9.1 Local License Removal

Local licenses, activated from license files cannot be returned or reused.
You cannot reactivate a removed local license.
To remove a local license, you use the License Administrator on the WorkStation
or Enterprise Server where the local license is activated.

11.9.2 Network License Return

To return a network license means that a license is transferred from the License
Server back to the License Activation Server. A returned network license,
located on the License Activation Server, is not available for the WorkStation or
Enterprise Server to check out.
For more information, see section 12.4 “Network License Return” on page 213.

11.9.3 Lost License

If the License Server, WorkStation, or Enterprise Server physically crash and you
cannot retain activated licenses, the licenses are lost. Activated licenses cannot
be reactivated by the License Activation Server.
For more information, see section 11.15 “Lost License” on page 198.

11.9.4 License Repair

A license can in several ways become damaged. Use the License Administrator
to repair a damaged network license on the License Server where the damaged
license is located. Local licenses cannot be repaired. Instead you have to
remove the damaged local licenses and reactivate the licenses from new
license files.
For more information, see section 11.16 “License Repair” on page 199.

11.9.5 License Backup

Schneider Electric recommends backing up the License Server files on a regular
basis. To back up the license files, copy all files in the folder to an external
resource. This backup is primarily intended for cases when hardware or the
operating system malfunctions.
For more information, see section 11.17 “License Backup” on page 200.

04-30008-01-en, May 2019 IT

189
11 Licensing Introduction
11.10 Licenses

11.10 Licenses
EcoStruxure BMS uses two types of licenses: the network license and the local
license. Network licenses are the most common type of license in an
EcoStruxure BMS. With network licenses, only the number of licenses that are
used at the same time are required. The local license is often time limited and
used to test and run a system that is under construction.
The EcoStruxure Building Operation license policy consists of the following
licenses:

Table: EcoStruxure Building Operation Licenses

License File Name Description

Client Station client.station Use this license to start and

run WorkStation and
WebStation.

Client tool licenses client.graphiceditor This license product group

consists of several
client.script products, each required to
client.functionblock.view run the 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 start and

Enterprise Central run an Enterprise Server
under an Enterprise Central.
Without valid license, you
cannot add an Enterprise
Server under an Enterprise
Central.

Field bus devices under server.device.es Use this license to start and
Enterprise Server run Field bus devices under
an Enterprise Server.

Field bus devices under server.device.as Use this license to start and
SmartX server run Field bus devices under
a SmartX server.

SmartDriver smartdriver.license Use this license to allow

SmartDrivers.

SmartX server under server.es.as Use this license to start and

Enterprise Server run a SmartX server under
an Enterprise Server.
Without valid license, you
cannot add an SmartX
server under an Enterprise
Server.

IT 04-30008-01-en, May 2019

190
 11 Licensing Introduction
11.10 Licenses

Continued
License File Name Description

SNMP server.alarms.snmp Use this license to allow

SNMP notifications.

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 server.ws.generic.consume Use this license to start and

Cons run Web Services.

Cloud Connectivity server.cloud.demo Use this license to start and

run a demo version of Cloud
Connectivity.

Cloud Connectivity server.cloud.customer Use this license to start and

run Cloud Connectivity.

License files used to activate time-limited local licenses can be distributed

under certain circumstances.
For more information, see section 12.8 “Local Licenses” on page 218.
For more information on how to order licenses, please contact your EcoStruxure
BMS vendor.

11.10.1 End User License Agreement

When installing the EcoStruxure Building Operation software, make sure that you
agree with the Schneider Electric terms and conditions. For operators or other
positions that do not install the software, please refer to the “End User License
Agreement (EULA)” document distributed by Schneider Electric.

11.10.2 Local Licenses

A local license installs on the client or License Server from a license file with the
extension .asr. The local license is bound to the computer and cannot be
shared. The license file used to activate local licenses can only be used once
per computer and is typically time-limited.
For more information, see section 12.8 “Local Licenses” on page 218.

04-30008-01-en, May 2019 IT

191
11 Licensing Introduction
11.10 Licenses

11.10.3 Network Licenses

Network licenses are distributed from the License Server. The License Server
shares a predetermined number of simultaneous instances that are available
network-wide. To start licensed clients and EcoStruxure BMS servers using
network licenses, the required number of licenses have to be available on the
License Server.
For more information, see section 12.1 “Network Licenses ” on page 205.

11.10.4 Time-Limited Licenses

A time-limited license is a license that gives license rights for a predetermined
period of time, usually 30 days. When the time period is over, the license
expires. These licenses are distributed as local licenses.

NOTICE
To avoid critical stops, purchase permanent licenses before the time limited-
licenses expire.

11.10.5 Permanent License

A permanent license does not expire.

NOTICE
To avoid critical stops, purchase permanent licenses before the time limited-
licenses expire.

11.10.6 License Selection Process

When a licensed WorkStation, WebStation, client tool, Enterprise Server or
Enterprise Central starts, it first checks if a local license is available. If a local
license is not available or has expired, the WorkStation, Enterprise Server, or
Enterprise Central checks out a network license from a License Server. If no
license is available, the WorkStation, client tool, Enterprise Server, or Enterprise
Central does not start.
For more information, see section 11.13 “License Selection Process” on page
195.

IT 04-30008-01-en, May 2019

192
 11 Licensing Introduction
11.11 Viewing Activated Licenses

11.11 Viewing Activated Licenses

You view all the activated licenses on the License Server on the same computer
as the License Administrator.
For more information, see section 11.10 “Licenses” on page 190.

To view activated licenses

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

04-30008-01-en, May 2019 IT

193
11 Licensing Introduction
11.12 Editing Registration Details

11.12 Editing Registration Details

You must add your registration details before licenses can be activated. The
registration details are written to the license details when a license is activated.

NOTICE
• You need to enter the customer details before a licenses is activated.
• Only English letters are allowed in the license details.

For more information, see section 14.8 “License Administrator” on page 240.

To edit registration details

1. In License Administrator, click the Registration Details view.
2. In the License owner box, type the name of the organization that owns the
license.
3. In the Industry box, select the license owner’s field of business.
4. In the Type of project boxes, select the proposed field of application for the
license.
5. In the Name box, type the name of the account manager that supplied the
license.
6. In the E-mail box, type the e-mail address to the account manager that
supplied the license.
7. In the Telephone number box, type the telephone number to the account
manager that supplied the license.
8. Click OK
OK.
9. Click Yes
Yes.
Any changes in the registration details updates all activated licenses on the
License Server.

NOTICE
• The customer details must be edited or updated individually on all License
Servers.

IT 04-30008-01-en, May 2019

194
 11 Licensing Introduction
11.13 License Selection Process

11.13 License Selection Process

When a licensed WorkStation, WebStation, client tool, Enterprise Server or
Enterprise Central starts, it first checks if a local license is available. If a local
license is not available or has expired, the WorkStation, Enterprise Server, or
Enterprise Central checks out a network license from a License Server. If no
license is available, the WorkStation, client tool, Enterprise Server, or Enterprise
Central does not start.

Figure: The selection process flow for which license to use, local or network license.

04-30008-01-en, May 2019 IT

195
11 Licensing Introduction
11.14 Order Information Request

11.14 Order Information Request

To receive order information from the License Activation Server, you need the
Entitlement ID of the order. The entitlement ID is the designation that represents
the license purchased by the customer. This ID is included in the Entitlement
Certificate that is sent by e-mail when an order is approved.
For more information on how to order a license, contact your local EcoStruxure
BMS vendor.

Figure: Entitle Certificate with entitlement ID

Figure: Work flow when requesting order information

IT 04-30008-01-en, May 2019

196
 11 Licensing Introduction
11.14 Order Information Request

Table: Request Order Information

Number Description

1 The Entitlement ID
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.

The order information contains information about all licenses included in the
Entitlement Certificate.

04-30008-01-en, May 2019 IT

197
11 Licensing Introduction
11.15 Lost License

11.15 Lost License

If the License Server, WorkStation, or Enterprise Server physically crash and you
cannot retain activated licenses, the licenses are lost. Activated licenses cannot
be reactivated by the License Activation Server.
To regain lost licenses when no backup exits, contact the product support.
Product support performs a manual return of the lost licenses on the License
Activation Server. Once the licenses are manually returned, you can reactivate
them on a new License Server by using the original entitlement ID of the
licenses.

IT 04-30008-01-en, May 2019

198
 11 Licensing Introduction
11.16 License Repair

11.16 License Repair

A license can in several ways become damaged. Use the License Administrator
to repair a damaged network license on the License Server where the damaged
license is located. Local licenses cannot be repaired. Instead you have to
remove the damaged local licenses and reactivate the licenses from new
license files.
Licenses can be damaged by the following actions:
• Copying licenses from one system to another. This is an illegal action.
• Restoring a License Server backup.
• Adjusting the system clock to an earlier time.
• Restoring the system to correct system problems or roll back changes.
• Changing the Enterprise Server, License Server or WorkStation hardware
component.

NOTICE
• Repairing a network license requires access to the Internet.
• You are only allowed to repair a license four times a year.
• All repair actions are registered by the Activation Server and are traceable.

04-30008-01-en, May 2019 IT

199
11 Licensing Introduction
11.17 License Backup

11.17 License Backup

Schneider Electric recommends backing up the License Server files on a regular
basis. To back up the license files, copy all files in the folder to an external
resource. This backup is primarily intended for cases when 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
Servers, you first have to return the licenses to the License Activtation Server
and then activate them on the new License Server.
The License Server files are located in: \ProgramData\FLEXnet in Windows.
Licenses restored from a backup can be considered damaged by the License
Server. For more information, see section 11.16 “License Repair” on page 199.

IT 04-30008-01-en, May 2019

200
 11 Licensing Introduction
11.18 Backing Up Licenses

11.18 Backing Up Licenses

You back up licenses to easily restore them if something unexpected happens.
For more information, see section 11.17 “License Backup” on page 200.

To back up licenses
1. Close all EcoStruxure Building Operation applications, such as License
Administrator, WorkStation, and Enterprise Server.
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.

04-30008-01-en, May 2019 IT

201
11 Licensing Introduction
11.19 Restoring Licenses

11.19 Restoring Licenses

You restore the license data from a backup to restore a corrupt or non-
functioning License Server.
For more information, see section 11.17 “License Backup” on page 200.

To restore licenses
1. Close all EcoStruxure Building Operation applications, such as License
Administrator, WorkStation, and Enterprise Server.
2. On the License Server, browse to the the folder \ProgramData\FLEXnet\
3. Paste all your backed up files to the FLEX-net folder.

NOTICE
• You may need to repair restored licenses before you check out the
restored licenses. For more information, see section 12.7 “Repairing a
Network License ” on page 217.

You now restart the License Server so you can check out the restored licenses.
For more information, see section 14.4 “Restarting the License Server” on page
234.

IT 04-30008-01-en, May 2019

202
12 Type of Licenses

Topics
Network Licenses
Network License Management
Network Licenses Activation
Network License Return
Activating Network Licenses
Removing a Local License or Returning a Network License
Repairing a Network License
Local Licenses
Local License Management
Activating a Local License
 12 Type of Licenses
12.1 Network Licenses

12.1 Network Licenses

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

04-30008-01-en, May 2019 IT

205
12 Type of Licenses
12.1 Network Licenses

Figure: A network license is activated on a License Server and can be checked out by any
computer in the network.

IT 04-30008-01-en, May 2019

206
 12 Type of Licenses
12.1 Network Licenses

To check out a network license from a License Server, you have to define the
License Server address where network licenses are available for checkout. You
define the address to the License Server when installing the licensed product.
You edit the License Server address either in the Windows registry or in License
Administrator, on the computer or EcoStruxure BMS server that hosts the
licensed product.
A checked out network license is not physically moved to the client or
EcoStruxure BMS server. The checked out license is allocated in the License
Server until the license is released by the client or EcoStruxure BMS server.
When a licensed WorkStation, Enterprise Server, or client tool starts and no local
licenses are activated, the WorkStation or Enterprise Server searches the
License Server for an available network license. If an available network license is
found, the licensed product checks out the license and starts. If no licenses are
available, the licensed product does not start. When the application is closed,
the license is checked in on the License Server.

Figure: The WorkStation checks out license from the License Server.

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

04-30008-01-en, May 2019 IT

207
12 Type of Licenses
12.1 Network Licenses

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

IT 04-30008-01-en, May 2019

208
 12 Type of Licenses
12.2 Network License Management

12.2 Network License Management

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.
The examples in these sections are adaptable on all systems including the ones
where License Server, WorkStation, and Enterprise Server are located on the
same computer.
The license activation procedure consists of four steps:
• Request order information
• Activate network license on License Server
• Configure Enterprise Server’s address to the License Server
• Configure WorkStation’s address to the License Server

12.2.1 Order Information Request

To receive order information from the License Activation Server, you need the
Entitlement ID of the order. The entitlement ID is the designation that represents
the license purchased by the customer. This ID is included in the Entitlement
Certificate that is sent by e-mail when an order is approved.
For more information, see section 11.14 “Order Information Request” on page
196.

12.2.2 Network Licenses Activation

To activate a network license means that a license is transferred from the
License Activation Server, hosted by Schneider Electric, to your License Server.
Once activated, the network license is available for use.
For more information, see section 12.3 “Network Licenses Activation” on page
211.

12.2.3 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 either during the installation of Enterprise Server, through License
Administrator, or Windows registry.
For more information, see section 13.1 “Enterprise Server Address
Configuration” on page 223.

04-30008-01-en, May 2019 IT

209
12 Type of Licenses
12.2 Network License Management

12.2.4 WorkStation and Client Tools Address

Configuration
After licenses are activated on the License Server you have to configure the
Workstation and its client tools connection to the License Server, where licenses
are available for check out. The address to the License Server is defined either
during the installation of WorkStation, through License Administrator, or
Windows registry.
For more information, see section 13.2 “WorkStation and Client Tools Address
Configuration” on page 225.

IT 04-30008-01-en, May 2019

210
 12 Type of Licenses
12.3 Network Licenses Activation

12.3 Network Licenses Activation

To activate a network license means that a license is transferred from the
License Activation Server, hosted by Schneider Electric, to your License Server.
Once activated, the network license is available for use.

Figure: Activation of network license on License Server by the License Activation Server

Use the License Administrator to activate a network license. When activating a

network license, the License Administrator on the receiving computer requests
and administrates the activation.

04-30008-01-en, May 2019 IT

211
12 Type of Licenses
12.3 Network Licenses Activation

Figure: Work flow when activating licenses on License Server

Table: Activation of Licenses 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 now available on the License Server. Before the
License Server can distribute the network licenses, the License Server has to be
restarted.

IT 04-30008-01-en, May 2019

212
 12 Type of Licenses
12.4 Network License Return

12.4 Network License Return

To return a network license means that a license is transferred from the License
Server back to the License Activation Server. A returned network license,
located on the License Activation Server, is not available for the WorkStation or
Enterprise Server to check out.
When returning a license, 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 once again activate the returned licenses, use the entitlement ID that
contains the returned licenses.
This workflow 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.

2 The License Administrator returns the

licenses to the License Activation Server.

04-30008-01-en, May 2019 IT

213
12 Type of Licenses
12.4 Network License Return

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

IT 04-30008-01-en, May 2019

214
 12 Type of Licenses
12.5 Activating Network Licenses

12.5 Activating Network Licenses

You activate network licenses, from the License Activation Server, to make
network licenses for WorkStations, Enterprise Servers and client tools available
networkwide.

NOTICE
• This procedure requires that an order is placed and the entitlement
certificate is received. For more information on how to place an order,
contact your EcoStruxure BMS vendor.

For more information, see section 11.10 “Licenses” on page 190.

To activate network 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.

NOTICE
• The entitlement ID is printed on the entitlement certificate.

4. Click OK
OK.
5. In the Licenses View, in the Activate column, select the number of license
to activate.
6. Click Activate
Activate.
7. Click Close
Close.
8. Click Restart now to restart the License Server and activate the network
license.
The activated licenses are now available on the License Server.

04-30008-01-en, May 2019 IT

215
12 Type of Licenses
12.6 Removing a Local License or Returning a Network License

12.6 Removing a Local License or Returning

a Network License
You remove local licenses or return network licenses to the License Activation
Server. For example, you can clean up expired licenses from the Licenses view
or move network licenses to another License Server.

NOTICE
You cannot reactivate a removed local license.
• 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 remove a local license or return a network license

1. In License Administrator, click the Licenses view.
2. Select the local license to remove or the network license to return.

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

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

IT 04-30008-01-en, May 2019

216
 12 Type of Licenses
12.7 Repairing a Network License

12.7 Repairing a Network License

You repair damaged network licenses so they become available to check out by
WorkStations, client tools, and Enterprise Servers.
For more information, see section 11.16 “License Repair” on page 199.

To repair a network license

1. In License Administrator
Administrator, click the Licenses view.
2. Select the network license that you want to repair.

3. On the Licenses toolbar, click the Repair license button .

4. In the Licenses dialog box, click Yes
Yes.
5. In License Administrator
Administrator, click Close
Close.
6. Click Restart now to restart the License Server and make the repaired
licenses available for checkout.
The license is now repaired and available to be checked out.

04-30008-01-en, May 2019 IT

217
12 Type of Licenses
12.8 Local Licenses

12.8 Local Licenses

A local license installs on the client or License Server from a license file with the
extension .asr. The local license is bound to the computer and cannot be
shared. The license file used to activate local licenses can only be used once
per computer and is typically time-limited.

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

For more information on how to order additional licenses, please contact your
Schneider Electric vendor.

NOTICE
After removing a local license, you must restart the computer or server before
a similar network license can be checked out.

IT 04-30008-01-en, May 2019

218
 12 Type of Licenses
12.9 Local License Management

12.9 Local License Management

A local license is activated from a license file with the extension .asr. Local
licenses must be activated to a dedicated WorkStation or Enterprise Server
computer. The local license cannot be distributed and shared between different
computers as the network license can.
For more information, see section 12.8 “Local Licenses” on page 218.
For more information on how to order additional license files or license files for
client tools, please contact your EcoStruxure BMS vendor.

12.9.1 Local License Activation

Use the License Administrator on the WorkStation or Enterprise Server
depending of where to activate the local license.

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

04-30008-01-en, May 2019 IT

219
12 Type of Licenses
12.10 Activating a Local License

12.10 Activating a Local License

You activate a local license on a WorkStation, client tool, or Enterprise Server
computer to have as a substitute until you have set up an EcoStruxure BMS with
available network licenses.
For more information, see section 12.8 “Local Licenses” on page 218.

NOTICE
• Plan the license management carefully and purchase licenses early to avoid
unexpected operational stops caused by 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 11.10 “Licenses” on page 190.

To activate a local 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
Open.
4. Click Close
Close.
5. Click Restart now to restart the License Server and activate the local
license.
The local license is now activated and the WorkStation, client tool, or Enterprise
Server can start.

IT 04-30008-01-en, May 2019

220
13 Licensing Configuration and
Diagnostics

Topics
Enterprise Server Address Configuration
WorkStation and Client Tools Address Configuration
Viewing Diagnostic Information
Copying Diagnostics to the Clipboard
Showing the Licenses Log File
 13 Licensing Configuration and Diagnostics
13.1 Enterprise Server Address Configuration

13.1 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 either during the installation of Enterprise Server, through License
Administrator, or Windows registry.

Figure: Enterprise Server configuration and check out/in of Enterprise Server network
license

Table: Enterprise Server Configuration

Number Description

1 Configure the Enterprise Server address to

the License Server.

2 Remove any activated local licenses.

3 When the Enterprise Server starts, it

automatically checks out an Enterprise
Server network license from the License
Server.

When the Enterprise Server starts, it automatically checks out an available

network license from a License Server. A checked out network license is not
physically moved to or activated on 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 server to check out.

04-30008-01-en, May 2019 IT

223
13 Licensing Configuration and Diagnostics
13.1 Enterprise Server Address Configuration

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

IT 04-30008-01-en, May 2019

224
 13 Licensing Configuration and Diagnostics
13.2 WorkStation and Client Tools Address Configuration

13.2 WorkStation and Client Tools Address

Configuration
After licenses are activated on the License Server you have to configure the
Workstation and its client tools connection to the License Server, where licenses
are available for check out. The address to the License Server is defined either
during the installation of WorkStation, through License Administrator, or
Windows registry.

Figure: WorkStation configuration and check in/out of client station network license and
client tool network licenses

Table: WorkStation Configuration

Number Description

1 Configure the WorkStation and client tool

address to the License Server.

2 Remove any activated local licenses.

3 When you logon to WorkStation or start a

client tool, the required license is
automatically checked out from the
License Server.

A checked out network 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 check out.

04-30008-01-en, May 2019 IT

225
13 Licensing Configuration and Diagnostics
13.3 Viewing Diagnostic Information

13.3 Viewing Diagnostic Information

You view all licenses and the license details located on the License Server,
WorkStation, client tool, or Enterprise Server. This diagnostic information is
helpful when you are troubleshooting.
For more information, see section 11.8 “Service and Maintenance ” on page
187.

To view diagnostic 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, WorkStation, client tool, or Enterprise Server.

IT 04-30008-01-en, May 2019

226
 13 Licensing Configuration and Diagnostics
13.4 Copying Diagnostics to the Clipboard

13.4 Copying Diagnostics to the Clipboard

You copy the diagnostics information to your clipboard and then paste the
information into a document or E-mail message.
For more information, see section 11.8 “Service and Maintenance ” on page
187.

To copy the 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 E-mail.

04-30008-01-en, May 2019 IT

227
13 Licensing Configuration and Diagnostics
13.5 Showing the Licenses Log File

13.5 Showing the Licenses Log File

You show the licenses log file to get information regarding licenses, for example
when you are troubleshooting.
For more information, see section 11.8 “Service and Maintenance ” on page
187.

To show the licenses log file

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

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

IT 04-30008-01-en, May 2019

228
14 License Server and License
Administrator

Topics
License Server
Starting the License Server
Stopping the License Server
Restarting the License Server
Flexnet License Administrator, License Server Manager
Accessing Flexnet lmadmin
Changing the Flexnet lmadmin License Server Manager Port
Number
License Administrator
Starting License Administrator
License Server Address
Configuring the Address to the License Server
License Server Reset
Resetting the License Server
Configuring License Server Recovery Settings
License Server Maintenance
 14 License Server and License Administrator
14.1 License Server

14.1 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.
The License Server is designed to not require user intervention. The License
Server is a Microsoft Windows service named Building Operation License
Server. Because of the lack of user interface and graphical notifications that
display the status of the License Server, it is recommended that you configure
the License Server to automatically restart if it unexpectedly stops. For more
information, see section 14.14 “Configuring License Server Recovery Settings ”
on page 247.
You use the License Administrator to activate network licenses on the License
Server. The network licenses are then checked out from the License Server by
WorkStation, editors, or Enterprise Server. For more information, see section
14.8 “License Administrator” on page 240.

14.1.1 Flexnet License Manager, License Server

Manager
The License Server can be managed through a web-based administration tool
called FLEXnet License Administrator. You use the Administration part of the tool
to view system information and administer License Server user accounts, alerts,
and other configuration.
The FLEXnet License Administrator web page is hosted by the License Server.
You use a web browser to connect to the web page via HTTP or HTTPS. The
default protocol is HTTP through port 8888, that is on the License Server host
itself: http://localhost:8888. The default user name is "admin" and the default
password is "admin".
The License Server files are located in: \ProgramData\FLEXnet in Windows.
For more information, see section 14.5 “Flexnet License Administrator, License
Server Manager” on page 235.

04-30008-01-en, May 2019 IT

231
14 License Server and License Administrator
14.2 Starting the License Server

14.2 Starting the License Server

You manually start the License Server, if the service does not start automatically
with the operating system.
For more information, see section 14.1 “License Server” on page 231.

To start the License Server

1. On the License Server, open the Service management console.

NOTICE
• In Windows, open the Run dialog box and type services.msc
services.msc.

2. Right-click Building Operation License Server

Server.
3. Select Start
Start.
For more information about the Service management console, please refer to the
operating system manufacturer’s manual.

IT 04-30008-01-en, May 2019

232
 14 License Server and License Administrator
14.3 Stopping the License Server

14.3 Stopping the License Server

You manually stop the License Server, if the service is running.
For more information, see section 14.1 “License Server” on page 231.

To stop the License Server

1. On the License Server computer, open the Service management console.
2. Right-click Building Operation License Server
Server.
3. Select Stop
Stop.
For more information about the Service management console, please refer to the
operating system manufacturer’s manual.

04-30008-01-en, May 2019 IT

233
14 License Server and License Administrator
14.4 Restarting the License Server

14.4 Restarting the License Server

You manually restart the License Server, for example, if the License Server stops
to respond or licenses on the License Server have been restored.
For more information, see section 14.1 “License Server” on page 231.

To restart the License Server

1. On the License Server, open the Services management console.

NOTICE
• In Windows, open the Run dialog box and type services.msc
services.msc.

2. In the Services view, right-click EcoStruxure Building Operation License

Server and the click Restart
Restart.
For more information about the Service management console, please refer to the
operating system manufacturer’s manual.

IT 04-30008-01-en, May 2019

234
 14 License Server and License Administrator
14.5 Flexnet License Administrator, License Server Manager

14.5 Flexnet License Administrator, License

Server Manager
The License Server can be managed through a web-based administration tool
called FLEXnet License Administrator. You use the Administration part of the tool
to view system information and administer License Server user accounts, alerts,
and other configuration.
The FLEXnet License Administrator web page is hosted by the License Server.
You use a web browser to connect to the web page via HTTP or HTTPS. The
default protocol is HTTP through port 8888, that is on the License Server host
itself: http://localhost:8888. The default user name is "admin" and the default
password is "admin".
The Flexnet License Administrator has two main parts: Dashboard and
Administration. Use the Dashboard to view the status and information of the
licenses that are activated on the License Server. Alerts, such as status and
expiring licenses, are reported in the Alert pane.

Figure: FLEXnet License Administrator, Dashboard part.

Use the Administrator part to view the System information and administer Flexnet
License Administrator user accounts, alerts, License Server configuration, or
vendor daemon configuration.

04-30008-01-en, May 2019 IT

235
14 License Server and License Administrator
14.5 Flexnet License Administrator, License Server Manager

Figure: FLEXnet License Administrator, Administration part.

For more information about FLEXnet License Administrator, click the FLEXnet

License Administrator Help button .

14.5.1 License Server Port Number

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.

IT 04-30008-01-en, May 2019

236
 14 License Server and License Administrator
14.5 Flexnet License Administrator, License Server Manager

Figure: FLEXnet License Administrator, License Server Configuration

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.

For more information, click FLEXnet License Administrator Help button .

14.5.2 FLEXnet License Administrator Port Number

The port number to the FLEXnet License Administrator is configured in the file
“server.xml” located on the License Server. The path to the file is: C:\Program
Files\Schneider Electric EcoStruxure\Building Operation x.y\License
Server\conf, where x.y is the version number. The “port” attribute is found within
the “webServer” tag.

Figure: The port attribute is embedded in the “webServer” tag.

04-30008-01-en, May 2019 IT

237
14 License Server and License Administrator
14.6 Accessing Flexnet lmadmin

14.6 Accessing Flexnet lmadmin

You access Flexnet lmadmin to configure the settings of the License Server, for
example, change the port number to the License Server.
For more information, see section 14.5 “Flexnet License Administrator, License
Server Manager” on page 235.

To access Flexnet lmadmin

1. On a computer that has access to the network where 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.

NOTICE
• Flexnet lmadmin has the HTTP protocol through port 8888 set as the
default. For example: http://162.192.10.1:8888
The default user name and password is: admin
admin.

For more information, click the Flexnet lmadmin Help button .

IT 04-30008-01-en, May 2019

238
 14 License Server and License Administrator
14.7 Changing the Flexnet lmadmin License Server Manager Port Number

14.7 Changing the Flexnet lmadmin License

Server Manager Port Number
You change the port number of the Flexnet lmadmin License Server Manager if
the default port 8888 is dedicated to other application or blocked by your
firewall.
For more information, see section 14.5 “Flexnet License Administrator, License
Server Manager” on page 235.

To change the Flexnet lmadmin License Server Manager port

number
1. On the License Server, open the folder C:\ProgramData\Schneider Electric
EcoStruxure\Building Operation x.y\License Server\conf
Server\conf, where x.y is the
version number.
2. Open the file server.xml with Notepad or other text or code editor.
3. In the Port attribute within the webServer tag, type the number to an
available port.

4. Save the file and close the editor.

5. Restart the License Server.
To access the Flexnet lmadmin License Server Manager, open a web browser
and type in the address to the License Server with the new port number.

04-30008-01-en, May 2019 IT

239
14 License Server and License Administrator
14.8 License Administrator

14.8 License Administrator

The License Administrator administers the activation, return, and repair of
licenses.

14.8.1 Registration Details

Before the first network license is activated on the License Server, details about
the customer’s organization and the contact information of the account manager
must be entered. The registration details are written to the license details when a
license is activated. These registration details are automatically saved and
reused the next time a license is activated.

NOTICE
Only English letters are allowed in the license details.

If you change the registration details, the changes are applied to all licenses
located on the License Server.

NOTICE
• To ensure that all the licenses have the same information, the registration
details must be updated on all License Servers in the EcoStruxure BMS.

14.8.2 License Server Address

During the installation of License Administrator on WorkStations or Enterprise
Servers, you need to type the network address to the License Server where
network licenses are available for check out. The address to the License Server
can later be entered or edited through License Administrator or directly in the
Windows registry of the computer or Enterprise Server that hosts the licensed
product.
For more information, see section 14.10 “License Server Address” on page 242.

IT 04-30008-01-en, May 2019

240
 14 License Server and License Administrator
14.9 Starting License Administrator

14.9 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 14.8 “License Administrator” on page 240.

To start License Administrator

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

04-30008-01-en, May 2019 IT

241
14 License Server and License Administrator
14.10 License Server Address

14.10 License Server Address

During the installation of License Administrator on WorkStations or Enterprise
Servers, you need to type the network address to the License Server where
network licenses are available for check out. The address to the License Server
can later be entered or edited through License Administrator or directly in the
Windows registry of the computer or Enterprise Server that hosts the licensed
product.
In a 32-bit operating system, the License Server address is stored in the
Windows registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Schneider
Electric\StruxureWare\License Administrator\TACLIC_LICENSE_FILE. In a 64-bit
operating system, there is a separate area in the registry for all running 32-bit
programs.
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: Example 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.

IT 04-30008-01-en, May 2019

242
 14 License Server and License Administrator
14.10 License Server Address

Figure: Example of License Server addresses in License Administrator

In this example, @localhost refers to this computer, through port 19650. For
example if a License Server and an Enterprise Server are located on the same
computer, the network address of the Enterprise Server to the License Server is
recommended to be @localhost.

04-30008-01-en, May 2019 IT

243
14 License Server and License Administrator
14.11 Configuring the Address to the License Server

14.11 Configuring the Address to the License

Server
You configure the address to the License Server so the Enterprise Server,
WorkStation, or client tool knows where to find available licenses to check out.

NOTICE
• Before a WorkStation or Enterprise Server starts to check out network
licenses from a License Server, the local license in use must be removed.
For more information, see section 12.6 “Removing a Local License or
Returning a Network License” on page 216.

For more information, see section 12.2 “Network License Management” on page
209.

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.

NOTICE
• 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
Save.
Next time a WorkStation, client tool, or Enterprise Server starts, it checks out
available network licenses from a defined License Server.

NOTICE
• The License Server address is configured individually on all WorkStations
and Enterprise Servers.

IT 04-30008-01-en, May 2019

244
 14 License Server and License Administrator
14.12 License Server Reset

14.12 License Server Reset

If problems with the License Server or activated licenses occur, you may have to
reset the License Server. All details about activated licenses on the License
Server are compiled in files that start with "taclic" and have the .data extension.
The file name string after "taclic" can differ. An example of the License Server file
name is taclic_00249e00_tsf.data. The license details files are created the first
time a license is activated on the License Server. By deleting the files you reset
the License Server.
The license files are located in the following locations:
• Windows 7, Windows 8.1, and Windows 10: \ProgramData\FLEXnet
• Windows Server 2008 and Windows Server 2012: \ProgramData\FLEXnet
Before deleting the License Server files, you have to return all activated network
licenses to the License Activation Server.

NOTICE
• If you delete the License Server files, all activated network licenses are lost.

04-30008-01-en, May 2019 IT

245
14 License Server and License Administrator
14.13 Resetting the License Server

14.13 Resetting the License Server

You reset the License Server if it does not work correctly.

NOTICE
• Return all the licenses to the License Activation Server before you reset the
License Server. Resetting the License Server erases the licenses on the
License Server.

For more information, see section 14.12 “License Server Reset” on page 245.

To reset the License Server

1. In License Administrator, click the Licenses view.
2. In the Licenses view, select all the network licenses.

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

4. In the Licenses dialog box, click Yes
Yes.
5. In the License Administrator
Administrator, click Close
Close.
6. Close all EcoStruxure Building Operation programs that are running.
7. Stop the License Server.
8. In the License Server application folder, remove all .data files that start with
taclic
taclic:
• Windows 7, Windows 8.1, and Windows 10: \ProgramData\FLEXnet
• Windows Server 2008 and Windows Server 2012:
\ProgramData\FLEXnet
9. Start the License Server.
10. Reactivate the returned network licenses.
When you reactivate all returned network licenses, new License Server .data
files are created together with the activation of the first license.

NOTICE
If the licenses cannot be returned, contact your local Customer Care Center to
manually enter the license files into their server.

IT 04-30008-01-en, May 2019

246
 14 License Server and License Administrator
14.14 Configuring License Server Recovery Settings

14.14 Configuring License Server Recovery

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

To configure the license server recovery settings

1. On the license server, open the Services management console.

NOTICE
In Windows, open the Run dialog box and type services.msc
services.msc.

2. Right-click Building Operation License Server

Server.
3. Select Properties
Properties.
4. Click the Recovery tab.
5. In the First failure box, select Restart the Service
Service.
6. In the Second failure box, select Restart the Service
Service.
7. In the Subsequent failures box, select Restart the Service
Service.
8. Click OK
OK.

04-30008-01-en, May 2019 IT

247
14 License Server and License Administrator
14.15 License Server Maintenance

14.15 License Server Maintenance

The EcoStruxure Building Operation licenses are controlled by license policies
regarding the transaction of licenses. Therefore, it is important that a
replacement or reinstallation of the license server is carefully planned.

14.15.1 License Server Address Change

If the License Server is assigned a new network address, all WorkStations and
Enterprise Servers must be updated with the new address.

14.15.2 License Server Reinstallation

When reinstalling a License Server, the licenses on the License Server are not
affected. All you have to do is to uninstall the License Server and then reinstall it.
The licenses on the License Server do not have to be returned to the License
Activation Server.

14.15.3 License Server Replacement

Before replacing the License Server hardware, return the licenses to the License
Activation Server and then activate the licenses on the new License Server.
You can also use this workflow when relocating licenses to another License
Server.

IT 04-30008-01-en, May 2019

248
 14 License Server and License Administrator
14.15 License Server Maintenance

Figure: Replacing the License Server or moving licenses

Table: Replace of Licenses or Move of Licenses

Number Description

1 All licenses, located on the old License

Server, are returned to the License
Activation Server.

2 The License Activation Server activates the

licenses on the new License Server using
the entitlement ID that originally was used
to activate the licenses.

Make sure that the new License Server has the same network address as the
former License Server. If a new network address is assigned, update all
WorkStations and Enterprise Servers with the address to the new License
Server.

04-30008-01-en, May 2019 IT

249
14 License Server and License Administrator
14.15 License Server Maintenance

14.15.4 License Server Reset

If problems with the License Server or activated licenses occur, you may have to
reset the License Server. All details about activated licenses on the License
Server are compiled in files that start with "taclic" and have the .data extension.
The file name string after "taclic" can differ. An example of the License Server file
name is taclic_00249e00_tsf.data. The license details files are created the first
time a license is activated on the License Server. By deleting the files you reset
the License Server.
For more information, see section 14.12 “License Server Reset” on page 245.

IT 04-30008-01-en, May 2019

250
15 Licensing User Interface

Topics
Registration Details View
Licenses View
Licenses View Toolbar
Licenses View Icons
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 and SmartX Server
License Information Enterprise Central
 15 Licensing User Interface
15.1 Registration Details View

15.1 Registration Details View

Use the Registration Details view to edit the contact information for the license
owner and the account manger that supplied the license. The registration details
are written to the license details when a license is activated.

NOTICE
Only English letters are allowed in the license details.

Figure: Registration details view

Table: Registration Details View

Component Description

License owner Type the name of the organization that

purchased the license.

Industry Select the end user’s field of business.

Type of project Select the proposed fields of application

for the license.

Name Type the name of the account manager

that supplied the license.

E-mail Type the e-mail address of the account

manager that supplied the license.

04-30008-01-en, May 2019 IT

253
15 Licensing User Interface
15.1 Registration Details View

Continued
Component Description

Telephone number Type the phone number of the account

manager that supplied the license.

IT 04-30008-01-en, May 2019

254
 15 Licensing User Interface
15.2 Licenses View

15.2 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 15.3 “Licenses View Toolbar”
on page 256.

Use the Licenses view columns to view

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

Use the Licenses view icons to get

information on different licenses and
status. For more information, see section
15.4 “Licenses View Icons” on page 257.

04-30008-01-en, May 2019 IT

255
15 Licensing User Interface
15.3 Licenses View Toolbar

15.3 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.

Repair license
Click to repair a damaged network license.

Show log
Click to open the license log file.

IT 04-30008-01-en, May 2019

256
 15 Licensing User Interface
15.4 Licenses View Icons

15.4 Licenses View Icons

Use the Licenses view icons to get information on different licenses and status.

Table: Licenses View Icons

Icon Description

Network License
Indicates that the license is a network
license located on the License Server.

Local License
Indicates that the license is a local license
located on a server or computer.

Damaged Local License

Indicates that a local license is damaged.
Local licenses can not be repaired.

Damaged Network License

Indicates that a network license is
damaged and needs to be repaired.

04-30008-01-en, May 2019 IT

257
15 Licensing User Interface
15.5 Licenses View Columns

15.5 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.

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.

IT 04-30008-01-en, May 2019

258
 15 Licensing User Interface
15.6 Add License Dialog Box

15.6 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.

04-30008-01-en, May 2019 IT

259
15 Licensing User Interface
15.7 License Activation Dialog Box

15.7 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.

IT 04-30008-01-en, May 2019

260
 15 Licensing User Interface
15.7 License Activation Dialog Box

Continued
Component Description

Activate (button) Click to activate the selected number of

licenses.

04-30008-01-en, May 2019 IT

261
15 Licensing User Interface
15.8 License Progress Dialog Box

15.8 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-30008-01-en, May 2019

262
 15 Licensing User Interface
15.9 License Server Address View

15.9 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-30008-01-en, May 2019 IT

263
15 Licensing User Interface
15.10 Diagnostics View

15.10 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-30008-01-en, May 2019

264
 15 Licensing User Interface
15.11 License Violation Bar

15.11 License Violation Bar

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

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 15.12
“License Information Enterprise Server and
SmartX Server” on page 266.

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-30008-01-en, May 2019 IT

265
15 Licensing User Interface
15.12 License Information Enterprise Server and SmartX Server

15.12 License Information Enterprise Server

and SmartX Server
Use License Information to check the licenses for an Enterprise Server or a
SmartX server.

Figure: License Information

Table: License Information

Property Description

Automation Server Licenses Displays the number of licenses for SmartX

Servers attached to the EcoStruxure BMS
server. For more information, see section
11.5 “License Information” on page 181.

IT 04-30008-01-en, May 2019

266
 15 Licensing User Interface
15.12 License Information Enterprise Server and SmartX Server

Continued
Property Description

Fieldbus Device Licenses Displays the number of licenses for the

fieldbus devices attached to the Enterprise
Server. For more information, see section
11.5 “License Information” on page 181.

Smart Driver Licenses Displays the number of licenses for the

Smart driver devices attached to the
EcoStruxure BMS server and SmartX AS-P
server. For more information, see section
11.5 “License Information” on page 181.

SNMP Notification Licenses Display the licenses for the SNMP

notification for each EcoStruxure BMS
server. SNMP notification required one
license per server. For more information,
see section 11.5 “License Information” on
page 181.

04-30008-01-en, May 2019 IT

267
15 Licensing User Interface
15.13 License Information Enterprise Central

15.13 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 15.12 “License
Information Enterprise Server and SmartX
Server” on page 266.

Enterprise Central SNMP Notification Display the SNMP licenses on the license
Licenses server that is used by the selected
Enterprise Server.

Server Name Displays the name of the servers attached

to the Enterprise Central.

IT 04-30008-01-en, May 2019

268
 15 Licensing User Interface
15.13 License Information Enterprise Central

Continued
Component Description

Server Type Displays the server type.

Automation Servers Displays the number of licenses for SmartX

servers attached to the Enterprise server.
Required/Activated.

ES hosted Fieldbus devices Displays the number of licenses for

fieldbuses attached to the Enterprise
Server. Required/Activated.

Smart Drivers Displays the number of licenses for Smart

Drivers attached to the Enterprise Server.
Required/Activated.

SNMP Notification Displays the number of licenses for SNMP

Notifications for the Enterprise Server.
Required/Activated.

04-30008-01-en, May 2019 IT

269
16 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
 16 Software Administrator
16.1 Software Administrator

16.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.

16.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.

16.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.

NOTICE
Port changes you have made using Software Administrator are not
automatically updated in the Communication view for EcoStruxure BMS
servers.

16.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.

16.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-30008-01-en, May 2019 IT

273
16 Software Administrator
16.2 Starting Software Administrator

16.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 16.1 “Software Administrator” on page 273.

To start Software Administrator

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

IT 04-30008-01-en, May 2019

274
 16 Software Administrator
16.3 Configuring Server Port Settings

16.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 16.1 “Software Administrator” on page 273.

To configure server ports

1. In Software Administrator
Administrator, click the tab of the Enterprise Server or
Enterprise Central
Central.
2. Click Stop Service
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
Service.
7. Click OK
OK.

04-30008-01-en, May 2019 IT

275
16 Software Administrator
16.4 Starting the Enterprise Central Windows Service

16.4 Starting the Enterprise Central Windows

Service
You start Enterprise Central manually if it has been stopped.

NOTICE
Ensure that you have a working and available license. A working license is
required to start the server. For more information, see section 11.10 “Licenses”
on page 190.

NOTICE
• Enterprise Central is automatically started when installed and when
Windows is started.

For more information, see section 16.1 “Software Administrator” on page 273.

To start the Enterprise Central Windows service

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

IT 04-30008-01-en, May 2019

276
 16 Software Administrator
16.5 Stopping the Enterprise Central Windows Service

16.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 16.1 “Software Administrator” on page 273.

To stop the Enterprise Central Windows service

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

04-30008-01-en, May 2019 IT

277
16 Software Administrator
16.6 Starting the Enterprise Server or Enterprise Central Windows Service

16.6 Starting the Enterprise Server or

Enterprise Central Windows Service
You start the server manually in case you previously have stopped it.

NOTICE
Ensure that you have a working and available license. A working license is
required to start the server. For more information, see section 11.10 “Licenses”
on page 190.

NOTICE
• Enterprise Server or Enterprise Central are automatically started when
installed and when Windows is started.

For more information, see section 16.1 “Software Administrator” on page 273.

To start the Enterprise Server Enterprise Central Windows

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

IT 04-30008-01-en, May 2019

278
 16 Software Administrator
16.7 Stopping the Enterprise Server Windows Service

16.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
Server.
For more information, see section 16.1 “Software Administrator” on page 273.

To stop the Enterprise Server Windows service

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

04-30008-01-en, May 2019 IT

279
16 Software Administrator
16.8 Restarting the Enterprise Server Windows Service

16.8 Restarting the Enterprise Server

Windows Service
You restart the Enterprise Server Windows service to reset or apply new
settings.

NOTICE
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 11.10 “Licenses” on page 190.

For more information, see section 16.1 “Software Administrator” on page 273.

To restart the Enterprise Server Windows service

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

IT 04-30008-01-en, May 2019

280
 16 Software Administrator
16.9 Enterprise Server and Enterprise Central System Logs

16.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-30008-01-en, May 2019 IT

281
16 Software Administrator
16.10 Viewing the Enterprise Server or Enterprise Central System Log

16.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 16.9 “Enterprise Server and Enterprise Central
System Logs” on page 281.

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
OK.

IT 04-30008-01-en, May 2019

282
 16 Software Administrator
16.11 Resolving Enterprise Server or Enterprise Central Port Conflicts

16.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 16.1 “Software Administrator” on page 273.

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
Port, HTTPS Port
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
OK.

04-30008-01-en, May 2019 IT

283
16 Software Administrator
16.12 Software Administrator – Enterprise Central View

16.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-30008-01-en, May 2019

284
 16 Software Administrator
16.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-30008-01-en, May 2019 IT

285
16 Software Administrator
16.13 Software Administrator – Enterprise Server View

16.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-30008-01-en, May 2019

286
 16 Software Administrator
16.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-30008-01-en, May 2019 IT

287
17 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
1Configuring a User Account Group to Log off to the Guest
User Account
 17 User Account Management
17.1 User Account Management Overview

17.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-30008-01-en, May 2019 IT

291
17 User Account Management
17.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

17.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 17.3 “User Accounts and User Account
Groups” on page 295.

17.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 19.1 “Domains” on page 329.

17.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 20.1 “Software Permissions” on page 345.

17.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 19.2 “Log On Methods” on page 332.

17.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 22.1 “Workspace Management” on page 391.

IT 04-30008-01-en, May 2019

292
 17 User Account Management
17.1 User Account Management Overview

17.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 17.12 “Automatic Logoff” on page 306.

17.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 17.14 “Guest User Account” on page 308.

17.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 17.15 “Automatic Logoff to Guest Account” on
page 309.

17.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 section 19.3 “Guest Logon in WebStation” on page
333.

04-30008-01-en, May 2019 IT

293
17 User Account Management
17.2 Opening the Account Management Control Panel

17.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
management.

IT 04-30008-01-en, May 2019

294
 17 User Account Management
17.3 User Accounts and User Account Groups

17.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 21.1 “Password Administration” on page 379.
• 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 19.1 “Domains”
on page 329.
• Manage accounts at the domain level using a default administrator account.
For more information, see section 19.11 “Administration Accounts in
EcoStruxure BMS Server Local Domain” on page 341.
• Track user activity at the user-account level. For more information, see
section 23.2 “Audit Trailing of User Activity” on page 420.

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-30008-01-en, May 2019 IT

295
17 User Account Management
17.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

NOTICE
• 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.

17.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 18.1 “Windows Active Directory User Groups”
on page 313.

IT 04-30008-01-en, May 2019

296
 17 User Account Management
17.3 User Accounts and User Account Groups

17.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 23.1 “WorkStation Account Management” on
page 419.

04-30008-01-en, May 2019 IT

297
17 User Account Management
17.4 Creating a User Account

17.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
management.
4. In the Domain box, select the domain the account is to be created in.
5. In the User Accounts area, click Add
Add.
6. Inthe 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
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
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.

NOTICE
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
Create.
18. Click OK
OK.

IT 04-30008-01-en, May 2019

298
 17 User Account Management
17.5 Editing a User Account Profile

17.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
management.
4. In Domain Control Panel
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
Summary.
7. Click the Profile tab.
8. Edit the user account profile information.

9. Click the Save button .

04-30008-01-en, May 2019 IT

299
17 User Account Management
17.6 Renaming a User Account

17.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
management.
4. In the Account Management Control Panel, click List users
users.
5. In the Users dialog box, select the user account you want to rename.
6. On the Edit menu, click Rename
Rename.
7. In the Rename Object dialog box, in the Object Name box, type a new
name for the user account.
8. Click OK
OK.

IT 04-30008-01-en, May 2019

300
 17 User Account Management
17.7 Disabling a User Account

17.7 Disabling a User Account

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

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
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
Summary.
7. In the Summary tab, in the Disabled box, select True to disable the
account.

8. Click the Save button .

04-30008-01-en, May 2019 IT

301
17 User Account Management
17.8 Enabling a Disabled User Account

17.8 Enabling a Disabled User Account

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

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
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
Summary.
7. In Summary tab, in the Disabled box, select False to enable the account.
8. On the File
File, click Save
Save.

IT 04-30008-01-en, May 2019

302
 17 User Account Management
17.9 Setting an Expiration Date for a User Account

17.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
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
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-30008-01-en, May 2019 IT

303
17 User Account Management
17.10 Removing the Expiration Date for a User Account

17.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
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
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
Save.

IT 04-30008-01-en, May 2019

304
 17 User Account Management
17.11 Deleting a User Account

17.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
management.
4. In the Account Management Control Panel
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
Yes.

04-30008-01-en, May 2019 IT

305
17 User Account Management
17.12 Automatic Logoff

17.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-30008-01-en, May 2019

306
 17 User Account Management
17.13 Setting the Automatic Logoff Time

17.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 17.12 “Automatic Logoff” on page 306.

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
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
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-30008-01-en, May 2019 IT

307
17 User Account Management
17.14 Guest User Account

17.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.
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 17.15 “Automatic Logoff to Guest Account” on
page 309.
If the EcoStruxure Building Operation software fails to auto log on using the
Guest user account, no event is generated.

IT 04-30008-01-en, May 2019

308
 17 User Account Management
17.15 Automatic Logoff to Guest Account

17.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-30008-01-en, May 2019 IT

309
17 User Account Management
17.16 1Configuring a User Account Group to Log off to the Guest User Account

17.16 1Configuring 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 17.15 “Automatic Logoff to Guest Account” on
page 309.

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
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
account.
9. On the File menu, click Save
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-30008-01-en, May 2019

310
18 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
 18 User Account Groups
18.1 Windows Active Directory User Groups

18.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.

NOTICE
• Windows Active Directory account groups can only be mapped on
EcoStruxure BMS servers that are running on Microsoft Windows operating
system. SmartX 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.

NOTICE
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-30008-01-en, May 2019 IT

313
18 User Account Groups
18.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-30008-01-en, May 2019

314
 18 User Account Groups
18.2 Creating a User Account Group

18.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 20.28 “Software Permissions, User Accounts,
and User Account Groups” on page 374.

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
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
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
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
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
Next.
17. In the Windows Group Name and Group Policies page, select Allow
members to close WorkStation if you want the users in the user account
group to be able to close the WorkStation software.
18. Select Log user actions of group members if you want to activate logging
for the users in the user account group.
19. Select Allow members to change password if you want the users in the
user account group to be able to change their own passwords.
20. Select Allow members to access AS Web Configuration if you want the
users in the user account group to be able to log on to SmartX servers'
Web configuration sites.
Continued on next page

04-30008-01-en, May 2019 IT

315
18 User Account Groups
18.2 Creating a User Account Group

21. In the Automatic logoff box, select a time if you want the users in the user
account group to be logged off after a defined time of inactivity. For more
information, see section 17.12 “Automatic Logoff” on page 306.
22. Select On logoff switch to guest account if you want to log on to the guest
account when user accounts that belong to the user account group are
manually or automatically logged off. For more information, see section
17.15 “Automatic Logoff to Guest Account” on page 309.

23. Click the refresh button to populate the Windows group name box
with Windows Active Directory user account groups.

NOTICE
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 19.4 “Creating and Configuring a Domain” on page 334.
Windows Active Directory account groups can only be mapped on
EcoStruxure BMS servers that are running on Microsoft Windows
operating system. SmartX servers cannot map Windows Active Directory
groups.

24. 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.

NOTICE
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.

25. Click Create

Create.

IT 04-30008-01-en, May 2019

316
 18 User Account Groups
18.3 Editing the Description of a User Account Group

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
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
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-30008-01-en, May 2019 IT

317
18 User Account Groups
18.4 Adding a User Account to a User Account Group

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
management.
4. In the Domain Control Panel
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
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
Save.

IT 04-30008-01-en, May 2019

318
 18 User Account Groups
18.5 Removing a User Account from a User Account Group

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
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
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
Save.

04-30008-01-en, May 2019 IT

319
18 User Account Groups
18.6 Reviewing the User Account Group Memberships for a User Account

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
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
membership.

IT 04-30008-01-en, May 2019

320
 18 User Account Groups
18.7 Adding a User Account Group to a User Account Group

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
management.
4. In the Account Management Control Panel
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
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-30008-01-en, May 2019 IT

321
18 User Account Groups
18.8 Removing a User Account Group from another User Account Group

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
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
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
Save.

IT 04-30008-01-en, May 2019

322
 18 User Account Groups
18.9 Reviewing the User Account Group Memberships for a User Account Group

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
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
Membership.

04-30008-01-en, May 2019 IT

323
18 User Account Groups
18.10 Preventing a Group of Users from Exiting WorkStation

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
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
Policies.
7. In the Policies tab, clear the Allow members to close WorkStation box.

8. Click the Save button.

IT 04-30008-01-en, May 2019

324
 18 User Account Groups
18.11 Enabling a Group of Users to Exit WorkStation

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
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
Policies.
7. In the Policies tab, select the Allow members to close WorkStation box.
8. On the File menu, click Save
Save.

04-30008-01-en, May 2019 IT

325
18 User Account Groups
18.12 Deleting a User Account Group

18.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 17.3 “User Accounts and User Account
Groups” on page 295.

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
management.
4. In the Domain Control Panel
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
Yes.

IT 04-30008-01-en, May 2019

326
19 Domains

Topics
Domains
Log On Methods
Guest Logon in WebStation
Creating and Configuring a Domain
Editing the Windows Domain Name
Editing the Description of a Domain
Editing the Maximum Logon Attempts
Assigning a SmartX Server to a Domain
Removing a SmartX Server from a Domain
Deleting a Domain
Administration Accounts in EcoStruxure BMS Server Local
Domain
 19 Domains
19.1 Domains

19.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.

NOTICE
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-30008-01-en, May 2019 IT

329
19 Domains
19.1 Domains

Figure: EcoStruxure Building Operation domain and its components.

NOTICE
You cannot change the name of a domain that is shared between EcoStruxure
BMS servers.

If an Enterprise Server is a member of an Enterprise Central domain, you add

SmartX servers to the same domain from the Enterprise Server domain
membership.

19.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.

IT 04-30008-01-en, May 2019

330
 19 Domains
19.1 Domains

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.

NOTICE
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.

19.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.

NOTICE
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.

19.1.3 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 19.11 “Administration Accounts in
EcoStruxure BMS Server Local Domain” on page 341.

04-30008-01-en, May 2019 IT

331
19 Domains
19.2 Log On Methods

19.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.

19.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.

19.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 17.3
“User Accounts and User Account Groups” on page 295.
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 19.11 “Administration Accounts in EcoStruxure BMS Server Local
Domain” on page 341.

19.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 21.1 “Password Administration” on page 379.

IT 04-30008-01-en, May 2019

332
 19 Domains
19.3 Guest Logon in WebStation

19.3 Guest Logon in WebStation

A guest logon is used when you want the user to get immediate access to the
EcoStruxure Building Operation software using WebStation.
When using a guest logon for WebStation, the user does not have to provide a
user name or password. Anyone who tries to access the system is logged on
automatically if the guest log on is used.
The guest logon is created using WorkStation and must be named GUEST and
use the password GUEST. The guest logon is valid for the domain it is created
on. The guest logon can be added to any user group in the system.
The guest account can be used immediately after you have created it. But if you
have logged on to WebStation before you created the guest account, you have
to clear cookies in the browser to log on automatically using the guest account.

04-30008-01-en, May 2019 IT

333
19 Domains
19.4 Creating and Configuring a Domain

19.4 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 a SmartX server to a domain in an Enterprise Central.
For more information, see section 19.1 “Domains” on page 329.

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
Domain.
4. In the Domain Control Panel
Panel, click Add
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
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
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.

NOTICE
• The Domain Members page appears only if there are any EcoStruxure
BMS servers available to connect to the domain.
• You cannot directly add a SmartX 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
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
Create.

IT 04-30008-01-en, May 2019

334
 19 Domains
19.5 Editing the Windows Domain Name

19.5 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 19.1 “Domains” on page 329.

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
Domain.
4. In the Domains box, select the domain that you want to edit.
5. Click Summary
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-30008-01-en, May 2019 IT

335
19 Domains
19.6 Editing the Description of a Domain

19.6 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 19.1 “Domains” on page 329.

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
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
Summary.
6. In the Summary tab, in the Description box, type a description for the
domain.

7. Click the Save button .

IT 04-30008-01-en, May 2019

336
 19 Domains
19.7 Editing the Maximum Logon Attempts

19.7 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 19.1 “Domains” on page 329.

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
Domain.
4. In the Domain Control Panel, in the Domains box, select the domain that
you want to edit.
5. Click Policies
Policies.
6. In the Policies tab, in the Maximum logon attempts box, enter a new
number.
7. On the File menu, click the Save
Save.

04-30008-01-en, May 2019 IT

337
19 Domains
19.8 Assigning a SmartX Server to a Domain

19.8 Assigning a SmartX Server to a Domain

You assign a SmartX server to a domain in the live system to extend your current
domain.
For more information, see section 19.1 “Domains” on page 329.

To assign a SmartX 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
Domains.
4. In Domain Control Panel, in the Domains list, select the domain you are
adding a SmartX 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-30008-01-en, May 2019

338
 19 Domains
19.9 Removing a SmartX Server from a Domain

19.9 Removing a SmartX Server from a

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

To remove a SmartX server from a domain

1. In WorkStation, in the System Tree pane, select the SmartX server you
want to configure.
2. Click the Control Panel tab.
3. Click Domains
Domains.
4. In the Domain Control Panel, in the Domains list, select a domain.
5. Click Domain members
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
Save.

04-30008-01-en, May 2019 IT

339
19 Domains
19.10 Deleting a Domain

19.10 Deleting a Domain

You delete a domain that is not anymore necessary in the EcoStruxure BMS.
For more information, see section 19.1 “Domains” on page 329.

NOTICE
• 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
Domain.
4. In the Domain Control Panel
Panel, in the Domain list, select the domain you are
deleting.

5. Click the Delete button .

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

IT 04-30008-01-en, May 2019

340
 19 Domains
19.11 Administration Accounts in EcoStruxure BMS Server Local Domain

19.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.

19.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.

19.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-30008-01-en, May 2019 IT

341
20 Software Permissions

Topics
Software Permissions
Path Permissions
Path Permissions Rules
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
20 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
 20 Software Permissions
20.1 Software Permissions

20.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.

20.1.1 Path Permissions

Path permissions grant a specific set of permissions to a user account or a user
account group to all the folders and objects defined in a path in the EcoStruxure
Building Operations software.
For more information, see section 20.2 “Path Permissions” on page 347.

20.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 20.7 “Command Permissions ” on page 352.

20.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 20.13 “Relative
Path Permissions” on page 359.
• Type permissions. For more information, see section 20.20 “Type
Permissions” on page 366.

20.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 20.13 “Relative Path Permissions” on page
359.

04-30008-01-en, May 2019 IT

345
20 Software Permissions
20.1 Software Permissions

20.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 20.20 “Type Permissions” on page 366.

20.1.6 Software Permissions Management

Software permissions can be combined between them.
For more information, see section 20.27 “Software Permissions Management” on
page 373.

IT 04-30008-01-en, May 2019

346
 20 Software Permissions
20.2 Path Permissions

20.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. 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.

20.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 20.3 “Path Permissions Rules” on page 348.

20.2.2 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 20.13 “Relative Path Permissions” on page
359.

04-30008-01-en, May 2019 IT

347
20 Software Permissions
20.3 Path Permissions Rules

20.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

NOTICE
You need delete permissions to rename, paste and duplicate folders and
objects in EcoStruxure Building Operation software.

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-30008-01-en, May 2019

348
 20 Software Permissions
20.4 Assigning Path Permissions to User Accounts or User Account Groups

20.4 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.

NOTICE
• 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 20.28 “Software
Permissions, User Accounts, and User Account Groups” on page 374.

For more information, see section 20.2 “Path Permissions” on page 347.

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
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
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.

NOTICE
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. On the File menu, click Save
Save.

04-30008-01-en, May 2019 IT

349
20 Software Permissions
20.5 Editing Path Permissions of User Accounts or User Account Groups

20.5 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 20.2 “Path Permissions” on page 347.

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
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
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. Click the Save button .

IT 04-30008-01-en, May 2019

350
 20 Software Permissions
20.6 Removing Path Permissions from User Accounts or User Account Groups

20.6 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 20.2 “Path Permissions” on page 347.

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
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
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 .

04-30008-01-en, May 2019 IT

351
20 Software Permissions
20.7 Command Permissions

20.7 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.

20.7.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 20.8 “Command Permissions Rules” on page
353.

IT 04-30008-01-en, May 2019

352
 20 Software Permissions
20.8 Command Permissions Rules

20.8 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.

04-30008-01-en, May 2019 IT

353
20 Software Permissions
20.8 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 20.29 “Software Permissions Rules
Management” on page 376.

IT 04-30008-01-en, May 2019

354
 20 Software Permissions
20.9 Assigning Command Permissions to User Account Groups

20.9 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 20.8 “Command Permissions Rules” on page
353.

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
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
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 .

04-30008-01-en, May 2019 IT

355
20 Software Permissions
20.10 Editing Command Permissions of User Account Groups

20.10 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 20.8 “Command Permissions Rules” on page
353.

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
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
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 .

IT 04-30008-01-en, May 2019

356
 20 Software Permissions
20.11 Removing Command Permissions from User Account Groups

20.11 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 20.28 “Software Permissions, User Accounts,
and User Account Groups” on page 374.
For more information, see section 20.8 “Command Permissions Rules” on page
353.

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
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
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
Setting.

10. Click the Save button .

04-30008-01-en, May 2019 IT

357
20 Software Permissions
20.12 Extended Software Permissions

20.12 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 20.13 “Relative
Path Permissions” on page 359.
• Type permissions. For more information, see section 20.20 “Type
Permissions” on page 366.

IT 04-30008-01-en, May 2019

358
 20 Software Permissions
20.13 Relative Path Permissions

20.13 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.

20.13.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 20.14 “Relative Path Permissions Rules” on
page 360.

04-30008-01-en, May 2019 IT

359
20 Software Permissions
20.14 Relative Path Permissions Rules

20.14 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

NOTICE
You need delete permissions to rename, paste and duplicate folders and
objects in EcoStruxure Building Operation software.

IT 04-30008-01-en, May 2019

360
 20 Software Permissions
20.15 Creating Relative Path Templates

20.15 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
permissions.
4. In the File menu, click New and then click Relative path permissions
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
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.

04-30008-01-en, May 2019 IT

361
20 Software Permissions
20.16 Editing Relative Path Permissions Templates

20.16 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
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.

IT 04-30008-01-en, May 2019

362
 20 Software Permissions
20.17 Deleting Relative Path Templates

20.17 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
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
Delete.
6. In the Confirm Delete dialog box, click Yes
Yes.

NOTICE
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.

04-30008-01-en, May 2019 IT

363
20 Software Permissions
20.18 Assigning Relative Path Permissions to User Accounts or User Account Groups

20.18 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
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
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.

IT 04-30008-01-en, May 2019

364
 20 Software Permissions
20.19 Removing Relative Path Permissions from User Accounts or User Account Groups

20.19 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 20.14 “Relative Path Permissions Rules” on page 360.

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
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
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.

04-30008-01-en, May 2019 IT

365
20 Software Permissions
20.20 Type Permissions

20.20 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.

20.20.1 Custom Type Permissions

Custom type permissions are type permissions for a type created by a user.

20.20.2 In-built Type Permissions

In-built type permissions are type permissions for a type provided by default
with the system.

20.20.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 20.21 “Type Permissions Rules” on page 367.

IT 04-30008-01-en, May 2019

366
 20 Software Permissions
20.21 Type Permissions Rules

20.21 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

NOTICE
You need delete permissions to rename, paste and duplicate folders and
objects in EcoStruxure Building Operation software.

04-30008-01-en, May 2019 IT

367
20 Software Permissions
20.22 Creating Type Permissions Templates

20.22 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 20.20 “Type Permissions” on page 366.

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
permissions.
4. In the File menu, choose New and then select Type permissions
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
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.

IT 04-30008-01-en, May 2019

368
 20 Software Permissions
20.23 Editing Type Permissions Templates

20.23 Editing Type Permissions Templates

You edit type permissions template to change permissions to this type.
For more information, see section 20.21 “Type Permissions Rules” on page 367.

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
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.

04-30008-01-en, May 2019 IT

369
20 Software Permissions
20.24 Removing Path Permissions Templates

20.24 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
permissions.
4. In the System Tree pane, select the type permissions you want to remove.
5. In the Edit menu, select Delete
Delete.
The template of a path permission is deleted.

IT 04-30008-01-en, May 2019

370
 20 Software Permissions
20.25 Assigning Type Permissions to User Accounts or User Account Groups

20.25 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 20.20 “Type Permissions” on page 366.

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
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
permissions.
6. In the Type Permissions pane, click +.
7. Browse to the type you want to assign permissions to and click Select
Select.

8. Click the Save button .

NOTICE
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.

04-30008-01-en, May 2019 IT

371
20 Software Permissions
20.26 Removing Type Permissions from User Accounts or User Account Groups

20.26 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 20.21 “Type Permissions Rules” on page 367.

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
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.

IT 04-30008-01-en, May 2019

372
 20 Software Permissions
20.27 Software Permissions Management

20.27 Software Permissions Management

Software permissions can be combined between them.

20.27.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 20.28 “Software Permissions, User Accounts,
and User Account Groups” on page 374.

20.27.2 Software Permissions Rules Management

You manage software permissions by combining various types of permissions.
For more information, see section 20.8 “Command Permissions Rules” on page
353.

04-30008-01-en, May 2019 IT

373
20 Software Permissions
20.28 Software Permissions, User Accounts, and User Account Groups

20.28 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.

IT 04-30008-01-en, May 2019

374
 20 Software Permissions
20.28 Software Permissions, User Accounts, and User Account Groups

Figure: Users inherit the user account group permissions of which they are members

04-30008-01-en, May 2019 IT

375
20 Software Permissions
20.29 Software Permissions Rules Management

20.29 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

NOTICE
You need delete permissions to rename, paste and duplicate folders and
objects in EcoStruxure Building Operation software.

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
Deny, and Deny overrules No Setting
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.

IT 04-30008-01-en, May 2019

376
21 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
Resetting the Administrator Password
 21 Login Configuration
21.1 Password Administration

21.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.

NOTICE
• If you are an administrator and have forgotten your password, contact the
EcoStruxure BMS support team.

04-30008-01-en, May 2019 IT

379
21 Login Configuration
21.2 Editing a User Account Password

21.2 Editing a User Account Password

You edit the password for a user account to give a user that has been locked out
of the EcoStruxure BMS by exceeding the number of allowed failed logon
attempts a new password.
For more information, see section 21.1 “Password Administration” on page 379.

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. Click Account management
management.
4. In Domain Control Panel
Panel, in the Domain box, select the domain the user
account to belongs to.
5. In the User Accounts list box, select the user account for which you wish to
change the password.
6. Click Summary
Summary.
7. On the Summary tab, in the Password box, type the new password.
8. In the Confirm Password box, confirm the password by retyping it.

9. Click the Save button .

IT 04-30008-01-en, May 2019

380
 21 Login Configuration
21.3 Allowing Users to Change their Password

21.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 20.28 “Software Permissions, User Accounts,
and User Account Groups” on page 374.

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
management.
4. In the Domain Control Panel
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
Policies.
7. In the Policies tab, select the May change Password box.

8. Click the Save button .

04-30008-01-en, May 2019 IT

381
21 Login Configuration
21.4 Changing Your Password

21.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
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
OK.

IT 04-30008-01-en, May 2019

382
 21 Login Configuration
21.5 Changing the Password for Local Administrator Accounts

21.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 21.1 “Password Administration” on page 379.

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
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
Save.

04-30008-01-en, May 2019 IT

383
21 Login Configuration
21.6 Turning off Remember Me On This Computer

21.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 19.2 “Log On Methods” on page 332.

To turn off Remember me on this Computer

1. In WorkStation, on the File menu, select Log Off
Off.
2. In the Building Operation WorkStation window, clear Remember me on
this computer
computer.
3. Log on again to activate the change.

IT 04-30008-01-en, May 2019

384
 21 Login Configuration
21.7 Forcing a User to Change the Password at Next Logon

21.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 21.1 “Password Administration” on page 379.

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
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
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-30008-01-en, May 2019 IT

385
21 Login Configuration
21.8 Preventing Users from Changing Their Passwords

21.8 Preventing Users from Changing Their

Passwords
You prevent a group of users from changing their passwords.
For more information, see section 21.1 “Password Administration” on page 379.

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
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
Policies.
7. In the Policies tab, clear the May change Password box.

8. Click the Save button.

IT 04-30008-01-en, May 2019

386
 21 Login Configuration
21.9 Resetting the Administrator Password

21.9 Resetting the Administrator Password

You reset the administrator password, if you are an administrator. For example if
you have locked yourself out of WorkStation. Schneider Electric Buildings
support team provides you with a temporary password for logging on to
EcoStruxure BMS and changing your administrator password.
For more information, see section 21.1 “Password Administration” on page 379.

NOTICE
• To authenticate yourself to the Schneider Electric Buildings support team,
you have to state your user name and password, the unique session ID (from
the failed logon attempt), and the domain you tried to log on to. To show the
session ID you need to press SHIFT and click the EcoStruxure Building
Operations icon in the WorkStation logon dialog box.

To reset the administrator password

1. Contact Schneider Electric Support and get a temporary password.
2. In WorkStation, log on using the temporary password.
3. Change your password.

04-30008-01-en, May 2019 IT

387
22 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
22 Customized Navigation Workflow
WebStation in Kiosk Mode
 22 Workspaces
22.1 Workspace Management

22.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.

22.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 22.2 “Predefined Workspaces” on page 393.

04-30008-01-en, May 2019 IT

391
22 Workspaces
22.1 Workspace Management

22.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 22.3 “Workspace Components and
Customization” on page 394.

22.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 22.21 “WebStation in Kiosk Mode” on page
415.

IT 04-30008-01-en, May 2019

392
 22 Workspaces
22.2 Predefined Workspaces

22.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-30008-01-en, May 2019 IT

393
22 Workspaces
22.3 Workspace Components and Customization

22.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-30008-01-en, May 2019

394
 22 Workspaces
22.3 Workspace Components and Customization

22.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 22.4 “Workspace Customization” on page
396.

22.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 22.6 “Workspace Content References” on
page 399.

22.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 22.16 “Panel Components” on page 410.

04-30008-01-en, May 2019 IT

395
22 Workspaces
22.4 Workspace Customization

22.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.

22.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 22.19 “Customized Navigation” on page 413.

IT 04-30008-01-en, May 2019

396
 22 Workspaces
22.4 Workspace Customization

22.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 22.5 “Workspace Path, Object, and Command
Customization” on page 398.

04-30008-01-en, May 2019 IT

397
22 Workspaces
22.5 Workspace Path, Object, and Command Customization

22.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 20.1 “Software Permissions” on page 345.
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 20.28
“Software Permissions, User Accounts, and User Account Groups” on page
374.

IT 04-30008-01-en, May 2019

398
 22 Workspaces
22.6 Workspace Content References

22.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-30008-01-en, May 2019 IT

399
22 Workspaces
22.7 Creating a Workspace

22.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.

NOTICE
You need to log off from the EcoStruxure BMS server for the changes to take
effect.

For more information, see section 22.3 “Workspace Components and

Customization” on page 394.

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
management.
4. In the Domain box, select the domain where you want to create the
workspace.
5. In the Workspaces area, click Add
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
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
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.
Continued on next page

IT 04-30008-01-en, May 2019

400
 22 Workspaces
22.7 Creating a Workspace

19. In the Initial path box, enter the path to the object you want to display in the
pane.
20. Click Create
Create.
21. In the Workspace wizard, click Create
Create.

04-30008-01-en, May 2019 IT

401
22 Workspaces
22.8 Editing the Layout of a Workspace

22.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 22.3 “Workspace Components and
Customization” on page 394.

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
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
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-30008-01-en, May 2019

402
 22 Workspaces
22.9 Editing the Description of a Workspace

22.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 22.1 “Workspace Management” on page 391.

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
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
Summary.
7. In the Summary tab, in the Description box, type a new description for the
workspace.

8. Click the Save button .

04-30008-01-en, May 2019 IT

403
22 Workspaces
22.10 Adding a Component to a Workspace

22.10 Adding a Component to a Workspace

You add a component to a workspace to extend the content and usage of the
workspace.

NOTICE
You need to log off from the EcoStruxure BMS server for the changes to take
effect.

For more information, see section 22.1 “Workspace Management” on page 391.

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
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
Content.
7. Click Add
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
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
Create.

IT 04-30008-01-en, May 2019

404
 22 Workspaces
22.11 Removing a Component from a Workspace

22.11 Removing a Component from a

Workspace
You remove a component from a workspace to reduce components and the
usage of the workspace.

NOTICE
You need to log off from the EcoStruxure BMS server for the changes to take
effect.

For more information, see section 22.1 “Workspace Management” on page 391.

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
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
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
Save.

04-30008-01-en, May 2019 IT

405
22 Workspaces
22.12 Editing a Workspace Component

22.12 Editing a Workspace Component

You edit the workspace components to adapt the usage of the workspace.

NOTICE
You need to log off from the EcoStruxure BMS server for the changes to take
effect.

For more information, see section 22.1 “Workspace Management” on page 391.

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
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
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
OK.
11. On the File menu, click Save
Save.

IT 04-30008-01-en, May 2019

406
 22 Workspaces
22.13 Adding a Workspace to a User Account Group

22.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 22.3 “Workspace Components and
Customization” on page 394.

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
management.
4. In the Domain Control Panel
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
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-30008-01-en, May 2019 IT

407
22 Workspaces
22.14 Removing a Workspace from a User Account Group

22.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 22.1 “Workspace Management” on page 391.

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
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
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
Save.

IT 04-30008-01-en, May 2019

408
 22 Workspaces
22.15 Reviewing the Workspace Memberships for a User Account Group

22.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 22.1 “Workspace Management” on page 391.

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
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
Workspaces.

04-30008-01-en, May 2019 IT

409
22 Workspaces
22.16 Panel Components

22.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.

NOTICE
• 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
22.19 “Customized Navigation” on page 413.

IT 04-30008-01-en, May 2019

410
 22 Workspaces
22.17 Creating a Panel

22.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 22.16 “Panel Components” on page 410.

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
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
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
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
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
Create.

04-30008-01-en, May 2019 IT

411
22 Workspaces
22.18 Editing a Panel

22.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 22.16 “Panel Components” on page 410.

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
Properties.
3. In the Panel properties, edit the properties of the panel.
4. Click OK
OK.
5. Click Close
Close.

IT 04-30008-01-en, May 2019

412
 22 Workspaces
22.19 Customized Navigation

22.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-30008-01-en, May 2019 IT

413
22 Workspaces
22.20 Customized Navigation Workflow

22.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 22.7 “Creating a Workspace” on page 400.
For more information, see section 22.17 “Creating a Panel ” on page 411.

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 22.10 “Adding a Component to a Workspace”
on page 404.
For more information, see section 22.17 “Creating a Panel ” on page 411.

IT 04-30008-01-en, May 2019

414
 22 Workspaces
22.21 WebStation in Kiosk Mode

22.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.

22.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 section 19.3 “Guest Logon in
WebStation” on page 333.

22.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/ to remove all toolbars.
The text string /?kiosk/ must be placed after the server address.
For example, you want to run this SmartX server without any toolbars:
https://10.142.0.227/#%2FAutomation%20Server
You add the /?kiosk/
https://10.142.0.227/?kiosk/Automation%20Server

NOTICE
The /?kiosk/ does not configure the browser to run in kiosk mode. It only
removes the toolbars.

04-30008-01-en, May 2019 IT

415
23 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
 23 Audit Trails
23.1 WorkStation Account Management

23.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.

23.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 23.2 “Audit Trailing of User Activity” on page
420.

23.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 23.6 “WorkStation Account Validation” on
page 425.

04-30008-01-en, May 2019 IT

419
23 Audit Trails
23.2 Audit Trailing of User Activity

23.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.

NOTICE
• 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.

IT 04-30008-01-en, May 2019

420
 23 Audit Trails
23.2 Audit Trailing of User Activity

Figure: The Policies tab with audit trailing enabled

04-30008-01-en, May 2019 IT

421
23 Audit Trails
23.3 Disabling Audit Trail for a Group of Users

23.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.

NOTICE
• 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 23.2 “Audit Trailing of User Activity” on page
420.

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
management.
4. In the Domain Control Panel
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
Policies.
7. Clear the Enable Audit Trailing box.

8. Click the Save button .

IT 04-30008-01-en, May 2019

422
 23 Audit Trails
23.4 Enabling Audit Trail for a Group of Users

23.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 23.2 “Audit Trailing of User Activity” on page
420.

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
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
Policies.
7. On the Policies tab, select Enable Audit Trailing
Trailing.

8. Click the Save button .

04-30008-01-en, May 2019 IT

423
23 Audit Trails
23.5 Viewing an Audit Trail Log

23.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 23.2 “Audit Trailing of User Activity” on page
420.

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
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
Events.

IT 04-30008-01-en, May 2019

424
 23 Audit Trails
23.6 WorkStation Account Validation

23.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.

NOTICE
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.

04-30008-01-en, May 2019 IT

425
24 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
24 Domain – Domain Members Tab
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
24 Domains Properties
Local Properties
Work Area Window Properties
Create Work Area Window Wizard – Name Page
Windows User Group Dialog Box
 24 User Management User Interface
24.1 User Management System Tree Icons

24.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 22.16 “Panel
Components” on page 410.

Folder of User Accounts

Indicates that the folder contains user
accounts. For more information, see
section 17.3 “User Accounts and User
Account Groups” on page 295.

User Account
Indicates that the object is a user account.
For more information, see section 17.3
“User Accounts and User Account
Groups” on page 295.

Domain
Indicates that the object is a domain. For
more information, see section 19.1
“Domains” on page 329.

User Account Groups

Indicates that the object is a user account
group. For more information, see section
17.3 “User Accounts and User Account
Groups” on page 295.

Workspace
Indicates that the object is a workspace.
For more information, see section 22.1
“Workspace Management” on page 391.

04-30008-01-en, May 2019 IT

431
24 User Management User Interface
24.2 Domain Properties

24.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-30008-01-en, May 2019

432
 24 User Management User Interface
24.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 18.1 “Windows Active Directory
User Groups” on page 313.

04-30008-01-en, May 2019 IT

433
24 User Management User Interface
24.3 Profile Properties

24.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-30008-01-en, May 2019

434
 24 User Management User Interface
24.4 Workspace Properties

24.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 24.5 “Pane
Properties” on page 437.

Remove
Click to remove a workspace pane.

Menu Select Visible to show the menu in the

workspace.

04-30008-01-en, May 2019 IT

435
24 User Management User Interface
24.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-30008-01-en, May 2019

436
 24 User Management User Interface
24.5 Pane Properties

24.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-30008-01-en, May 2019 IT

437
24 User Management User Interface
24.6 Panel Properties

24.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 24.5 “Pane
Properties” on page 437.

IT 04-30008-01-en, May 2019

438
 24 User Management User Interface
24.6 Panel Properties

Continued
Component Description

Remove
Click to remove a panel component.

04-30008-01-en, May 2019 IT

439
24 User Management User Interface
24.7 Navigation Pane

24.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-30008-01-en, May 2019

440
 24 User Management User Interface
24.8 Building Operation WorkStation Window

24.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 17.3 “User
Accounts and User Account Groups” on
page 295.

Password Type the password of your EcoStruxure

Building Operation user account or of your
Windows user account.

04-30008-01-en, May 2019 IT

441
24 User Management User Interface
24.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 19.1 “Domains” on
page 329.

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 17.3 “User
Accounts and User Account Groups” on
page 295.

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.
Operation For more information, see the WebHelp
Overview topic on WebHelp.

IT 04-30008-01-en, May 2019

442
 24 User Management User Interface
24.9 Domain Control Panel

24.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 24.11 “Account Management
Control Panel” on page 446.

Summary Click to open the Summary tab for the

domain. For more information, see section
24.17 “Domain – Summary Tab” on page
454.

Policies Click to open the Policies tab where you

edit the policies of the domain. For more
information, see section 24.18 “Domain –
Policies Tab” on page 455.

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 24.19 “Domain –
Domain Members Tab” on page 456.

04-30008-01-en, May 2019 IT

443
24 User Management User Interface
24.10 Edit Permissions Dialog Box

24.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 20.29
“Software Permissions Rules
Management” on page 376.

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-30008-01-en, May 2019

444
 24 User Management User Interface
24.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-30008-01-en, May 2019 IT

445
24 User Management User Interface
24.11 Account Management Control Panel

24.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-30008-01-en, May 2019

446
 24 User Management User Interface
24.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 24.20 “User
Account – Summary Tab” on page 457.

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 24.21 “User
Account – Group Membership Tab” on
page 458.

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
24.23 “User Account – Software
Permissions Tab” on page 461.

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 24.24 “User
Account – Audit Trailing Events Tab” on
page 462.

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 24.31 “User
Account Group – Summary Tab” on page
474.

Group membership (user account groups) Click to open the Group Membership tab
where you can edit the groups
membership in other groups, and add and
remove user accounts. For more
information, see section 24.33 “User
Account Group – Group Membership Tab”
on page 476.

04-30008-01-en, May 2019 IT

447
24 User Management User Interface
24.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 24.34 “User
Account Group – Software Permissions
Tab” on page 478.

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 24.35 “User
Account Group – Workspaces Tab” on
page 480.

Policies Click to open the Policies tab where you

can edit the policies of the user account
group. For more information, see section
24.32 “User Account Group – Policies Tab”
on page 475.

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 24.41 “Workspace – Summary
Tab” on page 488.

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 24.43 “Workspace – Members
Tab” on page 491.

Content Click to open the Content tab where you

edit the content of the workspace. For
more information, see section 24.42
“Workspace – Content Tab” on page 489.

Edit layout Click to open the view where you edit the
layout of the workspace. For more
information, see section 24.44 “Edit Layout
Workspace” on page 492.

IT 04-30008-01-en, May 2019

448
 24 User Management User Interface
24.12 Select Default Workspace Window

24.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-30008-01-en, May 2019 IT

449
24 User Management User Interface
24.13 Change Password Dialog Box

24.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.

Confirm password Type your new password again.

IT 04-30008-01-en, May 2019

450
 24 User Management User Interface
24.14 Domain Wizard – Authentication Page

24.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 18.1 “Windows Active Directory
User Groups” on page 313.

04-30008-01-en, May 2019 IT

451
24 User Management User Interface
24.15 Domain Wizard – Domain Members Page

24.15 Domain Wizard – Domain Members

Page
Use the Domain Members page to add SmartX server to the domain.

Figure: Domain members page

Table: Domain Members Page

Component Description

Available Servers List of all available SmartX servers.

Servers that are members of this Domain List of all SmartX servers in the domain.

Add All
Click to add all available SmartX servers to
the domain.

Add
Click to add a SmartX server to the
domain.

Remove
Click to remove a SmartX server from the
domain.

Remove All
Click to remove all SmartX server from the
domain.

IT 04-30008-01-en, May 2019

452
 24 User Management User Interface
24.16 Domain Wizard – Domain Policies Page

24.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-30008-01-en, May 2019 IT

453
24 User Management User Interface
24.17 Domain – Summary Tab

24.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 18.1 “Windows Active Directory
User Groups” on page 313.

Domain Controller Displays the path and name of the domain

controller.

IT 04-30008-01-en, May 2019

454
 24 User Management User Interface
24.18 Domain – Policies Tab

24.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-30008-01-en, May 2019 IT

455
24 User Management User Interface
24.19 Domain – Domain Members Tab

24.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 Domain List of all EcoStruxure BMS servers in the
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-30008-01-en, May 2019

456
 24 User Management User Interface
24.20 User Account – Summary Tab

24.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-30008-01-en, May 2019 IT

457
24 User Management User Interface
24.21 User Account – Group Membership Tab

24.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-30008-01-en, May 2019

458
 24 User Management User Interface
24.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-30008-01-en, May 2019 IT

459
24 User Management User Interface
24.22 User Account – Profile Tab

24.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-30008-01-en, May 2019

460
 24 User Management User Interface
24.23 User Account – Software Permissions Tab

24.23 User Account – Software Permissions

Tab
Use the Software Permissions tab to enter individual path permissions for a
user account.

NOTICE
• 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.

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.

Path The paths the user account has access to.

Permission Click to assign a permission level to a path

you have selected. For more information,
see section 20.29 “Software Permissions
Rules Management” on page 376.

Owner The owner of the path the user account has

access to. Owner can be one or more user
account groups the user account is a
member of or the user account.

04-30008-01-en, May 2019 IT

461
24 User Management User Interface
24.24 User Account – Audit Trailing Events Tab

24.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..

IT 04-30008-01-en, May 2019

462
 24 User Management User Interface
24.25 User Account Group Properties

24.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 Web 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.

04-30008-01-en, May 2019 IT

463
24 User Management User Interface
24.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 18.1 “Windows Active Directory
User Groups” on page 313.

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 17.15
“Automatic Logoff to Guest Account” on
page 309.

IT 04-30008-01-en, May 2019

464
 24 User Management User Interface
24.26 User Account Properties

24.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 24.3 “Profile
Properties” on page 434.

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.

04-30008-01-en, May 2019 IT

465
24 User Management User Interface
24.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.

IT 04-30008-01-en, May 2019

466
 24 User Management User Interface
24.27 Guest Account Properties

24.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
17.3 “User Accounts and User Account
Groups” on page 295.

Edit
Click to edit the selected user profile. For
more information, see section 17.3 “User
Accounts and User Account Groups” on
page 295.

04-30008-01-en, May 2019 IT

467
24 User Management User Interface
24.27 Guest Account Properties

Continued
Property Description

Remove
Click to remove the selected user profile.
For more information, see section 17.3
“User Accounts and User Account
Groups” on page 295.

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.

IT 04-30008-01-en, May 2019

468
 24 User Management User Interface
24.28 User Account Group Wizard – Users Belonging to this Group Page

24.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.

04-30008-01-en, May 2019 IT

469
24 User Management User Interface
24.29 User Account Group Wizard – Workspaces Belonging to this Group Page

24.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.

IT 04-30008-01-en, May 2019

470
 24 User Management User Interface
24.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.

04-30008-01-en, May 2019 IT

471
24 User Management User Interface
24.30 User Account Group Wizard – Windows Group Name and Group Policies Page

24.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 a SmartX server. For more
information, see the SmartX Server Device
Configuration in WebStation topic on
WebHelp.

Automatic logoff Select to log off users in this group after a

defined time of inactivity. For more
information, see section 17.12 “Automatic
Logoff” on page 306.

IT 04-30008-01-en, May 2019

472
 24 User Management User Interface
24.30 User Account Group Wizard – Windows Group Name and Group Policies Page

Continued
Component Description

On logoff switch 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 17.15 “Automatic Logoff to Guest
Account” on page 309.

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 18.1 “Windows Active Directory
User Groups” on page 313.

04-30008-01-en, May 2019 IT

473
24 User Management User Interface
24.31 User Account Group – Summary Tab

24.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 18.1 “Windows Active Directory
User Groups” on page 313.

IT 04-30008-01-en, May 2019

474
 24 User Management User Interface
24.32 User Account Group – Policies Tab

24.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

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 change password Select to enable users to change their

passwords.

Allow members to access Automation Select to enable users to access the Web
Server Web Configuration Configuration where you configure the
settings of a SmartX server. For more
information, see the SmartX Server Device
Configuration in WebStation topic on
WebHelp.

Automatic logoff Select to log off users in this group after a

defined time of inactivity. For more
information, see section 17.12 “Automatic
Logoff” on page 306.

On logoff switch 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 17.15 “Automatic Logoff to Guest
Account” on page 309.

04-30008-01-en, May 2019 IT

475
24 User Management User Interface
24.33 User Account Group – Group Membership Tab

24.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-30008-01-en, May 2019

476
 24 User Management User Interface
24.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-30008-01-en, May 2019 IT

477
24 User Management User Interface
24.34 User Account Group – Software Permissions Tab

24.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

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.

IT 04-30008-01-en, May 2019

478
 24 User Management User Interface
24.34 User Account Group – Software Permissions Tab

Continued
Component Description

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.

Path Displays the paths that have been defined

for the user account group.

Permission Select a permission level for the path. For

more information, see section 20.29
“Software Permissions Rules
Management” on page 376.

Owner Displays the user account group the path

has been added to.

Category Click a category to display the commands

included in the category.

Command Displays all commands for the category.

Permission Select a permission level for a command.

Command Displays all commands that are available

to the user account group members.

Permission Select a permission level for the command.

Owner Displays the user account groups the

commands have been added to.

04-30008-01-en, May 2019 IT

479
24 User Management User Interface
24.35 User Account Group – Workspaces Tab

24.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.

IT 04-30008-01-en, May 2019

480
 24 User Management User Interface
24.36 User Account Wizard – General Page

24.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.

04-30008-01-en, May 2019 IT

481
24 User Management User Interface
24.37 User Account Wizard – Member Of Page

24.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.

IT 04-30008-01-en, May 2019

482
 24 User Management User Interface
24.37 User Account Wizard – Member Of Page

Continued
Component Description

Remove all
Click to remove all user account groups
from the user account.

04-30008-01-en, May 2019 IT

483
24 User Management User Interface
24.38 User Account Management Folder Properties

24.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

IT 04-30008-01-en, May 2019

484
 24 User Management User Interface
24.39 Workspace Wizard – Workspace Configuration Page

24.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.

04-30008-01-en, May 2019 IT

485
24 User Management User Interface
24.39 Workspace Wizard – Workspace Configuration Page

Continued
Component Description

Listed components Lists the standard components included in

the workspace. Select a component and
click the Add
Add, Edit or Remove button.

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 24.5 “Pane
Properties” on page 437.

Click to remove a component.

IT 04-30008-01-en, May 2019

486
 24 User Management User Interface
24.40 Workspace Wizard – Pane Configuration Page

24.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 24.39 “Workspace Wizard –
Workspace Configuration Page” on page
485.

04-30008-01-en, May 2019 IT

487
24 User Management User Interface
24.41 Workspace – Summary Tab

24.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.

IT 04-30008-01-en, May 2019

488
 24 User Management User Interface
24.42 Workspace – Content Tab

24.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 22.6 “Workspace Content
References” on page 399.

04-30008-01-en, May 2019 IT

489
24 User Management User Interface
24.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 24.5 “Pane Properties” on
page 437.

Remove
Click to remove a component.

IT 04-30008-01-en, May 2019

490
 24 User Management User Interface
24.43 Workspace – Members Tab

24.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.

04-30008-01-en, May 2019 IT

491
24 User Management User Interface
24.44 Edit Layout Workspace

24.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.

IT 04-30008-01-en, May 2019

492
 24 User Management User Interface
24.45 Panel Wizard – Panel Configuration Page

24.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 24.5
“Pane Properties” on page 437.

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.

04-30008-01-en, May 2019 IT

493
24 User Management User Interface
24.46 Domains Properties

24.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
19.1 “Domains” on page 329.

IT 04-30008-01-en, May 2019

494
 24 User Management User Interface
24.47 Local Properties

24.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.

04-30008-01-en, May 2019 IT

495
24 User Management User Interface
24.48 Work Area Window Properties

24.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 22.3
“Workspace Components and
Customization” on page 394.

IT 04-30008-01-en, May 2019

496
 24 User Management User Interface
24.49 Create Work Area Window Wizard – Name Page

24.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 22.3
“Workspace Components and
Customization” on page 394.

04-30008-01-en, May 2019 IT

497
24 User Management User Interface
24.50 Windows User Group Dialog Box

24.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
18.1 “Windows Active Directory User
Groups” on page 313.

IT 04-30008-01-en, May 2019

498
25 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
 25 Connect Agent
25.1 Connect Agent Overview

25.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 SmartX
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 25.2 “Configuring Connect Agent
Settings” on page 502.

04-30008-01-en, May 2019 IT

501
25 Connect Agent
25.2 Configuring Connect Agent Settings

25.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 25.1 “Connect Agent Overview” on page 501.

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
Settings.
3. On the File menu, click Properties
Properties.
4. In the Enable crash information transfer box, select True
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-30008-01-en, May 2019

502
 25 Connect Agent
25.3 Transferring Crash Information

25.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 25.2 “Configuring Connect
Agent Settings” on page 502.

25.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 2.0\Enterprise Server

04-30008-01-en, May 2019 IT

503
25 Connect Agent
25.4 Applying Proxy Settings to the Connect Agent Service Log On

25.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 25.1 “Connect Agent Overview” on page 501.

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-30008-01-en, May 2019

504
 25 Connect Agent
25.5 Configuring Windows Firewall for Connect Agent

25.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 25.1 “Connect Agent Overview” on page 501.

To configuring Windows Firewall for Connect Agent

1. On the Windows toolbar, select Start and then click Control Panel
Panel.
2. Click System and Security and then click Check firewall status
status.
3. Click Advanced settings and then click Outbound Rules
Rules.
4. Click New Rule
Rule.
5. Select Program and click Next
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 Next.
7. Select Allow the connection and click Next
Next.
8. Select the profiles and click Next
Next.
9. In the Name box, type the name for the rule.
10. Click Finish
Finish.

04-30008-01-en, May 2019 IT

505
25 Connect Agent
25.6 Getting Connect Agent Debug Information

25.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 25.1 “Connect Agent Overview” on page 501.

To get Connect Agent Debug Information

1. In Windows, navigate to \Program Files (x86)\Schneider Electric
EcoStruxure\Building Operation x.y\S2ConnectAgent\bin
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
DEBUG.
The detailed debug information is retrieved in the crash log files.

IT 04-30008-01-en, May 2019

506
26 Connect Agent User Interface

Topics
Connect Agent Settings - Basic Tab
Connect Agent Settings - Advanced Tab
 26 Connect Agent User Interface
26.1 Connect Agent Settings - Basic Tab

26.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-30008-01-en, May 2019 IT

509
26 Connect Agent User Interface
26.2 Connect Agent Settings - Advanced Tab

26.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-30008-01-en, May 2019

510
27 Backup and Restore

Topics
Backup and Restore Overview
Comparison of Backup and Restore Methods
Retain Level
Configuring the Retain Level
 27 Backup and Restore
27.1 Backup and Restore Overview

27.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.

27.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 28.1 “Backup” on page 523.

27.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 31.1 “Restore” on page 573.

27.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.

27.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-30008-01-en, May 2019 IT

513
27 Backup and Restore
27.1 Backup and Restore Overview

27.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 27.2 “Comparison of Backup and Restore
Methods ” on page 515.

27.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 SmartX server.
For more information, see section 27.3 “Retain Level ” on page 517.

IT 04-30008-01-en, May 2019

514
 27 Backup and Restore
27.2 Comparison of Backup and Restore Methods

27.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 a SmartX 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 b3, LonWorks, Network
a backup set 8000, I/NET, MicroNet, and
Modbus devices.

04-30008-01-en, May 2019 IT

515
27 Backup and Restore
27.2 Comparison of Backup and Restore Methods

Continued
Method Purpose Description

BACnet Restore Restores a device using Use this method to backup

configuration data primarily:
contained in a backup set
(no historical data) • External devices
• Routers

NOTICE
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-30008-01-en, May 2019

516
 27 Backup and Restore
27.3 Retain Level

27.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 SmartX 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.
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 by an application
are retained. are 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 by an application
are retained. are retained.

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 by an application
are retained. are lost.

04-30008-01-en, May 2019 IT

517
27 Backup and Restore
27.3 Retain Level

Continued
System Events and Retain level: No Retain level: Cold Retain level: Warm
Activities start start

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 by an application
are retained. are 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 by an application
are retained. are 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 by an application
are retained. are lost.

a) Default value is the value the variable gets when it is created.

Function Block
Function block objects have there 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-30008-01-en, May 2019

518
 27 Backup and Restore
27.4 Configuring the Retain Level

27.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 27.3 “Retain Level ” on page 517.

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
level.

4. In the Retain level box, select the retain level.

04-30008-01-en, May 2019 IT

519
28 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 SmartX Servers
 28 Backups
28.1 Backup

28.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 29.1 “Backup Sets”
on page 539.

28.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 28.2 “Types of Data” on page 525.

28.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 SmartX servers in the Local folder within the Backup sets
folder.
For more information, see section 29.1 “Backup Sets” on page 539.

28.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 30.1 “Scheduled Backups” on page 559.

28.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 28.5 “Manual Backups” on page 528.

04-30008-01-en, May 2019 IT

523
28 Backups
28.1 Backup

28.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 28.6 “Mass Backup” on page 530.

28.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 28.8 “System Backup” on page 532.

28.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 28.3 “Backup Status” on page 526.

IT 04-30008-01-en, May 2019

524
 28 Backups
28.2 Types of Data

28.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
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 27.3 “Retain Level ” on page 517.
• All data
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,

NOTICE
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 27.3 “Retain Level ” on page 517.

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 a SmartX 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-30008-01-en, May 2019 IT

525
28 Backups
28.3 Backup Status

28.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-30008-01-en, May 2019

526
 28 Backups
28.4 Checking the Backup Status of an EcoStruxure BMS Server

28.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 28.3 “Backup Status” on page 526.

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
Manager.
4. View the EcoStruxure BMS server backup status or date and time of the last
successful backup.

04-30008-01-en, May 2019 IT

527
28 Backups
28.5 Manual Backups

28.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:
• SmartX server or Enterprise Server to perform a local backup. For more
information, see section 28.9 “Local Backup and Restore of EcoStruxure
BMS Servers” on page 534.
• Enterprise Server to perform a remote backup of any SmartX servers that
are created under the Enterprise Server. For more information, see section
28.10 “Remote Backup and Restore of SmartX Servers” on page 535.
• Enterprise Central to perform a remote backup of any Enterprise Servers
that are created under the Enterprise Central. For more information, see
section 28.9 “Local Backup and Restore of EcoStruxure BMS Servers” on
page 534.

28.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.

NOTICE
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

SmartX 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.

28.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.

IT 04-30008-01-en, May 2019

528
 28 Backups
28.5 Manual Backups

For more information, see section 28.9 “Local Backup and Restore of
EcoStruxure BMS Servers” on page 534.

28.5.3 Remote Backup and Restore of SmartX

Servers
When you log on to an Enterprise Server, you can perform remote backups of
any SmartX server in the system. Whenever a backup occurs on the SmartX
server, the system overwrites the locally stored file on the SmartX 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 28.10 “Remote Backup and Restore of SmartX
Servers” on page 535.

04-30008-01-en, May 2019 IT

529
28 Backups
28.6 Mass Backup

28.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 SmartX servers. In larger installations, multiple server groups may
include an Enterprise Server with a distinct set of SmartX 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 SmartX servers

You log on to the Enterprise Server to create a mass backup. For more
information, see section 32.6 “Backup Options Dialog Box” on page 597.

IT 04-30008-01-en, May 2019

530
 28 Backups
28.7 Backing Up EcoStruxure BMS Servers Manually

28.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 28.5 “Manual Backups” on page 528.

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
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
Backup.
12. In the Backup Status dialog box, verify that the backups succeeded and
click Close
Close.

04-30008-01-en, May 2019 IT

531
28 Backups
28.8 System Backup

28.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
SmartX 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 SmartX
server. The backups do not need to follow
any particular order. For more information,
see section 28.7 “Backing Up EcoStruxure
BMS Servers Manually” on page 531.

3 Save backup sets to an external Save the Enterprise Central, Enterprise

location Server, and SmartX 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 29.3 “Backup Set Storage and
Protection” on page 543.

IT 04-30008-01-en, May 2019

532
 28 Backups
28.8 System Backup

Continued
Step Procedure Description

4 Back up current Reports For systems that include a Reports Server,

database back up the WebReports database. For more
information, see section 9.15 “Backing Up the
WebReports Database” on page 143.
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-30008-01-en, May 2019 IT

533
28 Backups
28.9 Local Backup and Restore of EcoStruxure BMS Servers

28.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.

28.9.1 Local Backup and Restore of a Standalone

SmartX Server
In WorkStation, you can log on to a SmartX server to perform a manual backup
of the SmartX server data.
If you have multiple standalone SmartX servers, the Backup and Restore
processes on one SmartX server remain self-contained and, therefore, separate
from any another SmartX server on the network.
In a stand-alone system only one backup set is stored on the SmartX 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 a SmartX server.

28.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.

28.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-30008-01-en, May 2019

534
 28 Backups
28.10 Remote Backup and Restore of SmartX Servers

28.10 Remote Backup and Restore of SmartX

Servers
When you log on to an Enterprise Server, you can perform remote backups of
any SmartX server in the system. Whenever a backup occurs on the SmartX
server, the system overwrites the locally stored file on the SmartX 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 a SmartX server, the system displays only the valid
SmartX server backup files that are stored on the Enterprise Server.
In the event that the backup file on the SmartX server is damaged or lost, or not
the one you want to use, you can select a valid backup file to restore the SmartX
server. The restore operation overwrites the locally stored SmartX server backup
file located on the SmartX server with the selected backup file. For more
information, see section 31.4 “Restoring a SmartX Server from the Enterprise
Server” on page 577.

04-30008-01-en, May 2019 IT

535
29 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 a SmartX 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 SmartX 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
 29 Backup Sets
29.1 Backup Sets

29.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 SmartX servers in the Local folder within the Backup sets
folder.

29.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 29.2 “Location of Backup Sets” on page 541.

29.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 29.4 “Locating the Local
Backup Path on the Enterprise Server or Enterprise Central” on page 545.

NOTICE
Going forward, you must create new backups for the renamed EcoStruxure
BMS server.

29.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 29.3 “Backup Set Storage and Protection” on
page 543.

29.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 29.8 “Backup Set Import from WorkStation” on
page 549.

04-30008-01-en, May 2019 IT

539
29 Backup Sets
29.1 Backup Sets

29.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 29.11 “Automatic Purge of Backup Sets” on
page 553.

IT 04-30008-01-en, May 2019

540
 29 Backup Sets
29.2 Location of Backup Sets

29.2 Location of Backup Sets

Backup sets are stored in different locations for stand-alone systems and multi-
server systems.

29.2.1 Multi Server System

In a multi-server system with an Enterprise Server and one or more SmartX
servers, the backup sets are stored on the computer that runs the Enterprise
server. The SmartX 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 29.7 “Copying a Backup Set to the Enterprise
Server or Enterprise Central Local Directory” on page 548.
In the Backup sets folder of the installation directory, two directories are created:
• AS Archives
Archives: Lists separate subfolders that reflect the name of each
SmartX server. Each subfolder contains the backup files for that SmartX
server.
• Local
Local: Lists all the local backup files for the Enterprise Server and
Enterprise Central.

Figure: Location of backup sets

29.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 SmartX server.
For more information, see section 29.6 “Saving a SmartX Server Backup Set to
Another Location” on page 547.

04-30008-01-en, May 2019 IT

541
29 Backup Sets
29.2 Location of Backup Sets

The SmartX server stores only one backup set at a time, so each new backup
operation overwrites the previous backup set.

IT 04-30008-01-en, May 2019

542
 29 Backup Sets
29.3 Backup Set Storage and Protection

29.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 a SmartX 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 SmartX 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 30.1 “Scheduled Backups” on
page 559.

04-30008-01-en, May 2019 IT

543
29 Backup Sets
29.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 29.14 “Deleting a Backup Set from an Enterprise
Server or Enterprise Central” on page 556.
• Periodically: You can configure the system to remove backup sets on a
regular basis. For more information, see section 29.11 “Automatic Purge of
Backup Sets” on page 553.

IT 04-30008-01-en, May 2019

544
 29 Backup Sets
29.4 Locating the Local Backup Path on the Enterprise Server or Enterprise Central

29.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 29.3 “Backup Set Storage and Protection” on
page 543.

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
manager.
4. In the Backup sets path box, view the local backup path on the Enterprise
server.

04-30008-01-en, May 2019 IT

545
29 Backup Sets
29.5 Saving an Enterprise Server or Enterprise Central Backup Set to Another Location

29.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 29.3 “Backup Set Storage and Protection” on
page 543.

To save an Enterprise Server or Enterprise Central backup set

to another location
1. On the Tools menu, select Control Panel
Panel.
2. On the Control Panel toolbar, select the Enterprise Server or Enterprise
Central.
3. Click Backup Sets
Sets.
4. In the List View
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
to.
7. In the Save As dialog box, enter a storage location and click Save
Save.
8. Click Close
Close.

IT 04-30008-01-en, May 2019

546
 29 Backup Sets
29.6 Saving a SmartX Server Backup Set to Another Location

29.6 Saving a SmartX Server Backup Set to

Another Location
You save a backup set from a SmartX server to another location so you can store
the backup set on, for example, a network drive or a USB memory.

To save a SmartX server backup set to another location

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel toolbar, select the EcoStruxure BMS server.
3. Click Backup Sets
Sets.
4. In the List View
View, open the Local folder for a SmartX server or the AS
Archives folder for an Enterprise Server.
5. If connected to the Enterprise Server, open the SmartX 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
To.
8. In the Save As dialog box, enter a storage location and click Save
Save.
9. Click Close
Close.

04-30008-01-en, May 2019 IT

547
29 Backup Sets
29.7 Copying a Backup Set to the Enterprise Server or Enterprise Central Local Directory

29.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 29.3 “Backup Set Storage and Protection” on
page 543.

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
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
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
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.

NOTICE
If the LocalBackup folder does not appear within the db_backup folder,
you can create one using the exact name, LocalBackup
LocalBackup.

You can now restore the Enterprise Server or Enterprise Central using this
backup set. For more information, see section 31.3 “Restoring the EcoStruxure
BMS Server” on page 576.

IT 04-30008-01-en, May 2019

548
 29 Backup Sets
29.8 Backup Set Import from WorkStation

29.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 SmartX 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, a SmartX 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 SmartX servers, the
Enterprise Server retrieves and stores the latest backup set for each SmartX
server in a separate directory in the Backup Sets folder. In addition, the system
can store several backup sets for each SmartX 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.

NOTICE
When you back up the Enterprise Servers from an Enterprise Central, the
SmartX 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 a SmartX servers or Enterprise Server

04-30008-01-en, May 2019 IT

549
29 Backup Sets
29.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-30008-01-en, May 2019

550
 29 Backup Sets
29.9 Importing a Backup Set to an Enterprise Server or Enterprise Central

29.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 29.8 “Backup Set Import from WorkStation” on
page 549.

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
Restore.
3. In the Restore Options dialog box, click Import Backup Set
Set.
4. Select a backup set that is stored on a file system and click Open
Open.
5. Click Yes if you want to replace an existing backup set.
6. Click Close
Close.
You can now restore the Enterprise Server or Enterprise Central with the
imported backup set.

04-30008-01-en, May 2019 IT

551
29 Backup Sets
29.10 Importing a Backup Set to SmartX Server

29.10 Importing a Backup Set to SmartX

Server
You import a backup set from a network storage location to restore a
replacement SmartX server, or to replace a lost or damaged backup set.
For more information, see section 29.8 “Backup Set Import from WorkStation” on
page 549.

To import a backup set to SmartX server

1. Log on to the SmartX server to which you want to import a backup set.
2. In WorkStation, in the System Tree pane, select the SmartX server.
3. On the Actions menu, click Restore
Restore.
4. In the Restore Options dialog box, click Import Backup Set
Set.
5. In the Confirm Replace dialog box, click OK
OK.
6. Select a valid backup set that is stored on a file system and click Open
Open.
7. Click Close
Close.
You can now restore the SmartX server with the imported backup set.

IT 04-30008-01-en, May 2019

552
 29 Backup Sets
29.11 Automatic Purge of Backup Sets

29.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 SmartX
servers. For more information, see section 32.4 “Backup and Restore Manager
on the Enterprise Server” on page 594.
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
store, manages the backups
stored on an Enterprise Central or Enterprise Server.
• Global setting for SmartX servers: The global setting, Number of AS backup
sets to store
store, manages all the backups stored on the SmartX servers. You
cannot configure each SmartX server separately because the global setting
affects all the SmartX 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 SmartX
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
(SmartX 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 32.4
“Backup and Restore Manager on the Enterprise Server” on page 594.

04-30008-01-en, May 2019 IT

553
29 Backup Sets
29.12 Configuring Purge Settings on an Enterprise Server

29.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 a SmartX server.
For more information, see section 29.11 “Automatic Purge of Backup Sets” on
page 553.

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
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
SmartX 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
Save.

IT 04-30008-01-en, May 2019

554
 29 Backup Sets
29.13 Configuring Purge Settings on an Enterprise Central

29.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 29.11 “Automatic Purge of Backup Sets” on
page 553.

To configure purge settings on an Enterprise Central

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel toolbar, select the Enterprise Central.
3. In the Backup and archiving area, click Backup and Restore Manager
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-30008-01-en, May 2019 IT

555
29 Backup Sets
29.14 Deleting a Backup Set from an Enterprise Server or Enterprise Central

29.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 29.1 “Backup Sets” on page 539.

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
Manager.
4. In the Backup and Restore Manager
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
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
Delete.
9. Click Yes to remove the backup set.

IT 04-30008-01-en, May 2019

556
30 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
 30 Scheduled Backups
30.1 Scheduled Backups

30.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 28.5 “Manual Backups” on page 528.

Figure: Backup on an Enterprise Server

30.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-30008-01-en, May 2019 IT

559
30 Scheduled Backups
30.1 Scheduled Backups

For more information, see section 30.2 “Backup Rules” on page 561.

30.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 change the schedule settings for this backup rule, but you
cannot delete the schedule and select another.
For more information, see section 30.7 “Backup Schedules” on page 566.

30.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 30.9 “Synchronized Backups” on page 568.

IT 04-30008-01-en, May 2019

560
 30 Scheduled Backups
30.2 Backup Rules

30.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 32.9 “Backup Rules View” on page 601.

04-30008-01-en, May 2019 IT

561
30 Scheduled Backups
30.3 Creating a Backup Rule

30.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 30.2 “Backup Rules” on page 561.

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
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
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
Create.

IT 04-30008-01-en, May 2019

562
 30 Scheduled Backups
30.4 Editing a Backup Rule

30.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 30.2 “Backup Rules” on page 561.

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
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
OK.
10. On the File menu, click Save
Save.

04-30008-01-en, May 2019 IT

563
30 Scheduled Backups
30.5 Deleting a Backup Rule

30.5 Deleting a Backup Rule

You delete a backup rule to remove the rule from the EcoStruxure BMS server.
For more information, see section 30.2 “Backup Rules” on page 561.

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
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
Save.

IT 04-30008-01-en, May 2019

564
 30 Scheduled Backups
30.6 Removing a Lead Rule from a Backup Rule

30.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 30.2 “Backup Rules” on page 561.

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
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
OK.
7. On the File menu, click Save
Save.

04-30008-01-en, May 2019 IT

565
30 Scheduled Backups
30.7 Backup Schedules

30.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 change the schedule settings for this backup rule, but you
cannot delete the schedule and select another.

NOTICE
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 SmartX 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 a SmartX
server daily at 02:00. For more information, see section 32.9 “Backup Rules
View” on page 601.

IT 04-30008-01-en, May 2019

566
 30 Scheduled Backups
30.8 Editing a Backup Schedule

30.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 30.7 “Backup Schedules” on page 566.

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
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-30008-01-en, May 2019 IT

567
30 Scheduled Backups
30.9 Synchronized Backups

30.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
30.10 “Synchronizing EcoStruxure BMS Server Backups on a Network” on page
569.

IT 04-30008-01-en, May 2019

568
 30 Scheduled Backups
30.10 Synchronizing EcoStruxure BMS Server Backups on a Network

30.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 30.9 “Synchronized Backups” on page 568.

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
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.

NOTICE
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-30008-01-en, May 2019 IT

569
31 Restore

Topics
Restore
Restored Data
Restoring the EcoStruxure BMS Server
Restoring a SmartX Server from the Enterprise Server
Restoring an Enterprise Server from the Enterprise Central
SmartX Server Replacement Using Restore
SmartX Server Replacement Using Restore Workflow
Duplicate SmartX Server from a Backup Set
Duplicating a SmartX Server Using Restore
 31 Restore
31.1 Restore

31.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.

31.1.1 Restored Data

Depending on what is contained in the backup file, you can restore different
types of data.
• Configuration only
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
data: the EcoStruxure Building Operation software restores the
configuration, historical, and custom object types data.
For more information, see section 31.2 “Restored Data” on page 574.

31.1.2 SmartX Server Replacement Using Restore

Backup and Restore assures that SmartX server data can be restored to a
replacement SmartX server in the event of hardware failure, or to the same
SmartX server in the event of data loss. As a precaution, you back up your
SmartX servers regularly so that you can use the most current backup to restore
the SmartX server data to a replacement SmartX server. You also configure the
new SmartX server to match the name and the network settings of the replaced
SmartX server so the system can identify this SmartX server when online.
For more information, see section 31.6 “SmartX Server Replacement Using
Restore” on page 579.

31.1.3 Duplicate SmartX Server Using Restore

You can use the Restore function to re-use the configuration data from a backup
set in a new standalone SmartX server. Rather than manually configuring your
preferred SmartX server configuration, you can save time and configure the
standalone SmartX server from a backup set.
The backup set used can originate from a SmartX server that is or has been part
of a multi-server configuration.
For more information, see section 31.8 “Duplicate SmartX Server from a Backup
Set” on page 583.

04-30008-01-en, May 2019 IT

573
31 Restore
31.2 Restored Data

31.2 Restored Data

Depending on what is contained in the backup file, you can restore different
types of data.
• Configuration only
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
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 SmartX server

When you restore the SmartX server locally, the system retrieves the current
master backup set for that SmartX server. However, you cannot select a
particular backup set because the SmartX server stores only one backup set at
a time.

Restore from an Enterprise Server

Unlike the SmartX 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 SmartX servers in its group.
In this configuration, the non-local backup sets are stored in separate folders for
each SmartX server.

IT 04-30008-01-en, May 2019

574
 31 Restore
31.2 Restored Data

When you restore the SmartX server from the Enterprise Server, you can select a
particular backup set from a list of files that are stored for that SmartX server.
This restore method provides greater flexibility. For more information, see
section 31.4 “Restoring a SmartX Server from the Enterprise Server” on page
577.

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.
• SmartX server. For more information, see the SmartX Server Properties –
Basic Tab topic on WebHelp.

04-30008-01-en, May 2019 IT

575
31 Restore
31.3 Restoring the EcoStruxure BMS Server

31.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 31.1 “Restore” on page 573.

NOTICE
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 section 9.25 “Stopping the
Reporting Agent Windows Service ” on page 154.

To restore the EcoStruxure BMS server

1. Stop the Reporting Agent service on the Reports Server. For more
information, see section 9.25 “Stopping the Reporting Agent Windows
Service ” on page 154.
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
Restore.

NOTICE
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
Restore.
7. Click Yes
Yes.
8. Click Close
Close.
If your system includes the Reports Server, the Reporting Agent Windows
service restarts automatically.

IT 04-30008-01-en, May 2019

576
 31 Restore
31.4 Restoring a SmartX Server from the Enterprise Server

31.4 Restoring a SmartX Server from the

Enterprise Server
You log on to an Enterprise Server to restore a SmartX server.
For more information, see section 31.1 “Restore” on page 573.

To restore a SmartX server from the Enterprise Server

1. In WorkStation, in the System Tree pane, select the SmartX server that you
want to restore.
2. On the Actions menu, click Restore
Restore.

NOTICE
Take manual control of any output points that could potentially damage
equipment before restoring the SmartX server. If you cannot disconnect
the physical outputs, restore the SmartX 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 SmartX 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
Restore.
6. Click Yes
Yes.
7. Click Close
Close.

NOTICE
After a restore, WorkStation may display several SmartX 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-30008-01-en, May 2019 IT

577
31 Restore
31.5 Restoring an Enterprise Server from the Enterprise Central

31.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 31.1 “Restore” on page 573.

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
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
Restore.
6. Click Yes
Yes.
7. Click Close
Close.

IT 04-30008-01-en, May 2019

578
 31 Restore
31.6 SmartX Server Replacement Using Restore

31.6 SmartX Server Replacement Using

Restore
Backup and Restore assures that SmartX server data can be restored to a
replacement SmartX server in the event of hardware failure, or to the same
SmartX server in the event of data loss. As a precaution, you back up your
SmartX servers regularly so that you can use the most current backup to restore
the SmartX server data to a replacement SmartX server. You also configure the
new SmartX server to match the name and the network settings of the replaced
SmartX server so the system can identify this SmartX server when online.

Supported cases of SmartX server replacements

The following cases of SmartX server replacements are supported using restore:
• Replacing a SmartX server with a SmartX server of the same SmartX server
type
• Replacing Automation Server with a SmartX AS-P server
To replace Automation Server with a SmartX AS-P server, you first need to install
the server software on the new SmartX 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
If you replace an Automation Server with a SmartX 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.

NOTICE
You can reuse an Automation Server terminal base (TB-AS-W1) for a SmartX
AS-P server module by removing the terminal block at the top of the terminal
base.

SmartX server names

Typically, SmartX servers and WorkStations can acquire different identifiers and
user-assigned names. For example, SmartX server has a network identifier, AS-
000E00, which is used internally but is difficult to remember. For convenience,
you can also assign a descriptive SmartX server name, such as Main Lobby-AS,
to locate this SmartX 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 SmartX
server. Specifically, you use the static IP address or fully qualified domain name
to locate the new SmartX server on the network. To reconfigure the default
TCP/IP settings on the new SmartX server to match those of the replaced SmartX
servers, you use the Automation Server Web Configuration utility.

04-30008-01-en, May 2019 IT

579
31 Restore
31.6 SmartX Server Replacement Using Restore

If your network uses DHCP, a new SmartX 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
SmartX server on the network. By default, DHCP is turned off on SmartX servers.
To enable this and other network settings on the new SmartX server, you use the
Device Administrator. For more information, see the SmartX Server
Administration topic on WebHelp.

NOTICE
• Make sure that you have a valid SmartX server backup set before performing
a restore. A backup set can contain either configuration data only, or both
configuration and historical data.

Standalone SmartX server site

In a single SmartX server site, you log onto the SmartX server in WorkStation to
manage Backup and Restore operations. In this scenario, you need to have a
valid backup set to restore the SmartX server in case the hardware fails or data
is lost.
The SmartX server only stores one backup set at a time. Therefore, you should
create a backup set when the SmartX 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
SmartX 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 SmartX servers in the group.
Unlike the SmartX server, which only stores one backup set at a time, the
Enterprise Server can store multiple backup sets for each SmartX server. From
the AS Archives folder, you can select a stored backup set that was created
when the SmartX 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
SmartX 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 SmartX server. Therefore, be sure to log onto the SmartX server before
restoring the SmartX server in WorkStation. For more information, see section
29.6 “Saving a SmartX Server Backup Set to Another Location” on page 547.

31.6.1 SmartX Server Replacement Using Restore

Workflow
Use the workflow to duplicate the SmartX server from a backup set.
For more information, see section 31.7 “SmartX Server Replacement Using
Restore Workflow” on page 581.

IT 04-30008-01-en, May 2019

580
 31 Restore
31.7 SmartX Server Replacement Using Restore Workflow

31.7 SmartX Server Replacement Using

Restore Workflow
Use the workflow to duplicate the SmartX server from a backup set.

Figure: Duplicate SmartX server using restore flowchart

Copy SmartX server Backup Set to WorkStation

Save the most current backup set of the SmartX server that you want to replace
to WorkStation.
For more information, see section 29.6 “Saving a SmartX Server Backup Set to
Another Location” on page 547.

Add new SmartX server to network and configure communication

settings
Add the new SmartX 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 SmartX server using WorkStation

For more information, see the Logging on to WorkStation as an EcoStruxure
Building Operation User topic on WebHelp.

04-30008-01-en, May 2019 IT

581
31 Restore
31.7 SmartX Server Replacement Using Restore Workflow

Import backup set

Import the backup set to the new SmartX server.
For more information, see section 29.10 “Importing a Backup Set to SmartX
Server” on page 552.

Restore new SmartX server using the imported Backup Set

Restore the new SmartX server using the imported backup set.
For more information, see section 31.3 “Restoring the EcoStruxure BMS Server”
on page 576.

NOTICE
If the SmartX server does not go online, you can manually recreate the SmartX
server or restore the connections between the Enterprise Server and the
SmartX server. For more information, see the SmartX Server Remains Offline
After Restore topic on WebHelp.

The Restore process automatically renames the SmartX server and specifies the
objects and properties that the SmartX server uses to reestablish links and go
online.

IT 04-30008-01-en, May 2019

582
 31 Restore
31.8 Duplicate SmartX Server from a Backup Set

31.8 Duplicate SmartX 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 SmartX server. Rather than manually configuring your
preferred SmartX server configuration, you can save time and configure the
standalone SmartX server from a backup set.
The backup set used can originate from a SmartX 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 29.1 “Backup Sets” on page 539.

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 SmartX server

The LonWorks devices connected to the SmartX server are not the same as the
LonWorks devices that are to be connected to the duplicate. When you create a
duplicate from a SmartX 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 SmartX server.
For more information, see the LonWorks Device Workflows topic on WebHelp.

Password deleted on duplicated EcoStruxure BMS device

When you duplicate a SmartX 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 SmartX 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 SmartX server to the Enterprise Server and
select the backup set in the Create Object Wizard.
For more information, see the Creating a SmartX Server from a Backup Set topic
on WebHelp.

Standalone SmartX Server Site

You use a locally stored backup set to duplicate another SmartX server
configuration in a standalone SmartX server. You then import the backup set to a
client and restore to the new standalone SmartX server.
For more information, see section 31.9 “Duplicating a SmartX Server Using
Restore ” on page 586.

04-30008-01-en, May 2019 IT

583
31 Restore
31.8 Duplicate SmartX Server from a Backup Set

31.8.1 Duplicate SmartX Server from a Backup Set

Workflow
Use the following workflow to duplicate a SmartX server from a backup set.

Figure: Duplicate SmartX server using restore flowchart

Backup a SmartX server

Backup a SmartX server that has the configuration you want to use in the new
standalone SmartX server.
For more information, see section 28.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 531.

Copy backup set to local directory

Copy the backup set to a local directory.
For more information, see section 29.6 “Saving a SmartX Server Backup Set to
Another Location” on page 547.

Log on to standalone SmartX server

Log on to a new standalone SmartX 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-30008-01-en, May 2019

584
 31 Restore
31.8 Duplicate SmartX Server from a Backup Set

For more information, see section 29.10 “Importing a Backup Set to SmartX
Server” on page 552.

Restore SmartX 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 SmartX
server. The communication settings from the backup set are not duplicated.
For more information, see section 31.9 “Duplicating a SmartX Server Using
Restore ” on page 586.

NOTICE
When you restore a standalone SmartX server, you are logged off and need to
log on manually after the restore is complete.

04-30008-01-en, May 2019 IT

585
31 Restore
31.9 Duplicating a SmartX Server Using Restore

31.9 Duplicating a SmartX 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
SmartX server.

NOTICE
The locally stored backup set and the SmartX server need to have the same
password.

For more information, see section 31.8 “Duplicate SmartX Server from a Backup
Set” on page 583.

To duplicate a SmartX 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
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 SmartX server.
5. Click Restore
Restore.
6. Click Yes
Yes.
7. Click Close
Close.

IT 04-30008-01-en, May 2019

586
32 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 (SmartX
Servers) – Basic Tab
Backup and Restore Manager on the Enterprise Server
Backup and Restore Manager on a SmartX 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
32 Backup Rule Dialog Box
Backup and Restore System Tree Icons
Restore Options Dialog Box
Restore Status Dialog Box
Backup and Restore Folder Properties
 32 Backup and Restore User Interface
32.1 Backup and Restore Manager Properties (Enterprise Central) – Basic Tab

32.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-30008-01-en, May 2019 IT

589
32 Backup and Restore User Interface
32.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-30008-01-en, May 2019

590
 32 Backup and Restore User Interface
32.2 Backup and Restore Manager Properties (Enterprise Server) – Basic Tab

32.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 SmartX server backup files at the
next backup.

04-30008-01-en, May 2019 IT

591
32 Backup and Restore User Interface
32.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 SmartX
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-30008-01-en, May 2019

592
 32 Backup and Restore User Interface
32.3 Backup and Restore Manager Properties (SmartX Servers) – Basic Tab

32.3 Backup and Restore Manager

Properties (SmartX Servers) – Basic Tab
Use the Basic tab to view the current backup and restore status of a SmartX
server.

Figure: Backup and Restore Manager for the SmartX server

Table: Backup and Restore Manager Properties (SmartX 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-30008-01-en, May 2019 IT

593
32 Backup and Restore User Interface
32.4 Backup and Restore Manager on the Enterprise Server

32.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 SmartX
server automatically when a new backup
for that SmartX 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 SmartX 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-30008-01-en, May 2019

594
 32 Backup and Restore User Interface
32.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-30008-01-en, May 2019 IT

595
32 Backup and Restore User Interface
32.5 Backup and Restore Manager on a SmartX Server

32.5 Backup and Restore Manager on a

SmartX Server
Use the Backup and Restore Manager to view the backup status of a SmartX
server.

Figure: Backup and Restore Manager on a SmartX server

Table: Backup and Restore Manager on a SmartX 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-30008-01-en, May 2019

596
 32 Backup and Restore User Interface
32.6 Backup Options Dialog Box

32.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-30008-01-en, May 2019 IT

597
32 Backup and Restore User Interface
32.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
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
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-30008-01-en, May 2019

598
 32 Backup and Restore User Interface
32.7 Create Object Wizard – Configure Backup Rule Page

32.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-30008-01-en, May 2019 IT

599
32 Backup and Restore User Interface
32.8 Backup Rule Properties – Basic Tab

32.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-30008-01-en, May 2019

600
 32 Backup and Restore User Interface
32.9 Backup Rules View

32.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 32.10 “Backup
Rules Toolbar” on page 602.

Use the Backup Rules list to modify backup schedules or set

up lead rules. For more information, see section 32.11
“Backup Rules List” on page 603.

04-30008-01-en, May 2019 IT

601
32 Backup and Restore User Interface
32.10 Backup Rules Toolbar

32.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 30.3 “Creating a Backup Rule”
on page 562.

Edit backup rule

Click to open the Backup rule dialog box where you modify a backup
rule. For more information, see section 30.4 “Editing a Backup Rule”
on page 563.

Remove backup rule

Click to delete a backup rule. For more information, see section 30.5
“Deleting a Backup Rule” on page 564.

IT 04-30008-01-en, May 2019

602
 32 Backup and Restore User Interface
32.11 Backup Rules List

32.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-30008-01-en, May 2019 IT

603
32 Backup and Restore User Interface
32.12 Digital Schedule Properties – Basic Tab

32.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
transitiona changes.

IT 04-30008-01-en, May 2019

604
 32 Backup and Restore User Interface
32.12 Digital Schedule Properties – Basic Tab

Continued
Component Description

Following transition Displays the subsequent value following the next transition
valuea value.

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-30008-01-en, May 2019 IT

605
32 Backup and Restore User Interface
32.13 Backup Set Properties – Basic Tab

32.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-30008-01-en, May 2019

606
 32 Backup and Restore User Interface
32.14 Backup Sets View

32.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 SmartX 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-30008-01-en, May 2019 IT

607
32 Backup and Restore User Interface
32.15 Backup Status Dialog Box

32.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.

NOTICE
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-30008-01-en, May 2019

608
 32 Backup and Restore User Interface
32.16 Control Panel – Backup and Archiving

32.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 32.9 “Backup Rules View” on page 601.

Backup Sets Click to open the Backup Sets view where you manage
backup sets. For more information, see section 32.14
“Backup Sets View” on page 607.

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 32.4 “Backup and Restore
Manager on the Enterprise Server” on page 594.

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-30008-01-en, May 2019 IT

609
32 Backup and Restore User Interface
32.17 Backup Rule Dialog Box

32.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-30008-01-en, May 2019

610
 32 Backup and Restore User Interface
32.18 Backup and Restore System Tree Icons

32.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 28.1 “Backup” on
page 523.
• Backup and Restore Manager. For more information, see section
32.4 “Backup and Restore Manager on the Enterprise Server” on
page 594.

Backup schedule
Indicates a backup schedule. For more information, see section 30.7
“Backup Schedules” on page 566.

04-30008-01-en, May 2019 IT

611
32 Backup and Restore User Interface
32.19 Restore Options Dialog Box

32.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 SmartX 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.

Configuration only Select to restore only the configuration data and custom object
type 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 Set Click to import the backup set to an EcoStruxure BMS server. In a
multi-server configuration, you can import both SmartX server and
Enterprise Server backup sets to the Enterprise Server.

IT 04-30008-01-en, May 2019

612
 32 Backup and Restore User Interface
32.19 Restore Options Dialog Box

Continued
Component Description

Restore Select to duplicate the configuration data from the imported

configuration with backup set in the new standalone SmartX server. The
new IDs communication settings from the backup set will not be duplicated.
For more information, see section 31.8 “Duplicate SmartX Server
from a Backup Set” on page 583.

04-30008-01-en, May 2019 IT

613
32 Backup and Restore User Interface
32.20 Restore Status Dialog Box

32.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-30008-01-en, May 2019

614
 32 Backup and Restore User Interface
32.21 Backup and Restore Folder Properties

32.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-30008-01-en, May 2019 IT

615
Schneider Electric
www.schneider-electric.com/buildings

© 2019 Schneider Electric. All rights reserved.

04-30008-01-en
May 2019