StruxureWare Building Operation

IT
Reference Guide
04-13008-01-en
October 2012
StruxureWare Building Operation
IT
Reference Guide
04-13008-01-en
October 2012
Copyright © 2012 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 ......................................................... 21
1.1 Purpose of This Guide ................................................................. 23
1.2 How This Guide is Organized ...................................................... 24
1.3 Typographical Conventions ......................................................... 25

2 Additional Information .................................................. 27

2.1 Where to Find Additional Information ........................................... 29
2.2 Regulatory Notices ...................................................................... 30

Reference
3 Installation ................................................................... 33
3.1 Installation of Building Operation ................................................. 35
3.1.1 Installation Packages ................................................................ 35
3.1.2 Products ................................................................................... 35
3.1.3 Installation Example .................................................................. 35
3.1.4 Installation Reparation ............................................................... 35
3.1.5 Reinstall .................................................................................... 36
3.1.6 System Upgrade Overview ........................................................ 36
3.1.7 Uninstallation ............................................................................ 36
3.1.8 Version Numbers and Parallel Installations ................................. 36
3.1.9 Software Administrator .............................................................. 36
3.2 Products ..................................................................................... 37
3.2.1 WorkStation .............................................................................. 37
3.2.2 Graphics Editor ......................................................................... 37
3.2.3 Script Editor .............................................................................. 37
3.2.4 Menta Editor ............................................................................. 38
3.2.5 Function Block Editor ................................................................ 38
3.2.6 WorkPlace Tech ........................................................................ 38
3.2.7 Enterprise Server ...................................................................... 39
3.2.8 Software Administrator .............................................................. 39
3.2.9 Device Administrator ................................................................. 39
3.2.10 License Administrator ............................................................... 39
3.2.11 License Server .......................................................................... 39

04-13008-01-en, October 2012 IT

5
 3.2.12 WebReports ............................................................................. 40
3.2.13 Language Package ................................................................... 40
3.3 Installation Example .................................................................... 41
3.4 Version Numbers and Parallel Installations ................................... 43
3.5 Installing the License Administrator and the License Server ......... 45
3.6 Installing WorkStation and Client Tools ........................................ 49
3.7 Installing a Language Package .................................................... 53
3.8 Installing the Enterprise Server .................................................... 56
3.9 Installing the Device Administrator ............................................... 62

4 Installation Repair ......................................................... 65

4.1 Installation Reparation ................................................................. 67
4.2 Repairing the License Administrator and the License Server ........ 68
4.3 Repairing WorkStation and Client Tools Installation ..................... 74
4.4 Repairing the Enterprise Server ................................................... 79
4.5 Repairing the Device Administrator Installation ............................. 86

5 Reinstallation ............................................................... 91
5.1 Reinstallation .............................................................................. 93
5.2 Reinstalling the License Administrator and the License Server ..... 94
5.3 Reinstalling WorkStation and Client Tools .................................. 102
5.4 Reinstalling the Enterprise Server .............................................. 108
5.5 Reinstalling the Device Administrator Installation ........................ 116

6 System Upgrade ....................................................... 121

6.1 System Upgrade Overview ........................................................ 123
6.1.1 System Upgrade Software Requirements ................................ 123
6.1.2 System Upgrade Workflows .................................................... 124
6.2 System Upgrade Software Requirements .................................. 125
6.3 System Upgrade Workflows ...................................................... 126
6.3.1 Enterprise Server System Upgrade Workflow .......................... 126
6.3.2 Automation Server System Upgrade Workflow ........................ 126
6.4 Enterprise Server System Upgrade Workflow ............................ 127
6.4.1 Prepare for Upgrade ............................................................... 127
6.4.2 Upgrade Building Operation Software ..................................... 128
6.4.3 Upgrade WebReports ............................................................. 131
6.5 Automation Server System Upgrade Workflow .......................... 133
6.6 Upgrading the License Administrator and the License Server ..... 135
6.7 Upgrading WorkStation and Client Tools Installation .................. 144
6.8 Upgrading the Device Administrator Installation ......................... 150
6.9 Upgrading Multiple Automation Servers in Device Administrator 156
6.10 Upgrading the Enterprise Server ................................................ 158

7 Computer Maintenance ............................................. 167

7.1 Replace Enterprise Server or WebReports Computer Workflow . 169
7.1.1 Preparation ............................................................................. 169
7.1.2 Install Building Operation Software .......................................... 170
7.1.3 Restore the Enterprise Server Database .................................. 170

IT 04-13008-01-en, October 2012

6
 7.1.4 WebReports Migration Preparation ......................................... 172
7.1.5 Install WebReports .................................................................. 173

8 Uninstallation ............................................................. 175

8.1 Uninstallation ............................................................................ 177
8.2 Uninstalling the License Administrator ....................................... 178
8.3 Uninstalling the License Server .................................................. 181
8.4 Uninstalling WorkStation ........................................................... 186
8.5 Uninstalling Enterprise Server .................................................... 189
8.6 Uninstalling the Device Administrator ......................................... 194

9 Installation User interface ........................................... 197

9.1 Installation Wizard – Choose Components Page ....................... 199
9.2 Installation Wizard – Installation Type Page ................................ 201
9.3 Installation Wizard – License Server Configuration Page ............ 202
9.4 Enterprise Server Installation Wizard – Configuration Page ........ 203

10 Reports Installation .................................................... 205

10.1 WebReports Installation and Uninstallation Overview ................. 207
10.1.1 Reports Server Configuration .................................................. 207
10.1.2 WebReports Installation WorkFlow ......................................... 207
10.1.3 Windows Roles and Features .................................................. 207
10.1.4 SQL Server ............................................................................. 207
10.1.5 .NET Framework 4 .................................................................. 208
10.1.6 WebReports Installer and WebReports Components ............... 208
10.1.7 WebReports Uninstallation Workflow ....................................... 208
10.2 Reports Server Configuration .................................................... 209
10.3 WebReports Installation WorkFlow ............................................ 210
10.3.1 Installation Requirements ........................................................ 211
10.3.2 Windows Roles and Features Configuration ............................ 211
10.3.3 SQL Server Installation ............................................................ 212
10.3.4 .NET Framework 4 Installation or Repair .................................. 214
10.3.5 WebReports Installer Installation .............................................. 214
10.3.6 WebReports Application Installation ........................................ 215
10.4 Windows Roles and Features .................................................... 217
10.5 SQL Server ............................................................................... 221
10.5.1 SQL Server Version ................................................................. 221
10.5.2 SQL Server Installation Settings .............................................. 221
10.6 SQL Server Installation Settings ................................................. 222
10.7 .NET Framework 4 .................................................................... 227
10.8 WebReports Installer and WebReports Components ................ 228
10.8.1 WebReports Client .................................................................. 229
10.8.2 WebReports Service ............................................................... 230
10.8.3 Reporting Agent ...................................................................... 230
10.8.4 Report Pack ............................................................................ 230
10.8.5 ASP.NET and IIS ..................................................................... 230
10.8.6 SQL Server 2008 R2 ............................................................... 230

04-13008-01-en, October 2012 IT

7
 10.8.7 SQL Server Reporting Services and Reporting Services
Database ................................................................................ 231
10.8.8 Reports Database ................................................................... 231
10.9 Installing the WebReports Installer ............................................. 232
10.10 Installing WebReports ............................................................... 235
10.11 Detaching a WebReports Database .......................................... 247
10.12 Attaching a WebReports Database ........................................... 249
10.13 Transferring Reports Schedules ............................................... 250
10.14 Backing Up the WebReports Database ..................................... 252
10.15 Restoring the WebReports Database ........................................ 256
10.16 WebReports Uninstallation WorkFlow ....................................... 259
10.17 Uninstalling WebReports ........................................................... 262
10.18 Stopping a Windows Service ..................................................... 271

11 Reports Installation User Interface .............................. 273

11.1 Role Services Dialog Box .......................................................... 275
11.2 Features Dialog Box .................................................................. 277
11.3 Reports Installation Setup Wizard .............................................. 278
11.4 Reports Installation Setup Wizard – Select Installation Folder
Page ......................................................................................... 279
11.5 Reports Installation Setup Wizard – Confirm Installation Page .... 280
11.6 Reports Installation Setup Wizard – Installation Complete Page . 281
11.7 WebReports Installer – End User License Agreement Page ....... 282
11.8 WebReports Installer Main Page ................................................ 283
11.9 WebReports Installer – Setup Type Dialog Box .......................... 285
11.10 WebReports Installer – User Information Dialog Box .................. 286
11.11 WebReports Installer – SQL Server Dialog Box .......................... 287
11.12 WebReports Installer – Available SQL Servers Dialog Box ......... 288
11.13 WebReports Installer – Program Files and Database Path Dialog
Box ........................................................................................... 289
11.14 WebReports Installer – Reporting Agent Dialog Box .................. 290
11.15 WebReports Installer – Reporting Agent Logging Dialog Box ..... 291
11.16 WebReports Installer – WebReports Dialog Box ........................ 292
11.17 WebReports Installer – Confirmation Page ................................ 293
11.18 WebReports Installer – Check Installation Requirements Page ... 294
11.19 WebReports Installer – Requirements Check Successful Page .. 295
11.20 WebReports Installer – Pre-upgrade Configuration Page ........... 296
11.21 WebReports Installer – Pre-upgrade Configuration Successful
Page ......................................................................................... 297
11.22 WebReports Installer – Installing Reporting Agent Page ............. 298
11.23 WebReports Installer – Installing WebReports Page .................. 299
11.24 WebReports Installer – Installing WebReports Service Page ...... 300
11.25 WebReports Installer – Post-Installation Configuration Page ...... 301
11.26 WebReports Installer – Configuration Successful Page .............. 302
11.27 WebReports Installer – Installing PublishReports Page .............. 303

12 Licensing Introduction ............................................... 305

12.1 Licensing Overview ................................................................... 307

IT 04-13008-01-en, October 2012

8
 12.1.1 License System ...................................................................... 307
12.1.2 License Management .............................................................. 307
12.1.3 Service and Maintenance ........................................................ 307
12.2 License System ........................................................................ 308
12.2.1 License Activation Server ........................................................ 308
12.2.2 License Server ........................................................................ 308
12.2.3 License Administrator ............................................................. 308
12.2.4 Licenses ................................................................................. 309
12.3 License Management ................................................................ 310
12.3.1 License System Installation and Configuration ......................... 310
12.3.2 Network License Management ................................................ 311
12.3.3 Local License Management .................................................... 311
12.4 Service and Maintenance ......................................................... 312
12.4.1 License Service Maintenance .................................................. 312
12.4.2 License Maintenance .............................................................. 312
12.4.3 Diagnostics ............................................................................. 312
12.5 License Maintenance ................................................................ 314
12.5.1 Local License Removal ........................................................... 314
12.5.2 Network License Return .......................................................... 314
12.5.3 Lost License ........................................................................... 314
12.5.4 License Reparation ................................................................. 314
12.5.5 License Backup ...................................................................... 314
12.6 Licenses ................................................................................... 315
12.6.1 End User License Agreement .................................................. 315
12.6.2 Local Licenses ........................................................................ 316
12.6.3 Network Licenses .................................................................. 316
12.6.4 Time-Limited Licenses ............................................................ 316
12.6.5 Permanent License ................................................................. 316
12.6.6 License Selection Process ...................................................... 316
12.7 Viewing Activated Licenses ...................................................... 317
12.8 Editing Registration Details ........................................................ 318
12.9 License Selection Process ........................................................ 320
12.10 Order Information Request ........................................................ 321
12.11 Lost License ............................................................................. 323
12.12 License Repair .......................................................................... 324
12.13 License Backup ........................................................................ 325
12.14 Backing Up Licenses ................................................................ 326
12.15 Restoring Licenses .................................................................... 327

13 Type of Licenses ........................................................ 329

13.1 Network Licenses .................................................................... 331
13.2 Network License Management .................................................. 335
13.2.1 Order Information Request ...................................................... 335
13.2.2 Network Licenses Activation ................................................... 335
13.2.3 Enterprise Server Address Configuration ................................. 335
13.2.4 WorkStation and Client Tools Address Configuration ............... 336
13.2.5 Network License Upgrade ....................................................... 336

04-13008-01-en, October 2012 IT

9
 13.3 Network Licenses Activation ..................................................... 337
13.4 Network License Return ............................................................ 339
13.5 Activating Network Licenses .................................................... 341
13.6 Removing a Local License or Returning a Network License ....... 344
13.7 Network License Upgrade ......................................................... 346
13.8 Upgrading Network Licenses .................................................... 348
13.9 Repairing a Network License .................................................... 352
13.10 Local Licenses .......................................................................... 354
13.11 Local License Management ...................................................... 356
13.11.1 Local License Activation .......................................................... 356
13.12 Activating a Local License ........................................................ 357

14 Licensing Configuration and Diagnostics .................... 361

14.1 Enterprise Server Address Configuration ................................... 363
14.2 WorkStation and Client Tools Address Configuration ................. 365
14.3 Viewing Diagnostic Information .................................................. 366
14.4 Copying Diagnostics to the Clipboard ....................................... 367

15 License Server and License Administrator .................. 369

15.1 License Server .......................................................................... 371
15.1.1 Flexnet License Manager, License Server Manager ................. 371
15.2 Starting the License Server ........................................................ 372
15.3 Stopping the License Server ..................................................... 373
15.4 Restarting the License Server .................................................... 374
15.5 Flexnet License Administrator, License Server Manager ............ 375
15.5.1 License Server Port Number ................................................... 376
15.5.2 FLEXnet License Administrator Port Number ........................... 377
15.6 Accessing Flexnet lmadmin ....................................................... 378
15.7 Changing the lmadmin License Server Manager Port Number ... 379
15.8 License Server Address ............................................................ 380
15.9 Configuring the Address to the License Server .......................... 382
15.10 License Server Reset ................................................................ 384
15.11 Resetting the License Server ..................................................... 385
15.12 Configuring License Server Recovery Settings ........................ 387
15.13 License Server Maintenance ..................................................... 389
15.13.1 License Server Address Change ............................................. 389
15.13.2 License Server Reinstallation .................................................. 389
15.13.3 License Server Replacement ................................................... 389
15.13.4 License Server Reset .............................................................. 391
15.14 License Administrator ............................................................... 392
15.14.1 Registration Details ................................................................. 392
15.14.2 License Server Address .......................................................... 392
15.15 Starting the License Administrator ............................................. 393

16 Licensing User Interface ............................................. 395

16.1 Registration Details View ........................................................... 397
16.2 Licenses View .......................................................................... 399
16.3 Licenses View Toolbar .............................................................. 400

IT 04-13008-01-en, October 2012

10
 16.4 Licenses View Icons .................................................................. 401
16.5 Licenses View Columns ............................................................ 402
16.6 Add License Dialog Box ............................................................ 403
16.7 License Activation Dialog Box ................................................... 404
16.8 License Progress Dialog Box ..................................................... 406
16.9 License Server Address View .................................................... 407
16.10 Diagnostics View ....................................................................... 408

17 Software Administrator .............................................. 409

17.1 Software Administrator ............................................................. 411
17.1.1 Service ................................................................................... 411
17.1.2 Ports ...................................................................................... 411
17.1.3 Database Location .................................................................. 411
17.1.4 Enterprise Server System Log ................................................. 411
17.2 Enterprise Server ...................................................................... 412
17.3 Starting Software Administrator ................................................. 413
17.4 Configuring Enterprise Server Port Settings ............................... 414
17.5 Starting the Enterprise Server Windows Service ........................ 415
17.6 Stopping the Enterprise Server Windows Service ...................... 416
17.7 Restarting the Enterprise Server Windows Service ..................... 417
17.8 Enterprise Server System Log ................................................... 419
17.9 Viewing Enterprise Server System Log ...................................... 420
17.10 Software Administrator – Enterprise Server View ....................... 421

18 User Account Management ....................................... 423

18.1 User Account Management Overview ....................................... 425
18.1.1 User Accounts and User Account Groups ............................... 426
18.1.2 Domains ................................................................................. 426
18.1.3 Software Permissions ............................................................. 426
18.1.4 Log on Methods ..................................................................... 426
18.1.5 Workspaces ........................................................................... 426
18.1.6 Guest Log On in WebStation ................................................... 427
18.2 Opening the Account Management Control Panel ..................... 428
18.3 User Accounts and User Account Groups ................................. 429
18.3.1 Window Active Directory User Groups ..................................... 430
18.3.2 WorkStation Account Management ......................................... 431
18.4 Creating a User Account ........................................................... 432
18.5 Editing a User Account Profile ................................................... 436
18.6 Renaming a User Account ........................................................ 438
18.7 Disabling a User Account .......................................................... 440
18.8 Enabling a Disabled User Account ............................................. 442
18.9 Setting an Expiration Date for a User Account ........................... 444
18.10 Removing the Expiration Date for a User Account ...................... 446
18.11 Deleting a User Account ............................................................ 448

19 User Account Groups ................................................ 451

19.1 Windows Active Directory User Groups ..................................... 453
19.2 Creating a User Account Group ................................................ 455

04-13008-01-en, October 2012 IT

11
 19.3 Editing the Description of a User Account Group ....................... 460
19.4 Adding a User Account to a User Account Group ..................... 462
19.5 Removing a User Account from a User Account Group ............. 464
19.6 Reviewing the User Account Group Memberships for a User
Account .................................................................................... 466
19.7 Adding a User Account Group to a User Account Group ........... 468
19.8 Removing a User Account Group from another User Account
Group ....................................................................................... 471
19.9 Reviewing the User Account Group Memberships for a User
Account Group ......................................................................... 473
19.10 Preventing a Group of Users from Exiting WorkStation .............. 475
19.11 Enabling a Group of Users to Exit Workstation ........................... 477
19.12 Deleting a User Account Group ................................................. 479

20 Domains .................................................................... 481

20.1 Domains ................................................................................... 483
20.1.1 Windows Active Directory Domain ........................................... 484
20.1.2 Server Local Domain ............................................................... 485
20.1.3 Administration Accounts in Server Local Domain ..................... 485
20.2 Log On Methods ....................................................................... 486
20.2.1 Log On as a Windows User ..................................................... 486
20.2.2 Log On as a Building Operation User ....................................... 486
20.2.3 Password Administration ........................................................ 486
20.3 Guest Log On in WebStation ..................................................... 487
20.4 Creating and Configuring a Domain ........................................... 488
20.5 Editing the Windows Domain Name .......................................... 492
20.6 Editing the Description of a Domain ........................................... 494
20.7 Editing the Maximum Logon Attempts ....................................... 496
20.8 Assigning a Server to a Domain ................................................. 498
20.9 Removing a Server from a Domain ............................................ 500
20.10 Deleting a Domain ..................................................................... 502
20.11 Administration Accounts in Server Local Domain ....................... 504
20.11.1 Admin Account ....................................................................... 504
20.11.2 Reports Administrator Account ............................................... 504

21 Software Permissions ................................................ 505

21.1 Software Permissions ............................................................... 507
21.1.1 Path Permissions .................................................................... 507
21.1.2 Command Permissions ........................................................... 507
21.1.3 Software Permission Rules ...................................................... 507
21.1.4 Software Permissions and User Account Groups .................... 507
21.1.5 Software Permissions Summary .............................................. 508
21.2 Software Permissions and User Account Groups ...................... 509
21.3 Software Permission Rules ........................................................ 511
21.4 Path Permissions ...................................................................... 512
21.5 Command Permissions ............................................................ 515
21.6 Assigning Software Permissions to a User Account ................... 517
21.7 Editing the Software Permissions of a User Account .................. 519

IT 04-13008-01-en, October 2012

12
 21.8 Assigning Software Permissions to a User Account Group ........ 521
21.9 Editing the Software Permissions of a User Account Group ....... 524

22 Login Configuration .................................................... 529

22.1 Password Administration .......................................................... 531
22.2 Editing a User Account Password ............................................. 532
22.3 Allowing Users to Change their Password ................................. 534
22.4 Changing Your Password ......................................................... 536
22.5 Turning off Remember Me On This Computer ........................... 537
22.6 Forcing a User to Change the Password at Next Logon ............. 538
22.7 Preventing Users from Changing Their Passwords .................... 540
22.8 Resetting the Administrator Password ....................................... 542

23 Workspaces .............................................................. 543

23.1 Workspaces ............................................................................. 545
23.1.1 Predefined Workspaces .......................................................... 545
23.1.2 Workspace Components and Customization .......................... 546
23.1.3 WebStation in Kiosk Mode ...................................................... 546
23.2 Predefined Workspaces ............................................................ 547
23.3 Workspace Components and Customization ............................ 548
23.3.1 Workspace Component Customization ................................... 548
23.3.2 Workspace Content References .............................................. 549
23.3.3 Panel Components ................................................................. 549
23.4 Workspace Component Customization ..................................... 550
23.5 Workspace Content References ................................................ 552
23.6 Panel Components ................................................................... 553
23.7 Creating a Workspace ............................................................... 554
23.8 Editing the Layout of a Workspace ............................................ 558
23.9 Editing the Description of a Workspace ..................................... 561
23.10 Adding a Component to a Workspace ....................................... 563
23.11 Removing a Component from a Workspace .............................. 567
23.12 Editing a Workspace Component .............................................. 569
23.13 Adding a Workspace to a User Account Group ......................... 571
23.14 Removing a Workspace from a User Account Group ................. 573
23.15 Reviewing the Workspace Memberships for a User Account
Group ....................................................................................... 575
23.16 Creating a Panel ....................................................................... 577
23.17 Editing a Panel .......................................................................... 581
23.18 WebStation in Kiosk Mode ........................................................ 582
23.18.1 Configure WebStation to Run in Kiosk Mode ........................... 582
23.19 Configuring WebStation to Run in Kiosk Mode .......................... 584

24 Audit Trails ................................................................. 587

24.1 WorkStation Account Management .......................................... 589
24.1.1 Audit Trailing of User Activity ................................................... 589
24.1.2 WorkStation Account Validation .............................................. 589
24.2 Audit Trailing of User Activity ..................................................... 590
24.3 Disabling Audit Trail for a Group of Users ................................... 591

04-13008-01-en, October 2012 IT

13
 24.4 Enabling Audit Trail for a Group of Users ................................... 593
24.5 Viewing an Audit Trail Log ......................................................... 595
24.6 WorkStation Account Validation ................................................ 597

25 User Management User Interface ............................... 599

25.1 User Management System Tree Icons ....................................... 603
25.2 Domain Properties .................................................................... 604
25.3 Profile Properties ....................................................................... 605
25.4 Workspace Properties ............................................................... 606
25.5 Pane Properties ........................................................................ 608
25.6 Panel Properties ........................................................................ 609
25.7 Building Operation WorkStation Window ................................... 610
25.8 Domain Control Panel ............................................................... 612
25.9 Account Management Control Panel ......................................... 613
25.10 Select Default Workspace Window ............................................ 616
25.11 Change Password Dialog Box ................................................... 617
25.12 Domain Wizard – Authentication Page ....................................... 618
25.13 Domain Wizard – Domain Policies Page .................................... 619
25.14 Domain – Summary Tab ........................................................... 620
25.15 Domain – Policies Tab ............................................................... 621
25.16 Domain – Domain Members Tab ............................................... 622
25.17 User Account – Summary Tab .................................................. 623
25.18 User Account – Group Membership Tab ................................... 624
25.19 User Account – Profile Tab ........................................................ 626
25.20 User Account – Software Permissions Tab ................................ 627
25.21 User Account – Audit Trailing Events Tab .................................. 628
25.22 User Account Group Properties ................................................ 629
25.23 User Account Properties ........................................................... 630
25.24 User Account Group Wizard – Users Belonging to this Group
Page ......................................................................................... 631
25.25 User Account Group Wizard – Workspaces Belonging to this Group
Page ......................................................................................... 633
25.26 User Account Group Wizard – Windows Group Name and Group
Polices Page ............................................................................. 635
25.27 User Account Group – Summary Tab ........................................ 637
25.28 User Account Group – Policies Tab ........................................... 638
25.29 User Account Group – Group Membership Tab ........................ 639
25.30 User Account Group – Software Permissions Tab ..................... 641
25.31 User Account Group – Workspaces Tab ................................... 643
25.32 User Account Wizard – General Page ........................................ 644
25.33 User Account Wizard – Member Of Page .................................. 645
25.34 User Account Management Folder Properties ........................... 647
25.35 Workspace Wizard – Workspace Configuration Page ................ 648
25.36 Workspace Wizard – Pane Configuration Page .......................... 650
25.37 Workspace – Summary Tab ...................................................... 651
25.38 Workspace – Content Tab ........................................................ 652
25.39 Edit Layout Workspace ............................................................. 654
25.40 Workspace – Members Tab ...................................................... 655

IT 04-13008-01-en, October 2012

14
 25.41 Panel Wizard – Panel Configuration Page .................................. 656
25.42 Domain Wizard – Domain Members Page ................................. 657
25.43 Domains Properties ................................................................... 658
25.44 Local Properties ........................................................................ 659
25.45 Work Area Window Properties .................................................. 660
25.46 Create Work Area Window Wizard – Name Page ...................... 661

26 Backup and Restore .................................................. 663

26.1 Backup and Restore ................................................................. 665
26.1.1 Building Operation Backup ..................................................... 665
26.1.2 Building Operation Restore ..................................................... 666
26.1.3 BACnet Backup and Restore .................................................. 666
26.1.4 Archiving ................................................................................ 666
26.1.5 Summary of Backup and Restore Methods ............................. 666
26.2 Comparison of Backup and Restore Methods .......................... 667
26.3 Local Backup and Restore of a Standalone Automation Server . 670
26.4 Local Backup and Restore of an Enterprise Server .................... 671
26.5 Remote Backup and Restore of Automation Servers ................. 672

27 Backups .................................................................... 673

27.1 Building Operation Backup ....................................................... 675
27.1.1 Backup Sets ........................................................................... 676
27.1.2 Scheduled Backups ................................................................ 676
27.1.3 Manual Backups ..................................................................... 676
27.1.4 Multi-server Backups .............................................................. 676
27.1.5 Backup Status ........................................................................ 677
27.2 Backup Status .......................................................................... 678
27.3 Checking the Backup Status of a Server ................................... 679
27.4 Manual Backups ....................................................................... 680
27.5 Backing Up a Server Manually ................................................... 683
27.6 Multi-server Backup .................................................................. 686
27.6.1 Local Backup of a Standalone Automation Server ................... 687
27.6.2 Local Backup of an Enterprise Server ...................................... 687
27.6.3 Remote Backup of Multiple Automation Servers ...................... 687
27.7 Backing Up Multiple Servers ...................................................... 688
27.8 System Backup ........................................................................ 690

28 Backup Sets .............................................................. 693

28.1 Backup Sets ............................................................................. 695
28.1.1 Backup Set Storage and Protection ........................................ 696
28.1.2 Backup Set Import from WorkStation ...................................... 696
28.1.3 Automatic Purge of Backup Sets ............................................ 696
28.2 Backup Set Storage and Protection .......................................... 697
28.3 Locating the Local Backup Path on the Enterprise Server .......... 699
28.4 Copying an Automation Server Backup Set to WorkStation ....... 700
28.5 Copying an Enterprise Server Backup Set to WorkStation ......... 702
28.6 Copying a Backup Set to the Enterprise Server Local Directory . 703
28.7 Backup Set Import from WorkStation ........................................ 705

04-13008-01-en, October 2012 IT

15
 28.8 Importing a Backup Set from WorkStation to an Automation
Server ....................................................................................... 706
28.9 Automatic Purge of Backup Sets ............................................... 707
28.10 Configuring Purge Settings on an Enterprise Server ................... 709
28.11 Deleting a Backup Set from the Enterprise Server ...................... 710

29 Scheduled Backups ................................................... 713

29.1 Scheduled Backups .................................................................. 715
29.1.1 Backup Rules ......................................................................... 715
29.1.2 Backup Schedules .................................................................. 716
29.1.3 Synchronized Backups ........................................................... 716
29.2 Backup Rules ........................................................................... 717
29.3 Creating a Backup Rule ............................................................ 718
29.4 Editing a Backup Rule ............................................................... 720
29.5 Deleting a Backup Rule ............................................................. 722
29.6 Removing a Lead Rule from a Backup Rule ............................... 723
29.7 Backup Schedules .................................................................... 724
29.8 Editing a Backup Schedule ....................................................... 725
29.9 Synchronized Backups ............................................................. 726
29.10 Synchronizing Server Backups on a Network ............................ 727

30 Restore ...................................................................... 729

30.1 Building Operation Restore ....................................................... 731
30.1.1 Restore Status ........................................................................ 732
30.1.2 Automation Server Replacement Using Restore ...................... 732
30.2 Restore Status .......................................................................... 733
30.3 Restoring a Server Manually ...................................................... 734
30.4 Restoring an Automation Server from the Enterprise Server ....... 736
30.5 Automation Server Replacement Using Restore ........................ 738

31 Backup and Restore User Interface ............................ 741

31.1 Backup and Restore Manager Properties (Enterprise Server) – Basic
Tab ........................................................................................... 743
31.2 Backup and Restore Manager Properties (Automation Server) –
Basic Tab ................................................................................. 745
31.3 Backup and Restore Manager on the Enterprise Server ............. 746
31.4 Backup and Restore Manager on an Automation Server ............ 747
31.5 Backup Options Dialog Box ...................................................... 748
31.6 Backup Rule Properties – Basic Tab ......................................... 750
31.7 Backup Rules View ................................................................... 751
31.8 Backup Rules Toolbar ............................................................... 752
31.9 Backup Rules List ..................................................................... 753
31.10 Backup Schedule Properties – Basic Tab .................................. 754
31.11 Backup Set Properties – Basic Tab ........................................... 757
31.12 Backup Sets View ..................................................................... 758
31.13 Backup Status Dialog Box ......................................................... 759
31.14 Control Panel – Backup and Archiving ....................................... 760
31.15 Backup Rule Dialog Box ............................................................ 761

IT 04-13008-01-en, October 2012

16
 31.16 Enterprise Engineering System Tree Icons ................................. 762
31.17 Restore Options Dialog Box ...................................................... 763
31.18 Restore Status Dialog Box ........................................................ 764
31.19 Backup and Restore Folder Properties ...................................... 765

04-13008-01-en, October 2012 IT

17
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
Typographical Conventions
 1 About This Guide
1.1 Purpose of This Guide

1.1 Purpose of This Guide

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

04-13008-01-en, October 2012 IT

23
1 About This Guide
1.2 How This Guide is Organized

1.2 How This Guide is Organized

This 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 Building Operation Reference Guides.

IT 04-13008-01-en, October 2012

24
 1 About This Guide
1.3 Typographical Conventions

1.3 Typographical Conventions

Building Operation Guides use the following specially marked texts:

Tip
Helps you understand the benefits and capabilities of the product.

Note
Provides you with supplementary information.

Important
Alerts you to supplementary information that is essential to the completion of a
task.

Caution
Alerts you to a condition that can cause loss of data.

Warning
Alerts you to a condition that can cause product damage or physical harm.

Bold texts:
User interface items, such as property names and buttons, are written in bold, for
example "On the File menu, select New
New."

04-13008-01-en, October 2012 IT

25
2 Additional Information

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

2.1 Where to Find Additional Information

All the technical Building Operation information is available online, on WebHelp.
You also find additional information in the Building Operation Guides:
• Hardware Reference Guide
• Plain English and Script Difference Guide
• Function Block Editor and Menta Editor Difference Guide
• WebReports Reference Guide
• WebReports Operating Guide
• System Reference Guide
• Technical Reference Guide
• WorkStation Operating Guide
• IT Reference Guide
• WebStation Operating Guide
• Upgrade Reference Guide
• Administering Reports Tutorial Guide
• Configuring an Automation Server as a Controller Tutorial Guide
• Creating and Configuring a LonWorks Network with Xenta LonWorks Devices
Tutorial Guide
• Creating and Configuring a Modbus Network Tutorial Guide
• Creating and Configuring Alarms Tutorial Guide
• Creating and Configuring Graphics Tutorial Guide
• Creating and Configuring Schedules Tutorial Guide
• Creating and Configuring Trend Logs Tutorial Guide
• Creating and Configuring Users Tutorial Guide
• Starting a Project Tutorial Guide
• Creating and Configuring a BACnet Network with b3 BACnet Devices Tutorial
Guide

04-13008-01-en, October 2012 IT

29
2 Additional Information
2.2 Regulatory Notices

2.2 Regulatory Notices

UL 916 Listed products for the Unites States and Canada, Open
Class Energy Management Equipment.

WEEE - Directive of the European Union (EU)

This equipment and its packaging carry the waste of electrical and electronic
equipment (WEEE) label, in compliance with European Union (EU) Directive
2002/96/EC, governing the disposal and recycling of electrical and electronic
equipment in the European community.

CE - Compliance to European Union (EU)

2004/108/EC Electromagnetic Compatibility Directive
This equipment complies with the rules, of the Official Journal of the European
Union, for governing the Self Declaration of the CE Marking for the European Union
as specified in the above directive(s) per the provisions of the following standards:
IEC/EN 61326-1 Product Standard, IEC/EN 61010-1 Safety Standard.

Industry Canada
ICES-003
This is a Class B digital device that meets all requirements of the Canadian
Interference Causing Equipment Regulations.

C-Tick (Australian Communications Authority (ACA))

AS/NZS 3548
This equipment carries the C-Tick label and complies with EMC and radio
communications regulations of the Australian Communications Authority (ACA),
governing the Australian and New Zealand (AS/NZS) communities.

Federal Communications Commission

FCC Rules and Regulations CFR 47, Part 15, Class B
This device complies with part 15 of the FCC Rules. Operation is subject to the
following two conditions: (1) This device may not cause harmful interference. (2)
This device must accept any interference received, including interference that may
cause undesired operation.

IT 04-13008-01-en, October 2012

30
Reference

The Reference part contains conceptual information,

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

Topics
Installation of Building Operation
Products
Installation Example
Version Numbers and Parallel Installations
Installing the License Administrator and the License Server
Installing WorkStation and Client Tools
Installing a Language Package
Installing the Enterprise Server
Installing the Device Administrator
 3 Installation
3.1 Installation of Building Operation

3.1 Installation of Building Operation

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

3.1.1 Installation Packages

Building Operation 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
The installation files for Graphic Editor, Script Editor, Menta Editor, Function Block
Editor, and WorkPlace Tech Editor are bundled into the WorkStation installation
package.
All Building Operation products are installed in a default application folder. On
Windows operating systems this folder is located in C:\ProgramData\Schneider
Electric StruxureWare\Building Operation x.x, where x.x is the version number.

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

3.1.3 Installation Example

Schneider Electric recommends that you install the license server framework before
other Building Operation hardware or software. 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 41.

3.1.4 Installation Reparation

If something unexpected happens to a Building Operation product, for example, the
Building Operation product does not start or software files are missing, you can try
to solve the problem by repairing the installation.

04-13008-01-en, October 2012 IT

35
3 Installation
3.1 Installation of Building Operation

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

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

3.1.6 System Upgrade Overview

A system upgrade can include an Enterprise Server, Reports Server, one or more
Automation Servers and WorkStations, and the supporting administrator software,
such as Device Administrator.
For more information, see section 6.1 “System Upgrade Overview” on page 123.

3.1.7 Uninstallation
To uninstall a Building Operation product you use the Windows Add Remove
Program tool. The Windows Add Remove Program tool permanently removes the
Building Operation product from the computer or server.
For more information, see section 8.1 “Uninstallation” on page 177.

3.1.8 Version Numbers and Parallel Installations

The Building Operation 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 43.

3.1.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 17.1 “Software Administrator” on page 411.

IT 04-13008-01-en, October 2012

36
 3 Installation
3.2 Products

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

3.2.1 WorkStation
WorkStation is the interface where you supervise your Building Operation system. In
WorkStation you can also create, modify, and delete some of the objects that are
used to build a Building Operation system.

Important
Ensure that you have a working and available WorkStation license. A working
license is required to log on to WorkStation. For more information, see section
12.6 “Licenses” on page 315.

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

3.2.2 Graphics Editor

You can use Graphics Editor to create and edit graphics representing a site and the
devices that make up the site.

Important
You have to have a valid Graphics Editor license to start the Graphics Editor. For
more information, see section 12.6 “Licenses” on page 315.

The installation of Graphics Editor is bundled into the WorkStation installation

package.
For more information, see WebHelp.

3.2.3 Script Editor

Script Editor is a text programming tool you use to create Script programs that
control and monitor building automation systems. For example, in WorkStation, you
can create a basic program, called OfficeLights, to control lighting and ventilation in
a room based on occupancy.

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

04-13008-01-en, October 2012 IT

37
3 Installation
3.2 Products

The installation of Script Editor is bundled into the WorkStation installation package.
For more information, see 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.

Important
Ensure that you have a working and available Menta Editor license. A working
license is required to start the Menta Editor software. For more information, see
section 12.6 “Licenses” on page 315.

The installation of Menta Editor is bundled into the WorkStation installation

package.
TAC Menta, Technical Manual (04-00030).

3.2.5 Function Block Editor

Function Block Editor is a graphical programming tool for Automation Servers,
which you use to create function block programs that control and monitor building
automation systems. For example, you create a basic program, called OfficeLight,
to control lighting in a room based on occupancy.

Important
Ensure that you have a working and available Function Block Editor license. A
working license is required to start the Function Block Editor software. For more
information, see section 12.6 “Licenses” on page 315.

The installation of Function Block Editor is bundled into the WorkStation installation
package.
For more information, see WebHelp.

3.2.6 WorkPlace Tech

The WorkPlace Tech component of Building Operation WorkStation consists of two
graphical tools: WorkPlace Tech Monitor and WorkPlace Tech Editor. With these
tools you can view, examine, and program MNL LonWorks device applications.

Important
Ensure that you have a working and available WorkPlace Tech license. A working
license is required to start the WorkPlace Tech Editor or WorkPlace Tech Monitor
software. For more information, see section 12.6 “Licenses” on page 315.

IT 04-13008-01-en, October 2012

38
 3 Installation
3.2 Products

The installation of WorkPlace Tech is bundled into the WorkStation installation

package.
For more information, see WebHelp.

3.2.7 Enterprise Server

The Enterprise Server is a hierarchical top server that is primarily used for system
supervision and engineering. As the dedicated top server, the Enterprise Server
provides you with a system entry point. Through the Enterprise Server, you can
view and access all resources in the system.

Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see
section 12.6 “Licenses” on page 315.

For more information, see WebHelp.

3.2.8 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 17.1 “Software Administrator” on page 411.

3.2.9 Device Administrator

The Device Administrator is used to configure and upgrade the software of
Automation Servers through a network or USB connection.
For more information, see WebHelp.

3.2.10 License Administrator

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

3.2.11 License Server

The license server manages the administration of network licenses. A Building
Operation system running with network licenses must contain at least one license
server.
For more information, see section 15.1 “License Server” on page 371.

04-13008-01-en, October 2012 IT

39
3 Installation
3.2 Products

The License Server Installation is bundled into the License Administration installation
package.

3.2.12 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 WebHelp.

3.2.13 Language Package

At the main installation, WorkStation and servers only contain English. To support a
language other than English, you need to install the specific language package on
your WorkStation.
For more information, see WebHelp.

IT 04-13008-01-en, October 2012

40
 3 Installation
3.3 Installation Example

3.3 Installation Example

Schneider Electric recommends that you install the license server framework before
other Building Operation hardware or software. 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 to activate as time-limited local licenses are included in the installation
of Building Operation. The local license files are in the following paths:
• Windows XP: \Documents and Settings\All Users\Application Data\Schneider
Electric StruxureWare\Building Operation x.x\License Files\
• Windows server 2008: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\License Files\
• Windows 7: \ProgramData\Schneider Electric StruxureWare\Building
Operation x.x\License Files\
The x.x represents the version number. For more information, see section 13.10
“Local Licenses” on page 354.

Note
• Plan the license management carefully and purchase network licenses early
to avoid unexpected operational stops caused by expired local licenses.

This work flow describes a Building Operation system where license server and
Enterprise Server are located on the same computer.
To install Building Operation smoothly use the following installation order:

Figure: Installation and configuration order

04-13008-01-en, October 2012 IT

41
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 13.2 “Network License
Management” on page 335.
• 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-13008-01-en, October 2012

42
 3 Installation
3.4 Version Numbers and Parallel Installations

3.4 Version Numbers and Parallel

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

Figure: Building Operation version number structure

Table: 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-13008-01-en, October 2012 IT

43
3 Installation
3.4 Version Numbers and Parallel Installations

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

IT 04-13008-01-en, October 2012

44
 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 Building Operation licenses. A Building
Operation system must consist of at least one license server. The License
Administrator has to be installed on all clients or servers that run any licensed
Building Operation products.
For more information, see section 3.2 “Products” on page 37.

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
Yes, to confirm that you want to run the License Administrator
installation package.

3. Click Next
Next.

Continued on next page

04-13008-01-en, October 2012 IT

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

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

5. Select the components you want to install and then click Next
Next.

6. In the License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

Continued on next page

IT 04-13008-01-en, October 2012

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

7. Click Install
Install.
8. Click Next
Next.

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

Continued on next page

04-13008-01-en, October 2012 IT

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

9. 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 15.12 “Configuring License Server Recovery Settings ” on page 387.

IT 04-13008-01-en, October 2012

48
 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 Building
Operation system.

Important
Ensure that you have a working and available WorkStation, Graphics, Script, and
Menta / Function Block licenses. A working license for each product is required to
start and log on. For more information, see section 12.6 “Licenses” on page 315.

For more information, see section 3.1 “Installation of Building Operation” on page
35.

To install WorkStation and client tools

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

Important
If User Account Control (UAC) is enabled on the computer on which
you are installing WorkStation, you must run the installer as an
administrator. To do this, right-click the WorkStation installation file
and then, in the shortcut menu, choose Run as administrator
administrator.

2. Click Yes
Yes, to confirm that you want to run the Workstation installation pakage.

Continued on next page

04-13008-01-en, October 2012 IT

49
3 Installation
3.6 Installing WorkStation and Client Tools

3. Click Next
Next.

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

Continued on next page

IT 04-13008-01-en, October 2012

50
 3 Installation
3.6 Installing WorkStation and Client Tools

5. Select the components that you want to install and then click Next
Next.

6. In the License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

7. Click Install
Install.
Continued on next page

04-13008-01-en, October 2012 IT

51
3 Installation
3.6 Installing WorkStation and Client Tools

8. Click Next
Next.

9. Click Finish
Finish.

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

IT 04-13008-01-en, October 2012

52
 3 Installation
3.7 Installing a Language Package

3.7 Installing a Language Package

You install language packages to support languages other than English.

Note
• A WorkStation installation is a prerequisite to install additional language
packages.
• The version of the language package to install must correspond with your
Workstation version.

For more information, see section 3.1 “Installation of Building Operation” on page
35.

To install language package

1. Double-click on the Language Package installation file to start the installation
wizard.
2. Click Yes
Yes, to confirm that you want to run the Workstation installation pakage.

Continued on next page

04-13008-01-en, October 2012 IT

53
3 Installation
3.7 Installing a Language 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.

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

Continued on next page

IT 04-13008-01-en, October 2012

54
 3 Installation
3.7 Installing a Language Package

6. Click Finish
Finish.

The language to display in WorkStation is determined by the operating system

language on which the WorkStation is installed

04-13008-01-en, October 2012 IT

55
3 Installation
3.8 Installing the Enterprise Server

3.8 Installing the Enterprise Server

You install the Enterprise Server to collect data throughout the Building Operation
system while providing supervisory control.

Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see
section 12.6 “Licenses” on page 315.

For more information, see section 3.1 “Installation of Building Operation” on page
35.

To install the Enterprise Server

1. Double-click on the Enterprise Server installation file to start the installation
wizard.
2. Click Yes to confirm that you want to run the Workstation installation package.

Continued on next page

IT 04-13008-01-en, October 2012

56
 3 Installation
3.8 Installing the Enterprise Server

3. Click Next
Next.

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

Continued on next page

04-13008-01-en, October 2012 IT

57
3 Installation
3.8 Installing the Enterprise Server

5. Select Enterprise Server and then click Next

Next.

6. In the Database Folder box, enter the path to the location where you want to
save the Enterprise Server database.

Important
• The database folder path can contain up to 140 characters
• The database folder path can only contain ASCII characters.

7. Click Next
Next.
Continued on next page

IT 04-13008-01-en, October 2012

58
 3 Installation
3.8 Installing the Enterprise Server

8. In the HTTP Port box, type the port number the Enterprise Server listens to
when communicating through the Hypertext Transfer Protocol.

9. In the HTTPS Port box, type the port numer the Enterprise Server listens to
when communicating through the Hypertext Transfer Protocol Secure.
10. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.
11. Click Next
Next.
12. In the License Server Address box, type @ and then type the address to the
License Server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

Continued on next page

04-13008-01-en, October 2012 IT

59
3 Installation
3.8 Installing the Enterprise Server

13. Click Install

Install.
14. Click Next
Next.

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

Continued on next page

IT 04-13008-01-en, October 2012

60
 3 Installation
3.8 Installing the Enterprise Server

15. Click Finish

Finish.

04-13008-01-en, October 2012 IT

61
3 Installation
3.9 Installing the Device Administrator

3.9 Installing the Device Administrator

You install the Device Administrator to configure and upgrade the software of
Automation Servers through a network or USB connection.
For more information, see section 3.1 “Installation of Building Operation” on page
35.

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

3. Click Next
Next.

Continued on next page

IT 04-13008-01-en, October 2012

62
 3 Installation
3.9 Installing the Device Administrator

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

5. Select Device Administrator and then click Next.

6. Click Next
Next.

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

Continued on next page

04-13008-01-en, October 2012 IT

63
3 Installation
3.9 Installing the Device Administrator

7. Click Finish
Finish.

IT 04-13008-01-en, October 2012

64
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 a Building Operation product, for example, the
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 a Building Operation
product, the current product related database, files created by the user, and user
settings are kept intact. System files are replaced with the files from the installation
package.

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

04-13008-01-en, October 2012 IT

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

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

To repair the License Administrator and License Server

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

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

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

Server.

Continued on next page

IT 04-13008-01-en, October 2012

68
 4 Installation Repair
4.2 Repairing the License Administrator and the License 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.

Continued on next page

04-13008-01-en, October 2012 IT

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

7. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

8. Select the components you want to repair and then click Next
Next.

Continued on next page

IT 04-13008-01-en, October 2012

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

9. Select Repair current version to repair the current License Administrator

installation.

10. Click Next

Next.
11. Select Repair current version to repair the current License Server installation.

12. Click Next

Continued on next page

04-13008-01-en, October 2012 IT

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

13. In the License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

14. Click Install

Install.
15. Click Next
Next.

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

Continued on next page

IT 04-13008-01-en, October 2012

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

16. Click Finish

Finish.

04-13008-01-en, October 2012 IT

73
4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

4.3 Repairing WorkStation and Client Tools

Installation
You repair the WorkStation and client tools installation if any problems are caused
by the current installation.

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

Note
During the reparation of WorkStation, additional language packages are removed.

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

To repair the WorkStation and client tool installation

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

Important
If User Account Control (UAC) is enabled on the computer on which
you are installing WorkStation, you must run the installer as an
administrator. To do this, right-click the WorkStation installation file
and then, in the shortcut menu, choose Run as administrator
administrator.

2. Click Yes
Yes, to confirm that you want to run the Workstation installation
package.

Continued on next page

IT 04-13008-01-en, October 2012

74
 4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

3. Click Next
Next.

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

Continued on next page

04-13008-01-en, October 2012 IT

75
4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

5. Select the components that you want to repair and then click Next
Next.

6. Select Repair current version

version.

7. Click Next
Next.
Continued on next page

IT 04-13008-01-en, October 2012

76
 4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

8. In the License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

9. Click Install
Install.
10. Click Next
Next.

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

Continued on next page

04-13008-01-en, October 2012 IT

77
4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

11. Click Finish

Finish.

IT 04-13008-01-en, October 2012

78
 4 Installation Repair
4.4 Repairing the Enterprise Server

4.4 Repairing the Enterprise Server

You repair the Enterprise Server installation if any problems are caused by the
current installation.

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

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

To repair the Enterprise Server

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

Continued on next page

04-13008-01-en, October 2012 IT

79
4 Installation Repair
4.4 Repairing the Enterprise Server

5. Click Stop Service

Service.

6. Double-click on the Enterprise Server installation file to start the installation

wizard.
7. Click Yes
Yes, to confirm that you want to run the Workstation installation
package.

Continued on next page

IT 04-13008-01-en, October 2012

80
 4 Installation Repair
4.4 Repairing the Enterprise Server

8. Click Next
Next.

9. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

Continued on next page

04-13008-01-en, October 2012 IT

81
4 Installation Repair
4.4 Repairing the Enterprise Server

10. Select Enterprise Server and then click Next

Next.

11. Click Next

Next.

Continued on next page

IT 04-13008-01-en, October 2012

82
 4 Installation Repair
4.4 Repairing the Enterprise Server

12. In the Enterprise Server Installation Type

Type, select Repair current version to
repair the current Enterprise Server installation.

13. Click Next

Next.
14. In the HTTP Port box, type the port number the Enterprise Server listens to
when communicating through the Hypertext Transfer Protocol.

15. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.
16. Click Next
Next.
Continued on next page

04-13008-01-en, October 2012 IT

83
4 Installation Repair
4.4 Repairing the Enterprise Server

17. In the License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

18. Click Install

Install.
19. Click Next
Next.

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

Continued on next page

IT 04-13008-01-en, October 2012

84
 4 Installation Repair
4.4 Repairing the Enterprise Server

20. Click Finish

Finish.

04-13008-01-en, October 2012 IT

85
4 Installation Repair
4.5 Repairing the Device Administrator Installation

4.5 Repairing the Device Administrator

Installation
You repair the Device Administrator installation if any problems are caused by the
current installation.

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

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

To repair the Device Administrator installation

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.

Continued on next page

IT 04-13008-01-en, October 2012

86
 4 Installation Repair
4.5 Repairing the Device Administrator Installation

3. Click Next
Next.

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

Continued on next page

04-13008-01-en, October 2012 IT

87
4 Installation Repair
4.5 Repairing the Device Administrator Installation

5. Select Device Administrator and then click Next

Next.

6. Select Repair current version

version.

7. Click Next
Next.
8. Click Next
Next.

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

Continued on next page

IT 04-13008-01-en, October 2012

88
 4 Installation Repair
4.5 Repairing the Device Administrator Installation

9. Click Finish
Finish.

04-13008-01-en, October 2012 IT

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

Caution
Back up the Enterprise Server before reinstalling the product. All user settings,
database information, and system files related to this product are erased and
replaced. For more information, see section 27.5 “Backing Up a Server Manually”
on page 683.

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 Building Operation product within the same major and minor
version number but lower maintenance number, the installation wizard asks if you
want to uninstall the current version before installing this package.

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

04-13008-01-en, October 2012 IT

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

To reinstall the License Administrator and License Server

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

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

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

Server.

3. Select Stop
Stop.
4. Double-click on the License Administrator installation file to start the
installation wizard.
Continued on next page

IT 04-13008-01-en, October 2012

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

5. Click Yes
Yes, to confirm that you want to run the License Administrator
installation package.

6. Click Next
Next.

Continued on next page

04-13008-01-en, October 2012 IT

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

7. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

8. Select the components you want to reinstall and then click Next
Next.

Continued on next page

IT 04-13008-01-en, October 2012

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

9. Select Uninstall current version before reinstalling to reinstall the current

License Administrator installation.

10. Click Next

Next.
11. Select Uninstall current version before reinstalling to reinstall the current
License Server installation.

12. Click Next

Next.
Continued on next page

04-13008-01-en, October 2012 IT

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

13. In the License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

14. Click Install to start the installation procedure of License Administrator.

Continued on next page

IT 04-13008-01-en, October 2012

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

15. Click Uninstall to uninstall the current installation of License Administrator

before the new version is installed.

16. Click Close

Close.

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

Continued on next page

04-13008-01-en, October 2012 IT

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

17. Click Uninstall to uninstall the current installation of License Server before the
new version is installed.

18. Click Close

Close.

Continued on next page

IT 04-13008-01-en, October 2012

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

19. Click Next

Next.

20. Click Finish to close the installation wizard.

04-13008-01-en, October 2012 IT

101
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

5.3 Reinstalling WorkStation and Client

Tools
You reinstall WorkStation and client tools to replace your current installation with a
fresh copy.

Important
For reinstallation, it is assumed that you already have working and available
WorkStation, Graphics, Script, and Menta / Function Block licenses. A working
license for each product is required to start and log on. If necessary, acquire the
needed licenses. For more information, see section 12.6 “Licenses” on page 315.

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

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

To reinstall WorkStation and client tool installation

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

Important
If User Account Control (UAC) is enabled on the computer on which
you are installing WorkStation, you must run the installer as an
administrator. To do this, right-click the WorkStation installation file
and then, in the shortcut menu, choose Run as administrator
administrator.

2. Click Yes
Yes, to confirm that you want to run Workstation installation pakage.

Continued on next page

IT 04-13008-01-en, October 2012

102
 5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

3. Click Next
Next.

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

Continued on next page

04-13008-01-en, October 2012 IT

103
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

5. Select the components that you want to reinstall and then click Next
Next.

6. Select Uninstall current version before reinstalling

reinstalling.

7. Click Next
Next.
Continued on next page

IT 04-13008-01-en, October 2012

104
 5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

8. In the License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

9. Click Install
Install.
10. Click Uninstall to remove you current installation.

Continued on next page

04-13008-01-en, October 2012 IT

105
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

11. Click Close

Close.

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

12. Click Next

Next.

Continued on next page

IT 04-13008-01-en, October 2012

106
 5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

13. Click Finish

Finish.

04-13008-01-en, October 2012 IT

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

Important
• Before reinstalling the Enterprise Server, you must stop related Windows
services. For more information, see section 17.6 “Stopping the Enterprise
Server Windows Service” on page 416.

Caution
Back up the Enterprise Server before reinstalling the product. All user settings,
database information, and system files related to this product are erased and
replaced. For more information, see section 27.5 “Backing Up a Server Manually”
on page 683.

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

To reinstall the Enterprise Server

1. Ensure that you have a backup of the Enterprise Server data.
2. On the Windows toolbar, click Start
Start, point to All Programs
Programs, and then click
Schneider Electric StruxureWare
StruxureWare.
3. Click Building Operation x.x
x.x.
4. Click Building Operation Software Administrator
Administrator.
5. Click Yes
Yes, to confirm that you want to run Software Administrator.

Continued on next page

IT 04-13008-01-en, October 2012

108
 5 Reinstallation
5.4 Reinstalling the Enterprise Server

6. Click Stop Service

Service.

7. Double-click on the Enterprise Server installation file to start the installation

wizard.
8. Click Yes
Yes, to confirm that you want to run the Workstation installation
package.

Continued on next page

04-13008-01-en, October 2012 IT

109
5 Reinstallation
5.4 Reinstalling the Enterprise Server

9. Click Next
Next.

10. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

Continued on next page

IT 04-13008-01-en, October 2012

110
 5 Reinstallation
5.4 Reinstalling the Enterprise Server

11. Select Enterprise Server and then click Next

Next.

12. Click Next

Next.

Continued on next page

04-13008-01-en, October 2012 IT

111
5 Reinstallation
5.4 Reinstalling the Enterprise Server

13. Select Uninstall current version before reinstalling and then click Next
Next.

14. In the HTTP Port box, type the port number the Enterprise Server listens to
when communicating through the Hypertext Transfer Protocol.

15. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.
16. Click Next
Next.
Continued on next page

IT 04-13008-01-en, October 2012

112
 5 Reinstallation
5.4 Reinstalling the Enterprise Server

17. In the License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

18. Click Install

Install.
Continued on next page

04-13008-01-en, October 2012 IT

113
5 Reinstallation
5.4 Reinstalling the Enterprise Server

19. Click Uninstall to uninstall the current installation of Enterprise Server before
the new version is installed.

20. Click Close

Close.

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

Continued on next page

IT 04-13008-01-en, October 2012

114
 5 Reinstallation
5.4 Reinstalling the Enterprise Server

21. Click Next

Next.

22. Click Finish

Finish.

04-13008-01-en, October 2012 IT

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

To reinstall the Device Administrator installation

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.

Continued on next page

IT 04-13008-01-en, October 2012

116
 5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

5. Select Device Administrator and then click Next

Next.

Continued on next page

04-13008-01-en, October 2012 IT

117
5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

6. Select Uninstall current version before reinstalling

reinstalling.

7. Click Next
Next.
8. Click Uninstall to remove you current installation.

9. Click Close
Close.

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

Continued on next page

IT 04-13008-01-en, October 2012

118
 5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

10. Click Next

Next.

Continued on next page

04-13008-01-en, October 2012 IT

119
5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

11. Click Finish

Finish.

IT 04-13008-01-en, October 2012

120
6 System Upgrade

Topics
System Upgrade Overview
System Upgrade Software Requirements
System Upgrade Workflows
Enterprise Server System Upgrade Workflow
Automation Server System Upgrade Workflow
Upgrading the License Administrator and the License Server
Upgrading WorkStation and Client Tools Installation
Upgrading the Device Administrator Installation
Upgrading Multiple Automation Servers in Device
Administrator
Upgrading the Enterprise Server
 6 System Upgrade
6.1 System Upgrade Overview

6.1 System Upgrade Overview

A system upgrade can include an Enterprise Server, Reports Server, one or more
Automation Servers and WorkStations, and the supporting administrator software,
such as Device Administrator.

Important
• The upgrade process is sequential, for example, 1.1 to 1.2 to 1.3. Therefore,
if you plan to upgrade from 1.1 to 1.3, upgrade the system to Version 1.2
first. Note that there is a special hot fix to be used for this scenario. (Do NOT
use the standard released build 1.2.0.767.) This upgrade-only hot fix is
available from the Extranet at http://buildings.schneider-
electric.com/Navigate?node=14124
electric.com/Navigate?node=14124. You can copy and paste this link into
a browser.
For more information on upgrading 1.1 to 1.2, please refer to the system
upgrade 1.2 documentation.

Servers in the process of an upgrade (or already upgraded to a new version) cannot
communicate with servers running a previous version. As a result, the non-
upgraded servers appear offline in WorkStation because the versions do not match.
Multi-server communication resumes after the entire system is upgraded to the
same version and the servers are back online.

Figure: Partially upgraded multi-server system

6.1.1 System Upgrade Software Requirements

The supported operating systems are defined in a software compatibility matrix.

04-13008-01-en, October 2012 IT

123
6 System Upgrade
6.1 System Upgrade Overview

For more information, see section 6.2 “System Upgrade Software Requirements”
on page 125.

6.1.2 System Upgrade Workflows

Using a workflow, you can upgrade an Automation Server system or an Enterprise
Server system. Select the workflow that meets the requirements of your site.
For more information, see section 6.3 “System Upgrade Workflows” on page 126.

IT 04-13008-01-en, October 2012

124
 6 System Upgrade
6.2 System Upgrade Software Requirements

6.2 System Upgrade Software

Requirements
The supported operating systems are defined in a software compatibility matrix.
The following table lists the software supported by Version 1.3.

Table: Component Software Compatibility Matrix for Version 1.3

Component WSa DAb LAc LSd ESe RSf

Microsoft Windows 7 Pro X X X X X –

(32-bit)

Microsoft Windows 7 Pro X X X X X –

(64-bit)

Microsoft Windows XP SP3 X X X – X –

(32-bit)

Microsoft Windows Server X X X X X X

2008 R2 (64-bit)

Microsoft SQL Server 2008 – – – – – X

R2 Standard (64-bit)

Microsoft SQL Server 2008 – – – – – X

R2 Express with Advanced
Services (64-bit)

Microsoft .NET Framework 4 X – – – – X

with Update KB2468871

Microsoft .NET Framework 4 – X X – X –

Client Profile with Update
KB2468871

a) WorkStation, including Function Block Editor, Script Editor, Graphic Editor, and WorkPlace Tech
Editor
b) Device Administrator
c) License Administrator
d) License Server
e) Enterprise Server, including Software Administrator
f) Reports Server

04-13008-01-en, October 2012 IT

125
6 System Upgrade
6.3 System Upgrade Workflows

6.3 System Upgrade Workflows

Using a workflow, you can upgrade an Automation Server system or an Enterprise
Server system. Select the workflow that meets the requirements of your site.

Figure: System upgrade workflows flowchart

6.3.1 Enterprise Server System Upgrade Workflow

An Enterprise Server system can include an Enterprise Server, Reports Server, one
or more Automation Servers and WorkStations, and the supporting administrator
software, such as Device Administrator. Use this workflow to upgrade an Enterprise
Server system.
For more information, see section 6.4 “Enterprise Server System Upgrade
Workflow” on page 127.

6.3.2 Automation Server System Upgrade Workflow

Use this workflow to upgrade a single Automation Server or a series of standalone
Automation Servers along with the accompanying software, WorkStation, Device
Administrator, License Administrator, and License Server.
For more information, see section 6.5 “Automation Server System Upgrade
Workflow” on page 133.

Note
When necessary, you can change the operating system or replace the computer
on which the Building Operation software is installed. You can also migrate
WebReports from one computer to another. For more information, see section
7.1 “Replace Enterprise Server or WebReports Computer Workflow” on page
169.

IT 04-13008-01-en, October 2012

126
 6 System Upgrade
6.4 Enterprise Server System Upgrade Workflow

6.4 Enterprise Server System Upgrade

Workflow
An Enterprise Server system can include an Enterprise Server, Reports Server, one
or more Automation Servers and WorkStations, and the supporting administrator
software, such as Device Administrator. Use this workflow to upgrade an Enterprise
Server system.

Important
Upgrade the system components, such as License Server, on the recommended
platforms. For more information, see section 6.2 “System Upgrade Software
Requirements” on page 125.

6.4.1 Prepare for Upgrade

Prior to upgrading a system, complete the tasks listed in the following flowchart.
Related information can be found in the sections after the diagram.

Figure: Pre-upgrade flowchart

Perform a system backup of servers

Before upgrading a system, it is strongly recommended that you archive the
historical data and back up the servers to preserve the current data and
configurations. For more information, see section 27.8 “System Backup” on page
690.

Stop Enterprise Server Windows service

Use Software Administrator to stop the Enterprise Server Windows service. For
more information, see section 17.6 “Stopping the Enterprise Server Windows
Service” on page 416.

04-13008-01-en, October 2012 IT

127
6 System Upgrade
6.4 Enterprise Server System Upgrade Workflow

Stop License Server Windows service

If you are upgrading the License Server, use the Services tool to stop the License
Server Windows service. For more information, see section 15.3 “Stopping the
License Server” on page 373.

6.4.2 Upgrade Building Operation Software

The following flowchart shows the tasks for upgrading the Building Operation
software. Related information can be found in the sections after the diagram.

IT 04-13008-01-en, October 2012

128
 6 System Upgrade
6.4 Enterprise Server System Upgrade Workflow

Figure: System upgrade flowchart

04-13008-01-en, October 2012 IT

129
6 System Upgrade
6.4 Enterprise Server System Upgrade Workflow

Upgrade License Server and License Administrator

Upgrade the License Server and License Administrator. The Enterprise Server will
not start without a valid license. For more information, see section 6.6 “Upgrading
the License Administrator and the License Server” on page 135.

Upgrade WorkStations
Install WorkStation and choose the Upgrade option. You can also select what editor
tools you want to upgrade. For more information, see section 6.7 “Upgrading
WorkStation and Client Tools Installation” on page 144.

Upgrade Device Administrator

Upgrade the Device Administrator. Then, the Automation Servers can be upgraded
to the same version as the Device Administrator. For more information, see section
6.8 “Upgrading the Device Administrator Installation” on page 150.

Upgrade Automation Servers

Use the Device Administrator to upgrade the Automation Servers using the IP
network or USB port. For more information, see section 6.9 “Upgrading Multiple
Automation Servers in Device Administrator” on page 156.

Note
As of this release, Automation Servers include both BACnet and LonWorks
functionality and, consequently, are no longer referred to as AS–B or AS–L.
Therefore, the combined functionality will be available after the Automation
Servers are upgraded or installed.

Stop Reporting Agent Windows service

If you are upgrading WebReports, stop the Reporting Agent Windows service. For
more information, see section 10.18 “Stopping a Windows Service” on page 271.

Upgrade Enterprise Server

Install the Enterprise Server, select the Upgrade option, and use the previous server
communication port number. Bundled with the Enterprise Server software, the
Software Administrator is also upgraded. For more information, see section 6.10
“Upgrading the Enterprise Server” on page 158.

Warm start the servers

For optimal server performance, restart the servers after an upgrade.
To ensure that the upgrade process and all clean-up activities complete
successfully on an Enterprise Server or Automation Server, wait five minutes after
the upgrade is finished and then try to log on to the server in WorkStation. If a server
connection error displays during logon, the startup sequence has not finished.
When the server resumes and you can log on, restart the following servers using
these methods:
• Enterprise Server: Select Warm start from the Actions menu.
• Automation Server: Directly log on to each Automation Server and select Warm
start from the Actions menu.
After the upgrade process completes successfully on the License Server, restart the
License Server Windows service. For more information, see section 15.4
“Restarting the License Server” on page 374.

IT 04-13008-01-en, October 2012

130
 6 System Upgrade
6.4 Enterprise Server System Upgrade Workflow

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 that the servers are communicating with each other. For more
information, see WebHelp.

Caution
Ensure that the communication protocols are set to TCP rather than HTTP or
HTTPS. The Enterprise Server or Automation Servers using HTTP or HTTPS may
try to communicate with 1.2 servers, which can cause data corruption.

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 17.5 “Starting the Enterprise Server Windows
Service” on page 415.
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 servers

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

Important
If your system upgrade ends here and you are using WebStation, you must add
the language files for WebStation again.

Upgrade WebReports?
If you plan to upgrade WebReports, you need to continue.

6.4.3 Upgrade WebReports

The following flowchart shows the tasks for upgrading WebReports. Related
information can be found in the sections after the diagram.

04-13008-01-en, October 2012 IT

131
6 System Upgrade
6.4 Enterprise Server System Upgrade Workflow

Figure: Upgrade WebReports flowchart

Configure Windows roles and features

Use the Windows Server 2008 R2 Server Manager to configure the roles and
features. For more information, see WebHelp.

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 section 10.9 “Installing the WebReports Installer” on page
232.

Install WebReports and select upgrade option

Install WebReports and select the Install both software and database option to
upgrade the existing WebReports software version, and to upgrade and retain the
existing database. For more information, see section 10.10 “Installing WebReports”
on page 235.

Important
If you are using WebStation, you must add the language files for WebStation
again.

The system upgrade is now complete.

IT 04-13008-01-en, October 2012

132
 6 System Upgrade
6.5 Automation Server System Upgrade Workflow

6.5 Automation Server System Upgrade

Workflow
Use this workflow to upgrade a single Automation Server or a series of standalone
Automation Servers along with the accompanying software, WorkStation, Device
Administrator, License Administrator, and License Server.
The following flowchart shows the tasks for upgrading one or more Automation
Servers and the accompanying software. Related information can be found in the
sections after the diagram.

Figure: Automation Server Upgrade flowchart

Back up Automation Servers

In WorkStation, log onto each Automation Server and perform a manual backup.
For more information, see section 27.5 “Backing Up a Server Manually” on page
683.

04-13008-01-en, October 2012 IT

133
6 System Upgrade
6.5 Automation Server System Upgrade Workflow

Important
Upgrade the system components, such as License Server, on the recommended
platforms. For more information, see section 6.2 “System Upgrade Software
Requirements” on page 125.

Upgrade License Administrator and License Server

Use License Server to upgrade the License Administrator. WorkStation will not start
without a valid license. For more information, see section 6.6 “Upgrading the
License Administrator and the License Server” on page 135.

Upgrade Device Administrator

Upgrade the Device Administrator. Then, the Automation Servers can be upgraded
to the same version as the Device Administrator. For more information, see section
6.8 “Upgrading the Device Administrator Installation” on page 150.

Upgrade WorkStations
Install WorkStation and choose the Upgrade option. You can also select what editor
tools you want to upgrade. For more information, see section 3.6 “Installing
WorkStation and Client Tools” on page 49.

Upgrade Automation Servers

Use Device Administrator to upgrade the Automation Servers using the IP network
or USB port. You can also monitor the upgrade status of all the servers. For more
information, see section 6.9 “Upgrading Multiple Automation Servers in Device
Administrator” on page 156.

Note
As of this release, Automation Servers include both BACnet and LonWorks
functionality and, consequently, are no longer referred to as AS–B or AS–L.
Therefore, the combined functionality will be available after the Automation
Servers are upgraded or installed.

Warm start the servers

For optimal server performance, it is important to restart the servers after an
upgrade. To ensure the upgrade process and all clean-up activities are successfully
completed, wait five minutes after the upgrade is finished. Then, directly log on to
each Automation Server in WorkStation. If a server connection error displays during
logon, the startup sequence has not finished. When the server resumes and you
can log on, select Warm start from the Actions menu.

Verify control and monitoring operations

In WorkStation, log onto each Automation Server and verify that the control and
monitoring operations are functioning normally according to the guidelines specified
for your site.

Important
If you are using WebStation, you must add the language files for WebStation
again.

IT 04-13008-01-en, October 2012

134
 6 System Upgrade
6.6 Upgrading the License Administrator and the License Server

6.6 Upgrading the License Administrator

and the License Server
You upgrade the License Administrator and License Server to access new features
or improve the performance.

Important
• To upgrade License Administrator and License Server, you must have access
to an installation package with a higher number than the currently installed
version.

For more information, see section 6.1 “System Upgrade Overview” on page 123.

To upgrade the License Administrator and License Server

1. On the computer running License Server, open the Service management
console.
2. Select Building Operation x.x License Server
Server.

3. Click Stop
Stop.
Continued on next page

04-13008-01-en, October 2012 IT

135
6 System Upgrade
6.6 Upgrading the License Administrator and the License Server

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 License Administrator installation
package.

6. Click Next
Next.

Continued on next page

IT 04-13008-01-en, October 2012

136
 6 System Upgrade
6.6 Upgrading the License Administrator and the License Server

7. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

8. Select the components you want to upgrade and then click Next
Next.

Continued on next page

04-13008-01-en, October 2012 IT

137
6 System Upgrade
6.6 Upgrading the License Administrator and the License Server

9. Select Upgrade current version to version x.x.x.xxx to upgrade the current

License Administrator installation and then click Next
Next.

10. Click Next

Next.

Continued on next page

IT 04-13008-01-en, October 2012

138
 6 System Upgrade
6.6 Upgrading the License Administrator and the License Server

11. Select Upgrade current version to version x.x.x.xxx to upgrade the current
License Server installation an then click Next
Next.

12. Click Next

Next.

13. In the License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

Continued on next page

04-13008-01-en, October 2012 IT

139
6 System Upgrade
6.6 Upgrading the License Administrator and the License Server

14. Click Install to start the installation procedure of License Administrator.

15. Click Uninstall to uninstall the current installation of License Administrator
before the upgrade starts.

16. Click Close

Close.

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

Continued on next page

IT 04-13008-01-en, October 2012

140
 6 System Upgrade
6.6 Upgrading the License Administrator and the License Server

17. Click Uninstall to uninstall the current installation of License Server before the
upgrade starts.

Continued on next page

04-13008-01-en, October 2012 IT

141
6 System Upgrade
6.6 Upgrading the License Administrator and the License Server

18. Click Close

Close.

19. Click Next

Next.

Continued on next page

IT 04-13008-01-en, October 2012

142
 6 System Upgrade
6.6 Upgrading the License Administrator and the License Server

20. Click Finish to close the installation wizard.

04-13008-01-en, October 2012 IT

143
6 System Upgrade
6.7 Upgrading WorkStation and Client Tools Installation

6.7 Upgrading WorkStation and Client

Tools Installation
You upgrade the WorkStation to access new features or improve the performance
of the product.

Important
• To upgrade WorkStation, you must have access to an installation package
with a higher number than the currently installed version.
• For upgrading WorkStation, 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
12.6 “Licenses” on page 315.
• If you intend to use WorkPlace Tech Editor, install Microsoft Office Visio first.
Then install WorkStation, which includes this editor as an installation option.
For more information, see WebHelp.

Note
When upgrading WorkStation, you must also upgrade your additional language
packages.

For more information, see section 6.1 “System Upgrade Overview” on page 123.

To upgrade WorkStation and client tools installation

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

Important
If User Account Control (UAC) is enabled on the computer on which
you are installing WorkStation, you must run the installer as an
administrator. To do this, right-click the WorkStation installation file
and then, in the shortcut menu, choose Run as administrator
administrator.

2. Click Yes
Yes, to confirm that you want to run Workstation installation package.

Continued on next page

IT 04-13008-01-en, October 2012

144
 6 System Upgrade
6.7 Upgrading WorkStation and Client Tools Installation

3. Click Next
Next.

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

5. Select the components that you want to upgrade and then click Next
Next.

Note
Upgrade all components to the new version. It is not recommended
to run products with different version numbers.

Continued on next page

04-13008-01-en, October 2012 IT

145
6 System Upgrade
6.7 Upgrading WorkStation and Client Tools Installation

6. Select Upgrade current version to version x.x.x.xxx

x.x.x.xxx.

7. Click Next
Next.
Continued on next page

IT 04-13008-01-en, October 2012

146
 6 System Upgrade
6.7 Upgrading WorkStation and Client Tools Installation

8. Click Next
Next.

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

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

10. Click Install

Install.
Continued on next page

04-13008-01-en, October 2012 IT

147
6 System Upgrade
6.7 Upgrading WorkStation and Client Tools Installation

11. Click Uninstall to remove old installation files.

12. Click Close

Close.

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

Continued on next page

IT 04-13008-01-en, October 2012

148
 6 System Upgrade
6.7 Upgrading WorkStation and Client Tools Installation

13. Click Next

Next.

14. Click Finish

Finish.

04-13008-01-en, October 2012 IT

149
6 System Upgrade
6.8 Upgrading the Device Administrator Installation

6.8 Upgrading the Device Administrator

Installation
You upgrade the Device Administrator to access new features or improve the
performance of the product.
For more information, see section 6.1 “System Upgrade Overview” on page 123.

Important
To upgrade Device Administrator, you must have access to an installation
package with a higher number than the currently installed version.

To upgrade the Device Administrator installation

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 Device Administrator installation
package.

Continued on next page

IT 04-13008-01-en, October 2012

150
 6 System Upgrade
6.8 Upgrading the Device Administrator Installation

3. Click Next
Next.

4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

Continued on next page

04-13008-01-en, October 2012 IT

151
6 System Upgrade
6.8 Upgrading the Device Administrator Installation

5. Select Device Administrator and then click Next

Next.

6. Select Upgrade current version to version x.x.x.xxx

x.x.x.xxx.

7. Click Next
Next.
Continued on next page

IT 04-13008-01-en, October 2012

152
 6 System Upgrade
6.8 Upgrading the Device Administrator Installation

8. Click Install
Install.

9. Click Uninstall to remove old installation files.

10. Click Close

Close.

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

Continued on next page

04-13008-01-en, October 2012 IT

153
6 System Upgrade
6.8 Upgrading the Device Administrator Installation

11. Click Next

Next.

Continued on next page

IT 04-13008-01-en, October 2012

154
 6 System Upgrade
6.8 Upgrading the Device Administrator Installation

12. Click Finish

Finish.

04-13008-01-en, October 2012 IT

155
6 System Upgrade
6.9 Upgrading Multiple Automation Servers in Device Administrator

6.9 Upgrading Multiple Automation Servers

in Device Administrator
Once the Device Administrator is upgraded, you use this tool to connect to each
Automation Server over the IP network to upgrade all the firmware in a single
session.

Note
Be sure to reset the TCP and HTTP or HTTPS port numbers along with the
forced-variable settings and corresponding values that you previously jotted
down.

For more information, see section 6.3 “System Upgrade Workflows” on page 126.

To upgrade multiple Automation Servers in Device

Administrator
1. On the Device Administrator, click the Add network Automation Server

button .
2. In the Device address box, type the IP address or the host name of the
Automation Server.
For more information, see WebHelp.

3. Enter the user name and password in one of the following ways:
– Type the user name and password for this Automation Server.
– Select Use default device log on using the user name and password
specified in the Device log on options dialog box.
4. Click OK
OK.
5. Repeat steps 1-4 until you have a list of all the Automation Servers that you
want to upgrade.
Continued on next page

IT 04-13008-01-en, October 2012

156
 6 System Upgrade
6.9 Upgrading Multiple Automation Servers in Device Administrator

6. As a group, select all the Automation Servers that you want to upgrade
according to the appropriate order for your site.
7. On the Tools menu, click Upgrade device
device.
8. In the Type of upgrade box, select Upgrade database to upgrade the
firmware and preserve the database.
9. Monitor the upgrade process and verify that each upgrade started and
completed normally.

The upgrade is complete when the status LED is solid green on the
Automation Server.
It may take up to 60 minutes (or 180 minutes or more on rare occasions) for an
Automation Server to come back online after a successful upgrade.

04-13008-01-en, October 2012 IT

157
6 System Upgrade
6.10 Upgrading the Enterprise Server

6.10 Upgrading the Enterprise Server

You upgrade the Enterprise Server to access new features or improve the
performance of the product.

Important
• To upgrade Enterprise Server, you must have access to an installation
package with a higher number than currently installed version.

For more information, see section 6.1 “System Upgrade Overview” on page 123.

To upgrade the Enterprise Server

1. On the Windows toolbar, click Start
Start, point to All Programs
Programs, point to
Schneider Electric StruxureWare
StruxureWare, point to Building Operation x.xx.x, and
then click Building Operation Software Administrator
Administrator.
2. Click Yes
Yes, to confirm that you want to run Software Administrator.

Continued on next page

IT 04-13008-01-en, October 2012

158
 6 System Upgrade
6.10 Upgrading the Enterprise Server

3. Click Stop Service and then click OK

OK.

Tip
Be sure to close the Software Administrator before running the
Enterprise Server installation package.

4. Double-click on the Enterprise Server installation file to start the installation

wizard.
5. Click Yes
Yes, to confirm that you want to run the Enterprise Server installation
package.

Continued on next page

04-13008-01-en, October 2012 IT

159
6 System Upgrade
6.10 Upgrading the Enterprise Server

6. Click Next
Next.

7. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.

Continued on next page

IT 04-13008-01-en, October 2012

160
 6 System Upgrade
6.10 Upgrading the Enterprise Server

8. Select Enterprise Server and then click Next

Next.

9. Click Next
Next.

Continued on next page

04-13008-01-en, October 2012 IT

161
6 System Upgrade
6.10 Upgrading the Enterprise Server

10. Select Upgrade current version to upgrade the current Enterprise Server
installation.

11. Click Next

Next.
12. Click Next
Next.

Continued on next page

IT 04-13008-01-en, October 2012

162
 6 System Upgrade
6.10 Upgrading the Enterprise Server

13. In the HTTP Port box, type the port number the Enterprise Server listens to
when communicating through the Hypertext Transfer Protocol.
Important: If WebReports resides on the same server as the Enterprise
Server, you have to set the HTTP ports to different numbers. For example, if
you set the HTTP port for the Reports Server to 8080, then you must set the
HTTP port for the Enterprise Server to different number, such as 81
81.
WebReports resides on a another server, set the Enterprise Server HTTP port
to the default, 80
80.

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 License Server Address box, type @ and then type the address to the
license server.

Note
• If the license server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different license
servers.

Continued on next page

04-13008-01-en, October 2012 IT

163
6 System Upgrade
6.10 Upgrading the Enterprise Server

17. Click Install

Install.
18. Click Uninstall to uninstall the current installation of the Enterprise Server
before the upgrade starts.

19. Click Close

Close.

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

Continued on next page

IT 04-13008-01-en, October 2012

164
 6 System Upgrade
6.10 Upgrading the Enterprise Server

20. Click Next

Next.

Continued on next page

04-13008-01-en, October 2012 IT

165
6 System Upgrade
6.10 Upgrading the Enterprise Server

21. Click Finish

Finish.

IT 04-13008-01-en, October 2012

166
7 Computer Maintenance

Topics
Replace Enterprise Server or WebReports Computer
Workflow
 7 Computer Maintenance
7.1 Replace Enterprise Server or WebReports Computer Workflow

7.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 worflow to migrate WebReports
or the Enterprise Server to another computer.

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

Perform a system backup of servers

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

Stop Enterprise Server Windows service

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

04-13008-01-en, October 2012 IT

169
7 Computer Maintenance
7.1 Replace Enterprise Server or WebReports Computer Workflow

Stop License Server Windows service

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

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 7, Windows XP, or Windows Server
2008 documentation for installation or upgrade instructions.
• 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.

7.1.2 Install 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.

Figure: Reinstall 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.8 “Installing the
Enterprise Server” on page 56.

Install other Building Operation software

Install any other Building Operation software, such as WorkStation.

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

IT 04-13008-01-en, October 2012

170
 7 Computer Maintenance
7.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 10.18 “Stopping a Windows Service” on page
271.

Restore Enterprise Server database

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

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

04-13008-01-en, October 2012 IT

171
7 Computer Maintenance
7.1 Replace Enterprise Server or WebReports Computer Workflow

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 17.5 “Starting the Enterprise Server Windows
Service” on page 415.
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 servers

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

Important
If you are using WebStation, you must add the language files for WebStation
again.

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.

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

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 10.11 “Detaching a
WebReports Database” on page 247.

Export Reports schedules

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

IT 04-13008-01-en, October 2012

172
 7 Computer Maintenance
7.1 Replace Enterprise Server or WebReports Computer Workflow

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

Figure: Reinstall WebReports flowchart

Configure Windows roles and features

Use the Windows Server 2008 R2 Server Manager to configure the roles and
features. For more information, see WebHelp.

04-13008-01-en, October 2012 IT

173
7 Computer Maintenance
7.1 Replace Enterprise Server or WebReports Computer Workflow

Install Microsoft SQL Server 2008 64-bit

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

Attach WebReports database

Use SQL Server Management Studio to attach the WebReports database. For
more information, see section 10.12 “Attaching a WebReports Database” on page
249.

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 section 10.9 “Installing the WebReports Installer” on page
232.

Install WebReports and select upgrade option

Install WebReports and select the Install software (upgrade existing database)
option to install WebReports on a new comuter or operating system and retain the
existing database. For more information, see section 10.10 “Installing WebReports”
on page 235.

Import or recreate Reports schedules

Import or recreate the Reports schedules on the computer running WebReports.
For more information, see section 10.13 “Transferring Reports Schedules ” on page
250.

Important
If you are using WebStation, you must add the language files for WebStation
again.

The WebReports migration is now complete.

IT 04-13008-01-en, October 2012

174
8 Uninstallation

Topics
Uninstallation
Uninstalling the License Administrator
Uninstalling the License Server
Uninstalling WorkStation
Uninstalling Enterprise Server
Uninstalling the Device Administrator
 8 Uninstallation
8.1 Uninstallation

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

Caution
Return all activated network licenses to the License Activation Server before
uninstalling the License Server and License Administrator. Licenses cannot be
returned without a License Administrator. For more information, see section 13.6
“Removing a Local License or Returning a Network License” on page 344.

Caution
Back up the Enterprise Server before uninstalling the product. All user settings,
database information, and system files related to this product are erased. Files
and backups created by the user remain and are not erased. For more
information, see section 27.5 “Backing Up a Server Manually” on page 683.

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

04-13008-01-en, October 2012 IT

177
8 Uninstallation
8.2 Uninstalling the License Administrator

8.2 Uninstalling the License Administrator

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

Caution
Return all activated network licenses to the License Activation Server before
uninstalling the License Server and License Administrator. Licenses cannot be
returned without a License Administrator. For more information, see section 13.6
“Removing a Local License or Returning a Network License” on page 344.

For more information, see section 8.1 “Uninstallation” on page 177.

To uninstall the License Administrator

1. On the Windows toolbar, select Start
Start, and then click Control Panel
Panel.
2. Click Uninstall a program
program.

Continued on next page

IT 04-13008-01-en, October 2012

178
 8 Uninstallation
8.2 Uninstalling the License Administrator

3. Select Schneider Electric StruxureWare Building Operation License

Administrator and then click Uninstall
Uninstall.

4. Click Uninstall
Uninstall.

Continued on next page

04-13008-01-en, October 2012 IT

179
8 Uninstallation
8.2 Uninstalling the License Administrator

5. Click Close
Close.

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

IT 04-13008-01-en, October 2012

180
 8 Uninstallation
8.3 Uninstalling the License Server

8.3 Uninstalling the License Server

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

Caution
Return all activated network licenses to the License Activation Server before
uninstalling the License Server and License Administrator. Licenses cannot be
returned without a License Administrator. For more information, see section 13.6
“Removing a Local License or Returning a Network License” on page 344.

For more information, see section 8.1 “Uninstallation” on page 177.

To uninstall the License Server

1. Ensure that you have returned all activated network licenses before you
uninstall the License Server.
2. On the License Server, open the Service management console.

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

Continued on next page

04-13008-01-en, October 2012 IT

181
8 Uninstallation
8.3 Uninstalling the License Server

3. Right-click Building Operation License Server

Server.

4. Select Stop
Stop.
5. On the Windows toolbar, select Start
Start, and then click Control Panel
Panel.
Continued on next page

IT 04-13008-01-en, October 2012

182
 8 Uninstallation
8.3 Uninstalling the License Server

6. Click Uninstall a program

program.

Continued on next page

04-13008-01-en, October 2012 IT

183
8 Uninstallation
8.3 Uninstalling the License Server

7. Select Schneider Electric StruxureWare Building Operation License

Server and then click Uninstall
Uninstall.

8. Click Uninstall
Uninstall.

Continued on next page

IT 04-13008-01-en, October 2012

184
 8 Uninstallation
8.3 Uninstalling the License Server

9. Click Close
Close.

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

04-13008-01-en, October 2012 IT

185
8 Uninstallation
8.4 Uninstalling WorkStation

8.4 Uninstalling WorkStation

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

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

For more information, see section 8.1 “Uninstallation” on page 177.

To uninstall WorkStation
1. On the Windows toolbar, select Start
Start, and then click Control Panel
Panel.
2. Click Uninstall a program
program.

Continued on next page

IT 04-13008-01-en, October 2012

186
 8 Uninstallation
8.4 Uninstalling WorkStation

3. Select the Schneider Electric StruxureWare Building Operation

WorkStation and then click Uninstall
Uninstall.

4. Click Uninstall
Uninstall.

Continued on next page

04-13008-01-en, October 2012 IT

187
8 Uninstallation
8.4 Uninstalling WorkStation

5. Click Close
Close.

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

IT 04-13008-01-en, October 2012

188
 8 Uninstallation
8.5 Uninstalling Enterprise Server

8.5 Uninstalling Enterprise Server

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

Caution
Back up the Enterprise Server before uninstalling the product. All user settings,
database information, and system files related to this product are erased. Files
and backups created by the user remain and are not erased. For more
information, see section 27.5 “Backing Up a Server Manually” on page 683.

For more information, see section 8.1 “Uninstallation” on page 177.

To uninstall Enterprise Server

1. Ensure that you have a backup of the Enterprise Server data.
2. On the Windows toolbar, click Start
Start, point to All Programs
Programs, and then click
Schneider Electric StruxureWare
StruxureWare.
3. Click Building Operation x.x
x.x.
4. Click Building Operation Software Administrator
Administrator.
5. Click Yes
Yes, to confirm that you want to run Software Administrator.

Continued on next page

04-13008-01-en, October 2012 IT

189
8 Uninstallation
8.5 Uninstalling Enterprise Server

6. Click Stop Service

Service.

7. On the Windows toolbar, select Start

Start, and then click Control Panel
Panel.
Continued on next page

IT 04-13008-01-en, October 2012

190
 8 Uninstallation
8.5 Uninstalling Enterprise Server

8. Click Uninstall a program

program.

Continued on next page

04-13008-01-en, October 2012 IT

191
8 Uninstallation
8.5 Uninstalling Enterprise Server

9. Select the Schneider Electric StruxureWare Building Operation Enterprise

Server and then click Uninstall
Uninstall.

10. Click Uninstall

Uninstall.

Continued on next page

IT 04-13008-01-en, October 2012

192
 8 Uninstallation
8.5 Uninstalling Enterprise Server

11. Click Close

Close.

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

04-13008-01-en, October 2012 IT

193
8 Uninstallation
8.6 Uninstalling the Device Administrator

8.6 Uninstalling the Device Administrator

You uninstall a Device Administrator to permanently remove the application from
your computer or server.
For more information, see section 8.1 “Uninstallation” on page 177.

To uninstall the Device Administrator

1. On the Windows toolbar, select Start
Start, and then click Control Panel
Panel.
2. Click Uninstall a program
program.

Continued on next page

IT 04-13008-01-en, October 2012

194
 8 Uninstallation
8.6 Uninstalling the Device Administrator

3. Select the Schneider Electric StruxureWare Building Operation Device

Administrator and then click Uninstall
Uninstall.

4. Click Uninstall
Uninstall.

Continued on next page

04-13008-01-en, October 2012 IT

195
8 Uninstallation
8.6 Uninstalling the Device Administrator

5. Click Close
Close.

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

IT 04-13008-01-en, October 2012

196
9 Installation User interface

Topics
Installation Wizard – Choose Components Page
Installation Wizard – Installation Type Page
Installation Wizard – License Server Configuration Page
Enterprise Server Installation Wizard – Configuration Page
 9 Installation User interface
9.1 Installation Wizard – Choose Components Page

9.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 discover and upgrade
Automation Servers.

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 Building
Operation system.

Graphics Editor Select to install Graphics Editor, which you

use to create and edit graphics that
represents 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-13008-01-en, October 2012 IT

199
9 Installation User interface
9.1 Installation Wizard – Choose Components Page

Continued
Component Description

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

Workplace Tech Editor Select to program, modify, and compile

control applications for MNL LonWorks
devices.

Enterprise Server Select to install Enterprise Server and

Software Administrator, which administrates
your Building Operation site.

IT 04-13008-01-en, October 2012

200
 9 Installation User interface
9.2 Installation Wizard – Installation Type Page

9.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-13008-01-en, October 2012 IT

201
9 Installation User interface
9.3 Installation Wizard – License Server Configuration Page

9.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-13008-01-en, October 2012

202
 9 Installation User interface
9.4 Enterprise Server Installation Wizard – Configuration Page

9.4 Enterprise 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 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-13008-01-en, October 2012 IT

203
10 Reports Installation

Topics
WebReports Installation and Uninstallation Overview
Reports Server Configuration
WebReports Installation WorkFlow
Windows Roles and Features
SQL Server
SQL Server Installation Settings
.NET Framework 4
WebReports Installer and WebReports Components
Installing the WebReports Installer
Installing WebReports
Detaching a WebReports Database
Attaching a WebReports Database
Transferring Reports Schedules
Backing Up the WebReports Database
Restoring the WebReports Database
WebReports Uninstallation WorkFlow
Uninstalling WebReports
Stopping a Windows Service
 10 Reports Installation
10.1 WebReports Installation and Uninstallation Overview

10.1 WebReports Installation and

Uninstallation Overview
To install WebReports, you install the WebReports installer and then install the
WebReports application. However, before you install the WebReports installer, 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).
If you need to uninstall WebReports for any reason, for example before installing a
new version of WebReports, follow the uninstallation workflow (introduced in this
topic).

10.1.1 Reports Server Configuration

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

10.1.2 WebReports Installation WorkFlow

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

10.1.3 Windows Roles and Features

The WebReports installation requires you to install certain services in the Web
Server (IIS) role, and to install .NET Framework features. You select these roles and
features using the Server Manager in Windows Server 2008 R2. It is recommended
that you install these roles and features before you install SQL Server.
For more information, see section 10.4 “Windows Roles and Features” on page
217.

10.1.4 SQL Server

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

04-13008-01-en, October 2012 IT

207
10 Reports Installation
10.1 WebReports Installation and Uninstallation Overview

10.1.5 .NET Framework 4

You must install .NET Framework 4 before you can successfully install either the
WebReports Installer or Building Operation.
For more information, see section 10.7 “.NET Framework 4” on page 227.

10.1.6 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 SE.SBO.WebReports-x.x.x.xxx.msi. When you run the installation package,
the WebReports Installer and accompanying files are placed in /Program Files
(x86)/Schneider Electric StruxureWare/Building Operation Reports Installation by
default.
For more information, see section 10.8 “WebReports Installer and WebReports
Components” on page 228.

10.1.7 WebReports Uninstallation Workflow

The WebReports uninstallation workflow provides a simple guide to overall
uninstallation of WebReports.
For more information, see section 10.16 “WebReports Uninstallation WorkFlow ” on
page 259.

IT 04-13008-01-en, October 2012

208
 10 Reports Installation
10.2 Reports Server Configuration

10.2 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 7.0, which uses port 80.

04-13008-01-en, October 2012 IT

209
10 Reports Installation
10.3 WebReports Installation WorkFlow

10.3 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

IT 04-13008-01-en, October 2012

210
 10 Reports Installation
10.3 WebReports Installation WorkFlow

10.3.1 Installation Requirements

Details of the hardware and software requirements of the Reports Server are
contained in the Reports Server datasheet. For more information, see WebHelp.

10.3.2 Windows Roles and Features Configuration

The following flowchart describes the basic steps required to configure Windows
roles and features to meet the requirements of WebReports.

Figure: Windows Roles and Features configuration

For more information, see section 10.4 “Windows Roles and Features” on page
217.

04-13008-01-en, October 2012 IT

211
10 Reports Installation
10.3 WebReports Installation WorkFlow

10.3.3 SQL Server Installation

The following flowchart describes the basic steps required to download and install
SQL Server.

IT 04-13008-01-en, October 2012

212
 10 Reports Installation
10.3 WebReports Installation WorkFlow

Figure: SQL Server installation flowchart

For more information, see section 10.6 “SQL Server Installation Settings” on page
222.

04-13008-01-en, October 2012 IT

213
10 Reports Installation
10.3 WebReports Installation WorkFlow

10.3.4 .NET Framework 4 Installation or Repair

The following flowcharts describe the basic steps required to install or to repair
.NET Framework 4.

Figure: .NET Framework installation or repair

For more information, see section 10.7 “.NET Framework 4” on page 227.

10.3.5 WebReports Installer Installation

The following flowchart describes the basic steps required to install the
WebReports installer.

IT 04-13008-01-en, October 2012

214
 10 Reports Installation
10.3 WebReports Installation WorkFlow

Figure: WebReports installer installation flowChart

For more information, see section 10.9 “Installing the WebReports Installer” on
page 232.

10.3.6 WebReports Application Installation

The following flowchart describes the basic steps required to install the
WebReports application.

04-13008-01-en, October 2012 IT

215
10 Reports Installation
10.3 WebReports Installation WorkFlow

Figure: WebReports installation flowchart

For more information, see section 10.10 “Installing WebReports” on page 235.

IT 04-13008-01-en, October 2012

216
 10 Reports Installation
10.4 Windows Roles and Features

10.4 Windows Roles and Features

The WebReports installation requires you to install certain services in the Web
Server (IIS) role, and to install .NET Framework features. You select these roles and
features using the Server Manager in Windows Server 2008 R2. It is recommended
that you install these roles and features before you install SQL Server.
Server Manager is accessible by way of the Administrative Tools section of the
Windows Control Panel. 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.

Figure: Web Server (IIS) server role selection

04-13008-01-en, October 2012 IT

217
10 Reports Installation
10.4 Windows Roles and Features

Figure: Web Server (IIS) role service settings

IT 04-13008-01-en, October 2012

218
 10 Reports Installation
10.4 Windows Roles and Features

Figure: .NET Framework settings

04-13008-01-en, October 2012 IT

219
10 Reports Installation
10.4 Windows Roles and Features

Figure: Window roles and features - successful installation page

IT 04-13008-01-en, October 2012

220
 10 Reports Installation
10.5 SQL Server

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

10.5.1 SQL Server Version

Microsoft provides a number of versions of SQL Server. In order to install and run
WebReports with Building Operation version 1.2, you need to download and install
SQL Server 2008 R2 Standard, 64-bit (or R2 Express with Advanced Services, 64-
bit). Do not install any other version of SQL Server. You can download the
executable file for 64-bit operating systems:
• SQLEXPRADV_x64_ENU.exe.
Before you install SQL Server, ensure that your logon account has administrative
privileges.

10.5.2 SQL Server Installation 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 10.6 “SQL Server Installation Settings” on page 222.

04-13008-01-en, October 2012 IT

221
10 Reports Installation
10.6 SQL Server Installation Settings

10.6 SQL Server Installation Settings

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

Figure: SQL feature selection

IT 04-13008-01-en, October 2012

222
 10 Reports Installation
10.6 SQL Server Installation Settings

Figure: SQL instance configuration (for SQL Express installation)

04-13008-01-en, October 2012 IT

223
10 Reports Installation
10.6 SQL Server Installation Settings

Figure: SQL server configurtion

IT 04-13008-01-en, October 2012

224
 10 Reports Installation
10.6 SQL Server Installation Settings

Figure: SQL database engine configuration

04-13008-01-en, October 2012 IT

225
10 Reports Installation
10.6 SQL Server Installation Settings

Figure: SQL reporting services configuration

IT 04-13008-01-en, October 2012

226
 10 Reports Installation
10.7 .NET Framework 4

10.7 .NET Framework 4

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

Note
Even though you install .NET Framework 3.5.1 while adding Windows features,
you must also install .NET Framework 4 for successful WebReports and Building
Operation installation. For more information, see section 10.4 “Windows Roles
and Features” on page 217.

04-13008-01-en, October 2012 IT

227
10 Reports Installation
10.8 WebReports Installer and WebReports Components

10.8 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 SE.SBO.WebReports-x.x.x.xxx.msi. When you run the installation package,
the WebReports Installer and accompanying files are placed in /Program Files
(x86)/Schneider Electric StruxureWare/Building Operation Reports Installation by
default.
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 version 7.0
• SQL Server 2008 R2
• SQL Server Reporting Services
The illustration shows these installation components and identifies the tasks
performed by the WebReports Installer.

IT 04-13008-01-en, October 2012

228
 10 Reports Installation
10.8 WebReports Installer and WebReports Components

Figure: WebReports installation components

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

04-13008-01-en, October 2012 IT

229
10 Reports Installation
10.8 WebReports Installer and WebReports Components

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

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

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

10.8.5 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. Installation of 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
installed on your computer.

10.8.6 SQL Server 2008 R2

SQL Server 2008 R2 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.2 (or later) of Building
Operation, ensure that you install only SQL Server 2008 R2 Standard (or R2
Express with Advanced Services). 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.

IT 04-13008-01-en, October 2012

230
 10 Reports Installation
10.8 WebReports Installer and WebReports Components

10.8.7 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

10.8.8 Reports Database

The Reports database stores the trend, alarm, user account, and 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

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

04-13008-01-en, October 2012 IT

231
10 Reports Installation
10.9 Installing the WebReports Installer

10.9 Installing the WebReports Installer

You run the WebReports installation package to install the WebReports installer.
The installation package is named, SE.SBO.WebReports-x.x.x.xxx.msi
SE.SBO.WebReports-x.x.x.xxx.msi. After you
run the installation package, the WebReports installer files are available in the
Program Files folder.

To install the WebReports Installer

1. In Windows Explorer, navigate to the folder where you placed the WebReports
installation package.
2. Double-click the installation package .msi file, SE.SBO.WebReports-
x.x.x.xxx.msi
x.x.x.xxx.msi.

Note
If a previous version of the WebReports installer is present on your
PC, a warning is displayed which informs you that a previous version
is installed. You must remove the existing version before you can
continue installation.

3. In the Installation Setup Wizard, click Next

Next.

Continued on next page

IT 04-13008-01-en, October 2012

232
 10 Reports Installation
10.9 Installing the WebReports Installer

4. Keep the default installation folder and settings, and then click Next
Next.

5. Click Next
Next.

6. Wait for the WebReports Installer to install.

Continued on next page

04-13008-01-en, October 2012 IT

233
10 Reports Installation
10.9 Installing the WebReports Installer

7. Click Close
Close.

To proceed with the WebReports installation, run the WebReports Installer. For
more information, see section 10.10 “Installing WebReports” on page 235.

IT 04-13008-01-en, October 2012

234
 10 Reports Installation
10.10 Installing WebReports

10.10 Installing WebReports

You install WebReports to provide the facility to run reports relation to your building
management system. Install WebReports on the same computer where you
installed SQL Server. Before installing WebReports, refer to the relevant installation
flowcharts. For more information, see section 10.3 “WebReports Installation
WorkFlow” on page 210.

To install WebReports
1. In Windows Explorer, navigate to the folder where you placed the WebReports
installer. The default folder is \Program Files (x86)\Schneider Electric
StruxureWare\Building Operation Reports Installation.
2. Right-click SE.SBO.WebReports.Installer
SE.SBO.WebReports.Installer, and then click Run as
administrator
administrator.

Continued on next page

04-13008-01-en, October 2012 IT

235
10 Reports Installation
10.10 Installing WebReports

3. On the End User License Agreement page, click I Agree

Agree.

4. In the WebReports Installer, on the Main page, select Setup Type

Type.

Continued on next page

IT 04-13008-01-en, October 2012

236
 10 Reports Installation
10.10 Installing WebReports

5. In the Setup Type box, select one of the installation options:

• Select Install software (with new database) to install WebReports for a
new system. You do not retain an existing database.
• Select Install software (upgrade existing database) to install
WebReports on a new computer or Operating System and retain the
existing database.
• Select Install both software and database to install an upgrade to the
existing WebReports software version, and to upgrade and retain the
existing database.

6. Click Continue
Continue.
7. In the User name box, type a user name.

8. In the Company name box, type your company name.

9. Click Continue
Continue.
10. In the SQL Server box, click Find SQL servers
servers.

11. Select an SQL server.

12. Click Continue

Continue.
Continued on next page

04-13008-01-en, October 2012 IT

237
10 Reports Installation
10.10 Installing WebReports

13. In the Program files path box, use the default path that specifies where to
place the WebReports program files.

14. In the Database path box, use the default path that specifies where to place
the WebReports database.
15. Click Continue
Continue.
16. In the Enterprise Server URL box, type the IP address and port number of
the Enterprise Server.

17. In the Failure retry interval box, type the number of seconds that specify how
often you want the Reporting Agent to retry reading the Enterprise Server
following a failed attempt to read the server. The default is recommended.
18. In the Historical data read interval box, type the number of seconds that
specify how often you want the Reporting Agent to read Historical data. The
default is recommended.
19. Click Continue
Continue.
Continued on next page

IT 04-13008-01-en, October 2012

238
 10 Reports Installation
10.10 Installing WebReports

20. In the Log file box, use the default name for the Reporting Agent log file.

21. In the Log file size box, type the size for the Reporting Agent log file. The
default is recommended.
22. In the Log file count box, type the number of log files you want to keep. The
default is recommended.
23. Click Continue
Continue.
24. In the WebReports URL box, use the default URL.

25. In the Virtual Root box, use the default root directory.
26. Click Continue
Continue.
27. Verify your information and then click Continue
Continue.

Continued on next page

04-13008-01-en, October 2012 IT

239
10 Reports Installation
10.10 Installing WebReports

28. On the Check Installation Requirements page, click Check

Check.

29. When the requirements check succeeds, click Continue

Continue.

Continued on next page

IT 04-13008-01-en, October 2012

240
 10 Reports Installation
10.10 Installing WebReports

30. If the following dialog box is displayed (software and database upgrade only),
click Configure
Configure.

31. If the following dialog box is displayed (software and database upgrade only),
click Continue
Continue.

Continued on next page

04-13008-01-en, October 2012 IT

241
10 Reports Installation
10.10 Installing WebReports

32. Confirm that the Reporting Agent installed successfully and then click
Continue
Continue.

33. Confirm that WebReports installed successfully and then click Continue
Continue.

Continued on next page

IT 04-13008-01-en, October 2012

242
 10 Reports Installation
10.10 Installing WebReports

34. Confirm that the WebReports Service installed successfully and then click
Continue
Continue.

Continued on next page

04-13008-01-en, October 2012 IT

243
10 Reports Installation
10.10 Installing WebReports

35. On the Post-Installation Configuration page, click Configure

Configure.

Note
• If you are upgrading the WebReports database, fewer
configuration items are present.

Continued on next page

IT 04-13008-01-en, October 2012

244
 10 Reports Installation
10.10 Installing WebReports

36. Confirm that the post-installation configuration completes successfully.

37. Click Continue

Continue.
38. Confirm that PublishReports installed successfully and then click Finish
Finish.

04-13008-01-en, October 2012 IT

245
10 Reports Installation
10.10 Installing WebReports

Note
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 WebHelp.

IT 04-13008-01-en, October 2012

246
 10 Reports Installation
10.11 Detaching a WebReports Database

10.11 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 section 6.4 “Enterprise Server System Upgrade
Workflow” on page 127.

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.

Continued on next page

04-13008-01-en, October 2012 IT

247
10 Reports Installation
10.11 Detaching a WebReports Database

6. Select Drop Connections and then click OK

OK.

7. Copy all the files in C:\Program Files (x86)\Schneider

Electric\StruxureWareReports\DatabaseFiles to a convenient location, for
later attachment.

Note
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 10.12 “Attaching a WebReports
Database” on page 249.

IT 04-13008-01-en, October 2012

248
 10 Reports Installation
10.12 Attaching a WebReports Database

10.12 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 section 6.4 “Enterprise Server System Upgrade
Workflow” on page 127.

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)
(x86)\Schneider
\Schneider Electric StruxureWare\
StruxureWare\Building
Building
Operation Reports Installation\DatabaseFiles to a convenient location..

Note
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 all the database files to C:\Program Files (x86)\Schneider Electric
StruxureWare\Building Operation Reports Installation
Installation\DatabaseFiles
\DatabaseFiles.
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 10.10
“Installing WebReports” on page 235.

04-13008-01-en, October 2012 IT

249
10 Reports Installation
10.13 Transferring Reports Schedules

10.13 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 section 6.4 “Enterprise Server System Upgrade
Workflow” on page 127.

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.
Continued on next page

IT 04-13008-01-en, October 2012

250
 10 Reports Installation
10.13 Transferring Reports Schedules

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.

04-13008-01-en, October 2012 IT

251
10 Reports Installation
10.14 Backing Up the WebReports Database

10.14 Backing Up the WebReports Database

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

To back up the WebReports database

1. On the Windows toolbar, select Start
Start, and then click SQL Server
Management Studio
Studio.
2. Click Connect
Connect.

3. Expand the Databases folder.

Continued on next page

IT 04-13008-01-en, October 2012

252
 10 Reports Installation
10.14 Backing Up the WebReports Database

4. Right-click StruxureWareReportsDB
StruxureWareReportsDB, point to Tasks
Tasks, then click Back Up
Up.

Continued on next page

04-13008-01-en, October 2012 IT

253
10 Reports Installation
10.14 Backing Up the WebReports Database

5. Under Destination
Destination, click Add
Add.

6. Click OK
OK.
7. In the Destination on disk box, select the backup destination.

Continued on next page

IT 04-13008-01-en, October 2012

254
 10 Reports Installation
10.14 Backing Up the WebReports Database

8. Click OK
OK.

9. Click OK
OK.

04-13008-01-en, October 2012 IT

255
10 Reports Installation
10.15 Restoring the WebReports Database

10.15 Restoring the WebReports Database

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

To restore the WebReports database

1. On the Windows toolbar, select Start
Start, and then click SQL Server
Management Studio
Studio.
2. Click Connect
Connect.

3. Expand the Databases folder.

Continued on next page

IT 04-13008-01-en, October 2012

256
 10 Reports Installation
10.15 Restoring the WebReports Database

4. Right-click StruxureWareReportsDB and select Tasks

Tasks, then select Restore
Restore,
then select Database.

Continued on next page

04-13008-01-en, October 2012 IT

257
10 Reports Installation
10.15 Restoring the WebReports 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-13008-01-en, October 2012

258
 10 Reports Installation
10.16 WebReports Uninstallation WorkFlow

10.16 WebReports Uninstallation WorkFlow

The WebReports uninstallation workflow provides a simple guide to overall
uninstallation of WebReports.
To uninstall WebReports, you need to uninstall the WebReports application and
services in Control Panel, and then remove all WebReports components from
Microsoft SQL Management Studio, IIS, SQL Server Reporting Services, Computer
Management and Windows Explorer.
The flowchart describes the basic steps and the correct order required for a
successful uninstallation of WebReports.

04-13008-01-en, October 2012 IT

259
10 Reports Installation
10.16 WebReports Uninstallation WorkFlow

IT 04-13008-01-en, October 2012

260
 10 Reports Installation
10.16 WebReports Uninstallation WorkFlow

Figure: WebReports uninstallation flowchart

For more information, see section 10.17 “Uninstalling WebReports” on page 262.

04-13008-01-en, October 2012 IT

261
10 Reports Installation
10.17 Uninstalling WebReports

10.17 Uninstalling WebReports

You uninstall WebReports to remove the WebReports application and the
WebReports database from the Reports Server. Before uninstalling WebReports,
refer to the uninstallation flowchart. For more information, see section 10.16
“WebReports Uninstallation WorkFlow ” on page 259.

To uninstall WebReports
1. In Windows Control Panel
Panel, point to Programs and then select Uninstall a
program
program.

Continued on next page

IT 04-13008-01-en, October 2012

262
 10 Reports Installation
10.17 Uninstalling WebReports

2. Right-click Building Operation Reports Installation and then click Uninstall

Uninstall.

3. Right-click StruxureWare Report Pack Installer and then click Uninstall

Uninstall.
4. Right-click StruxureWare Reporting Agent and then click Uninstall
Uninstall.
5. Right-click StruxureWare WebReports and then click Uninstall
Uninstall.
6. Right-click StruxureWare WebReportsService and then click Uninstall
Uninstall.
Continued on next page

04-13008-01-en, October 2012 IT

263
10 Reports Installation
10.17 Uninstalling WebReports

7. In your Web browser, type the URL for SQL Server Reporting Services Report
Manager. If you have installed SQL Server 2008 R2 Express, the URL is
http://localhost/reports_sqlexpress

8. Click Details View

View.
9. Select the folders that contain the WebReports reports including Data
Sources
Sources.

10. Click Delete

Delete.
11. Click OK
OK.

12. Click Close

Close.
Continued on next page

IT 04-13008-01-en, October 2012

264
 10 Reports Installation
10.17 Uninstalling WebReports

13. Open Microsoft SQL Server Management Studio (type SQL in the Start menu
Search box).

14. Expand the Databases folder.

15. Right-click StruxureWareReportsDB and then click Delete
Delete.
16. In the Delete Object window, select StruxureWareReportsDB
StruxureWareReportsDB.

17. Select Close existing connections

connections.
Continued on next page

04-13008-01-en, October 2012 IT

265
10 Reports Installation
10.17 Uninstalling WebReports

18. Click OK
OK.
19. Open Internet Information Services (IIS) Manager (type IIS in the Start menu
Search box).
20. In the Connections pane, expand Sites
Sites, expand Default Web Site
Site, and then
expand SchneiderElectric
SchneiderElectric.

21. Delete each virtual directory in the specified order:

• Right-click WebReportsService and then click Remove
Remove.
• Right-click WebReports and then click Remove
Remove.
• Right-click SchneiderElectric and then click Remove
Remove.
22. In the Connections pane, select Application Pools
Pools.

23. Right-click SchneiderElectric.WebReportsAppPool and then click

Remove
Remove.
24. Right-click SchneiderElectric.WebReports
SchneiderElectric.WebReportsServiceAppPool
ServiceAppPool and then click
Remove
Remove.
25. Exit Internet Information Services (IIS) Manager.
Continued on next page

IT 04-13008-01-en, October 2012

266
 10 Reports Installation
10.17 Uninstalling WebReports

26. In SQL Server Reporting Services Report Manager (see previous steps), click
Folder Settings
Settings.

27. Select the NT AUTHORITY\IUSR check box and the \appuser check box,
and then click Delete
Delete.
28. Exit SQL Server Reporting Services Report Manager.
29. In Windows Control Panel
Panel, select System and Security
Security, then select
Administrative Tools
Tools.
30. In Computer Management
Management, expand Local Users and Groups and then
select Users
Users.

31. Right-click appuser and click Delete

Delete, then follow any further prompts to
complete the deletion.
Continued on next page

04-13008-01-en, October 2012 IT

267
10 Reports Installation
10.17 Uninstalling WebReports

32. In Microsoft SQL Server Management Studio, expand Security and then
expand Logins
Logins.

33. Right-click the appuser account and then click Delete

Delete.
Continued on next page

IT 04-13008-01-en, October 2012

268
 10 Reports Installation
10.17 Uninstalling WebReports

34. In the Delete Object window, select appuser

appuser.

35. Click OK again.

36. Click OK
OK.
37. Right-click NT AUTHORITY\IUSR and delete it in the same way as you
deleted the previous (appuser
appuser) account.
38. Right-click \appuser and delete it in the same way as you deleted the
previous (appuser
appuser) account.
39. Exit SQL Server Management Studio.
Continued on next page

04-13008-01-en, October 2012 IT

269
10 Reports Installation
10.17 Uninstalling WebReports

40. In Windows Explorer, expand Program Files (x86) and then expand
Schneider Electric
Electric.

41. Right-click StruxureWareReports and click Delete

Delete, then follow any further
prompts to complete deletion.
42. Expand Program Files (x86) and then expand Schneider Electric
StruxureWare.

43. Right-click Building Operation Reports Installation and then click Delete
Delete.

IT 04-13008-01-en, October 2012

270
 10 Reports Installation
10.18 Stopping a Windows Service

10.18 Stopping a Windows Service

You stop a Windows service to install, upgrade, or restore a server.

To stop 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 the service and then click Stop
Stop.

04-13008-01-en, October 2012 IT

271
11 Reports Installation User
Interface

Topics
Role Services Dialog Box
Features Dialog Box
Reports Installation Setup Wizard
Reports Installation Setup Wizard – Select Installation Folder
Page
Reports Installation Setup Wizard – Confirm Installation
Page
Reports Installation Setup Wizard – Installation Complete
Page
WebReports Installer – End User License Agreement Page
WebReports Installer Main Page
WebReports Installer – Setup Type Dialog Box
WebReports Installer – User Information Dialog Box
WebReports Installer – SQL Server Dialog Box
WebReports Installer – Available SQL Servers Dialog Box
WebReports Installer – Program Files and Database Path
Dialog Box
WebReports Installer – Reporting Agent Dialog Box
WebReports Installer – Reporting Agent Logging Dialog Box
WebReports Installer – WebReports Dialog Box
WebReports Installer – Confirmation Page
WebReports Installer – Check Installation Requirements
Page
WebReports Installer – Requirements Check Successful
Page
WebReports Installer – Pre-upgrade Configuration Page
WebReports Installer – Pre-upgrade Configuration
Successful Page
WebReports Installer – Installing Reporting Agent Page
WebReports Installer – Installing WebReports Page
WebReports Installer – Installing WebReports Service Page
WebReports Installer – Post-Installation Configuration Page
WebReports Installer – Configuration Successful Page
WebReports Installer – Installing PublishReports Page
 11 Reports Installation User Interface
11.1 Role Services Dialog Box

11.1 Role Services Dialog Box

Use the Role Services 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: Role Services dialog box

Table: Role Services Dialog Box

Component Description

Static Content Select to allow IIS 7.0 to serve static HTML

and image files.

04-13008-01-en, October 2012 IT

275
11 Reports Installation User Interface
11.1 Role Services Dialog Box

Continued
Component Description

Default Document Select to allow files to be opened

automatically when a file name is not
specified in a URL.

Directory Browsing Select to allow the contents of a Web site

that does not contain a default document.

HTTP Errors Select to allow customized error pages to

display.

ASP.NET Select to enable the features that allow IIS

7.0 to host ASP.NET applications.

.NET Extensibility Select to enable the features that allow IIS

7.0 to host .NET framework applications.

ISAPI Extensions Select to enable ISAPI extensions to handle

client requests.

ISAPI Filters Select to allow ISAPI filters to modify Web

server behavior.

HTTP Logging Select to enable logging of HTTP activity.

Request Monitor Select to enable the viewing of current

worker processes in an application pool.

Windows Authentication Select to enable authentication to the

WebReports Web site.

Static Content Compression Select to enable IIS 7.0 to compress static

content such as HTML and images before
sending these to the browser.

Request Filtering Select to enable analysis of all HTTP

requests.

IIS Management Console Select to install the Web server management

console that manages the WebReports Web
site running on a local or remote IIS 7.0
server.

IIS Metabase and IIS 6 configuration Select to enable IIS 6.0 metabase calls to
compatibility interact with the IIS 7.0 configuration store.

IIS 6 WMI Compatibility Select to enable the IIS 6 WMI scripting

interface.

IT 04-13008-01-en, October 2012

276
 11 Reports Installation User Interface
11.2 Features Dialog Box

11.2 Features Dialog Box

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

04-13008-01-en, October 2012 IT

277
11 Reports Installation User Interface
11.3 Reports Installation Setup Wizard

11.3 Reports Installation Setup Wizard

Use the Reports Installation Setup Wizard to begin the process of installing the
WebReports installation files.

Figure: Reports Installation Setup Wizard

Table: Reports Installation Setup Wizard

Component Description

Next Click to begin the process of installing the

WebReports installation files.

IT 04-13008-01-en, October 2012

278
 11 Reports Installation User Interface
11.4 Reports Installation Setup Wizard – Select Installation Folder Page

11.4 Reports Installation Setup Wizard –

Select Installation Folder Page
Use the Select Installation Folder page to choose the folder for the WebReports
installation files.

Figure: Select Installation Folder page

Table: Select Installation Folder Page

Component Description

Folder Enter the directory location for the

WebReports installation files. The default
folder is recommended.

Disk Cost... Click to view the available disks where you

can install the WebReports installation files
and to view the available disk space.

Everyone Click to allow uninstall rights to any user

account that has Administrator privileges.
The default is recommended.

Just me Click to restrict uninstall rights to the user

account that is logged on to do the
installation. This setting is not
recommended.

Next Click to proceed with installing the

WebReports installation files.

04-13008-01-en, October 2012 IT

279
11 Reports Installation User Interface
11.5 Reports Installation Setup Wizard – Confirm Installation Page

11.5 Reports Installation Setup Wizard –

Confirm Installation Page
Use the Confirm Installation page to start the installation of the WebReports
installation files.

Figure: Confirm Installation page

Table: Confirm Installation Page

Component Description

Next Click to start the installation of the

WebReports installation files.

IT 04-13008-01-en, October 2012

280
 11 Reports Installation User Interface
11.6 Reports Installation Setup Wizard – Installation Complete Page

11.6 Reports Installation Setup Wizard –

Installation Complete Page
Use the Installation Complete page to end the installation of the WebReports
installation files.

Figure: Installation Complete page

Table: Installation Complete Page

Component Description

Close Click to end the installation of the

WebReports installation files.

04-13008-01-en, October 2012 IT

281
11 Reports Installation User Interface
11.7 WebReports Installer – End User License Agreement Page

11.7 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

I Agree Click to accept the End User License

Agreement and to proceed with the
WebReports installation.

IT 04-13008-01-en, October 2012

282
 11 Reports Installation User Interface
11.8 WebReports Installer Main Page

11.8 WebReports Installer Main Page

Use the WebReports Installer main page to select an installation option.

Figure: WebReports Installer main page

Table: WebReports Installer Main Page

Component Description

Setup Type Click to select the installation type. For more

information, see section 11.9 “WebReports
Installer – Setup Type Dialog Box” on page
285.

User Information Click to enter your user information. For

more information, see section 11.10
“WebReports Installer – User Information
Dialog Box” on page 286.

SQL Server Click to select the SQL Server that can

access the Reports server. For more
information, see section 11.11 “WebReports
Installer – SQL Server Dialog Box” on page
287.

Program Files and Database Path Click to enter the program files location and
database destination. For more information,
see section 11.13 “WebReports Installer –
Program Files and Database Path Dialog
Box” on page 289.

04-13008-01-en, October 2012 IT

283
11 Reports Installation User Interface
11.8 WebReports Installer Main Page

Continued
Component Description

Reporting Agent Click to enter the Reporting Agent

information. For more information, see
section 11.14 “WebReports Installer –
Reporting Agent Dialog Box” on page 290.

Reporting Agent Logging Click to enter the Reporting Agent log file
information. For more information, see
section 11.15 “WebReports Installer –
Reporting Agent Logging Dialog Box” on
page 291.

WebReports Click to enter the URL and virtual root

directory of the WebReports Web site. For
more information, see section 11.16
“WebReports Installer – WebReports Dialog
Box” on page 292.

IT 04-13008-01-en, October 2012

284
 11 Reports Installation User Interface
11.9 WebReports Installer – Setup Type Dialog Box

11.9 WebReports Installer – Setup Type

Dialog Box
Use the Setup Type dialog box to choose the installation type.

Figure: Setup Type dialog box

Table: Setup Type Dialog Box

Component Description

Install software (with new database) Select Install software (with new
database) to install WebReports for a new
system. You do not retain an existing
database.

Install software (upgrade existing Select Install software (upgrade existing

database) database) to install WebReports on a new
computer or Operating System and retain
the existing database.

Upgrade both software and database Select Upgrade both software and
database to install an upgrade to the
existing WebReports software version, and
to upgrade and retain the existing database.

04-13008-01-en, October 2012 IT

285
11 Reports Installation User Interface
11.10 WebReports Installer – User Information Dialog Box

11.10 WebReports Installer – User

Information Dialog Box
Use the User Information dialog box to enter your user information.

Figure: User Information dialog box

Table: User Information Dialog Box

Component Description

User name Type your user name. The user name is a

product user name and is not related to your
user account in WorkStation.

Company name Type your company name.

IT 04-13008-01-en, October 2012

286
 11 Reports Installation User Interface
11.11 WebReports Installer – SQL Server Dialog Box

11.11 WebReports Installer – SQL Server

Dialog Box
Use the SQL Server dialog box to display a list of SQL Servers that are installed on
your server.

Figure: SQL Server dialog box

Table: SQL Server Dialog Box

Component Description

Find SQL servers Click to open a list of SQL servers.

04-13008-01-en, October 2012 IT

287
11 Reports Installation User Interface
11.12 WebReports Installer – Available SQL Servers Dialog Box

11.12 WebReports Installer – Available SQL

Servers Dialog Box
Use the Available SQL servers dialog box to choose the SQL Server that can
access the Reports server.

Figure: Available SQL servers dialog box

Table: Available SQL Servers Dialog Box

Component Description

Available SQL servers Select the SQL server that can access the
Reports server.

IT 04-13008-01-en, October 2012

288
 11 Reports Installation User Interface
11.13 WebReports Installer – Program Files and Database Path Dialog Box

11.13 WebReports Installer – Program Files

and Database Path Dialog Box
Use the Program Files and Database Path dialog box to enter the destination for
the WebReports program files and the Reports database. The WebReports
Program files and database are created during the installation and are placed in the
directories that you specify.

Figure: Program Files and Database Path dialog box

Table: Program Files and Database Path Dialog Box

Component Description

Program files path Enter a location to specify the destination for

the WebReports program files. The default is
recommended.

Database path Enter a location to specify the destination for

the Reports database. The default is
recommended.

04-13008-01-en, October 2012 IT

289
11 Reports Installation User Interface
11.14 WebReports Installer – Reporting Agent Dialog Box

11.14 WebReports Installer – Reporting Agent

Dialog Box
Use the Reporting Agent dialog box to enter values for the Reporting Agent. You
also enter the URL of the computer where the Enterprise Server is installed. For
more information, see section 10.2 “Reports Server Configuration” on page 209.

Figure: Reporting Agent dialog box

Table: Reporting Agent Dialog Box

Component Description

Enterprise Server URL Type the URL of the Enterprise Server. If you
are installing WebReports on the same
computer where the Enterprise Server is
installed, enter a port number other than 80.
For more information, see section 10.2
“Reports Server Configuration” on page 209.

Failure retry interval Type the number of seconds that you want
the Reporting Agent to wait before retrying
to read the Enterprise Server following a
failed attempt to read the server. The default
is recommended.

Historical data read interval Type the number of seconds that you want
the Reporting Agent to read historical data,
and send the retrieved data to the Reports
Server. The default is recommended. For
more information, see section 10.7 “.NET
Framework 4” on page 227.

IT 04-13008-01-en, October 2012

290
 11 Reports Installation User Interface
11.15 WebReports Installer – Reporting Agent Logging Dialog Box

11.15 WebReports Installer – Reporting Agent

Logging Dialog Box
Use the Reporting Agent Logging dialog box to enter the name, size, and number
of the Reporting Agent log files. The log files are typically used by Technical Support
to troubleshoot problems with the Reporting Agent. The default values are
recommended.

Figure: Reporting Agent Logging dialog box

Table: Reporting Agent Logging Dialog Box

Component Description

Log file Type a name for the Reporting Agent log file.
The default is recommended.

Log file size Type the size for the Reporting Agent log file.
The default is recommended.

Log file count Type the number of log files you want to
keep. The default is recommended.

04-13008-01-en, October 2012 IT

291
11 Reports Installation User Interface
11.16 WebReports Installer – WebReports Dialog Box

11.16 WebReports Installer – WebReports

Dialog Box
Use the WebReports dialog box to enter the URL and virtual root directory of the
WebReports Web site. The default values are recommended.

Figure: WebReports dialog box

Table: WebReports Dialog Box

Component Description

WebReports URL Type the URL of the WebReports Web site.

The default is recommended.

Virtual Root Type the virtual root directory of the

WebReports Web site. The default is
recommended.

IT 04-13008-01-en, October 2012

292
 11 Reports Installation User Interface
11.17 WebReports Installer – Confirmation Page

11.17 WebReports Installer – Confirmation

Page
Use the Confirmation page to proceed with the installation after you have verified
the information you entered.

Figure: Confirmation page

Table: Confirmation Page

Component Description

Continue Click to proceed with the installation.

04-13008-01-en, October 2012 IT

293
11 Reports Installation User Interface
11.18 WebReports Installer – Check Installation Requirements Page

11.18 WebReports Installer – Check

Installation Requirements Page
Use the Check Installation Requirements page to start the requirements
verification.

Figure: Check Installation Requirements page

Table: Check Installation Requirements Page

Component Description

Check Click to start the verification of your system

requirements.

IT 04-13008-01-en, October 2012

294
 11 Reports Installation User Interface
11.19 WebReports Installer – Requirements Check Successful Page

11.19 WebReports Installer – Requirements

Check Successful Page
Use the Requirements Check Successful page to confirm the successful
completion of the requirements check.

Figure: Requirements Check Successful page

Table: Requirements Check Successful Page

Component Description

Continue Click to proceed with the installation. Stop

the installation if the requirements check
does not succeed.

04-13008-01-en, October 2012 IT

295
11 Reports Installation User Interface
11.20 WebReports Installer – Pre-upgrade Configuration Page

11.20 WebReports Installer – Pre-upgrade

Configuration Page
Use the Pre-upgrade Configuration page to start the pre-upgrade configuration.

Figure: Pre-upgrade Configuration page

Table: Pre-upgrade Configuration Page

Component Description

Configure Click to start the pre-upgrade configuration.

IT 04-13008-01-en, October 2012

296
 11 Reports Installation User Interface
11.21 WebReports Installer – Pre-upgrade Configuration Successful Page

11.21 WebReports Installer – Pre-upgrade

Configuration Successful Page
Use the Pre-upgrade Configuration page to complete the pre-upgrade
configuration.

Figure: Pre-upgrade Configuration Successful page

Table: Pre-upgrade Configuration Successful Page

Component Description

Configure Click to complete the pre-upgrade

configuration.

04-13008-01-en, October 2012 IT

297
11 Reports Installation User Interface
11.22 WebReports Installer – Installing Reporting Agent Page

11.22 WebReports Installer – Installing

Reporting Agent Page
Use the Installing Reporting Agent page to monitor the progress of the Reporting
Agent installation.

Figure: Installing Reporting Agent page

Table: Installing Reporting Agent Page

Component Description

Continue Click after the Reporting Agent installs.

IT 04-13008-01-en, October 2012

298
 11 Reports Installation User Interface
11.23 WebReports Installer – Installing WebReports Page

11.23 WebReports Installer – Installing

WebReports Page
Use the Installing WebReports page to monitor the progress of the WebReports
client installation.

Figure: Installing WebReports page

Table: Installing WebReports Page

Component Description

Continue Click after the WebReports client installs.

04-13008-01-en, October 2012 IT

299
11 Reports Installation User Interface
11.24 WebReports Installer – Installing WebReports Service Page

11.24 WebReports Installer – Installing

WebReports Service Page
Use the Installing WebReports Service page to monitor the progress of the
WebReports Service installation.

Figure: Installing WebReports Service page

Table: Installing WebReports Service Page

Component Description

Continue Click after the WebReports Service installs.

IT 04-13008-01-en, October 2012

300
 11 Reports Installation User Interface
11.25 WebReports Installer – Post-Installation Configuration Page

11.25 WebReports Installer – Post-Installation

Configuration Page
Use the Post-Installation Configuration page to start the post-installation
configuration.

Figure: Post-Installation Configuration page

Table: Post-Installation Configuration Page

Component Description

Configure Click to start the post-installation

configuration.

04-13008-01-en, October 2012 IT

301
11 Reports Installation User Interface
11.26 WebReports Installer – Configuration Successful Page

11.26 WebReports Installer – Configuration

Successful Page
Use the Configuration Successful page to confirm the successful completion of
the WebReports configuration.

Figure: Configuration Successful page

Table: Configuration Successful Page

Component Description

Continue Click to proceed with the installation. Stop

the installation if the configuration does not
succeed.

IT 04-13008-01-en, October 2012

302
 11 Reports Installation User Interface
11.27 WebReports Installer – Installing PublishReports Page

11.27 WebReports Installer – Installing

PublishReports Page
Use the Installing PublishReports page to monitor the progress of the Production
Reports installation.

Figure: Installing PublishReports page

Table: Installing PublishReports Page

Component Description

Finish Click after PublishReports installs to

complete the WebReports Installation.

04-13008-01-en, October 2012 IT

303
12 Licensing Introduction

Topics
Licensing Overview
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
 12 Licensing Introduction
12.1 Licensing Overview

12.1 Licensing Overview

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

12.1.1 License System

When setting up a new Building Operation system, 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 12.2 “License System” on page 308.

12.1.2 License Management

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

12.1.3 Service and Maintenance

The license policy in Building Operation is strictly controlled and is sensitive to any
changes on the license server, both hardware and software.
For more information, see section 12.4 “Service and Maintenance ” on page 312.

04-13008-01-en, October 2012 IT

307
12 Licensing Introduction
12.2 License System

12.2 License System

When setting up a new Building Operation system, 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 dedicated 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 server 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.

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

12.2.1 License Activation Server

The License Activation Server is the server controlled by Schneider Electric to
manage the activation of licenses on customer’s 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.

12.2.2 License Server

The license server manages the administration of network licenses. A Building
Operation system running with network licenses must contain at least one license
server.
For more information, see section 15.1 “License Server” on page 371.

12.2.3 License Administrator

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

IT 04-13008-01-en, October 2012

308
 12 Licensing Introduction
12.2 License System

12.2.4 Licenses
Building Operation uses two types of licenses: the network license and the local
license. Network licenses are the most common type of license in Building
Operation. 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 12.6 “Licenses” on page 315.

04-13008-01-en, October 2012 IT

309
12 Licensing Introduction
12.3 License Management

12.3 License Management

A Building Operation license system consists of, for example, a license server,
WorkStation with client tools, and an 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.

12.3.1 License System Installation and Configuration

Schneider Electric recommends that you install the license server framework before
other Building Operation hardware or software. 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 41.

IT 04-13008-01-en, October 2012

310
 12 Licensing Introduction
12.3 License Management

12.3.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 13.2 “Network License Management” on page
335.

12.3.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. The local
license cannot be distributed and shared between different WorkStations or servers
as the network license can.
For more information, see section 13.11 “Local License Management” on page
356.

04-13008-01-en, October 2012 IT

311
12 Licensing Introduction
12.4 Service and Maintenance

12.4 Service and Maintenance

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

12.4.1 License Service Maintenance

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 15.13 “License Server Maintenance” on page
389.

12.4.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 12.5 “License Maintenance” on page 314.

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

IT 04-13008-01-en, October 2012

312
 12 Licensing Introduction
12.4 Service and Maintenance

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

04-13008-01-en, October 2012 IT

313
12 Licensing Introduction
12.5 License Maintenance

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

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

12.5.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 13.4 “Network License Return” on page 339.

12.5.3 Lost License

If a 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 12.11 “Lost License” on page 323.

12.5.4 License Reparation

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 12.12 “License Repair” on page 324.

12.5.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.
For more information, see section 12.13 “License Backup” on page 325.

IT 04-13008-01-en, October 2012

314
 12 Licensing Introduction
12.6 Licenses

12.6 Licenses
Building Operation uses two types of licenses: the network license and the local
license. Network licenses are the most common type of license in Building
Operation. 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 Building Operation license policy consists of the following licenses:

Table: Building Operation Licenses

License File Name Description

Client Station client.station Use this license to start and

run WorkStation.

Client tool licenses client.graphiceditor This license product group

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

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

run an Enterprise Server.

License files to activate as time-limited local licenses are included in the installation
of Building Operation. The local license files are in the following paths:
• Windows XP: \Documents and Settings\All Users\Application Data\Schneider
Electric StruxureWare\Building Operation x.x\License Files\
• Windows server 2008: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\License Files\
• Windows 7: \ProgramData\Schneider Electric StruxureWare\Building
Operation x.x\License Files\
The x.x represents the version number. For more information, see section 13.10
“Local Licenses” on page 354.
For more information on how to order licenses, please contact your Building
Operation vendor.

12.6.1 End User License Agreement

When installing Building Operation, 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.

04-13008-01-en, October 2012 IT

315
12 Licensing Introduction
12.6 Licenses

12.6.2 Local Licenses

A local license installs on the client or server from a license file with the extension
.asr. The local license is bound to the computer and cannot be shared. The license
file to activate local licenses can only be used once.
For more information, see section 13.10 “Local Licenses” on page 354.

12.6.3 Network Licenses

Network licenses are distributed from a license server. The license server shares a
predetermined number of simultaneous instances that are available networkwide.
To start licensed clients and servers using network licenses, the required number of
licenses have to be available on the license server.
For more information, see section 13.1 “Network Licenses ” on page 331.

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

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

12.6.5 Permanent License

A permanent license does not expire.

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

12.6.6 License Selection Process

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

IT 04-13008-01-en, October 2012

316
 12 Licensing Introduction
12.7 Viewing Activated Licenses

12.7 Viewing Activated Licenses

You view all the activated licenses on a license server, WorkStation, or Enterprise
Server.
For more information, see section 12.6 “Licenses” on page 315.

To view activated licenses

1. In License Administrator, click the Licenses view.

All licenses activated on the license server, WorkStation, or Enterprise Server are
listed.

04-13008-01-en, October 2012 IT

317
12 Licensing Introduction
12.8 Editing Registration Details

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

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

For more information, see section 15.14 “License Administrator” on page 392.

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.
Continued on next page

IT 04-13008-01-en, October 2012

318
 12 Licensing Introduction
12.8 Editing Registration Details

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.

Note
• The customer details must be edited or updated individually on all license
servers.

04-13008-01-en, October 2012 IT

319
12 Licensing Introduction
12.9 License Selection Process

12.9 License Selection Process

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

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

IT 04-13008-01-en, October 2012

320
 12 Licensing Introduction
12.10 Order Information Request

12.10 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 Building
Operation vendor.

Figure: Entitle Certificate with entitlement ID

04-13008-01-en, October 2012 IT

321
12 Licensing Introduction
12.10 Order Information Request

Figure: Work flow when requesting order information

Table: Request Order Information

Number Description

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

IT 04-13008-01-en, October 2012

322
 12 Licensing Introduction
12.11 Lost License

12.11 Lost License

If a 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 Building Operation
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.

04-13008-01-en, October 2012 IT

323
12 Licensing Introduction
12.12 License Repair

12.12 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 an Enterprise Server, License Server or WorkStation hardware
component.

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

Figure: Damaged local and network licenses.

IT 04-13008-01-en, October 2012

324
 12 Licensing Introduction
12.13 License Backup

12.13 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.
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 licenses server,
you first have to return the liceses to the License Activtation Server and then
activate them on the new license server.
The license server files are located in the following locations:
• Windows XP: \Documents and Settings\All Users\Application Data\FLEXnet.
• Windows 7: \ProgramData\FLEXnet
• Windows Server 2008: \ProgramData\FLEXnet
Licenses restored from a backup can be considered damaged by the license
server. For more information, see section 12.12 “License Repair” on page 324.

04-13008-01-en, October 2012 IT

325
12 Licensing Introduction
12.14 Backing Up Licenses

12.14 Backing Up Licenses

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

To back up licenses
1. Close all Building Operation applications, such as License Administrator,
WorkStation, and Enterprise Server.
2. On the license server, browse to the the folder:
• Windows xp: \Documents and Settings\All Users\Application
Data\FLEXnet
• Windows 7: \ProgramData\FLEXnet
• Windows Server 2008: \ProgramData\FLEXnet
3. Copy all files in the FLEX-net folder that start with taclic_ and paste the files
onto your external backup resource.

IT 04-13008-01-en, October 2012

326
 12 Licensing Introduction
12.15 Restoring Licenses

12.15 Restoring Licenses

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

To restore licenses
1. Close all Building Operation applications, such as License Administrator,
WorkStation, and Enterprise Server.
2. On the license server, browse to the the folder:
• Windows xp: \Documents and Settings\All Users\Application
Data\FLEXnet
• Windows 7: \ProgramData\FLEXnet\
• Windows Server 2008: \ProgramData\FLEXnet\
3. Paste all your backed up files to the FLEX-net folder.

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

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

04-13008-01-en, October 2012 IT

327
13 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
Network License Upgrade
Upgrading Network Licenses
Repairing a Network License
Local Licenses
Local License Management
Activating a Local License
 13 Type of Licenses
13.1 Network Licenses

13.1 Network Licenses

Network licenses are distributed from a license server. The license server shares a
predetermined number of simultaneous instances that are available networkwide.
To start licensed clients and servers using network licenses, the required number of
licenses have to be available on the license server.

04-13008-01-en, October 2012 IT

331
13 Type of Licenses
13.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-13008-01-en, October 2012

332
 13 Type of Licenses
13.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 server that hosts the licensed product.
A checked out network license is not physically moved to the client or server. The
checked out license is allocated in the license server until the license is released by
the client or 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 licenses server.

Figure: The WorkStation checks out license from the license server.

Note
• On a server running both a license server and an Enterprise Server, use the
address @localhost so the Enterprise Server does not connect to the License
server through the network.

04-13008-01-en, October 2012 IT

333
13 Type of Licenses
13.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-13008-01-en, October 2012

334
 13 Type of Licenses
13.2 Network License Management

13.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 Building Operation systems
including the systems 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

13.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 12.10 “Order Information Request” on page 321.

13.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 13.3 “Network Licenses Activation” on page 337.

13.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 14.1 “Enterprise Server Address Configuration”
on page 363.

04-13008-01-en, October 2012 IT

335
13 Type of Licenses
13.2 Network License Management

13.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 14.2 “WorkStation and Client Tools Address
Configuration” on page 365.

13.2.5 Network License Upgrade

When a new license version is released it is recommended that you upgrade your
old versions. Customers that have signed up for the Building Operation
Maintenance Subscription are automatically notified about the new upgrade and
can directly activate the newest version. If your organization does not have the
Building Operation Maintenance Subscription, contact your Building Operation
vendor to place an upgrade order.
For more information, see section 13.7 “Network License Upgrade” on page 346.

IT 04-13008-01-en, October 2012

336
 13 Type of Licenses
13.3 Network Licenses Activation

13.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-13008-01-en, October 2012 IT

337
13 Type of Licenses
13.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-13008-01-en, October 2012

338
 13 Type of Licenses
13.4 Network License Return

13.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-13008-01-en, October 2012 IT

339
13 Type of Licenses
13.4 Network License Return

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

IT 04-13008-01-en, October 2012

340
 13 Type of Licenses
13.5 Activating Network Licenses

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

Note
• 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
Building Operation vendor.

For more information, see section 12.6 “Licenses” on page 315.

To activate network licenses

1. In License Administrator, click the Licenses view.

2. On the Licenses toolbar, click the Add license from entitlement ID button
.
Continued on next page

04-13008-01-en, October 2012 IT

341
13 Type of Licenses
13.5 Activating Network Licenses

3. In the Enter license entitlement ID box, type the entitlement ID that contains
the licenses to activate.

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

4. Click OK
OK.
5. In the Activate column, select the number of license to activate.

6. Click Activate
Activate.
Continued on next page

IT 04-13008-01-en, October 2012

342
 13 Type of Licenses
13.5 Activating Network Licenses

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-13008-01-en, October 2012 IT

343
13 Type of Licenses
13.6 Removing a Local License or Returning a Network License

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

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

Continued on next page

IT 04-13008-01-en, October 2012

344
 13 Type of Licenses
13.6 Removing a Local License or Returning a Network License

4. Click Yes
Yes.

5. Click Close
Close.

6. Click Restart now

now, to apply the changes to the license server.

04-13008-01-en, October 2012 IT

345
13 Type of Licenses
13.7 Network License Upgrade

13.7 Network License Upgrade

When a new license version is released it is recommended that you upgrade your
old versions. Customers that have signed up for the Building Operation
Maintenance Subscription are automatically notified about the new upgrade and
can directly activate the newest version. If your organization does not have the
Building Operation Maintenance Subscription, contact your Building Operation
vendor to place an upgrade order.
You activate the upgrade by using the same Entitlement ID as you used when you
first activated the licenses on your license server. Before licenses with the new
version are activated, all licenses with the older version included in the Entitlement
Certification are returned to the License Activation Server.

Note
• You cannot reactivate a returned license that has an old version.

Figure: License upgrade

Table: License Upgrade

Number Description

1 The Entitlement Certificate, which contains

the licenses to upgrade, is entered into the
License Administrator.

IT 04-13008-01-en, October 2012

346
 13 Type of Licenses
13.7 Network License Upgrade

Continued
Number Description

2 All licenses with old versions are returned to

the License Activation Server.

3 Licenses with the new version are activated

on the License Server.

04-13008-01-en, October 2012 IT

347
13 Type of Licenses
13.8 Upgrading Network Licenses

13.8 Upgrading Network Licenses

You upgrade your licenses when new versions are released, for example, to get
access to new licensed features.
For more information, see section 13.7 “Network License Upgrade” on page 346.

To upgrade network licenses

1. In License Administrator, click the Licenses view.

Continued on next page

IT 04-13008-01-en, October 2012

348
 13 Type of Licenses
13.8 Upgrading Network Licenses

2. On the Licenses toolbar, click the Add license from entitlement ID button
.

3. In the Enter license entitlement ID box, type the entitlement ID that contains
the licenses to upgrade.

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

4. Click OK
OK.
Continued on next page

04-13008-01-en, October 2012 IT

349
13 Type of Licenses
13.8 Upgrading Network Licenses

5. In the Activate column, select the number of licenses with the new version to
activate.

Note
• All licenses with old versions that are activated on the license
server with this entitlement ID are returned.

6. Click Activate
Activate.
7. Click Yes to confirm that all network licenses with the old version, included in
the entitlement, are returned to the License Activation Server.

Continued on next page

IT 04-13008-01-en, October 2012

350
 13 Type of Licenses
13.8 Upgrading Network Licenses

8. Click Close
Close.

9. Click Restart now

now, to restart the license server and make the upgraded
licenses available for checkout.

04-13008-01-en, October 2012 IT

351
13 Type of Licenses
13.9 Repairing a Network License

13.9 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 12.12 “License Repair” on page 324.

To repair a network license

1. In License 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. Click Yes
Yes.

Continued on next page

IT 04-13008-01-en, October 2012

352
 13 Type of Licenses
13.9 Repairing a Network License

5. Click Close
Close.

6. Click Restart now

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-13008-01-en, October 2012 IT

353
13 Type of Licenses
13.10 Local Licenses

13.10 Local Licenses

A local license installs on the client or server from a license file with the extension
.asr. The local license is bound to the computer and cannot be shared. The license
file to activate local licenses can only be used once.

Figure: A local license is activated on the computer that will use it and cannot be shared
with other computers.
License files to activate as time-limited local licenses are included in the installation
of Building Operation. The local license files are in the following paths:
• Windows XP: \Documents and Settings\All Users\Application Data\Schneider
Electric StruxureWare\Building Operation x.x\License Files\
• Windows server 2008: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\License Files\
• Windows 7: \ProgramData\Schneider Electric StruxureWare\Building
Operation x.x\License Files\
The x.x represents the version number. For more information, see section 13.10
“Local Licenses” on page 354.
For more information on how to order additional licenses, please contact your
Schneider Electric vendor.

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

IT 04-13008-01-en, October 2012

354
 13 Type of Licenses
13.10 Local Licenses

04-13008-01-en, October 2012 IT

355
13 Type of Licenses
13.11 Local License Management

13.11 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. The local
license cannot be distributed and shared between different WorkStations or servers
as the network license can.
License files to activate as time-limited local licenses are included in the installation
of Building Operation. The local license files are in the following paths:
• Windows XP: \Documents and Settings\All Users\Application Data\Schneider
Electric StruxureWare\Building Operation x.x\License Files\
• Windows server 2008: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\License Files\
• Windows 7: \ProgramData\Schneider Electric StruxureWare\Building
Operation x.x\License Files\
The x.x represents the version number. For more information, see section 13.10
“Local Licenses” on page 354.
For more information on how to order additional license files or license files for client
tools, please contact your Building Operation vendor.

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

IT 04-13008-01-en, October 2012

356
 13 Type of Licenses
13.12 Activating a Local License

13.12 Activating a Local License

You activate a local license on a WorkStation, client tool, or Enterprise Server, to
have as a substitute until you have set up a Building Operation stystem with
available network licenses.
License files to activate as time-limited local licenses are included in the installation
of Building Operation. The local license files are in the following paths:
• Windows XP: \Documents and Settings\All Users\Application Data\Schneider
Electric StruxureWare\Building Operation x.x\License Files\
• Windows server 2008: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\License Files\
• Windows 7: \ProgramData\Schneider Electric StruxureWare\Building
Operation x.x\License Files\
The x.x represents the version number. For more information, see section 13.10
“Local Licenses” on page 354.

Note
• 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 Building Operation vendor.

For more information, see section 12.6 “Licenses” on page 315.

04-13008-01-en, October 2012 IT

357
13 Type of Licenses
13.12 Activating a Local License

To activate a local license

1. In License Administrator, click the Licenses view.

2. On the Licenses toolbar, click the Add license from file button .
Continued on next page

IT 04-13008-01-en, October 2012

358
 13 Type of Licenses
13.12 Activating a Local License

3. Select the license file and then click Open

Open.

4. Click Close
Close.

Continued on next page

04-13008-01-en, October 2012 IT

359
13 Type of Licenses
13.12 Activating a Local License

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-13008-01-en, October 2012

360
14 Licensing Configuration and
Diagnostics

Topics
Enterprise Server Address Configuration
WorkStation and Client Tools Address Configuration
Viewing Diagnostic Information
Copying Diagnostics to the Clipboard
 14 Licensing Configuration and Diagnostics
14.1 Enterprise Server Address Configuration

14.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 servers to check out.

04-13008-01-en, October 2012 IT

363
14 Licensing Configuration and Diagnostics
14.1 Enterprise Server Address Configuration

Note
• If the Enterprise Server does not start, refer to the Enterprise Server log for
more information. For more information, see section 17.9 “Viewing Enterprise
Server System Log” on page 420.

IT 04-13008-01-en, October 2012

364
 14 Licensing Configuration and Diagnostics
14.2 WorkStation and Client Tools Address Configuration

14.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-13008-01-en, October 2012 IT

365
14 Licensing Configuration and Diagnostics
14.3 Viewing Diagnostic Information

14.3 Viewing Diagnostic Information

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

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-13008-01-en, October 2012

366
 14 Licensing Configuration and Diagnostics
14.4 Copying Diagnostics to the Clipboard

14.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 12.4 “Service and Maintenance ” on page 312.

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-13008-01-en, October 2012 IT

367
15 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 lmadmin License Server Manager Port
Number
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
License Administrator
Starting the License Administrator
 15 License Server and License Administrator
15.1 License Server

15.1 License Server

The license server manages the administration of network licenses. A Building
Operation system 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
15.12 “Configuring License Server Recovery Settings ” on page 387.
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 15.14
“License Administrator” on page 392.

15.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.
For more information, see section 15.5 “Flexnet License Administrator, License
Server Manager” on page 375.

04-13008-01-en, October 2012 IT

371
15 License Server and License Administrator
15.2 Starting the License Server

15.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 15.1 “License Server” on page 371.

To start the license server

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

Note
• 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-13008-01-en, October 2012

372
 15 License Server and License Administrator
15.3 Stopping the License Server

15.3 Stopping the License Server

You manually stop the license server, if the service is running.
For more information, see section 15.1 “License Server” on page 371.

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-13008-01-en, October 2012 IT

373
15 License Server and License Administrator
15.4 Restarting the License Server

15.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 15.1 “License Server” on page 371.

To restart the license server

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

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

2. Right-click Building Operation License Server

Server.

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

IT 04-13008-01-en, October 2012

374
 15 License Server and License Administrator
15.5 Flexnet License Administrator, License Server Manager

15.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, server configuration, or vendor
daemon configuration.

04-13008-01-en, October 2012 IT

375
15 License Server and License Administrator
15.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 .

15.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. The license server port
number is configured in the Administration part, Server Configuration tab.

IT 04-13008-01-en, October 2012

376
 15 License Server and License Administrator
15.5 Flexnet License Administrator, License Server Manager

Figure: FLEXnet License Administrator, 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 .

15.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 StruxureWare\Building Operation x.x\License Server\conf,
where x.x is the version number. The “port” attribute is found within the
“webServer” tag.

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

04-13008-01-en, October 2012 IT

377
15 License Server and License Administrator
15.6 Accessing Flexnet lmadmin

15.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 15.5 “Flexnet License Administrator, License
Server Manager” on page 375.

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 colon and then the port number.

Note
• 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-13008-01-en, October 2012

378
 15 License Server and License Administrator
15.7 Changing the lmadmin License Server Manager Port Number

15.7 Changing the lmadmin License Server

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

To change the lmadmin license server manager port number

1. On the license server, open the folder \Program Files\Schneider Electric
StruxureWare\Building Operation x.x\License Server\conf
Server\conf, where x.x 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 lmadmin license server manager, open a web browser and type in
the address to the license server with the new port number.

04-13008-01-en, October 2012 IT

379
15 License Server and License Administrator
15.8 License Server Address

15.8 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 server that hosts the licensed product.
The license server address is stored in the Windows registry key:
HKEY_LOCAL_MACHINE\SOFTWARE\Schneider Electric\StruxureWare\License
Administrator\TACLIC_LICENSE_FILE.
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-13008-01-en, October 2012

380
 15 License Server and License Administrator
15.8 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-13008-01-en, October 2012 IT

381
15 License Server and License Administrator
15.9 Configuring the Address to the License Server

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

Note
• 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 13.6 “Removing a Local License or Returning a
Network License” on page 344.

For more information, see section 13.2 “Network License Management” on page
335.

To configure the address to the license server

1. In License Administrator, click the Licenses server address view.
Continued on next page

IT 04-13008-01-en, October 2012

382
 15 License Server and License Administrator
15.9 Configuring the Address to the License Server

2. In the License server address box, type @ and then type the address to the
server.

Note
• The address must begin with an @.
• If you use a port other than the default port of 27000, type the
port number in front of @. For example, 567@localhost.
• Use a semicolon to separate addresses to different license
servers.

3. Click Save
Save.
Next time a WorkStation, client tool, or Enterprise Server starts, it checks out
available network licenses from a defined license server.

Note
• The license server address is configured individually on all WorkStations and
Enterprise Servers.

04-13008-01-en, October 2012 IT

383
15 License Server and License Administrator
15.10 License Server Reset

15.10 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 a license server are
compiled in files that start with "taclic" and has the .data extension. The file name
string after "taclic" can differ. An example of a 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 XP: \Documents and Settings\All Users\Application Data\FLEXnet
• Windows 7: \ProgramData\FLEXnet
• Windows Server 2008: \ProgramData\FLEXnet
Before deleting the license server files, you have to return all activated network
licenses to the License Activation Server.

Note
• If you delete the license server files, all activated network licenses are lost.

IT 04-13008-01-en, October 2012

384
 15 License Server and License Administrator
15.11 Resetting the License Server

15.11 Resetting the License Server

You reset the license server if it does not work correctly.

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

For more information, see section 15.10 “License Server Reset” on page 384.

To reset the license server

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

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

Continued on next page

04-13008-01-en, October 2012 IT

385
15 License Server and License Administrator
15.11 Resetting the License Server

4. Click Yes
Yes.

5. Click Close
Close.

6. Close all running Building Operation programs.

7. Stop the license server.
8. In the license server application folder, remove all .data files that start with
taclic
taclic:
• Windows XP: \Documents and Settings\All Users\Application
Data\FLEXnet
• Windows 7: \ProgramData\FLEXnet
• Windows Server 2008: \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.

IT 04-13008-01-en, October 2012

386
 15 License Server and License Administrator
15.12 Configuring License Server Recovery Settings

15.12 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 15.1 “License Server” on page 371.

To configure the license server recovery settings

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

Note
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.
Continued on next page

04-13008-01-en, October 2012 IT

387
15 License Server and License Administrator
15.12 Configuring License Server Recovery Settings

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.

IT 04-13008-01-en, October 2012

388
 15 License Server and License Administrator
15.13 License Server Maintenance

15.13 License Server Maintenance

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.

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

15.13.2 License Server Reinstallation

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

15.13.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 server.

04-13008-01-en, October 2012 IT

389
15 License Server and License Administrator
15.13 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
server. If a new network address is assigned, update all WorkStations and
Enterprise Servers with the address to the new license server.

IT 04-13008-01-en, October 2012

390
 15 License Server and License Administrator
15.13 License Server Maintenance

15.13.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 a license server are
compiled in files that start with "taclic" and has the .data extension. The file name
string after "taclic" can differ. An example of a 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 15.10 “License Server Reset” on page 384.

04-13008-01-en, October 2012 IT

391
15 License Server and License Administrator
15.14 License Administrator

15.14 License Administrator

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

15.14.1 Registration Details

Before the first network license is activated on a license server, details about the
customer’s organization and the contact information to the account manager must
be entered. The registration details are written to the license details when a license
is activated. Building Operation automatically saves these registration details and
reuses the details the next time a license is activated.

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

Note
• To ensure that all the licenses have the same information, the registration
details must be updated on all license servers in the Building Operation
system.

15.14.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 server that hosts the licensed product.

IT 04-13008-01-en, October 2012

392
 15 License Server and License Administrator
15.15 Starting the License Administrator

15.15 Starting the License Administrator

The License Administrator administrates the licenses on the license server and
defines the address to the license servers for all licensed Building Operation
products.
For more information, see section 15.14 “License Administrator” on page 392.

To start the license administrator

1. Click Start
Start, point to Schneider Electric\StruxureWare
Electric\StruxureWare, and then click
License Administrator
Administrator.
2. Click Yes
Yes, to confirm that you want to run License Administrator.

04-13008-01-en, October 2012 IT

393
16 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
 16 Licensing User Interface
16.1 Registration Details View

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

Note
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-13008-01-en, October 2012 IT

397
16 Licensing User Interface
16.1 Registration Details View

Continued
Component Description

Telephone number Type the phone number of the account

manager that supplied the license.

IT 04-13008-01-en, October 2012

398
 16 Licensing User Interface
16.2 Licenses View

16.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 16.3 “Licenses View Toolbar” on
page 400.

Use the Licenses view columns to view

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

Use the Licenses view icons to get

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

04-13008-01-en, October 2012 IT

399
16 Licensing User Interface
16.3 Licenses View Toolbar

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

IT 04-13008-01-en, October 2012

400
 16 Licensing User Interface
16.4 Licenses View Icons

16.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 a 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-13008-01-en, October 2012 IT

401
16 Licensing User Interface
16.5 Licenses View Columns

16.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-13008-01-en, October 2012

402
 16 Licensing User Interface
16.6 Add License Dialog Box

16.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-13008-01-en, October 2012 IT

403
16 Licensing User Interface
16.7 License Activation Dialog Box

16.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 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-13008-01-en, October 2012

404
 16 Licensing User Interface
16.7 License Activation Dialog Box

Continued
Component Description

Activate (button) Click to activate the selected number of

licenses.

04-13008-01-en, October 2012 IT

405
16 Licensing User Interface
16.8 License Progress Dialog Box

16.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-13008-01-en, October 2012

406
 16 Licensing User Interface
16.9 License Server Address View

16.9 License Server Address View

Use the License Server Address view to specify the address to a 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-13008-01-en, October 2012 IT

407
16 Licensing User Interface
16.10 Diagnostics View

16.10 Diagnostics View

Use the Diagnostics view to list the licenses with license details located on a
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-13008-01-en, October 2012

408
17 Software Administrator

Topics
Software Administrator
Enterprise Server
Starting Software Administrator
Configuring Enterprise Server Port Settings
Starting the Enterprise Server Windows Service
Stopping the Enterprise Server Windows Service
Restarting the Enterprise Server Windows Service
Enterprise Server System Log
Viewing Enterprise Server System Log
Software Administrator – Enterprise Server View
 17 Software Administrator
17.1 Software Administrator

17.1 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.
Other Enterprise Server settings, for example e-mail service, time, and time zone
settings are configured through WorkStation.

17.1.1 Service
The Enterprise Server runs in the background as a Windows service. You start and
stop the Enterprise Server service through the Software Administrator or Windows
Service. Before shutting down the Enterprise Server, make sure the stop does not
negatively affect your site.

17.1.2 Ports
The Enterprise Server uses HTTP and TCP protocols to communicate with other
servers and clients. In the Software Administrator, you configure the port number of
each protocol the Enterprise Server listens to when communicating through a
specific protocol.

Note
To configure a protocol port number, you first have to stop the running Enterprise
Server service.

17.1.3 Database Location

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

17.1.4 Enterprise Server System Log

The Enterprise Server System log contains events logged by the Enterprise Server.
Examples of logged events are start up sequence, port settings, failures, run time,
and current server status.

04-13008-01-en, October 2012 IT

411
17 Software Administrator
17.2 Enterprise Server

17.2 Enterprise Server

Depending on the size and requirements of the Building Operation system, one or
(in future releases) several Enterprise Servers are connected on the network. Both
Script and Function Block programmed Automation Servers are supported by the
Enterprise Server.
Enterprise Servers run on Windows PCs and operate as fully distributed peer-to-
peer devices.

Figure: An Enterprise Server network

IT 04-13008-01-en, October 2012

412
 17 Software Administrator
17.3 Starting Software Administrator

17.3 Starting Software Administrator

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

To start Software Administrator

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

04-13008-01-en, October 2012 IT

413
17 Software Administrator
17.4 Configuring Enterprise Server Port Settings

17.4 Configuring Enterprise Server Port

Settings
You configure the Enterprise Server HTTP and TCP ports to define the
communication of the different protocols.
For more information, see section 17.1 “Software Administrator” on page 411.

To configure the ports for the Enterprise Server

1. In Software Administrator
Administrator, click Stop Service
Service.

2. In the HTTP Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Protocol.
3. In the HTTPS Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Secure Protocol.
4. In the TCP Port box, type the port number that the server listens to when
communicating through the Transmission Control Protocol.
5. Click Apply
Apply.
6. Click Start Service
Service.

IT 04-13008-01-en, October 2012

414
 17 Software Administrator
17.5 Starting the Enterprise Server Windows Service

17.5 Starting the Enterprise Server Windows

Service
You start the Enterprise Server to manage your Building Operation system.

Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see
section 12.6 “Licenses” on page 315.

Note
• The Enterprise Server is automatically started when installed or when the
server is restarted.

For more information, see section 17.1 “Software Administrator” on page 411.

To start the Enterprise Server windows service

1. In Software Administrator
Administrator, click Start Service
Service.

04-13008-01-en, October 2012 IT

415
17 Software Administrator
17.6 Stopping the Enterprise Server Windows Service

17.6 Stopping the Enterprise Server

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

To stop the Enterprise Server Windows service

1. In Software Administrator
Administrator, click Stop Service
Service.

IT 04-13008-01-en, October 2012

416
 17 Software Administrator
17.7 Restarting the Enterprise Server Windows Service

17.7 Restarting the Enterprise Server

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

Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see
section 12.6 “Licenses” on page 315.

For more information, see section 17.1 “Software Administrator” on page 411.

To restart the Enterprise Server Windows service

1. In Software Administrator
Administrator, click Stop Service
Service.

Continued on next page

04-13008-01-en, October 2012 IT

417
17 Software Administrator
17.7 Restarting the Enterprise Server Windows Service

2. Click Start Service

Service.

IT 04-13008-01-en, October 2012

418
 17 Software Administrator
17.8 Enterprise Server System Log

17.8 Enterprise Server System Log

The Enterprise Server System log contains events logged by the Enterprise Server.
Examples of logged events are start up sequence, port settings, failures, run time,
and current server status.
The log is displayed in the SoftWare Administrator dialog box. The log can also be
found in the db, database folder, in the Enterprise folder.

04-13008-01-en, October 2012 IT

419
17 Software Administrator
17.9 Viewing Enterprise Server System Log

17.9 Viewing Enterprise Server System Log

You view logged server events in the Enterprise Server system log to troubleshoot
server problems that are traced to the Enterprise Server.
For more information, see section 17.8 “Enterprise Server System Log” on page
419.

To view the Enterprise Server system log

1. In the Software Administrator, in the System box, view the events in the
system log.

2. When finished, click OK

OK.

IT 04-13008-01-en, October 2012

420
 17 Software Administrator
17.10 Software Administrator – Enterprise Server View

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

04-13008-01-en, October 2012 IT

421
17 Software Administrator
17.10 Software Administrator – Enterprise Server View

Continued
Component Description

System Displays the system log.

Path Displays the path to the folder where the

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

IT 04-13008-01-en, October 2012

422
18 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
 18 User Account Management
18.1 User Account Management Overview

18.1 User Account Management Overview

When logging on to a Building Operation 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 server that acts as the domain controller, in this example an
Enterprise Server, you have access to all servers in the domain without using
additional log on. If you log on to an individual server, in this example an Automation
Server, you have no access to other servers in the domain.

Figure: To log on to a Building Operation server you have to use a valid user account that
is located in the same domain as the server.
Building Operation 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
• The user account group belongs to a domain

04-13008-01-en, October 2012 IT

425
18 User Account Management
18.1 User Account Management Overview

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

18.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 18.3 “User Accounts and User Account Groups”
on page 429.

18.1.2 Domains
A Building Operation domain contains user accounts, user account groups,
software permissions, workspaces, and one or several Building Operation servers.
The Building Operation server that host and administrates the domain is called the
domain controller.
For more information, see section 20.1 “Domains” on page 483.

18.1.3 Software Permissions

Software Permissions are used to control user activities in a software application.
For example, you can set up these permissions to manage the type of data and
commands the user has permission to within a workspace, panel, or domain.
Software permissions comprise path permissions and command permissions.
For more information, see section 21.1 “Software Permissions” on page 507.

18.1.4 Log on Methods

Building Operation 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 Building
Operation user with your Building Operation user account.
For more information, see section 20.2 “Log On Methods” on page 486.

18.1.5 Workspaces
The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted to users or user account groups different
tasks.
For more information, see WebHelp.

IT 04-13008-01-en, October 2012

426
 18 User Account Management
18.1 User Account Management Overview

18.1.6 Guest Log On in WebStation

A guest log on is used if you want the user to get immediate access to Building
Operation using WebStation.
For more information, see section 20.3 “Guest Log On in WebStation” on page 487.

04-13008-01-en, October 2012 IT

427
18 User Account Management
18.2 Opening the Account Management Control Panel

18.2 Opening the Account Management

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

To open the Account Management control panel

1. On the Tools menu, click Control Panel
Panel.
2. Click Account management
management.

IT 04-13008-01-en, October 2012

428
 18 User Account Management
18.3 User Accounts and User Account Groups

18.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
22.1 “Password Administration” on page 531.
• 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 20.1 “Domains” on
page 483.
• Manage accounts at the domain level using a default administrator account.
For more information, see section 20.11 “Administration Accounts in Server
Local Domain” on page 504.
• Track user activity at the user-account level. For more information, see section
24.2 “Audit Trailing of User Activity” on page 590.

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-13008-01-en, October 2012 IT

429
18 User Account Management
18.3 User Accounts and User Account Groups

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

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

18.3.1 Window Active Directory User Groups

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

IT 04-13008-01-en, October 2012

430
 18 User Account Management
18.3 User Accounts and User Account Groups

18.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 24.1 “WorkStation Account Management” on
page 589.

04-13008-01-en, October 2012 IT

431
18 User Account Management
18.4 Creating a User Account

18.4 Creating a User Account

You create and configure a user account for each person requiring access to
Building Operation.
For more information, see section 18.3 “User Accounts and User Account Groups”
on page 429.

To create a user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select a server for the user account.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

432
 18 User Account Management
18.4 Creating a User Account

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. In the Name box, type a name for the user account.

7. In the Description box, type a description.

8. Click Next
Next.
Continued on next page

04-13008-01-en, October 2012 IT

433
18 User Account Management
18.4 Creating a User Account

9. 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 E-mail address box, type the user's e-mail address.
13. In the Work E-mail address
address, type the users work e-mail 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.
Continued on next page

IT 04-13008-01-en, October 2012

434
 18 User Account Management
18.4 Creating a User Account

15. In the Password box, type a password for the user.

16. In the Confirm Password box, type the password again.

17. Click Create
Create.
18. Click OK
OK.

04-13008-01-en, October 2012 IT

435
18 User Account Management
18.5 Editing a User Account Profile

18.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 18.3 “User Accounts and User Account Groups”
on page 429.

To edit a user account profile

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list box, select the server where the user
account is located.

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 box, select the user account you want to edit the
profile information.
6. Click Summary
Summary.
7. Click the Profile tab.
Continued on next page

IT 04-13008-01-en, October 2012

436
 18 User Account Management
18.5 Editing a User Account Profile

8. Edit the user account profile information.

9. Click the Save button .

04-13008-01-en, October 2012 IT

437
18 User Account Management
18.6 Renaming a User Account

18.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 18.3 “User Accounts and User Account Groups”
on page 429.

To rename a user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account you are
renaming.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

438
 18 User Account Management
18.6 Renaming a User Account

4. Click List users

users.

5. Select the user account you want to rename.

6. On the Edit menu, click Rename

Rename.
7. In the Object Name box, type a new name for the user account.

8. Click OK
OK.

04-13008-01-en, October 2012 IT

439
18 User Account Management
18.7 Disabling a User Account

18.7 Disabling a User Account

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

To disable a user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.

2. In the Server list, select the server containing the user account you want to
disable.
Continued on next page

IT 04-13008-01-en, October 2012

440
 18 User Account Management
18.7 Disabling a User Account

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 you want to disable.
6. Click Summary
Summary.
7. In the Disabled box, select True to disable the account.

8. Click the Save button .

04-13008-01-en, October 2012 IT

441
18 User Account Management
18.8 Enabling a Disabled User Account

18.8 Enabling a Disabled User Account

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

To enable a disabled user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account you want to
enable.

Continued on next page

IT 04-13008-01-en, October 2012

442
 18 User Account Management
18.8 Enabling a Disabled User Account

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 Disabled box, select False to enable the account.

8. Click the Save button .

04-13008-01-en, October 2012 IT

443
18 User Account Management
18.9 Setting an Expiration Date for a User Account

18.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 18.3 “User Accounts and User Account Groups”
on page 429.

To set an expiration date for a user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account you want to set
an expiration date for.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

444
 18 User Account Management
18.9 Setting an Expiration Date for a User Account

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 Expires on boxes, select the date and the time when you want the user
account to expire.

8. Click the Save button .

04-13008-01-en, October 2012 IT

445
18 User Account Management
18.10 Removing the Expiration Date for a User Account

18.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 18.3 “User Accounts and User Account Groups”
on page 429.

To remove the expiration date for a user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account for which you
are removing the expiration date.
3. Click Account management
management.

Continued on next page

IT 04-13008-01-en, October 2012

446
 18 User Account Management
18.10 Removing the Expiration Date for a User Account

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 Expires on boxes, remove the date and time settings for the account.

8. Click the Save button .

04-13008-01-en, October 2012 IT

447
18 User Account Management
18.11 Deleting a User Account

18.11 Deleting a User Account

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

To delete a user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list box, select the server with the domain
the user account belongs to.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

448
 18 User Account Management
18.11 Deleting a User Account

4. 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-13008-01-en, October 2012 IT

449
19 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
 19 User Account Groups
19.1 Windows Active Directory User Groups

19.1 Windows Active Directory User Groups

You can map Windows Active Directory groups to Building Operation user account
groups if Building Operation runs on a network that uses this directory to manage
users and user account groups. A Building Operation user account group that
includes a Windows account group can be member of another Building Operation
user account group.
Mapping Windows Active Directory account groups to 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 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 a Building Operation account, the user is authenticated
to access WorkStation without having to log in a second time.

Note
• The Building Operation domain used to map the Windows Active Directory
user account groups must be a member of the Windows domain where the
Active Directory is located.
Windows Active Directory account groups can only be mapped on servers that
are based upon Microsoft Windows operating system. Other servers, for example
Automation Servers, cannot map Windows Active Directory groups.

For example, the Windows Active Directory user account groups Main Admin and
Main User are mapped to the 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.

04-13008-01-en, October 2012 IT

453
19 User Account Groups
19.1 Windows Active Directory User Groups

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

IT 04-13008-01-en, October 2012

454
 19 User Account Groups
19.2 Creating a User Account Group

19.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 21.2 “Software Permissions and User Account
Groups” on page 509.

To create a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select a server for the user account group.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

455
19 User Account Groups
19.2 Creating a User Account Group

4. In the Domain box, select the server where you want to create the user
account group.

5. In the User Account Groups area, click Add

Add.
6. 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.
Continued on next page

IT 04-13008-01-en, October 2012

456
 19 User Account Groups
19.2 Creating a User Account Group

9. 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 Account list, select the user accounts you want to add
to the user account group.

11. Click the Add button .

12. Click Next
Next.
Continued on next page

04-13008-01-en, October 2012 IT

457
19 User Account Groups
19.2 Creating a User Account Group

13. 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 Selected Workspaces box, select the workspaces you want available
to the user account group.

15. Click the Add button .

16. Click Next
Next.
Continued on next page

IT 04-13008-01-en, October 2012

458
 19 User Account Groups
19.2 Creating a User Account Group

17. 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 Automation Servers'
Web configuration sites.

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

Note
To connect a Windows Active Directory user account group to a
Building Operation user account group, you need to establish the
connection between the Building Operation domain and Active
Directory Windows domain. For more information, see section 20.4
“Creating and Configuring a Domain” on page 488.
Windows Active Directory account groups can only be mapped on
servers that are based upon Microsoft Windows operating system.
Other servers, for example Automation Servers, cannot map
Windows Active Directory groups.

22. In the Windows group name box, select the Windows Active Directory user
account group you want to map to the Building Operation user account
group.
23. Click Create
Create.

04-13008-01-en, October 2012 IT

459
19 User Account Groups
19.3 Editing the Description of a User Account Group

19.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 18.3 “User Accounts and User Account Groups”
on page 429.

To edit the description of a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group you
want to edit the description for.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

460
 19 User Account Groups
19.3 Editing the Description of a User Account Group

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 you want to
edit the description for.
6. Click Summary
Summary.

7. In the Description box, type a new description for the user account group.

8. Click the Save button .

04-13008-01-en, October 2012 IT

461
19 User Account Groups
19.4 Adding a User Account to a User Account Group

19.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 18.3 “User Accounts and User Account Groups”
on page 429.

To add a user account to a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list, select the server where the user
account is located.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

462
 19 User Account Groups
19.4 Adding a User Account to a User Account Group

4. 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 Available User Account Groups list, select a user account group and

click the Add button .

8. On the File menu, click Save

Save.

04-13008-01-en, October 2012 IT

463
19 User Account Groups
19.5 Removing a User Account from a User Account Group

19.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 18.3 “User Accounts and User Account Groups”
on page 429.

To remove a user account from a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account whose user
account group membership you want to remove.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

464
 19 User Account Groups
19.5 Removing a User Account from a User Account Group

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 Group membership
membership.
7. In the Selected User Account Groups list, select the user account group you

want to remove, and click the Remove button .

8. Click the Save button .

04-13008-01-en, October 2012 IT

465
19 User Account Groups
19.6 Reviewing the User Account Group Memberships for a User Account

19.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 18.3 “User Accounts and User Account Groups”
on page 429.

To review the group memberships for a user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account you want to
review the user account group memberships for.

3. Click Account Management

Management.
Continued on next page

IT 04-13008-01-en, October 2012

466
 19 User Account Groups
19.6 Reviewing the User Account Group Memberships for a User Account

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.

04-13008-01-en, October 2012 IT

467
19 User Account Groups
19.7 Adding a User Account Group to a User Account Group

19.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 18.3 “User Accounts and User Account Groups”
on page 429.

To add a user account group to a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group you
want to add to another user account group.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

468
 19 User Account Groups
19.7 Adding a User Account Group to a User Account Group

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

Continued on next page

04-13008-01-en, October 2012 IT

469
19 User Account Groups
19.7 Adding a User Account Group to a User Account Group

8. Click the Save button .

IT 04-13008-01-en, October 2012

470
 19 User Account Groups
19.8 Removing a User Account Group from another User Account Group

19.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 18.3 “User Accounts and User Account Groups”
on page 429.

To remove a user account group from another user account

group
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server that contain the user account group with
the user account group membership you want to remove.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

471
19 User Account Groups
19.8 Removing a User Account Group from another User Account Group

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.
7. 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. Click the Save button .

IT 04-13008-01-en, October 2012

472
 19 User Account Groups
19.9 Reviewing the User Account Group Memberships for a User Account Group

19.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 18.3 “User Accounts and User Account Groups”
on page 429.

To review the user account group memberships for a user

account group
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group whose
group membership you want to view.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

473
19 User Account Groups
19.9 Reviewing the User Account Group Memberships for a User Account Group

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.

IT 04-13008-01-en, October 2012

474
 19 User Account Groups
19.10 Preventing a Group of Users from Exiting WorkStation

19.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 Building Operation system computer.
This feature must be disabled for all user account groups the user is a member of.
For more information, see section 18.3 “User Accounts and User Account Groups”
on page 429.

To prevent a group of users from exiting WorkStation

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group whose
members you want to prevent from exiting WorkStation.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

475
19 User Account Groups
19.10 Preventing a Group of Users from Exiting WorkStation

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. Clear the May close User Interface box.

8. Click the Save button .

IT 04-13008-01-en, October 2012

476
 19 User Account Groups
19.11 Enabling a Group of Users to Exit Workstation

19.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 18.3 “User Accounts and User Account Groups”
on page 429.

To enable a group of users to exit WorkStation

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

477
19 User Account Groups
19.11 Enabling a Group of Users to Exit Workstation

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. Select the May close User Interface box.

8. Click the Save button .

IT 04-13008-01-en, October 2012

478
 19 User Account Groups
19.12 Deleting a User Account Group

19.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 18.3 “User Accounts and User Account Groups”
on page 429.

To delete a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list, select the server with the domain the
user account group belongs to.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

479
19 User Account Groups
19.12 Deleting a User Account Group

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 you want to
delete.

6. Click the Delete button .

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

IT 04-13008-01-en, October 2012

480
20 Domains

Topics
Domains
Log On Methods
Guest Log On 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 Server to a Domain
Removing a Server from a Domain
Deleting a Domain
Administration Accounts in Server Local Domain
 20 Domains
20.1 Domains

20.1 Domains
A Building Operation domain contains user accounts, user account groups,
software permissions, workspaces, and one or several Building Operation servers.
The Building Operation server that host and administrates the domain is called the
domain controller.
A user or user account group that is a member of a domain which hosts several
Building Operation servers has access to all servers within the domain without
additional logon. Provided that the user account does not have any restricted path
permissions which prevent the user to access the servers.
You can set up domains in several ways. You can have a communication domain
that only contains Building Operation servers and one domain that contains users,
workspaces, and software permissions. Or you can have a combined domain that
manages both servers and users.

Note
A Building Operation server can belong to more than one domain.

For example, a Building Operation system consist of two domains, the Inner City
domain and the Outer city domain. The user Larry has a user account at 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, beside the shared Automation Server.

04-13008-01-en, October 2012 IT

483
20 Domains
20.1 Domains

Figure: Building Operation domain and its components.

Note
You cannot change the name of a domain that is shared between servers.

20.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 Building Operation domain and the
Windows Active Directory. This connection enables inherit user account groups
from the Windows Active Directory to Building Operation, and allows users to login
to WorkStation with their Windows user account.

Important
If the Windows Active Directory name is changed, you have to manually update
the change in Building Operation.

IT 04-13008-01-en, October 2012

484
 20 Domains
20.1 Domains

20.1.2 Server Local Domain

All servers have by default a local domain that includes a local administrator
account, administrator user account group, and administrator workspace. The local
domain of a server cannot hold a Building Operation multiserver 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 Building
Operation servers.

20.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 server, using the local administrator and local reports administrator
accounts.
For more information, see section 20.11 “Administration Accounts in Server Local
Domain” on page 504.

04-13008-01-en, October 2012 IT

485
20 Domains
20.2 Log On Methods

20.2 Log On Methods

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

20.2.1 Log On as a Windows User

If you are logged on with a Windows user account that is mapped in Building
Operation to the Windows Active Directory user account group that you belong to,
you can select a Building Operation server and log on in a single sign-on. For more
information, see WebHelp.
You can also log on using another Windows account that is mapped in Building
Operation. For more information, see WebHelp.

20.2.2 Log On as a Building Operation User

When logging on as a Building Operation user, you authenticate yourself with a
Building Operation account user name and password. For more information, see
WebHelp.
You also select which Building Operation domain and server that you want to
access. For more information, see section 18.3 “User Accounts and User Account
Groups” on page 429.
With a Building Operation user account, you can also connect directly to the local
domain of a server. For more information, see section 20.11 “Administration
Accounts in Server Local Domain” on page 504.

20.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 ability of users to
change their passwords.
For more information, see section 22.1 “Password Administration” on page 531.

IT 04-13008-01-en, October 2012

486
 20 Domains
20.3 Guest Log On in WebStation

20.3 Guest Log On in WebStation

A guest log on is used if you want the user to get immediate access to Building
Operation 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 log on is created using WorkStation and must be named GUEST and use
the password GUEST. The guest log on is valid for the domain it is created on. The
guest log on can be added to any user group in the system.

04-13008-01-en, October 2012 IT

487
20 Domains
20.4 Creating and Configuring a Domain

20.4 Creating and Configuring a Domain

You create a domain to group servers, users, and user groups in one domain so
that all users and user groups of the domain have access to all 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 Building
Operation, and to allow users to log on to WorkStation with their Windows user
account.
For more information, see section 20.1 “Domains” on page 483.

To create and configure a domain

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select a server for which you want to create a domain.

3. Click Domain
Domain.
4. Click Add
Add.

Continued on next page

IT 04-13008-01-en, October 2012

488
 20 Domains
20.4 Creating and Configuring a Domain

5. In the Name box, type a name for the domain.

6. In the Description box, type a description for the domain.

7. Click Next
Next.
8. In the Windows domain name box, type the name of a Windows Active
Directory domain to connect the domain to a Windows domain.

Note
• The Windows domain name box is case sensitive. The name
must be spelled exactly as the name of the Windows Active
Directory domain.

Continued on next page

04-13008-01-en, October 2012 IT

489
20 Domains
20.4 Creating and Configuring a Domain

9. Click Next
Next.
10. In the Available Servers box, select the servers that you want to connect to
the domain.

Note
• The Domain Members page appears only if there are any
servers available to connect to the domain.

Continued on next page

IT 04-13008-01-en, October 2012

490
 20 Domains
20.4 Creating and Configuring a Domain

11. Click the Add button .

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

04-13008-01-en, October 2012 IT

491
20 Domains
20.5 Editing the Windows Domain Name

20.5 Editing the Windows Domain Name

In order for members of the Windows Active Directory to be mapped into the
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 20.1 “Domains” on page 483.

To edit the Windows domain name

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the domain is located.

3. Click Domain
Domain.
4. In the Domains box, select the domain that you want to edit.

5. Click Summary
Summary.
Continued on next page

IT 04-13008-01-en, October 2012

492
 20 Domains
20.5 Editing the Windows Domain Name

6. In the Windows domain name box, type the name of the customer's
Windows domain, using the same spelling as the name of the Windows Active
Directory domain you want to connect to.

7. Click the Save button .

04-13008-01-en, October 2012 IT

493
20 Domains
20.6 Editing the Description of a Domain

20.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 20.1 “Domains” on page 483.

To edit the description of a domain

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the domain is located.

3. Click Domain
Domain.
4. In the Domains box, select the domain for which you wish to edit the
description.

5. Click Summary
Summary.
Continued on next page

IT 04-13008-01-en, October 2012

494
 20 Domains
20.6 Editing the Description of a Domain

6. In the Description box, type a description for the domain.

7. Click the Save button .

04-13008-01-en, October 2012 IT

495
20 Domains
20.7 Editing the Maximum Logon Attempts

20.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 20.1 “Domains” on page 483.

To edit the maximum logon attempts

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the domain is located.

3. Click Domain
Domain.
4. In the Domains box, select the domain that you want to edit.

5. Click Policies
Policies.
Continued on next page

IT 04-13008-01-en, October 2012

496
 20 Domains
20.7 Editing the Maximum Logon Attempts

6. In the Maximum logon attempts box, enter a new number.

7. On the File menu, click the Save

Save.

04-13008-01-en, October 2012 IT

497
20 Domains
20.8 Assigning a Server to a Domain

20.8 Assigning a Server to a Domain

You assign a server to a domain in the live system to extend your current domain.
For more information, see section 20.1 “Domains” on page 483.

To assign a server to a domain

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. Click Domain
Domain.

3. In the Domains list, select the domain you are adding a server to.

4. Click Domain members

members.
Continued on next page

IT 04-13008-01-en, October 2012

498
 20 Domains
20.8 Assigning a Server to a Domain

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

6. Click the Save button .

04-13008-01-en, October 2012 IT

499
20 Domains
20.9 Removing a Server from a Domain

20.9 Removing a Server from a Domain

You remove a server from a domain, for example, limit the Building Operation
system to only hold servers in use.
For more information, see section 20.1 “Domains” on page 483.

To remove a server from a domain

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. Click Domain
Domain.

3. In the Domains list, select a domain.

4. Click Domain members

members.
Continued on next page

IT 04-13008-01-en, October 2012

500
 20 Domains
20.9 Removing a Server from a Domain

5. In the Selected Servers list, select the server, and click the Remove button

6. Click the Save button .

04-13008-01-en, October 2012 IT

501
20 Domains
20.10 Deleting a Domain

20.10 Deleting a Domain

You delete a domain that is not anymore necessary in the Building Operation
system.
For more information, see section 20.1 “Domains” on page 483.

Note
• You cannot delete the default local domain that was installed with the system.
• You cannot restore a domain that you have deleted.

To delete a domain
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the domain you are deleting is
located.

3. Click Domain
Domain.
4. In the Domain list, select the domain you are deleting.

Continued on next page

IT 04-13008-01-en, October 2012

502
 20 Domains
20.10 Deleting a Domain

5. Click the Delete button .

6. Click Yes
Yes.

7. In the Confirm Delete dialog box, click Yes

Yes.

04-13008-01-en, October 2012 IT

503
20 Domains
20.11 Administration Accounts in Server Local Domain

20.11 Administration Accounts in Server Local

Domain
You can manage user accounts on a domain controller by logging on to the local
domain of the server, using the local administrator and local reports administrator
accounts.

20.11.1 Admin Account

Each Building Operation server has a local administrator account, named admin.
This account is preferably used to log on to the 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.

20.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.
For more information, see WebHelp.

IT 04-13008-01-en, October 2012

504
21 Software Permissions

Topics
Software Permissions
Software Permissions and User Account Groups
Software Permission Rules
Path Permissions
Command Permissions
Assigning Software Permissions to a User Account
Editing the Software Permissions of a User Account
Assigning Software Permissions to a User Account Group
Editing the Software Permissions of a User Account Group
 21 Software Permissions
21.1 Software Permissions

21.1 Software Permissions

Software Permissions are used to control user activities in a software application.
For example, you can set up these permissions to manage the type of data and
commands the user has permission to within a workspace, panel, or domain.
Software permissions comprise path permissions and command permissions.
If no software permissions are configured for a user account or its belonging user
account group, the user has no access to Building Operation.

Note
• When creating a new user account, the account has by default no
permissions to access Building Operation.
• Any changes to a software permission settings of a user or user group are
applied next time the user logs on.

21.1.1 Path Permissions

Path permissions give a user or user account group basic permissions to the
objects defined in a path. The permission level set on a path applies to all
subbranches unless you set a new permission level for a subbranch.
For more information, see section 21.4 “Path Permissions” on page 512.

21.1.2 Command Permissions

To make the system even more flexible and useful, you can assign a user account
group with special command permissions. Use the command permission to control
exceptions from path permissions that allow or deny actions on specific
commands.
For more information, see section 21.5 “Command Permissions ” on page 515.

21.1.3 Software Permission Rules

Software permissions provide members of user account groups with certain rights
and privileges.
For more information, see section 21.3 “Software Permission Rules” on page 511.

21.1.4 Software Permissions and User Account

Groups
A user account group assembles both user accounts and other user account
groups with similar interests. By using a well planned strategy for your user account
groups, you easily apply software permissions and polices to multiple user
accounts.

04-13008-01-en, October 2012 IT

507
21 Software Permissions
21.1 Software Permissions

For more information, see section 21.2 “Software Permissions and User Account
Groups” on page 509.

21.1.5 Software Permissions Summary

Similar to branches on a tree, software permissions direct users down a particular
path in Building Operation. Along this path or branch, users can be granted
permission to a set of read/write commands that control what they see and do. For
example, an operator uses only a few objects on the WorkStation System Tree,
such as Alarms and trend charts to acknowledge an alarm and survey the system.
The operator has therefore access to those object, while other objects and
commands that are not within the operator's responsibility are hidden.

IT 04-13008-01-en, October 2012

508
 21 Software Permissions
21.2 Software Permissions and User Account Groups

21.2 Software Permissions and User Account

Groups
A user account group assembles both user accounts and other user account
groups with similar interests. By using a well planned strategy for your user account
groups, you easily apply software permissions and polices to multiple user
accounts.
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 Building Operation applications. For instance, you can group
software permissions with user accounts based on common tasks and
responsibilities
You create user accounts groups and then apply one or more software
permissions. For example, create a user account for Paul and associate him with
the two user account groups: Administrators and Janitors. Paul inherits the
software permissions of both user account groups. You can also set up general
policies for the user accounts that are members to the user account group. For
example, you can enable or disable the ability of group members to change their
passwords or to close the User Interface. For more information, see section 21.1
“Software Permissions” on page 507.

Figure: Users inherit the user account group permissions of which they are members
Paul and Susan are members of the Janitor user account group, which includes an
Operator workspace and a set of software permissions. The Janitor group is also a
member of the Operator group. Therefore, the Janitor group inherits the settings
and workspaces of the Operator group. In other words, Paul and Susan share the
software permissions of both the Janitor and the Operator groups, and have access
to the Operator and Janitor workspaces.

04-13008-01-en, October 2012 IT

509
21 Software Permissions
21.2 Software Permissions and User Account Groups

Figure: Software permissions and workspaces are assigned to user account groups

IT 04-13008-01-en, October 2012

510
 21 Software Permissions
21.3 Software Permission Rules

21.3 Software Permission Rules

Software permissions provide members of user account groups with certain rights
and privileges.
Building Operation uses the following basic rules to interpret software permission
priorities:
• The path permission settings of lower branches overrule the settings of higher
branches within a user account group.
For example, a user account group has the Read permission to the path
/Trend_Logs and Full Access permission to the subbranch /Trend_Charts.
Users in the user account group have permission to modify the objects in the
/Trend_Charts but can only view the objects in the superior /Trend_Logs.
If the path /System has the permission level Read, and the subbranch /Alarms
has the permission level Full Access, the users in the group have full access to
the objects in the /Alarms path.
• The highest permission rule wins between user account groups.
For example, if a user has inherited the permission to accept an alarm from one
group, this overrules settings from other groups that deny the user the
permission to acknowledge alarms.
• The software permissions for a single user account overrule the permissions of
any inherited user account group permissions.
• The path permission rules also apply to the basic commands Create, Copy,
Paste, Cut, Move, Rename, and Delete. For example, you only need the Read
path permission level to copy an object but you need the Full Access path
permission level to paste an object. See the table for more details.

Figure: Required permission levels to perform the basic commands.

04-13008-01-en, October 2012 IT

511
21 Software Permissions
21.4 Path Permissions

21.4 Path Permissions

Path permissions give a user or user account group basic permissions to the
objects defined in a path. The permission level set on a path applies to all
subbranches unless you set a new permission level for a subbranch.
The following permissions can be set for a path:
• No Access: Users cannot navigate to or modify any of the objects in the path.
• Read: Users can navigate to the objects but cannot modify them.
• Full Access: Users can navigate to and modify the objects.
For example, a user has the permission Full Access to the folder Building A. The
user account group has also Read permissions to the folder Building B, but No
access to the subbranches of Building B. Therefore the user has permission to
navigate and modify the objects in the Building A folder, but only permission to view
the objects in the Building B main folder.

Figure: Path permission levels in Building Operation

The path permission rules rely on the actual path string with the name of the server
or folder. If you change the name of a server or folder, users that earlier had
permission are denied access. For example, a user group has full access to the
folder LABB. The folder is renamed to Laboratory B. The users that had access to
the LABB folder do not have access to the Laboratory B folder or its subfolders.

Note
The local admin account is always granted access on the local server. For more
information, see section 20.11 “Administration Accounts in Server Local Domain”
on page 504.

IT 04-13008-01-en, October 2012

512
 21 Software Permissions
21.4 Path Permissions

Figure: If you change the name of server or folder, you also have to configure the path
permission to the folder.
The System folder and its subfolder, beside the domain folder, are always
accessible by a user though the path permission for the folders are set to No
Access. This means that a user can always at least navigate and view the objects in
the System and its subfolder.

Note
The Domain folder is the only folder subordinated by the System folder that
restricts access to users with the path permission No Access.

04-13008-01-en, October 2012 IT

513
21 Software Permissions
21.4 Path Permissions

Figure: The Domain folder is the only folder of the System subfolders that can be restricted
by the path permission.

IT 04-13008-01-en, October 2012

514
 21 Software Permissions
21.5 Command Permissions

21.5 Command Permissions

To make the system even more flexible and useful, you can assign a user account
group with special command permissions. Use the command permission to control
exceptions from path permissions that allow or deny actions on specific
commands.
You can set the following permissions for a command:
• No Setting: No Setting is the default command permission setting. No settings
means that 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.
For example, you allow a user account group to only add comments to trend log
records. All other command permissions for trend logs are set to Deny. Users with
this command permissions can comment on existing records but are not allowed to
perform other actions such as add records or clear the trend log. This assumes that
the users have path permission to access the trend logs.

Figure: The user account group has only permission to read and comment trend log
objects
Another example could be that a user account group has the path permission Full
Access to a folder that contains BacNet objects. To prevent the users in the user
account group from updating the BacNet firmware, you set the command
permission for this action to Deny. All other command permissions are set to No
Settings. Due to the Full Access path permission, the users can perform all
commands on BacNet devices, beside updating the firmware.

04-13008-01-en, October 2012 IT

515
21 Software Permissions
21.5 Command Permissions

Figure: The user account group has full permission to open and modify BacNet objects,
beside performing firmware update
Building Operation software permissions follow a series 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 21.1 “Software Permissions” on page 507.

IT 04-13008-01-en, October 2012

516
 21 Software Permissions
21.6 Assigning Software Permissions to a User Account

21.6 Assigning Software Permissions to a

User Account
You assign a user account individual path permissions to overrule the settings
inherited from the user account groups the user account is a member of.

Note
• To facilitate the administration of users and software permissions, it is
recommended that you assign software permissions to groups rather than to
individual user accounts.
• You cannot assign command permissions to an individual user, only path
permissions.

For more information, see section 21.1 “Software Permissions” on page 507.

To assign software permissions to a user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list, select the server where the user
account is located.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

517
21 Software Permissions
21.6 Assigning Software Permissions to a User Account

4. 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 assign path
permissions.
6. Click Software Permissions
Permissions.
7. On the Software Permissions tab, in the path box, step-wise enter a path by
clicking the forward arrow and selecting a new branch in the tree view.

8. Click the Add button .

9. Click the path you have created, and select a permission level in the
Permission drop-down list.

10. Click the Save button .

IT 04-13008-01-en, October 2012

518
 21 Software Permissions
21.7 Editing the Software Permissions of a User Account

21.7 Editing the Software Permissions of a

User Account
You edit the permission level of a path that has been assigned to an individual user
account to configure the user's access in the Building Operation system.

Note
• You cannot assign command permissions to an individual user, only path
permissions.

For more information, see section 21.1 “Software Permissions” on page 507.

To edit the software permissions of a user account

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list box, select the server where the user
account is located.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

519
21 Software Permissions
21.7 Editing the Software Permissions of a User Account

4. 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 wish to edit path
permissions.
6. Click Software permissions
permissions.
7. On the Software Permissions tab, in the path box, step-wise enter a path by
clicking the forward arrow and selecting a new branch in the tree view.

8. Click the Add button .

9. Click the path you have created.

10. In the Permission column, select a permission level.

11. Click the Save button .

IT 04-13008-01-en, October 2012

520
 21 Software Permissions
21.8 Assigning Software Permissions to a User Account Group

21.8 Assigning Software Permissions to a

User Account Group
You assign software permissions to user account groups for controlling user
activities and access in Building Operation.
For more information, see section 21.1 “Software Permissions” on page 507.

To assign software permissions to a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select a server for the user account group.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

521
21 Software Permissions
21.8 Assigning Software Permissions to a User Account Group

4. In the Domain box, select a domain for the user account group.

5. In the User Account Groups box, select a user account group.

6. In the User Account Group area, click Software permissions
permissions.
7. In the Path Permissions box, click the forward arrow and select a folder or an
object. Repeat until the folder or object for which you want to assign
permissions is selected.

8. Click the Add button .

Continued on next page

IT 04-13008-01-en, October 2012

522
 21 Software Permissions
21.8 Assigning Software Permissions to a User Account Group

9. In the Permission box, select a permission level for the path.

10. In the Category column, select a category that you want to configure
permissions for.
11. In the Command column, select a command.
12. In the Permission box for the command, select a permission level.

13. On the File menu, click Save

Save.

04-13008-01-en, October 2012 IT

523
21 Software Permissions
21.9 Editing the Software Permissions of a User Account Group

21.9 Editing the Software Permissions of a

User Account Group
You edit the software permissions of a user account group to add or remove
permissions to objects and system features for the users that belong to the group.
For more information, see section 21.2 “Software Permissions and User Account
Groups” on page 509.

To edit the software permissions of a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the user account group is located.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

524
 21 Software Permissions
21.9 Editing the Software Permissions of a User Account Group

4. In the Domain box, select the domain the user account group belongs to.

5. In the User Account Groups box, select the user account group for which
you want to edit the software permissions.
6. Under User Account Groups
Groups, click Software permissions
permissions.
7. In the Path Permissions box, click the forward arrow and select a folder or an
object. Repeat until the folder or object for which you want to assign

permissions is selected.

8. Click the Add button .

Continued on next page

04-13008-01-en, October 2012 IT

525
21 Software Permissions
21.9 Editing the Software Permissions of a User Account Group

9. In the Permission box, select a permission level for the path.

10. In the Category column, select a category that you want to configure
permissions for.
11. In the Command column, select a command.
Continued on next page

IT 04-13008-01-en, October 2012

526
 21 Software Permissions
21.9 Editing the Software Permissions of a User Account Group

12. In the Permission box for the command, select a permission level.

13. Click the Save button .

04-13008-01-en, October 2012 IT

527
22 Login Configuration

Topics
Password Administration
Editing a User Account Password
Allowing Users to Change their Password
Changing Your Password
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
 22 Login Configuration
22.1 Password Administration

22.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 ability of users to
change their passwords.
Passwords are managed at the user account group level. Building Operation
applies password changes to all user accounts that belong to the user account
group.

Note
• If you are an administrator and have forgotten your password, contact the
Building Operation support team.

04-13008-01-en, October 2012 IT

531
22 Login Configuration
22.2 Editing a User Account Password

22.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 system by exceeding the number of allowed failed logon attempts a new
password.
For more information, see section 22.1 “Password Administration” on page 531.

To edit a user account password

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list box, select the server where the user
account is located.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

532
 22 Login Configuration
22.2 Editing a User Account Password

4. In the Domain list 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 .

04-13008-01-en, October 2012 IT

533
22 Login Configuration
22.3 Allowing Users to Change their Password

22.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 21.2 “Software Permissions and User Account
Groups” on page 509.

To allow users to change their password

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group whose
users you want to allow to change their passwords.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

534
 22 Login Configuration
22.3 Allowing Users to Change their Password

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. Select the May change Password box.

8. Click the Save button .

04-13008-01-en, October 2012 IT

535
22 Login Configuration
22.4 Changing Your Password

22.4 Changing Your Password

You change your 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 Present Password box, type your current password.

3. In the New password box, type your new password.

4. In the Confirm new password box, type your new password again.
5. Click OK
OK.

IT 04-13008-01-en, October 2012

536
 22 Login Configuration
22.5 Turning off Remember Me On This Computer

22.5 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 servers in the
domain.
For more information, see section 20.2 “Log On Methods” on page 486.

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.

04-13008-01-en, October 2012 IT

537
22 Login Configuration
22.6 Forcing a User to Change the Password at Next Logon

22.6 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 22.1 “Password Administration” on page 531.

To force a user to change the password at next logon

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list box, select the server containing the user account of the user
you want to force to change the password at next logon.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

538
 22 Login Configuration
22.6 Forcing a User to Change the Password at Next Logon

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-13008-01-en, October 2012 IT

539
22 Login Configuration
22.7 Preventing Users from Changing Their Passwords

22.7 Preventing Users from Changing Their

Passwords
You prevent a group of users from changing their passwords.
For more information, see section 22.1 “Password Administration” on page 531.

To prevent users from changing their passwords

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list box, select the server containing the user account group
whose members you want to prevent from changing their passwords.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

540
 22 Login Configuration
22.7 Preventing Users from Changing Their Passwords

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. Clear the May change Password box.

8. Click the Save button .

04-13008-01-en, October 2012 IT

541
22 Login Configuration
22.8 Resetting the Administrator Password

22.8 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 Building Operation
and changing your administrator password.
For more information, see section 22.1 “Password Administration” on page 531.

Note
• To authenticate yourself to the Schneider Electric Buildings support team,
you must state your user name and password, the unique logon ID (from the
failed logon attempt), and the domain you tried to log on to.

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.

IT 04-13008-01-en, October 2012

542
23 Workspaces

Topics
Workspaces
Predefined Workspaces
Workspace Components and Customization
Workspace Component Customization
Workspace Content References
Panel Components
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
Creating a Panel
Editing a Panel
WebStation in Kiosk Mode
Configuring WebStation to Run in Kiosk Mode
 23 Workspaces
23.1 Workspaces

23.1 Workspaces
The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted to users or user account groups different
tasks.
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 to 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 the user to select a default workspace at the first log on. Next
time you log on to Building Operation on the same computer, your default
workspace is automatically displayed. Once logged in you can change your default
workspace settings.

23.1.1 Predefined Workspaces

Some workspace layouts are included in the Building Operation main installation
and cannot be deleted or edited. Those workspaces are located in the local domain
of the Enterprise Server or Automation Server.
For more information, see section 23.2 “Predefined Workspaces” on page 547.

04-13008-01-en, October 2012 IT

545
23 Workspaces
23.1 Workspaces

23.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 23.3 “Workspace Components and
Customization” on page 548.

23.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 23.18 “WebStation in Kiosk Mode” on page 582.

IT 04-13008-01-en, October 2012

546
 23 Workspaces
23.2 Predefined Workspaces

23.2 Predefined Workspaces

Some workspace layouts are included in the Building Operation main installation
and cannot be deleted or edited. Those workspaces are located in the local domain
of the Enterprise Server or Automation 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,
Building Operation 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 Building Operation 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-13008-01-en, October 2012 IT

547
23 Workspaces
23.3 Workspace Components and Customization

23.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 lock, release,
and move these components to another location. You can also display and stack
several panes on top of each other.
Building Operation provides several predefined workspace panes, which are
accessible through the View menu:
• System Tree pane
• Watch
• Events
• Alarms

23.3.1 Workspace Component Customization

You customize the workspace layout to suit the specific user requirements. For
example, you hide or show toobars and menus based on user permissions. You
can save workspace layouts on the server. In this case, the layout becomes the
default workspace layout for all users. A user can modify the workspace layout and
save it on the local computer. In this case, the modified workspace layout is

IT 04-13008-01-en, October 2012

548
 23 Workspaces
23.3 Workspace Components and Customization

accessible only to that user. A user-modified layout overrides the default layout and
is displayed the next time the user logs on to WorkStation. Workspaces are task
oriented, which means that a user can switch workspaces during a single
WorkStation session.
For more information, see section 23.4 “Workspace Component Customization” on
page 550.

23.3.2 Workspace Content References

Workspace content references are used to customize the workspace by refering
the content you want to display in the workspace panes and Work Area window.
For more information, see section 23.5 “Workspace Content References” on page
552.

23.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 and opens as a window in the work area of the current workspace.
For more information, see section 23.6 “Panel Components” on page 553.

04-13008-01-en, October 2012 IT

549
23 Workspaces
23.4 Workspace Component Customization

23.4 Workspace Component Customization

You customize the workspace layout to suit the specific user requirements. For
example, you hide or show toobars and menus based on user permissions. You
can save workspace layouts on the server. In this case, the layout becomes the
default workspace layout for all users. A user can modify the workspace layout and
save it on the local computer. In this case, the modified workspace layout is
accessible only to that user. A user-modified layout overrides the default layout and
is displayed the next time the user logs on to WorkStation. 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, or remove the following panes and
windows:
• Graphics
• Alarms, Events, or Watch
• Basic or Advanced Schedules
• Functional Block Programs
• Trend Log Lists or Charts
• Work Areas
• Calendars
• Panels
• System Tree
For example, you can create a workspace that only displays an Alarms pane along
with a graphic in the work area representing a building.
You can undo a saved workspace by resetting it to the earlier layout. For more
information, see For more information, see WebHelp.Resetting All User Settings

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 these objects are not made available. For more information,
see section 21.1 “Software Permissions” on page 507.For more information, see
Software Permissions
Workspaces and software permissions are linked to user account groups.
Therefore, a user inherits the workspaces and permissions of all groups to which
the user is a member. For more information, see For more information, see section
21.2 “Software Permissions and User Account Groups” on page 509.Software
Permissions and User Account Groups

User Customized Workspace Layout

Depending on permissions, users can modify the workspace layouts to suit their
specific requirements. If the user saves the layout modifications, the layout is
displayed next time the user logs on to WorkStation. Workspaces are task oriented
so users can switch workspaces during a single WorkStation session.

IT 04-13008-01-en, October 2012

550
 23 Workspaces
23.4 Workspace Component Customization

Note
A user customized workspace is locally stored on the computer. The user cannot
access the customized layout when logging on to WorkStation through another
computer.

04-13008-01-en, October 2012 IT

551
23 Workspaces
23.5 Workspace Content References

23.5 Workspace Content References

Workspace content references are used to customize the workspace by refering
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.

IT 04-13008-01-en, October 2012

552
 23 Workspaces
23.6 Panel Components

23.6 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 and opens as a window in the work area of the current workspace.

Figure: Example of panel components

In the procedure when creating a panel, you link existing objects to the panes or
workspace that is added within the panel. Therefore you have to first create the
object, for example a trend chart, before you add or rather link in the object into the
panel. You can define whether to show or hide a pane's toolbar.

Note
• A panel can not contain a System Tree.
• A maximum of six levels of panels are allowed in a single pane, 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 simply 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.

04-13008-01-en, October 2012 IT

553
23 Workspaces
23.7 Creating a Workspace

23.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.
For more information, see section 23.3 “Workspace Components and
Customization” on page 548.

To create a workspace
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where you want to create the workspace.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

554
 23 Workspaces
23.7 Creating a Workspace

4. In the Domain box, select the server where you want to create the
workspace.

5. In the Workspaces area, click Add

Add.
6. 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.
Continued on next page

04-13008-01-en, October 2012 IT

555
23 Workspaces
23.7 Creating a Workspace

9. 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 Add to add panes to the workspace.
12. In the object type list, select the type of pane you want to add to the Work
area.

Continued on next page

IT 04-13008-01-en, October 2012

556
 23 Workspaces
23.7 Creating a Workspace

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 Default dock position box, select the location of the pane for display in
the WorkStation window.

17. In the Default visibility box, select Hidden to make the pane available only
from the View menu and not open in the Work area.
18. In the Display name box, type the name to be displayed on the pane.
19. In the Initial path box, enter the path to the object you want to display in the
pane.
20. Click Create
Create.
21. In the Workspace wizard, click Create
Create.

04-13008-01-en, October 2012 IT

557
23 Workspaces
23.8 Editing the Layout of a Workspace

23.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 23.3 “Workspace Components and
Customization” on page 548.

To edit the layout of a workspace

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the workspace is located.

3. Click Account management

management.
Continued on next page

IT 04-13008-01-en, October 2012

558
 23 Workspaces
23.8 Editing the Layout of a Workspace

4. 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.
Continued on next page

04-13008-01-en, October 2012 IT

559
23 Workspaces
23.8 Editing the Layout of a Workspace

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-13008-01-en, October 2012

560
 23 Workspaces
23.9 Editing the Description of a Workspace

23.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 23.1 “Workspaces” on page 545.

To edit the description of a workspace

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the workspace is located.

3. Click Account management

management.
4. In the Domain box, select the domain the workspace belongs to.

Continued on next page

04-13008-01-en, October 2012 IT

561
23 Workspaces
23.9 Editing the Description of a Workspace

5. In the Workspaces list, select the workspace.

6. Click Summary
Summary.
7. In the Description box, type a new description for the workspace.

8. Click the Save button .

IT 04-13008-01-en, October 2012

562
 23 Workspaces
23.10 Adding a Component to a Workspace

23.10 Adding a Component to a Workspace

You add a component to a workspace to extend the content and usage of the
workspace.
For more information, see section 23.1 “Workspaces” on page 545.

To add a component to a workspace

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the workspace is located.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

563
23 Workspaces
23.10 Adding a Component to a Workspace

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

Continued on next page

IT 04-13008-01-en, October 2012

564
 23 Workspaces
23.10 Adding a Component to a Workspace

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

Continued on next page

04-13008-01-en, October 2012 IT

565
23 Workspaces
23.10 Adding a Component to a Workspace

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-13008-01-en, October 2012

566
 23 Workspaces
23.11 Removing a Component from a Workspace

23.11 Removing a Component from a

Workspace
You remove a component from a workspace to reduce components and the usage
of the workspace.
For more information, see section 23.1 “Workspaces” on page 545.

To remove a component from a workspace

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the workspace is located.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

567
23 Workspaces
23.11 Removing a Component from a Workspace

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

9. Click the Save button .

IT 04-13008-01-en, October 2012

568
 23 Workspaces
23.12 Editing a Workspace Component

23.12 Editing a Workspace Component

You edit the workspace components to adapt the usage of the workspace.
For more information, see section 23.1 “Workspaces” on page 545.

To edit a workspace component

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the workspace is located.

3. Click Account management

management.
4. In the Domain box, select the domain the workspace belongs to.

Continued on next page

04-13008-01-en, October 2012 IT

569
23 Workspaces
23.12 Editing a Workspace Component

5. In the Workspaces list, select the workspace.

6. Click Content
Content.
7. In the Components list, select the component you want to edit.

8. Click Edit
Edit.
9. Edit the workspace component properties.

10. Click the Save button .

IT 04-13008-01-en, October 2012

570
 23 Workspaces
23.13 Adding a Workspace to a User Account Group

23.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 23.3 “Workspace Components and
Customization” on page 548.

To add a workspace to a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group you
want to add the workspace to.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

571
23 Workspaces
23.13 Adding a Workspace to a User Account Group

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

IT 04-13008-01-en, October 2012

572
 23 Workspaces
23.14 Removing a Workspace from a User Account Group

23.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 WebHelp.

To remove a workspace from a user account group

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the workspace for which you
want to remove the link to a user account group.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

573
23 Workspaces
23.14 Removing a Workspace from a User Account Group

4. 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 Selected User Account Groups list, select the user account group you

want to remove the workspace from, and click the Remove button .

8. Click the Save button .

IT 04-13008-01-en, October 2012

574
 23 Workspaces
23.15 Reviewing the Workspace Memberships for a User Account Group

23.15 Reviewing the Workspace Memberships

for a User Account Group
You review the workspace memberships for a user account group to determin if the
user account group, for example, needs additional workspaces.
For more information, see section 23.1 “Workspaces” on page 545.

To review the workspace memberships for a user account

group
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group you
want to review the workspace memberships for.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

575
23 Workspaces
23.15 Reviewing the Workspace Memberships for a User Account Group

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.

IT 04-13008-01-en, October 2012

576
 23 Workspaces
23.16 Creating a Panel

23.16 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 23.6 “Panel Components” on page 553.

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, click New
New, and then Panel
Panel.
3. 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.
Continued on next page

04-13008-01-en, October 2012 IT

577
23 Workspaces
23.16 Creating a Panel

6. Click Add to add an object to the panel.you add an object to the panel.

7. 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.
Continued on next page

IT 04-13008-01-en, October 2012

578
 23 Workspaces
23.16 Creating a Panel

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

Continued on next page

04-13008-01-en, October 2012 IT

579
23 Workspaces
23.16 Creating a Panel

16. Click Create

Create.
17. In the 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.

IT 04-13008-01-en, October 2012

580
 23 Workspaces
23.17 Editing a Panel

23.17 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 23.6 “Panel Components” on page 553.

To edit of a panel
1. In WorkStation, in the System Tree pane, select the panel you want to edit.
2. Click Properties
Properties.
3. In the Properties pane, edit the properties of the panel.

4. Click OK
OK.
5. Click Close
Close.

04-13008-01-en, October 2012 IT

581
23 Workspaces
23.18 WebStation in Kiosk Mode

23.18 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.
When kiosk mode is used the toolbar, menus and right-click menus are disabled.
Most keyboard shortcuts, such as alt + F4, to close Internet Explorer will 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 20.3 “Guest Log On in WebStation”
on page 487.

23.18.1 Configure WebStation to Run in Kiosk Mode

To be able to run WebStation in kiosk mode, you decide which object in
WebStation the users' will have access to, such as a graphic, a viewer, or a panel.
The easiest way to configure WebStation to run in kiosk mode is to create a
shortcut to Internet Explorer and add the command for kiosk mode (-k).
After you have created the shortcut, you open the object in WebStation you want
the users' to have access to. Then you copy the full address to the object and paste
it, within quotation marks, after the command –k in the target box in the Shortcut
tab in the properties dialog box of the Shortcut.
The syntax in the Target box in the properties dialog box in the shortcut will looks
like this:

IT 04-13008-01-en, October 2012

582
 23 Workspaces
23.18 WebStation in Kiosk Mode

Figure: The properties dialog for a shortcut opening WebStation in kiosk mode.

04-13008-01-en, October 2012 IT

583
23 Workspaces
23.19 Configuring WebStation to Run in Kiosk Mode

23.19 Configuring WebStation to Run in Kiosk

Mode
You configure WebStation to run in kiosk mode when you want the user to access
only a single object in your system, without any toolbars.
For more information, see section 23.18 “WebStation in Kiosk Mode” on page 582.

To configure WebStation to run in kiosk mode

1. Right-click on the desktop, point to New, and click Shortcut
Shortcut.
2. In the Type the location of the item box, click Browse
Browse.
3. In the Browse for File or Folders box, browse to iexplore.
4. Click OK
OK.
5. Add "-k" after the address to iexplore.

6. Click Next
Next.
7. In the Type name for this shortcut box, type the name, for example
WebStation in Kiosk Mode.
8. Click Finish
Finish.
9. Log on to WebStation using the same account as you want to use for the
kiosk mode.
10. Open the object you want WebStation to display in kiosk mode.
11. Copy the address in the address field.
12. Right-click the Shortcut and click Properties
Properties.
Continued on next page

IT 04-13008-01-en, October 2012

584
 23 Workspaces
23.19 Configuring WebStation to Run in Kiosk Mode

13. Click Shortcut

Shortcut.
14. Paste the address, within quotation marks, in the Target box after the
command -k.

15. Click OK
OK.

04-13008-01-en, October 2012 IT

585
24 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
 24 Audit Trails
24.1 WorkStation Account Management

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

24.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 24.2 “Audit Trailing of User Activity” on page 590.

24.1.2 WorkStation Account Validation

Building Operation stores all account information centrally in a user database, which
contains information about software permissions, user account memberships,
workspaces, and domains.
For more information, see section 24.6 “WorkStation Account Validation” on page
597.

04-13008-01-en, October 2012 IT

589
24 Audit Trails
24.2 Audit Trailing of User Activity

24.2 Audit Trailing of User Activity

An audit trail tracks all actions of a user that has logged on to the system. For
example, you can view when a user logged on or off WorkStation, what commands
the user made, and if the user changed or removed an object. Not all user actions
are logged. For example, the system does not log user interface navigation and
workspace switching.
For each user action, the system logs the following information:
• User name and domain name
• Date and time of the logged action
• Path of the object that was changed
• Type of action, such as Object created
• Old values and new values
The audit trailing log shown in WorkStation is simple a filtered Event view that
shows user related events. You can limit the number of events that are shown in the
Audit trail log:
• Select a time span
• Select how many of the most recent events to view.

Note
• The system retains a user's historic audit trail even if the user is deleted from
the system.
• Audit trailing is enabled by default.

Audit Trail Configuration at the User Account Group Level

Audit trailing is enabled and disabled at the user account group level in the user
account group policies. The default setting is that audit trail is enabled.
A user inherits the settings from all user account groups the user is a member of. To
activate audit trailing for a user, enable audit trailing for one of the user account
groups the user is a member of. To disable audit trail logging for a user, you must
disable audit trail logging for all user account groups that the user is a member of.
In addition, you can enable audit trailing as a policy in a user account group.

Figure: The Policies tab with audit trailing enabled

IT 04-13008-01-en, October 2012

590
 24 Audit Trails
24.3 Disabling Audit Trail for a Group of Users

24.3 Disabling Audit Trail for a Group of

Users
You disable audit trail for a group of users that do not need auditing, such as users
who can only view the objects in the system. To disable audit trail for a user, you
must disable audit trail for all user account groups the user is, directly or indirectly, a
member of. Audit trail is by default enabled.

Note
• The system retains a user's historic audit trail even if the user is deleted from
the system.
• Audit trailing is enabled by default.

For more information, see section 24.2 “Audit Trailing of User Activity” on page 590.

To disable audit trail for a group of users

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group for
which you want to disable audit trail.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

591
24 Audit Trails
24.3 Disabling Audit Trail for a Group of Users

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. Clear the Enable Audit Trailing box.

8. Click the Save button .

IT 04-13008-01-en, October 2012

592
 24 Audit Trails
24.4 Enabling Audit Trail for a Group of Users

24.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 24.2 “Audit Trailing of User Activity” on page 590.

To enable audit trail for a group of users

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group for
which you want to enable audit trail.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

593
24 Audit Trails
24.4 Enabling Audit Trail for a Group of Users

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 .

IT 04-13008-01-en, October 2012

594
 24 Audit Trails
24.5 Viewing an Audit Trail Log

24.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 24.2 “Audit Trailing of User Activity” on page 590.

To view an audit trail log

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account for which you
want to view the audit trail log.

3. Click Account management

management.
Continued on next page

04-13008-01-en, October 2012 IT

595
24 Audit Trails
24.5 Viewing an Audit Trail Log

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 Audit Trailing Events
Events.

7. In the Show Events box, select an interval of events to view.

8. Click the Refresh button .

IT 04-13008-01-en, October 2012

596
 24 Audit Trails
24.6 WorkStation Account Validation

24.6 WorkStation Account Validation

Building Operation stores all account information centrally in a 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 server you want to log on to. Building Operation
confirms that you are using a valid user account and verifies that correct password
is used. Building Operation also authenticates access to workspaces associated
with your user account group memberships. After validation, Building Operation
retrieves your software permissions and stores them in a user token, valid for this
log on session.

Note
User name, password, and domain name are case sensitive.

WorkStation User Token

A user token remains active as long as you are logged onto WorkStation. Any
changes to your software permissions during your current sessions take effect the
next time you log on.

04-13008-01-en, October 2012 IT

597
25 User Management User
Interface

Topics
User Management System Tree Icons
Domain Properties
Profile Properties
Workspace Properties
Pane Properties
Panel Properties
Building Operation WorkStation Window
Domain Control Panel
Account Management Control Panel
Select Default Workspace Window
Change Password Dialog Box
Domain Wizard – Authentication Page
Domain Wizard – Domain Policies Page
Domain – Summary Tab
Domain – Policies Tab
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
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 Polices 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
Edit Layout Workspace
Workspace – Members Tab
Panel Wizard – Panel Configuration Page
Domain Wizard – Domain Members Page
Domains Properties
Local Properties
Work Area Window Properties
Create Work Area Window Wizard – Name Page
 25 User Management User Interface
25.1 User Management System Tree Icons

25.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 23.6 “Panel
Components” on page 553.

Folder of User Accounts

Indicates that the folder contains user
accounts. For more information, see section
18.3 “User Accounts and User Account
Groups” on page 429.

User Account
Indicates that the object is a user account.
For more information, see section 18.3 “User
Accounts and User Account Groups” on
page 429.

Domain
Indicates that the object is a domain. For
more information, see section 20.1
“Domains” on page 483.

User Account Groups

Indicates that the object is a user account
group. For more information, see section
18.3 “User Accounts and User Account
Groups” on page 429.

Workspace
Indicates that the object is a workspace. For
more information, see WebHelp.

04-13008-01-en, October 2012 IT

603
25 User Management User Interface
25.2 Domain Properties

25.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 servers internally use to

enhance the server communication security
in the domain.

Confirm Password Type the password servers internally use to

enhance the server communication security
in the domain.

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 19.1 “Windows Active Directory User
Groups” on page 453.

IT 04-13008-01-en, October 2012

604
 25 User Management User Interface
25.3 Profile Properties

25.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 E-mail address Type the e-mail address of the user.

Work E-mail address Type the work e-mail address of the user.

04-13008-01-en, October 2012 IT

605
25 User Management User Interface
25.4 Workspace Properties

25.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 WebHelp.

Edit Click to edit a workspace pane. For more

information, see section 25.5 “Pane
Properties” on page 608.

Remove Click to remove a workspace pane.

Menu Select Visible to show the menu in the

workspace.

Toolbar Select Visible to show the toolbar in the

workspace.

IT 04-13008-01-en, October 2012

606
 25 User Management User Interface
25.4 Workspace Properties

Continued
Component Description

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.

04-13008-01-en, October 2012 IT

607
25 User Management User Interface
25.5 Pane Properties

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

IT 04-13008-01-en, October 2012

608
 25 User Management User Interface
25.6 Panel Properties

25.6 Panel Properties

Use the Panel properties to configure the properties of a panel.

Figure: Panel properties

Table: Panel Properties

Component Description

Initial path Enter the path, for example a graphical link,

that points to the panel.

Show toolbars Select Yes to show the toolbar of the panel.

Add Click to add a pane component to the panel.

For more information, see WebHelp.

Edit Click to edit a pane component. For more

information, see section 25.5 “Pane
Properties” on page 608.

Remove Click to remove a panel component.

04-13008-01-en, October 2012 IT

609
25 User Management User Interface
25.7 Building Operation WorkStation Window

25.7 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

Windows domain\user name Click to log on to WorkStation using the

Windows credentials of the current Windows
account. For more information, see section
18.3 “User Accounts and User Account
Groups” on page 429.

Other user Click to log on to WorkStation as another

Windows user or using a Building Operation
account. For more information, see section
18.3 “User Accounts and User Account
Groups” on page 429.

User name Type the user name.

Password Type the password.

IT 04-13008-01-en, October 2012

610
 25 User Management User Interface
25.7 Building Operation WorkStation Window

Continued
Component Description

Domain Type the name of the domain that you want

to log on to. If you do not enter a domain,
you log on to the default domain. For more
information, see section 20.1 “Domains” on
page 483.

Server Enter a server to log on to.

Remember me on this computer Select to save the entered information. The

information is automatically filled in the next
time you log on.

Log on Click to log on to WorkStation.

Click here to learn more about Building Click to open the WebHelp home page. For
Operation more information, see WebHelp.

04-13008-01-en, October 2012 IT

611
25 User Management User Interface
25.8 Domain Control Panel

25.8 Domain Control Panel

Use the Domain Control Panel to create and configure domains.

Table: Domain Control Panel

Component Description

Server Displays the server that acts as domain

controller.

Domains Select a domain to edit.

Add Click to create a new domain. For more

information, see 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 25.9 “Account Management Control
Panel” on page 613.

Summary Click to open the Summary tab for the

domain. For more information, see section
25.14 “Domain – Summary Tab” on page
620.

Policies Click to open the Policies tab where you edit

the policies of the domain. For more
information, see section 25.15 “Domain –
Policies Tab” on page 621.

Domain members Click to open the Domain members tab

where you add and remove servers from the
domain. For more information, see section
25.16 “Domain – Domain Members Tab” on
page 622.

IT 04-13008-01-en, October 2012

612
 25 User Management User Interface
25.9 Account Management Control Panel

25.9 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 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 WebHelp.

Delete (user account) Click to delete a user account. For more

information, see WebHelp.

List users Click to open the user accounts list view

where you can select a user account. For
more information, see WebHelp.

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 25.17 “User Account – Summary
Tab” on page 623.

04-13008-01-en, October 2012 IT

613
25 User Management User Interface
25.9 Account Management Control Panel

Continued
Component Description

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 25.18 “User
Account – Group Membership Tab” on page
624.

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
25.20 “User Account – Software
Permissions Tab” on page 627.

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 25.21 “User
Account – Audit Trailing Events Tab” on
page 628.

User Account Groups Select a user account group.

Add (user account groups) Click to add a new user account group. For
more information, see WebHelp.

Delete (user account group) Click to delete a user account group. For
more information, see 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 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 25.27 “User
Account Group – Summary Tab” on page
637.

Group membership (user account Click to open the Group Membership tab
groups) where you can edit the groups membership
in other groups, and add and remove user
accounts. For more information, see section
25.29 “User Account Group – Group
Membership Tab” on page 639.

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 25.30 “User
Account Group – Software Permissions
Tab” on page 641.

IT 04-13008-01-en, October 2012

614
 25 User Management User Interface
25.9 Account Management Control Panel

Continued
Component Description

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 25.31 “User
Account Group – Workspaces Tab” on page
643.

Policies Click to open the Policies tab where you can

edit the policies of the user account group.
For more information, see section 25.28
“User Account Group – Policies Tab” on
page 638.

Workspaces Select a workspace.

Add (workspaces) Click to add a new workspace. For more

information, see WebHelp.

Delete (workspaces) Click to delete a workspace. For more

information, see WebHelp.

List workspaces Click to open the Workspace menu where

you can select a workspace. For more
information, see WebHelp.

Summary (workspaces) Click to open the workspace Summary tab

where you can edit the description of the
workspace. For more information, see
section 25.37 “Workspace – Summary Tab”
on page 651.

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 25.40 “Workspace – Members Tab”
on page 655.

Content Click to open the Content tab where you edit

the content of the workspace. For more
information, see section 25.38
“Workspace – Content Tab” on page 652.

Edit layout Click to open the view where you edit the
layout of the workspace. For more
information, see section 25.39 “Edit Layout
Workspace” on page 654.

04-13008-01-en, October 2012 IT

615
25 User Management User Interface
25.10 Select Default Workspace Window

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

Click the History icon to return to the

previous page.

IT 04-13008-01-en, October 2012

616
 25 User Management User Interface
25.11 Change Password Dialog Box

25.11 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

Present password Type your present password.

New password Type your new password.

Confirm new password Type your new password again.

04-13008-01-en, October 2012 IT

617
25 User Management User Interface
25.12 Domain Wizard – Authentication Page

25.12 Domain Wizard – Authentication Page

Use the Authentication page to map the 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 19.1 “Windows Active Directory User
Groups” on page 453.

IT 04-13008-01-en, October 2012

618
 25 User Management User Interface
25.13 Domain Wizard – Domain Policies Page

25.13 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-13008-01-en, October 2012 IT

619
25 User Management User Interface
25.14 Domain – Summary Tab

25.14 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 19.1 “Windows Active Directory User
Groups” on page 453.

Domain Controller Displays the path and name of the domain

controller.

IT 04-13008-01-en, October 2012

620
 25 User Management User Interface
25.15 Domain – Policies Tab

25.15 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 log on attempts Enter the maximum number of failed logon

attempts a user can make before the user´s
account is temporarily locked.

04-13008-01-en, October 2012 IT

621
25 User Management User Interface
25.16 Domain – Domain Members Tab

25.16 Domain – Domain Members Tab

Use the Domain Members tab to add and remove servers to and from the domain.

Figure: Domain members tab

Table: Domain Members Tab

Component Description

Available Servers List of all available servers.

Servers that are members of this Domain List of all servers in the domain.

Add All
Click to add all available servers to the
domain.

Add
Click to add a server to the domain.

Remove
Click to remove a server from the domain.

Remove All
Click to remove all servers from the domain.

IT 04-13008-01-en, October 2012

622
 25 User Management User Interface
25.17 User Account – Summary Tab

25.17 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 a password for the user account.

Confirm password Type a password for the user account.

04-13008-01-en, October 2012 IT

623
25 User Management User Interface
25.18 User Account – Group Membership Tab

25.18 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-13008-01-en, October 2012

624
 25 User Management User Interface
25.18 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-13008-01-en, October 2012 IT

625
25 User Management User Interface
25.19 User Account – Profile Tab

25.19 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 E-mail address Type the e-mail address of the user.

Work E-mail address Type the work e-mail address of the user.

IT 04-13008-01-en, October 2012

626
 25 User Management User Interface
25.20 User Account – Software Permissions Tab

25.20 User Account – Software Permissions

Tab
Use the Software Permissions tab to enter individual path permissions for a user
account.

Note
• To simplify the task of administering software permissions, it is recommended
that you assign software permissions to user account groups rather than user
accounts.

Figure: Software permissions tab

Table: Software Permissions Tab

Component Description

Add Adds a new path to the list of paths that the

user account can access.

Path The paths the user account has access to.

Permission Click to assign a permission level to a path

you have selected.

Owner The owners of the paths the user has access

to. The owner can be a user account group
the account is a member of, or the actual
user account.

Delete
Click to remove a path you have selected.

04-13008-01-en, October 2012 IT

627
25 User Management User Interface
25.21 User Account – Audit Trailing Events Tab

25.21 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

Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.

Show Events Select an available option for limiting the

events displayed.

Refresh
Click to refresh the Audit Trailing Events list..

Filter Enter a word or a character to filter on. For

more information, see WebHelp.

IT 04-13008-01-en, October 2012

628
 25 User Management User Interface
25.22 User Account Group Properties

25.22 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 AS Web Select to enable users to access the Web
Configuration Configuration where you configure the
settings of an Automation Server.

Windows group name Select the Windows Active Directory user

account group that you want to map to this
Building Operation user account group. For
more information, see section 19.1
“Windows Active Directory User Groups” on
page 453.

04-13008-01-en, October 2012 IT

629
25 User Management User Interface
25.23 User Account Properties

25.23 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

Add Click to create a new user profile. For more

information, see WebHelp.

Edit Click to edit a user profile. For more

information, see section 25.3 “Profile
Properties” on page 605.

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

Password Type a password for the user account.

Confirm Password Type a password for the user account.

Expires on Enter an expiration date and time for the

user account. By default, there is no
expiration date for the account.

IT 04-13008-01-en, October 2012

630
 25 User Management User Interface
25.24 User Account Group Wizard – Users Belonging to this Group Page

25.24 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

Select from Select a group with user accounts you want

to include in the group.

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.

04-13008-01-en, October 2012 IT

631
25 User Management User Interface
25.24 User Account Group Wizard – Users Belonging to this Group Page

Continued
Component Description

Remove all
Click to remove all user accounts from the
user account group.

IT 04-13008-01-en, October 2012

632
 25 User Management User Interface
25.25 User Account Group Wizard – Workspaces Belonging to this Group Page

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

04-13008-01-en, October 2012 IT

633
25 User Management User Interface
25.25 User Account Group Wizard – Workspaces Belonging to this Group Page

Continued
Component Description

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-13008-01-en, October 2012

634
 25 User Management User Interface
25.26 User Account Group Wizard – Windows Group Name and Group Polices Page

25.26 User Account Group Wizard – Windows

Group Name and Group Polices Page
Use the Windows group name and group polices page to map a Windows Active
Directory and enter policies for the group.

Note
• The default setting is that all options on the Policies page are selected.

Figure: Windows group name and group polices page

Table: Windows Group name and Group Polices 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.

AS web configuration Select to enable users to access the Web

Configuration where you configure the
settings of an Automation Server.

04-13008-01-en, October 2012 IT

635
25 User Management User Interface
25.26 User Account Group Wizard – Windows Group Name and Group Polices Page

Continued
Component Description

Windows group name Select the Windows Active Directory user

account group that you want to map to this
Building Operation user account group. For
more information, see section 19.1
“Windows Active Directory User Groups” on
page 453.

IT 04-13008-01-en, October 2012

636
 25 User Management User Interface
25.27 User Account Group – Summary Tab

25.27 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
Building Operation user account group. For
more information, see section 19.1
“Windows Active Directory User Groups” on
page 453.

04-13008-01-en, October 2012 IT

637
25 User Management User Interface
25.28 User Account Group – Policies Tab

25.28 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

May close User Interface Select to let users log off and close
WorkStation.

Enable Audit Trailing Select to enable audit trailing for users

belonging to this group.

May change Password Select to enable users to change their

passwords.

May access web user interface Select to enable users to access the Web
Configuration where you configure the
settings of an Automation Server.

IT 04-13008-01-en, October 2012

638
 25 User Management User Interface
25.29 User Account Group – Group Membership Tab

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

Add all
Click to add all available user accounts or
user account groups to the list of selected
user accounts or user account groups.

04-13008-01-en, October 2012 IT

639
25 User Management User Interface
25.29 User Account Group – Group Membership Tab

Continued
Component Description

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.

IT 04-13008-01-en, October 2012

640
 25 User Management User Interface
25.30 User Account Group – Software Permissions Tab

25.30 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 the path to which you want to
add software permissions.

Path Displays the paths that have been defined

for the user account group.

Permission Select a permission level for the path.

Owner Displays the user account group the path

has been added to.

04-13008-01-en, October 2012 IT

641
25 User Management User Interface
25.30 User Account Group – Software Permissions Tab

Continued
Component Description

Delete
Click to remove a path. For more
information, see WebHelp.

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.

IT 04-13008-01-en, October 2012

642
 25 User Management User Interface
25.31 User Account Group – Workspaces Tab

25.31 User Account Group – Workspaces Tab

Use the Workspaces tab to edit the workspace membership settings for a user
account group.

Figure: Workspaces tab

Table: Workspaces Tab

Component Description

Available Workspaces Lists workspaces that are available to add to

the user account group.

Selected Workspaces Lists workspaces that are available to add to

the user account group.

Add all
Click to add all available workspaces to the
user account group.

Add
Click to add a workspace to the user
account group.

Remove
Click to remove a workspace from the user
account group.

Remove all
Click to remove all workspaces from the user
account group.

04-13008-01-en, October 2012 IT

643
25 User Management User Interface
25.32 User Account Wizard – General Page

25.32 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 E-mail address Type the e-mail address of the user.

Work E-mail address Type the e-mail 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 a password for the user account.

Confirm Password Type a password for the user account.

IT 04-13008-01-en, October 2012

644
 25 User Management User Interface
25.33 User Account Wizard – Member Of Page

25.33 User Account Wizard – Member Of Page

Use the Member Of page to make the user account a member of an existing user
account group.

Figure: Member of page

Table: Member of Page

Component Description

Select from Select a user account that is member of the

user account group you want to connect
your user account.

Available User Accounts Groups Lists available user account groups.

Selected User Accounts Groups Lists user account groups that are
connected to the user account group.

Add all
Click to add all user account groups to the
user account.

Add
Click to add a user account group to the
user account.

Remove
Click to remove a user account group from
the user account.

04-13008-01-en, October 2012 IT

645
25 User Management User Interface
25.33 User Account Wizard – Member Of Page

Continued
Component Description

Remove all
Click to remove all user account groups from
the user account.

IT 04-13008-01-en, October 2012

646
 25 User Management User Interface
25.34 User Account Management Folder Properties

25.34 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 WebHelp.

Figure: User Management Folder properties

04-13008-01-en, October 2012 IT

647
25 User Management User Interface
25.35 Workspace Wizard – Workspace Configuration Page

25.35 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 component.
System Tree)

IT 04-13008-01-en, October 2012

648
 25 User Management User Interface
25.35 Workspace Wizard – Workspace Configuration Page

Continued
Component Description

Components Lists the standard components included in

the workspace. Select a component and
click the Add
Add, Edit or Remove button.

Add Click to add a new component to the

workspace. For more information, see
WebHelp.

Edit Click to edit a component. The workspace

properties pane is displayed. For more
information, see section 25.5 “Pane
Properties” on page 608.

Remove Click to remove a component.

04-13008-01-en, October 2012 IT

649
25 User Management User Interface
25.36 Workspace Wizard – Pane Configuration Page

25.36 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 25.35 “Workspace Wizard –
Workspace Configuration Page” on page
648.

IT 04-13008-01-en, October 2012

650
 25 User Management User Interface
25.37 Workspace – Summary Tab

25.37 Workspace – Summary Tab

Use the Summary tab to edit the description of the workspace.

Figure: Summary tab

Table: Summary Tab

Component Description

Name Displays the name of the workspace.

Description Displays the description of the workspace.

Location Displays the location of the workspace.

04-13008-01-en, October 2012 IT

651
25 User Management User Interface
25.38 Workspace – Content Tab

25.38 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 workspace.
System Tree)

Add Click to add a new component to the

workspace. For more information, see
WebHelp.

IT 04-13008-01-en, October 2012

652
 25 User Management User Interface
25.38 Workspace – Content Tab

Continued
Component Description

Edit Click to edit a pane. For more information,

see section 25.5 “Pane Properties” on page
608.

Remove Click to remove a component.

04-13008-01-en, October 2012 IT

653
25 User Management User Interface
25.39 Edit Layout Workspace

25.39 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-13008-01-en, October 2012

654
 25 User Management User Interface
25.40 Workspace – Members Tab

25.40 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-13008-01-en, October 2012 IT

655
25 User Management User Interface
25.41 Panel Wizard – Panel Configuration Page

25.41 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 WebHelp.

Edit Click to edit the properties of a component.

For more information, see section 25.5
“Pane Properties” on page 608.

Remove Click to remove a component from the

panel.

Initial path Click to enter the path for the Work Area
component.

Show toolbars Select Yes to show the toolbars for the Work
Area component.

IT 04-13008-01-en, October 2012

656
 25 User Management User Interface
25.42 Domain Wizard – Domain Members Page

25.42 Domain Wizard – Domain Members

Page
Use the Domain Members page to add servers to the domain.

Figure: Domain members tab

Table: Domain Members Tab

Component Description

Available Servers List of all available servers.

Servers that are members of this Domain List of all servers in the domain.

Add All
Click to add all available servers to the
domain.

Add
Click to add a server to the domain.

Remove
Click to remove a server from the domain.

Remove All
Click to remove all servers from the domain.

04-13008-01-en, October 2012 IT

657
25 User Management User Interface
25.43 Domains Properties

25.43 Domains Properties

Use the Domains properties to configure the Building Operation domains.

Figure: Domains properties

IT 04-13008-01-en, October 2012

658
 25 User Management User Interface
25.44 Local Properties

25.44 Local Properties

Use the Local properties to configure the local 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-13008-01-en, October 2012 IT

659
25 User Management User Interface
25.45 Work Area Window Properties

25.45 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 23.3 “Workspace
Components and Customization” on page
548.

IT 04-13008-01-en, October 2012

660
 25 User Management User Interface
25.46 Create Work Area Window Wizard – Name Page

25.46 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 23.3
“Workspace Components and
Customization” on page 548.

04-13008-01-en, October 2012 IT

661
26 Backup and Restore

Topics
Backup and Restore
Comparison of Backup and Restore Methods
Local Backup and Restore of a Standalone Automation
Server
Local Backup and Restore of an Enterprise Server
Remote Backup and Restore of Automation Servers
 26 Backup and Restore
26.1 Backup and Restore

26.1 Backup and Restore

Backup and Restore assures that Building Operation server data can be restored
after damage or loss due to hardware or software failures, security threats, or
application testing. Building Operation provides backup and restore capabilities that
preserve both configuration and historical data on an as-needed or periodic basis.

Figure: Building Operation Backup and Restore

26.1.1 Building Operation Backup

Backup is the process of copying and storing data so that the copy can be used to
restore the primary source if a data loss occurs as well as to revert to an older
version. Ideally, server backups should take place during non-business hours. In
Building Operation, you can perform backups on an individual server and its devices
or a group of servers and their devices.
You can select the type of data to back up:
• Configuration only: Useful for new installations, Building Operation backs up
the configuration database, which includes points, values, alarm objects, trend
objects, programs, graphics, and custom object type data. However, trend
logs and events are not included in a backup.
• All data: Useful for existing systems, Building Operation backs up the
configuration database and historical database.
For more information, see section 27.1 “Building Operation Backup” on page 675.

04-13008-01-en, October 2012 IT

665
26 Backup and Restore
26.1 Backup and Restore

26.1.2 Building Operation Restore

Restore is the process of restoring data to an original or former state. Using
Restore, you can revert back to a previous snapshot of the server data despite any
configuration changes made since the last backup. In Building Operation, Restore
is designed to be a manual rather than an automatic process to avoid the
accidental overwriting of current server data. For convenience, Building Operation
displays only the backup files that apply to the selected server.
For more information, see section 30.1 “Building Operation Restore” on page 731.

26.1.3 BACnet Backup and Restore

BACnet Backup uses a binary file format to back up an entire device. Specifically,
BACnet Backups comprise the entire contents of the selected device, such as
associated objects, properties, bindings, historical data, and related proprietary
configuration data.
For more information, see WebHelp.

26.1.4 Archiving
Archiving is used to archive historical data. Archiving is not a backup function
because the archive data cannot be imported back into the system.
For more information, see WebHelp.

26.1.5 Summary of Backup and Restore Methods

There are two Backup and Restore methods: Building Operation and BACnet. You
can select the backup and restore method that suits your server data storage and
retrieval requirements.
For more information, see section 26.2 “Comparison of Backup and Restore
Methods ” on page 667.

IT 04-13008-01-en, October 2012

666
 26 Backup and Restore
26.2 Comparison of Backup and Restore Methods

26.2 Comparison of Backup and Restore

Methods
There are two Backup and Restore methods: Building Operation and BACnet. You
can select the backup and restore method that suits your server data storage and
retrieval requirements.

About Building Operation Backup and Third-party Devices

Building Operation Backup backs up the historical and configuration databases of
Building Operation servers.
Building Operation can interact with many different third-party devices throughout a
building. Third-party devices and their objects are represented in Building Operation
servers as object proxies, which are backed up with the rest of the Building
Operation server data. A backup of object proxies assures that these connectivity
objects, similar to references or links, do not need to be recreated in the event of a
disaster.
The full application of third-party devices are not always fully represented by the
object proxies in the Building Operation server. Therefore, you should use other
methods to protect third-party devices fully. For example, some BACnet devices
that support the BACnet Backup and Restore services can be completely backed
up directly through Building Operation. For more information, see WebHelp.

Note
Do not confuse Archiving with Backup since you cannot restore archived data.
Archiving is designed for long-term storage of historical data that can be retrieved
for auditing and diagnostics.

When to Use Building Operation Backup and Restore

Use the Building Operation Backup method to back up a database along with any
BACnet backup files that are currently stored in the server backup directory. This
method protects the current server data so you can restore the historical and
configuration data later.

About BACnet Backup and b3 Devices

BACnet Backup uses a binary file format to back up an entire BACnet 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.
The b3 devices are a family of intelligent, programmable, standalone devices that
comply with the BACnet Advanced Application Controller profile. These b3 devices
are already included in the Building Operation server database. Consequently,
these devices are automatically backed up whenever a Building Operation server is
backed up. Therefore, b3s do not need backing up using the BACnet Backup
method.

When to Use BACnet Backup and Restore

Building Operation supports the BACnet Reinitialize Device service that controls the
backup and restore of BACnet devices. In Building Operation, you use BACnet
Backup and Restore to back up and restore primarily third-party controllers and
routers.

04-13008-01-en, October 2012 IT

667
26 Backup and Restore
26.2 Comparison of Backup and Restore Methods

The BACnet Backup and Restore can also back up and restore b3 devices that are
connected either to a b3CX controller or a third-party router. BACnet backup and
restore cannot back up b3s when the devices are connected to an Automation
Server that functions as a router. For more information, see WebHelp.

Figure: Comparison of Building Operation and BACnet backup methods

Note
Some BACnet devices do not support the BACnet Backup and Restore services.
Therefore, you should verify that any third-party BACnet device supports these
services before backing up the device.

The following table contrasts the Building Operation and BACnet backup and
restore methods.

Table: Comparison of Building Operation and BACnet Backup and Restore

Method Purpose Description

Building Backs up configuration Use this method to back up:

Operation data and historical data
Backup • Enterprise Servers
• Automation Servers
• b3 devices created under Automation
Servers
• LonWorks devices
• Xenta 280/300/401 LonWorks devices

IT 04-13008-01-en, October 2012

668
 26 Backup and Restore
26.2 Comparison of Backup and Restore Methods

Continued
Method Purpose Description

BACnet Backs up configuration Use this method to back up primarily:

Backup data
• Third-party controllers
• Routers

Building Restores a Building Use this method to restore:

Operation Operation server using
Restore configuration data and • Enterprise Servers
historical data • Automation Servers
contained in a backup
set • b3 devices created under Automation
Servers
• LonWorks devices
• Xenta 280/300/401 LonWorks devices

BACnet Restores a device Use this method to restore:

Restore using configuration
data contained in a • Third-party controllers
backup set (no • Routers
historical data)

04-13008-01-en, October 2012 IT

669
26 Backup and Restore
26.3 Local Backup and Restore of a Standalone Automation Server

26.3 Local Backup and Restore of a

Standalone Automation Server
In WorkStation, you can log onto an Automation Server to back up the server data
locally. If you have multiple standalone Automation Servers, the Backup and
Restore processes on one Automation Server remain self-contained and, therefore,
separate from any another Automation Server on the network.

Figure: Backup and Restore for standalone Automation Servers

The system only stores one backup file at a time on the Automation Server. If you
import a backup set, the system overwrites the locally stored file with the imported
file. Therefore, you will only see one backup file in the Restore Options dialog box
when you log onto an Automation Server.

IT 04-13008-01-en, October 2012

670
 26 Backup and Restore
26.4 Local Backup and Restore of an Enterprise Server

26.4 Local Backup and Restore of an

Enterprise Server
In WorkStation, you can log onto an Enterprise Server to back up the server data
locally. 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. For more information, see section 27.4
“Manual Backups” on page 680.

04-13008-01-en, October 2012 IT

671
26 Backup and Restore
26.5 Remote Backup and Restore of Automation Servers

26.5 Remote Backup and Restore of

Automation Servers
When you log onto an Enterprise Server, you can perform remote backups of any
lower tier Automation Servers in the group. Whenever a manual or scheduled
backup occurs, the system overwrites the locally stored file on the Automation
Server with the new backup file. The system then notifies the Enterprise Server that
a new local Automation Server backup file is available. The Enterprise Server then
fetches and stores this backup file in a separate directory on the hard drive.
The system only displays valid backup files stored on the Enterprise Server in the
Restore Options dialog box. In the event that the Automation Server’s backup file is
damaged or lost, or not the one you want to use, you can select a valid backup file
to restore the server. The restore operation overwrites the locally stored server
backup file located on the Automation Server with the selected backup file. For
more information, see section 30.4 “Restoring an Automation Server from the
Enterprise Server” on page 736.
The Backup and Restore Manager displays the stored backup rules for all the
servers in a multi-server configuration. For ease of use, you can easily access and
apply the backup rules across all the servers in the group. The Backup and Restore
Manager may display different information based on the current configuration and
run-time data of the server you select. This data can vary from server to server. For
more information, see section 31.3 “Backup and Restore Manager on the
Enterprise Server” on page 746.

IT 04-13008-01-en, October 2012

672
27 Backups

Topics
Building Operation Backup
Backup Status
Checking the Backup Status of a Server
Manual Backups
Backing Up a Server Manually
Multi-server Backup
Backing Up Multiple Servers
System Backup
 27 Backups
27.1 Building Operation Backup

27.1 Building Operation Backup

Backup is the process of copying and storing data so that the copy can be used to
restore the primary source if a data loss occurs as well as to revert to an older
version. Ideally, server backups should take place during non-business hours. In
Building Operation, you can perform backups on an individual server and its devices
or a group of servers and their devices.
You can select the type of data to back up:
• Configuration only: Useful for new installations, Building Operation backs up
the configuration database, which includes points, values, alarm objects, trend
objects, programs, graphics, and custom object type data. However, trend
logs and events are not included in a backup.
• All data: Useful for existing systems, Building Operation backs up the
configuration database and historical database.
The following table lists the types of data that you can back up, and the benefits
and purposes of each.

Table: Backup Options

Type of Data Contents Benefits

Historical Includes Trend logs and Event logs Preserves a copy of the Trend logs
stored on a server. and Event logs.

Configuration Includes configuration data and Preserves a snapshot of the

custom object types stored on a configuration data for a particular
server. date and time.
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 WebHelp.

When deciding on the frequency of 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 choose to back up an Automation
Server daily if multiple operators use their WorkStations frequently. As a precaution,
you can initiate a full server backup before installing a new application or modifying
the current configuration.
Using WorkStation, you can back up data to the local drive of each installed
Building Operation server. Building Operation stores the files by date in a predefined
directory location on the server to which Workstation is connected. For more
information, see section 28.1 “Backup Sets” on page 695.

Note
Depending on the type of data, the system locks the database while a backup is
in progress in different ways. For configuration changes, Building Operation
queues up the changes until the backup completes. For historical data changes,
Building Operation buffers the data based on the limits of the buffer size.

04-13008-01-en, October 2012 IT

675
27 Backups
27.1 Building Operation Backup

Impact on Configuration Values and Variables

When you back up a server specifying either Configuration only or All data, Building
Operation includes all the configuration values that are specified for the server’s
objects. If you restore the 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.

27.1.1 Backup Sets

Backup sets are compressed backup files used for restoring data. Building
Operation stores the local backup set for an Enterprise Server or Automation Server
under a Local folder in the Backup sets folder. The Automation Server stores only
one backup set at a time, so each new backup operation overwrites the previous
backup set.
For more information, see section 28.1 “Backup Sets” on page 695.

27.1.2 Scheduled Backups

A scheduled backup is an automated way to back up data on a server. You can
back up servers individually using each server’s local backup rule. You can also use
backup rules to synchronize the backups of all the Building Operation servers on
your network.
For more information, see section 29.1 “Scheduled Backups” on page 715.

27.1.3 Manual Backups

Manual Backup is a non-automated process of copying and storing data on a
selected Building Operation server. You can use this option to create backups on
an as-needed basis. You can also manually restore the data at any time.
For more information, see section 27.4 “Manual Backups” on page 680.

27.1.4 Multi-server Backups

Multi-server backup is designed for backing up multiple Building Operation servers
in one operation across an entire network. You can back up multiple servers
selectively using the mass backup method, or automatically using the synchronized
backup method.
For more information, see section 27.6 “Multi-server Backup” on page 686.

IT 04-13008-01-en, October 2012

676
 27 Backups
27.1 Building Operation Backup

27.1.5 Backup Status

Building Operation generates a system alarm when an Automation Server or
Enterprise Server backup fails. For example, an alarm displays in the server’s
Alarms pane when a backup does not complete because the server is offline.
For more information, see section 27.2 “Backup Status” on page 678.

04-13008-01-en, October 2012 IT

677
27 Backups
27.2 Backup Status

27.2 Backup Status

Building Operation generates a system alarm when an Automation Server or
Enterprise Server backup fails. For example, an alarm displays in the server’s
Alarms pane when a backup does not complete because the server is offline.
There are several default backup and restore alarms. For more information, see
WebHelp.
Building Operation adds an event in the Event log whenever a backup takes place.
For example, you can check the Events pane to see if a server database backup is
successful. For more information, see WebHelp.
You can also check the current backup status of a server from the Backup and
Restore Manager. For more information, see section 31.3 “Backup and Restore
Manager on the Enterprise Server” on page 746.

Figure: Backup status in Backup and Restore Manager view

In addition, you can set up your own backup alarms. For more information, see
WebHelp.

IT 04-13008-01-en, October 2012

678
 27 Backups
27.3 Checking the Backup Status of a Server

27.3 Checking the Backup Status of a Server

You check the backup status of a server to verify that a backup is complete and to
note the date and time of the last backup.
For more information, see section 27.2 “Backup Status” on page 678.

To check the backup status of a server

1. In WorkStation, on the Tools menu, select Control Panel
Panel.
2. In the Server box, select a server where you want to check the backup status.
3. In the Backup and archiving area, click the Backup and Restore Manager
Manager.

4. View the current server status or date and time of the last successful backup.

04-13008-01-en, October 2012 IT

679
27 Backups
27.4 Manual Backups

27.4 Manual Backups

Manual Backup is a non-automated process of copying and storing data on a
selected Building Operation 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 onto the following Building Operation servers:
• An Automation Server to initiate manual backups in WorkStation. For more
information, see section 27.5 “Backing Up a Server Manually” on page 683.
• An Enterprise Server to initiate manual backups of the server in WorkStation.
You can also manually back up any Automation Servers that are created under
the Enterprise Server.

Note
The system generates default backup names that are a combination of the server
name and date/time. For ease of use, manual backups include the local time of
the WorkStation, such as Server 1_20110823-020127. Conversely, system
generated scheduled backups include the UTC time in the backup name, such as
Server 1_2011-08-23 180156. However, the system also retains the UTC time of
the manual 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.

Backup Set Renaming

When you create a manual backup, the system initially names the backup set by
combining the server name with the localized date and time in WorkStation.
However, you can change this initial (default) name prior to generating the backup. If
some backup sets are given identical names by mistake, the duplicate backup sets
(restore points) display in the Restore Options dialog box.
Duplicating names can occur when you log onto the Automation Server in
WorkStation to create a backup. The Automation Server cannot check for duplicate
names because only one backup set is stored locally at any given time. As the
Enterprise Server fetches (copies and stores) the latest Automation Server backup
file, the system automatically appends an extended date (year, month, and day) and
military-based time stamp to differentiate the backup set names and avoid
accidental overwriting. For example, if two backup sets are mistakenly named
Tuesday_Automation Server _Full Backup, one of the backup sets will be renamed
Tuesday_Automation Server _Full Backup_20110208-114332. To view the different
time stamps for each similarly named file, you expand the name column in the
Restore Points dialog box.

IT 04-13008-01-en, October 2012

680
 27 Backups
27.4 Manual Backups

Figure: Duplicate restore points in the Restore Options dialog box

If you log onto the Enterprise Server in WorkStation to create a backup of an
Automation Server, the system automatically checks for identical backup set
names. If a name is found in the AS Archives folder, the system warns of a
potential duplication by highlighting the Backup set name prefix box or the
Backup set name suffix box in solid red. If you do not change the prefix or suffix,
the system displays a red box around the backup set in the Backup set name
column to indicate that there is an existing name. If you still do not change the
name, the system automatically appends an extended time stamp to prevent the
accidental overwriting. For more information, see WebHelp.

Backup Comments
When you create a manual backup, you can also add a comment up to 255
characters to identify a particular backup set. Once the backup completes, the
system displays these comments as ToolTips in the Restore Options dialog box.
For example, you can add a comment, Final Commissioning, to backups of newly
installed and configured servers. For more information, see section 31.5 “Backup
Options Dialog Box” on page 748.

Mass Backup of Multiple Servers

A mass backup is a method of performing a manual, simultaneous backup of all the
servers in the network, which is useful for capturing data at a critical point, such as
prior to an upgrade. You can choose which servers you want to back up along with
the type of data for each.

04-13008-01-en, October 2012 IT

681
27 Backups
27.4 Manual Backups

Figure: Mass backup of multiple servers

IT 04-13008-01-en, October 2012

682
 27 Backups
27.5 Backing Up a Server Manually

27.5 Backing Up a Server Manually

You back up a server manually to copy and store data that is frequently updated or
involved in application testing.
For more information, see section 27.4 “Manual Backups” on page 680.

To back up a server manually

1. In WorkStation, in the System Tree pane, select an Automation Server or
Enterprise Server.
2. On the Actions menu, click Backup
Backup.
3. In the Backup set name prefix box, type some text at the beginning of the file
name that helps identify the backup set, such as Daily.
4. In the Backup set name suffix box, type some text at the end of the file name
that helps identify the backup set, such as Final Configuration.
5. In the Include column, manually select the servers that you want to include in

the backup, or click the Select All button to include all the listed servers
in the backup.

6. In the Backup content column, select the type of data you want to back up
for each server:
• Select All data to back up both the historical and configuration
databases. This combined data option protects the configuration,
historical data, and custom object type data for a specified date and time.
• Select Configuration only to back up the configuration database and
custom object type data. This data option protects the configuration data
for a specified date and time.
7. In the Backup set description column, type a brief description up to 255
characters to help identify the content of the backup.
Continued on next page

04-13008-01-en, October 2012 IT

683
27 Backups
27.5 Backing Up a Server Manually

8. Click the Synchronize Comment button to add the same backup set
description entered for one server to all the other backup sets, such as Daily
server - All data backup.

9. Click the Synchronize Content button to add the same content type
chosen for one server to all the other backup sets, such as All data.

10. Click the Synchronize All button to add both the backup set description
and the content type chosen for one server to all the other backup sets, such
as All data and Daily server - All data backup.
11. Click Backup
Backup.
12. Verify that each backup succeeded and click Close
Close.

Continued on next page

IT 04-13008-01-en, October 2012

684
 27 Backups
27.5 Backing Up a Server Manually

13. Confirm that each backup set is listed in the Local or AS Archives folder.

After you back up a Building Operation server, you can restore the server data at
any time.

04-13008-01-en, October 2012 IT

685
27 Backups
27.6 Multi-server Backup

27.6 Multi-server Backup

Multi-server backup is designed for backing up multiple Building Operation servers
in one operation across an entire network. You can back up multiple servers
selectively using the mass backup method, or automatically using the synchronized
backup method.

Figure: Multi-server backups

The following table provides a comparison of the different methods of backing up
multiple servers on a network.

Table: Multi-server Backup Methods

Method Purpose Action Benefits

Mass backup To manually Select one or more Can selectively back up

back up servers in a manual servers as well as the type of
multiple servers backup operation. For data on an as-needed basis.
more information, see
section 27.4 “Manual Uses a single dialog box. For
Backups” on page 680. more information, see
section 31.5 “Backup
Options Dialog Box” on page
748.

Synchronized To Select a backup rule to be Can automatically back up

backup automatically the lead rule for one or servers on a recurring basis.
back up more servers. For more
multiple servers information, see section Uses a single backup rule
on a network 29.9 “Synchronized editor. For more information,
Backups” on page 726. see section 31.7 “Backup
Rules View” on page 751.

IT 04-13008-01-en, October 2012

686
 27 Backups
27.6 Multi-server Backup

In smaller installations, there can be an Enterprise Server with one or more assigned
Automation Servers that form a single group. In larger installations, there can be
multiple Enterprise Servers that have their own distinct set of Automation Servers. In
either case, the Enterprise Server is the hierarchical top server and Automation
Servers constitute the base tier.

27.6.1 Local Backup of a Standalone Automation

Server
In WorkStation, you can log onto an Automation Server to back up the server data
locally. If you have multiple standalone Automation Servers, the Backup and
Restore processes on one Automation Server remain self-contained and, therefore,
separate from any another Automation Server on the network.
For more information, see section 26.3 “Local Backup and Restore of a Standalone
Automation Server” on page 670.

27.6.2 Local Backup of an Enterprise Server

In WorkStation, you can log onto an Enterprise Server to back up the server data
locally. 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.
For more information, see section 26.4 “Local Backup and Restore of an Enterprise
Server” on page 671.

27.6.3 Remote Backup of Multiple Automation

Servers
When you log onto an Enterprise Server, you can perform remote backups of any
lower tier Automation Servers in the group. Whenever a manual or scheduled
backup occurs, the system overwrites the locally stored file on the Automation
Server with the new backup file. The system then notifies the Enterprise Server that
a new local Automation Server backup file is available. The Enterprise Server then
fetches and stores this backup file in a separate directory on the hard drive.
For more information, see section 26.5 “Remote Backup and Restore of
Automation Servers” on page 672.

04-13008-01-en, October 2012 IT

687
27 Backups
27.7 Backing Up Multiple Servers

27.7 Backing Up Multiple Servers

You perform a backup of multiple servers simultaneously to save time.
For more information, see section 27.4 “Manual Backups” on page 680.

To back up multiple servers

1. In WorkStation, in the System Tree pane, select the Enterprise Server.
2. On the Actions menu, click Backup
Backup.
3. In the Backup set name prefix box, type some text at the beginning of the file
name that helps identify the backup set, such as Daily.
4. In the Backup set name suffix box, type some text at the end of the file name
that helps identify the backup set, such as Final Configuration.
5. In each Include column, select the servers that you want to include in the

backup, or click the Select All button to include all the listed servers in
the backup.

6. In the Backup content column, select the type of data you want to back up
for each server:
• Select Configuration only to back up the configuration database and
custom object type data.
• Select All data to back up the configuration, historical, 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 Comment button to add the same backup set
description entered for one server to all the other backup sets, such as Daily
server - All data backup.
Continued on next page

IT 04-13008-01-en, October 2012

688
 27 Backups
27.7 Backing Up Multiple Servers

9. Click the Synchronize Content button to add the same content type
chosen for one server to all the other backup sets, such as All data.

10. Click the Synchronize All button to add both the backup set description
and the content type chosen for one server to all the other backup sets, such
as All data and Daily server - All data backup.
11. Click Backup
Backup.
12. Verify that the backups succeeded and click Close
Close.

04-13008-01-en, October 2012 IT

689
27 Backups
27.8 System Backup

27.8 System Backup

Before upgrading the system, it is strongly recommended that you archive the
historical data and back up the 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 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.
(Archiving is not on Automation Servers.) For
more information, see WebHelp.

2 Back up current servers Create an All data backup for the Enterprise
Server and each Automation Server created
under the Enterprise Server to ensure that a
valid backup set is available, if needed. The
backups do not need to follow any particular
order. For more information, see section 27.6
“Multi-server Backup” on page 686.

3 Verify backup status Check that the backup process completed

successfully on each server. For more
information, see section 27.3 “Checking the
Backup Status of a Server” on page 679.

IT 04-13008-01-en, October 2012

690
 27 Backups
27.8 System Backup

Continued
Step Procedure Description

4 Save backup sets to an external Save the Enterprise Server and Automation
location Server backup sets (.xbk) to a safe location on
the file system that is external to the Enterprise
Server. For more information, see section 28.2
“Backup Set Storage and Protection” on page
697.

5 Back up current Reports For systems that include a Reports Server,

database back up the WebReports database in case the
upgrade process does not complete
successfully. By doing so, you can recover the
original database and restart the upgrade
process, if necessary. For more information,
see section 10.14 “Backing Up the
WebReports Database” on page 252.
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).

6 Copy current server configuration Jot down the following information that you will
need to reset after the upgrade:
• Forced-variable settings and
corresponding values
• Server communication protocol port
information (Enterprise Server,
Communications tab)
• TCP and HTTP or HTTPS port numbers
for the Building Operation servers

7 Back up upgraded servers As a good practice, perform a final backup of all

the newly upgraded servers in the system. For
more information, see section 27.6 “Multi-
server Backup” on page 686.

8 Back up upgraded WebReports For systems that include a Reports Server, you
database can also back up the upgraded WebReports
database. For more information, see section
10.14 “Backing Up the WebReports Database”
on page 252.

Caution
In a multi-server system, the impact of a server restore is difficult to predict until
the restore process completes and the server restarts. Take manual control of
any output points that could potentially damage equipment before restoring the
server. If disconnecting the physical outputs is not possible, restore the server
using a trusted restore file that will turn on/off the outputs predictably and safely.
In this way, you avoid the possibility of incurring any unexpected physical
outcomes or injuries.

04-13008-01-en, October 2012 IT

691
28 Backup Sets

Topics
Backup Sets
Backup Set Storage and Protection
Locating the Local Backup Path on the Enterprise Server
Copying an Automation Server Backup Set to WorkStation
Copying an Enterprise Server Backup Set to WorkStation
Copying a Backup Set to the Enterprise Server Local
Directory
Backup Set Import from WorkStation
Importing a Backup Set from WorkStation to an Automation
Server
Automatic Purge of Backup Sets
Configuring Purge Settings on an Enterprise Server
Deleting a Backup Set from the Enterprise Server
 28 Backup Sets
28.1 Backup Sets

28.1 Backup Sets

Backup sets are compressed backup files used for restoring data. Building
Operation stores the local backup set for an Enterprise Server or Automation Server
under a Local folder in the Backup sets folder. The Automation Server stores only
one backup set at a time, so each new backup operation overwrites the previous
backup set.
An Enterprise Server can store multiple backup sets in the Local Folder.

Figure: Backup sets in Local folder on an Enterprise Server

In multiple server sites, the Enterprise Server manages all the Automation Servers in
its group. When you back up an Automation Server remotely from an an Enterprise
Server, the backup set is actually stored in two places: on the Automation Server
and on the Enterprise Server.
Unlike an Automation Server, an Enterprise Server can store multiple local and
remote backup files. In the Backup sets folder of the installation directory, Building
Operation creates two directories:
• ASArchives
ASArchives: Lists separate subfolders that reflect the name of each
Automation Server. Each subfolder contains the backup files for that server.
• LocalBackup
LocalBackup: Lists all the local backup files for the Enterprise Server.

Server Rename
Building Operation associates each backup set with a particular server name.
Therefore, you should not rename a Building Operation server unless absolutely
necessary. If you do rename a server, the previous backup sets do not display in
the Restore Options dialog box. You can view all the backup sets that are stored
locally on an Enterprise Server. For more information, see section 28.3 “Locating
the Local Backup Path on the Enterprise Server” on page 699.

04-13008-01-en, October 2012 IT

695
28 Backup Sets
28.1 Backup Sets

Tip
Going forward, you must create new backups for the renamed server.

28.1.1 Backup Set Storage and Protection

Building Operation servers store backup sets in their local directory. 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 Building
Operation servers to WorkStation. After saving the backup set, you can also copy
the file to another backup storage location.
For more information, see section 28.2 “Backup Set Storage and Protection” on
page 697.

28.1.2 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 server.
For more information, see section 28.7 “Backup Set Import from WorkStation” on
page 705.

28.1.3 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 server. To resolve this
problem, Building Operation provides an automated way to remove outdated
backup sets.
For more information, see section 28.9 “Automatic Purge of Backup Sets” on page
707.

IT 04-13008-01-en, October 2012

696
 28 Backup Sets
28.2 Backup Set Storage and Protection

28.2 Backup Set Storage and Protection

Building Operation servers store backup sets in their local directory. 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 Building
Operation 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 Building Operation 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 server. This unique folder name can help you
identify a particular Enterprise Server or Automation server backup set, such as AS-
1 Final Configuration Backup. Using this method, you can easily locate the backup
set on your network.

Backup Set Renaming

Scheduled backup sets have a unique file name and extension based on the date
stamp and software version. However, you can rename the backup set, if
necessary. For more information, see section 29.1 “Scheduled Backups” on page
715.

04-13008-01-en, October 2012 IT

697
28 Backup Sets
28.2 Backup Set Storage and Protection

Backup Set Removal

You can remove backups sets in two ways:
• Manually. You can delete backups sets using a browser. For more information,
see section 28.11 “Deleting a Backup Set from the Enterprise Server” on page
710.
• Periodically. You can configure the system to remove backup sets on a regular
basis. For more information, see section 28.9 “Automatic Purge of Backup
Sets” on page 707.

IT 04-13008-01-en, October 2012

698
 28 Backup Sets
28.3 Locating the Local Backup Path on the Enterprise Server

28.3 Locating the Local Backup Path on the

Enterprise Server
You locate the local backup folder on the Enterprise Server to view the stored
backup sets. The system displays the valid backup sets stored in this folder in the
Restore Options dialog box.
For more information, see section 28.2 “Backup Set Storage and Protection” on
page 697.

To locate a local backup path on the Enterprise Server

1. Log onto the Enterprise Server in WorkStation.
2. On the Tools menu, select Control Panel
Panel.
3. In the Backup and archiving area, select Backup and Restore Manager
Manager.

The Backup sets path box displays the local backup path on the server.

04-13008-01-en, October 2012 IT

699
28 Backup Sets
28.4 Copying an Automation Server Backup Set to WorkStation

28.4 Copying an Automation Server Backup

Set to WorkStation
You copy an Automation Server backup set to a file location on a PC running
WorkStation.

To copy an Automation Server backup set to WorkStation

1. In WorkStation, on the Tools menu, select Control Panel
Panel.
2. In the Backup and archiving area, click Backup Sets
Sets.

3. In the List View

View, open the AS Archives folder.
4. Open the Automation Server folder that contains the backup set.
5. Select the backup set that you want to save to a different location.

6. On the Actions menu, click Save To

To.
7. In the Browse For Folder dialog box, enter a storage location and click Save
Save.
Continued on next page

IT 04-13008-01-en, October 2012

700
 28 Backup Sets
28.4 Copying an Automation Server Backup Set to WorkStation

8. Make a note of the destination and click Close

Close.

04-13008-01-en, October 2012 IT

701
28 Backup Sets
28.5 Copying an Enterprise Server Backup Set to WorkStation

28.5 Copying an Enterprise Server Backup

Set to WorkStation
You save a backup set from an Enterprise Server to WorkStation so you can copy
the backup set to a different (remote) location. This procedure is recommended
only for advanced technicians and system administrators.
For more information, see section 28.2 “Backup Set Storage and Protection” on
page 697.

To copy an Enterprise Server backup set to WorkStation

1. In WorkStation, on the Tools menu, select Control Panel
Panel.
2. In the Backup and archiving area, click Backup Sets
Sets.

3. In the List View

View, open the Local folder.
4. Select the Enterprise Server backup set that you want to save to a different
location.
5. On the Actions menu, click Save To
To.
6. In the Browse For Folder dialog box, enter a storage location and click Save
Save.
7. Make a note of the destination and click Close
Close.

IT 04-13008-01-en, October 2012

702
 28 Backup Sets
28.6 Copying a Backup Set to the Enterprise Server Local Directory

28.6 Copying a Backup Set to the Enterprise

Server Local Directory
You copy a backup set to the Local (db_backup) folder to restore the targeted
Enterprise Server.
For more information, see section 28.2 “Backup Set Storage and Protection” on
page 697.

To copy a backup set to the Enterprise Server local directory

1. In the Backup sets path box, copy the entire backup sets path of the
Enterprise Server.

2. Open a browser, such as Windows Explorer.

3. In the browser Address box, paste the backup sets path and press Enter
Enter.
4. In the db_backup folder, open the LocalBackup folder.

Continued on next page

04-13008-01-en, October 2012 IT

703
28 Backup Sets
28.6 Copying a Backup Set to the Enterprise Server Local Directory

5. Paste the backup set into the LocalBackup folder.

Note
If the LocalBackup folder does not appear within the db_backup
folder, you can create one using the exact name, LocalBackup
LocalBackup.

IT 04-13008-01-en, October 2012

704
 28 Backup Sets
28.7 Backup Set Import from WorkStation

28.7 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 server. Building Operation stores a local
backup set for an Enterprise Server or Automation Server under the Local folder in
the Backup Sets folder. However, the system handles the storage of backup sets
based on the type of server. For example, an Automation Server stores only one
backup set at a time. Therefore, the system overwrites the previous backup file with
the latest file. If there is no file present, Building Operation adds the backup set to
the Local folder. In a multi-server system, the Enterprise Server fetches and stores
the latest backup set for each lower tier Automation Server in a separate directory in
the Backup Sets folder. In addition, the system can store several backup sets for
each Automation Server as well as multiple backup sets for the Enterprise Server.

Figure: Import backup set from WorkStation to an Automation Server or Enterprise Server
Importing is a three-step process: logging onto the server, importing the file, and
then restoring the server. First, you log onto a Building Operation server in
WorkStation. You then import the selected backup set from a network storage
area. Finally, you restore the server.
You can only restore a server using a backup set that was created with the same
software version on the same server. 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 a server, no backup set
displays after importing.

04-13008-01-en, October 2012 IT

705
28 Backup Sets
28.8 Importing a Backup Set from WorkStation to an Automation Server

28.8 Importing a Backup Set from

WorkStation to an Automation Server
You import a backup set from a network storage location to restore a replacement
Automation Server, or to replace a lost or damaged backup set.
For more information, see section 27.4 “Manual Backups” on page 680.

To import a backup set from WorkStation to an Automation

Server
1. Log onto the Automation Server to which you want to import a backup set.
2. In WorkStation, in the System Tree pane, select the Automation Server.
3. On the Actions menu, click Restore
Restore.
4. In the Available restore points box, ensure that the imported data is
displayed.

5. Select a backup set in black text, which indicates that the backup set is
compatible with the current version of the server.
6. Click Import Backup Set
Set.
7. Click OK to replace the existing backup set with the imported backup set.

You can now restore the Automation Server with the imported backup set.

IT 04-13008-01-en, October 2012

706
 28 Backup Sets
28.9 Automatic Purge of Backup Sets

28.9 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 server. To resolve this
problem, Building Operation provides an automated way to remove outdated
backup sets.
You configure purge settings on an Enterprise Server, rather than an Automation
Server. For more information, see section 31.3 “Backup and Restore Manager on
the Enterprise Server” on page 746.

Purge Configuration on an Enterprise Server

You can set the maximum number of local and remote backups that you want to
store at a given time on the Enterprise Server. The system compares two values:
the maximum number that you set for the server and the date stamp on each
stored backup. Whenever a new backup is created, Building Operation
automatically replaces the most outdated file with the newest file. In other words,
the system adds a new file and then deletes the oldest file to maintain the maximum
number that you set for the server.

Local and Remote Backup Sets

You can manage automatic purging on an Enterprise Server by setting a maximum
number of files to store. There are two settings available: a local setting for the
Enterprise Server and a global setting for Automation Servers. The local setting
(Number of local backup sets to store) manages the backups stored on an
Enterprise Server. The global setting (Number of AS backup sets to store) manages
all the backups stored on the Automation Servers. You cannot configure each
Automation Server separately because the global setting affects all the servers
created under the Enterprise Server.

Table: Automatic Purge Settings on an Enterprise Server

ES Setting Local Remote Default Description

Number of AS - X 5 This setting affects all the

backup sets to store Automation Servers. The minimum
number is 1.

Number of local X - 5 This setting only affects the

backup sets to store Enterprise Server. The minimum
number is 1.

Automatic purging X X Enabled When enabled, the Enterprise Server

purges any outdated backup files at
the next backup.
When disabled, the Enterprise
Server stores all backup files.

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 and two remote backup sets for each Automation Server.

04-13008-01-en, October 2012 IT

707
28 Backup Sets
28.9 Automatic Purge of Backup Sets

Enable/Disable Automatic Purging

By default, Building Operation enables automatic purging for both local (Enterprise
Server) and remote (Automation Server) backup sets. However, you can disable this
feature to ensure that all manual and scheduled backup sets are automatically
stored on the Enterprise Server. For more information, see section 31.3 “Backup
and Restore Manager on the Enterprise Server” on page 746.

IT 04-13008-01-en, October 2012

708
 28 Backup Sets
28.10 Configuring Purge Settings on an Enterprise Server

28.10 Configuring Purge Settings on an

Enterprise Server
You purge outdated backup sets to help reduce the resource constraints on an
Enterprise Server. You cannot configure these settings on an Automation Server.
For more information, see section 28.9 “Automatic Purge of Backup Sets” on page
707.

To configure purge settings on an Enterprise Server

1. In WorkStation, on the Tools menu, select Control Panel
Panel.
2. In the Backup and archiving area, click Backup and Restore Manager
Manager.

3. Select Enable AS purge to enable the Enterprise Server to automatically

purge the oldest backup of an Automatin Server when a new backup is
stored.
4. In the Number of AS backup sets to keep box, enter the maximum number
of backups that the Enterprise Server can store for each Automation Server.
5. Select Enable ES purge to enable the Enterprise Server to automatically
purge the oldest Enterprise Server backup when a new backup is stored.
6. In the Number of local backup sets to keep box, enter the maximum
number of backup sets that the system can store for the Enterprise Server.
7. Click Save
Save.

04-13008-01-en, October 2012 IT

709
28 Backup Sets
28.11 Deleting a Backup Set from the Enterprise Server

28.11 Deleting a Backup Set from the

Enterprise Server
You delete a backup set from the db_Backup folder of the Enterprise Server when
you no longer need the backup set.
For more information, see section 28.1 “Backup Sets” on page 695.

To delete a backup set from the Enterprise Server

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Backup and archiving area, click Backup and Restore Manager
Manager.

3. In the Backup sets path box, copy the entire backup sets path of the
Enterprise Server.

4. Open a browser, such as Windows Explorer.

5. In the browser Address box, paste the backup sets path and press Enter
Enter.
Continued on next page

IT 04-13008-01-en, October 2012

710
 28 Backup Sets
28.11 Deleting a Backup Set from the Enterprise Server

6. In the db_backup folder, open the ASArchives or LocalBackup folder.

7. Right-click on the backup set that you want to delete and click Delete
Delete.
8. Click Yes to remove the backup set.

04-13008-01-en, October 2012 IT

711
29 Scheduled Backups

Topics
Scheduled Backups
Backup Rules
Creating a Backup Rule
Editing a Backup Rule
Deleting a Backup Rule
Removing a Lead Rule from a Backup Rule
Backup Schedules
Editing a Backup Schedule
Synchronized Backups
Synchronizing Server Backups on a Network
 29 Scheduled Backups
29.1 Scheduled Backups

29.1 Scheduled Backups

A scheduled backup is an automated way to back up data on a server. You can
back up servers individually using each server’s local backup rule. You can also use
backup rules to synchronize the backups of all the Building Operation servers on
your network.
As part of the scheduled backup process, Building Operation 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 a
server manually. For more information, see section 27.4 “Manual Backups” on page
680.

Figure: Backup on an Enterprise Server

29.1.1 Backup Rules

In 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 a 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.
For more information, see section 29.2 “Backup Rules” on page 717.

04-13008-01-en, October 2012 IT

715
29 Scheduled Backups
29.1 Scheduled Backups

29.1.2 Backup Schedules

Building Operation 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 Automation Server or Enterprise 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 29.7 “Backup Schedules” on page 724.

29.1.3 Synchronized Backups

A synchronized backup is a method of performing a recurring, simultaneous
backup of a selected number of servers. You can use a lead and shadow
relationship to automate all the Building Operation server backups on your network.
Using this method, you configure and manage one lead backup rule on one server,
which other backup rules can reference.
For more information, see section 29.9 “Synchronized Backups” on page 726.

IT 04-13008-01-en, October 2012

716
 29 Scheduled Backups
29.2 Backup Rules

29.2 Backup Rules

In 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 a 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.
Building Operation automatically backs up all data on an Automation Server or
Enterprise 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
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.
Alternately, you may want to create a backup rule that backs up only the
configuration data on an Automation Server once a day. In this case, you may want
to use the default backup rule and change the frequency, if needed. In addition, you
can set up another backup rule for one server, which acts as the lead, to manage a
recurring backup for a group of servers. For more information, see section 31.7
“Backup Rules View” on page 751.

04-13008-01-en, October 2012 IT

717
29 Scheduled Backups
29.3 Creating a Backup Rule

29.3 Creating a Backup Rule

You create a backup rule on an Automation Server or Enterprise 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 server.
For more information, see section 29.1 “Scheduled Backups” on page 715.

To create a backup rule

1. In WorkStation, in the System Tree pane, select a server.
2. On the Tools menu, select Control Panel
Panel.
3. In the Backup and archiving area, click Backup Rules
Rules.

4. Click the Add backup rule button .

Continued on next page

IT 04-13008-01-en, October 2012

718
 29 Scheduled Backups
29.3 Creating a Backup Rule

5. Type a name for the backup rule.

6. In the Description box, type a description for the backup rule.

7. Click Create
Create.
8. In the Backup set description box, type a comment up to 255 characters to
help identify the content of the backup.

9. 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.
10. In the Lead rule box, enter a backup rule that references a lead schedule
managed on another server.
11. In the Enabled box, select Yes to enable the backup rule.
12. Click OK
OK.

04-13008-01-en, October 2012 IT

719
29 Scheduled Backups
29.4 Editing a Backup Rule

29.4 Editing a Backup Rule

You edit a backup rule on a 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 server.
For more information, see section 29.1 “Scheduled Backups” on page 715.

To edit a backup rule

1. In WorkStation, in the System Tree pane, select the server that contains the
backup rule that you want to edit.
2. On the Tools menu, select Control Panel
Panel.
3. In the Backup and archiving area, click Backup Rules
Rules.

4. Select the backup rule.

5. Click the Edit backup rule button .

Continued on next page

IT 04-13008-01-en, October 2012

720
 29 Scheduled Backups
29.4 Editing a Backup Rule

6. In the Backup set description box, type or modify the backup comment.

7. 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 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.
8. In the Lead rule box, enter a backup rule that references a lead schedule
managed on another server.
9. In the Enabled box, select Yes to enable the backup schedule.
10. Click OK
OK.

04-13008-01-en, October 2012 IT

721
29 Scheduled Backups
29.5 Deleting a Backup Rule

29.5 Deleting a Backup Rule

You delete a backup rule to remove the rule from the server.
For more information, see section 29.1 “Scheduled Backups” on page 715.

To delete a backup rule

1. In WorkStation, in the System Tree pane, select the server that contains the
backup rule that you want to remove.
2. On the Tools menu, select Control Panel
Panel.
3. In the Backup and archiving area, click Backup Rules
Rules.

4. Select the backup rule.

5. Click the Remove backup rule button .

6. Click Yes to delete the backup rule from the server.

IT 04-13008-01-en, October 2012

722
 29 Scheduled Backups
29.6 Removing a Lead Rule from a Backup Rule

29.6 Removing a Lead Rule from a Backup

Rule
You remove the lead and shadow relationship from a server by deleting the lead rule
reference.
For more information, see section 29.1 “Scheduled Backups” on page 715.

To remove a lead rule from a backup rule

1. In WorkStation, on the Tools menu, select Control Panel
Panel.
2. In the Backup and archiving area, click Backup Rules
Rules.

3. In the Lead rule box, delete the lead backup rule, which removes the lead and
shadow relationship for the selected server.

4. Click Save
Save.

04-13008-01-en, October 2012 IT

723
29 Scheduled Backups
29.7 Backup Schedules

29.7 Backup Schedules

Building Operation 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 Automation Server or Enterprise 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.

Figure: Backup on a standalone Automation Server

You can create a custom backup rule and then modify its schedule. For example,
you can create a backup rule that backs up all data on an Automation Server daily
at 02:00. For more information, see section 31.7 “Backup Rules View” on page
751.

IT 04-13008-01-en, October 2012

724
 29 Scheduled Backups
29.8 Editing a Backup Schedule

29.8 Editing a Backup Schedule

You edit a backup schedule, which is combined with a backup rule, to change the
frequency of the backup.
For more information, see section 29.1 “Scheduled Backups” on page 715.

To edit a backup schedule

1. In WorkStation, in the System Tree pane, select a server.
2. On the Tools menu, select Control Panel
Panel.
3. In the Backup and archiving area, click Backup Rules
Rules.

4. In the Schedule column, click the schedule that you want to modify.

04-13008-01-en, October 2012 IT

725
29 Scheduled Backups
29.9 Synchronized Backups

29.9 Synchronized Backups

A synchronized backup is a method of performing a recurring, simultaneous
backup of a selected number of servers. You can use a lead and shadow
relationship to automate all the Building Operation server backups on your network.
Using this method, you configure and manage one lead backup rule on one server,
which other backup rules can reference.

Figure: Synchronized recurring backup – Lead/Shadow method

The system synchronizes all the shadow rules with the lead backup rule, and all the
shadow schedules with the lead schedule. For more information, see section 29.10
“Synchronizing Server Backups on a Network” on page 727.

IT 04-13008-01-en, October 2012

726
 29 Scheduled Backups
29.10 Synchronizing Server Backups on a Network

29.10 Synchronizing Server Backups on a

Network
You synchronize all the Building Operation server backups on your network by
setting up all the server backup rules in a lead and shadow relationship. In this way,
you increase efficiency by centralizing the automated backup management on a
single server, rather than across multiple servers.
For more information, see section 29.1 “Scheduled Backups” on page 715.

To synchronize server backups on a network

1. In WorkStation, in the System Tree pane, select the Enterprise Server.
2. On the Tools menu, select Control Panel
Panel.
3. In the Backup and archiving area, click Backup Rules
Rules.

Continued on next page

04-13008-01-en, October 2012 IT

727
29 Scheduled Backups
29.10 Synchronizing Server Backups on a Network

4. In the Lead rule colum, enter a backup rule that you want to use as the lead
for one or more servers in the list.

Note
When you select a lead rule, the backup rule on a server becomes a
shadow of the lead rule.

5. Click Save
Save.

IT 04-13008-01-en, October 2012

728
30 Restore

Topics
Building Operation Restore
Restore Status
Restoring a Server Manually
Restoring an Automation Server from the Enterprise Server
Automation Server Replacement Using Restore
 30 Restore
30.1 Building Operation Restore

30.1 Building Operation Restore

Restore is the process of restoring data to an original or former state. Using
Restore, you can revert back to a previous snapshot of the server data despite any
configuration changes made since the last backup. In Building Operation, Restore
is designed to be a manual rather than an automatic process to avoid the
accidental overwriting of current server data. For convenience, Building Operation
displays only the backup files that apply to the selected server.

Figure: Backup Sets in Local and AS Archives folders on an Enterprise Server

Depending on what is contained in the backup file, you can restore different types
of data.
• Configuration only
only: Building Operation restores the configuration database
and custom object type data. Any existing historical data is lost when you
select this option.
• All data
data: Building Operation restores the configuration, historical, and custom
object types data.

Table: Types of Data and Contents

Types of Data Contents

Historical Includes Trend logs and Event logs stored on the server.

Configuration Includes points, values, alarm objects, trend objects, programs,

graphics, and custom object type data stored on a 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 server name is part of the restore data. Therefore, if you rename a server after a
backup, a restore process will revert back to the previous server name.

04-13008-01-en, October 2012 IT

731
30 Restore
30.1 Building Operation Restore

Impact on Configuration Values and Variables

When you back up a server specifying either Configuration only or All data, Building
Operation includes all the configuration values that are specified for the server’s
objects. If you restore the 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 an Automation Server

When you restore an Automation Server locally, the system retrieves the current
master backup set for that server. However, you cannot select a particular backup
set because the Automation Server stores only one backup set at a time.

Restore from an Enterprise Server

Unlike an Automation Server, an Enterprise Server can store multiple local and non-
local backup sets. When you restore an Enterprise Server, you can select a local
backup set from a list of files to restore the server. In multiple server sites, the
Enterprise Server manages all the Automation Servers in its group. In this
configuration, the non-local backup sets are stored in separate folders for each
Automation Server.
When you restore an Automation Server from an Enterprise Server, you can select a
particular backup set from a list of files that are stored for that Automation Server.
This restore method provides greater flexibility. For more information, see section
31.17 “Restore Options Dialog Box” on page 763.

30.1.1 Restore Status

Building Operation generates a system alarm when an Automation Server or
Enterprise Server restore fails. For example, an alarm displays in the server’s Alarms
pane if the Enterprise Server cannot fetch a backup set from an Automation Server.
For more information, see section 30.2 “Restore Status” on page 733.

30.1.2 Automation Server Replacement Using

Restore
Backup and Restore assures that Building Operation server data can be restored
after a hardware failure or data loss. As a precaution, you back up your Automation
Servers regularly so that you can use the most current backup to restore the server
data to a replacement server. You also configure the new server to match the name
and the network settings of the replaced server so the system can identify this
server when online.
For more information, see section 30.5 “Automation Server Replacement Using
Restore” on page 738.

IT 04-13008-01-en, October 2012

732
 30 Restore
30.2 Restore Status

30.2 Restore Status

Building Operation generates a system alarm when an Automation Server or
Enterprise Server restore fails. For example, an alarm displays in the server’s Alarms
pane if the Enterprise Server cannot fetch a backup set from an Automation Server.
There are several default system restore alarms. For more information, see
WebHelp.
Building Operation adds an event in the Event log whenever a restore takes place.
For example, you can check the Events pane to see if a server database restore is
successful. For more information, see WebHelp.
You can also check the current restore status and the last backup date of a server
from the Backup and Restore Manager. For more information, see section 31.3
“Backup and Restore Manager on the Enterprise Server” on page 746.

Figure: Restore status in Backup and Restore Manager view

In addition, you can create your own restore alarms. For more information, see
WebHelp.

04-13008-01-en, October 2012 IT

733
30 Restore
30.3 Restoring a Server Manually

30.3 Restoring a Server Manually

You restore a server to revert back to a previous snapshot of the server data. If you
log on directly to a server in WorkStation that you plan to restore, the server shuts
down temporarily during the restore process. When the server restarts, the backed
up data replaces the current data.
For more information, see section 27.4 “Manual Backups” on page 680.

Important
If your system includes a Reports Server and an Enterprise Server, stop the
Reporting Agent service on the Reports Server first to prevent report generation
during a restore of the Enterprise Server. For more information, see section 10.18
“Stopping a Windows Service” on page 271.

To restore a server manually

1. In WorkStation, in the System Tree pane, select the server that you want to
restore.
2. On the Actions menu, click Restore
Restore.
3. In the Available restore points list, select a backup set in black text that you
want to use to restore the server.

Black text indicates that the backup set is compatible with the current version
of the server.
4. 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.
Continued on next page

IT 04-13008-01-en, October 2012

734
 30 Restore
30.3 Restoring a Server Manually

5. Click Restore and then click Yes

Yes.
6. Click Close
Close.
If your system includes a Reports Server, the Reporting Agent Windows
service restarts automatically.

04-13008-01-en, October 2012 IT

735
30 Restore
30.4 Restoring an Automation Server from the Enterprise Server

30.4 Restoring an Automation Server from

the Enterprise Server
You log onto an Enterprise Server in WorkStation to restore an Automation Server
remotely. In addition, you can choose the type of data that you want to restore.
Using this method, WorkStation does not lose connection with the restored server.
For more information, see section 27.6 “Multi-server Backup” on page 686.

To restore an Automation Server from the Enterprise Server

1. In WorkStation, in the System Tree pane, select the Automation Server that
you want to restore.
2. On the Actions menu, click Restore
Restore.
3. In the Available restore points list, select the backup file that you want to use
to restore the server.

4. Select a backup set in black text, which indicates that the backup set is
compatible with the current version of the server.
5. 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 to back up the configuration, historical, and custom object
types data
6. Click Restore
Restore.
7. Click Yes
Yes.
Continued on next page

IT 04-13008-01-en, October 2012

736
 30 Restore
30.4 Restoring an Automation Server from the Enterprise Server

8. Click Close at any time.

Note
After a restore, WorkStation may display several Automation Server
events in the Events pane that occurred while the restore was taking
place. However, these events are not part of the restored log data.

04-13008-01-en, October 2012 IT

737
30 Restore
30.5 Automation Server Replacement Using Restore

30.5 Automation Server Replacement Using

Restore
Backup and Restore assures that Building Operation server data can be restored
after a hardware failure or data loss. As a precaution, you back up your Automation
Servers regularly so that you can use the most current backup to restore the server
data to a replacement server. You also configure the new server to match the name
and the network settings of the replaced server so the system can identify this
server when online.

Server Names
Typically, Building Operation servers and WorkStations can acquire different
identifiers and user-assigned names. For example, an Automation Server has a
network identifier, AS-000E00, which is used internally but difficult to remember.
For convenience, you can also assign a descriptive server name, such as Main
Lobby-AS, to locate this server in Building Operation. You may encounter these two
names during configuration.

Network Device Protocols

If your network uses DNS server names or static IP addresses, you need to apply a
valid DNS host name or IP address to a replacement server. Specifically, you use
the host name or static IP address to locate the new server on the network. To
reconfigure the default TCP/IP settings on the new server to match those of the
replaced server, you use the Automation Server Web Configuration utility.
If your network uses DHCP, a new server can automatically acquire TCP/IP
configuration information from a DHCP server. When acquired, you use the DNS
server name rather than the IP address to locate the new server on the network. By
default, DHCP is turned off on Automation Servers. To enable this and other
network settings on the new server, you use the Device Administrator. For more
information, see WebHelp.

Important
• Make sure that you have a valid Automation Server backup set before
performing a restore. A backup set can contain either configuration data only,
or both configuration and historical data.

Standalone Automation Server Site

In a single Automation Server site, you log onto the server in WorkStation to
manage Backup and Restore operations. In this scenario, you need to have a valid
backup set to restore the server in case the hardware fails or data is lost.
An Automation Server only stores one backup set at a time. Therefore, you should
create a backup set when the server is functioning properly and then store this
backup set in different location. You save and store a backup set on your
WorkStation PC or network drive. You then can import this backup set to the
Automation Server.

IT 04-13008-01-en, October 2012

738
 30 Restore
30.5 Automation Server Replacement Using Restore

Multi-server Site
In a multi-server site, you can log onto an Enterprise Server in WorkStation to
manage backup and restore operations for all the Automation Servers in the group.
Unlike an Automation Server, which only stores one backup set at a time, the
Enterprise Server can store multiple backup sets for each Automation Server. From
the AS Archives folder, you can select a stored backup set that was created when
the server was functioning properly.
To store a backup set in another location, you save a selected backup set to a
folder on your WorkStation PC or network drive. You then log onto the new
Automation Server to import this backup set to the local directory. If you do not log
off from the Enterprise Server, the system uses the most current backup set stored
on the Enterprise Server hard drive instead of the newly imported file on the
Automation Server. Therefore, be sure to log onto the Automation Server before
restoring the server in WorkStation. For more information, see section 28.4
“Copying an Automation Server Backup Set to WorkStation” on page 700.

About the Automation Server Replacement Process

Replacing an Automation Server is a five-step process: saving a backup set, adding
the new server to the network, configuring the new server, importing the backup
set, and restoring the server.

Table: Automation Server Replacement Overview

Step Procedure

Save the most current backup set of Copy an Automation Server backup set to
the server that you want to replace WorkStation.
to WorkStation.
For more information, see section 28.4 “Copying an
Automation Server Backup Set to WorkStation” on
page 700.

Add the new server to the network Choose one of the following methods:
and configure the IP address.
• DHCP configuration. For more information, see
WebHelp.
• Static IP configuration. For more information,
see WebHelp.

Log onto WorkStation and connect Select the new Automation Server.
to the new server.

Import the backup set to the new Import a backup set from WorkStation to an
server. Automation Server.
For more information, see section 28.8 “Importing a
Backup Set from WorkStation to an Automation
Server” on page 706.

Restore the new server using the Restore a server.

imported backup set.
For more information, see section 30.3 “Restoring a
Server Manually” on page 734.

The Restore process automatically renames the Building Operation server and
specifies the objects and properties that the server uses to reestablish links and go
online.

04-13008-01-en, October 2012 IT

739
30 Restore
30.5 Automation Server Replacement Using Restore

Tip
If an Automation Server does not go online, you can manually recreate the server
or restore the connections between the Enterprise Server and the Automation
Server. For more information, see WebHelp.

IT 04-13008-01-en, October 2012

740
31 Backup and Restore User
Interface

Topics
Backup and Restore Manager Properties (Enterprise
Server) – Basic Tab
Backup and Restore Manager Properties (Automation
Server) – Basic Tab
Backup and Restore Manager on the Enterprise Server
Backup and Restore Manager on an Automation Server
Backup Options Dialog Box
Backup Rule Properties – Basic Tab
Backup Rules View
Backup Rules Toolbar
Backup Rules List
Backup Schedule Properties – Basic Tab
Backup Set Properties – Basic Tab
Backup Sets View
Backup Status Dialog Box
Control Panel – Backup and Archiving
Backup Rule Dialog Box
Enterprise Engineering System Tree Icons
Restore Options Dialog Box
Restore Status Dialog Box
Backup and Restore Folder Properties
 31 Backup and Restore User Interface
31.1 Backup and Restore Manager Properties (Enterprise Server) – Basic Tab

31.1 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 (Enterprise Server) – Basic tab

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.

04-13008-01-en, October 2012 IT

743
31 Backup and Restore User Interface
31.1 Backup and Restore Manager Properties (Enterprise Server) – Basic Tab

Continued
Component Description

Purge AS backup sets Select Yes to enable automatic purging of

remote Automation Server backup files at
the next backup.

Purge local backup sets Select Yes to enable automatic purging of

local Enterprise Server backup files at the
next backup.

Number of remote AS backup sets to Enter the maximum number of backup sets
store that the system can store for each
Automation Server.

Number of local backup sets to store Enter the maximum number of backup sets
that the system can store for the Enterprise
Server.

IT 04-13008-01-en, October 2012

744
 31 Backup and Restore User Interface
31.2 Backup and Restore Manager Properties (Automation Server) – Basic Tab

31.2 Backup and Restore Manager Properties

(Automation Server) – Basic Tab
Use the Basic tab to view the current backup and restore status of an Automation
Server.

Figure: Backup and Restore Manager Properties (Automation Server) – Basic tab

Table: Backup and Restore Manager Properties (Automation Server) – Basic Tab
Component Description

Backup and restore status Displays the current status, such as backing
up.

Last backup Displays the date and time of the last

successful backup.

Backup folder Displays the storage location of the backup

set.

04-13008-01-en, October 2012 IT

745
31 Backup and Restore User Interface
31.3 Backup and Restore Manager on the Enterprise Server

31.3 Backup and Restore Manager on the

Enterprise Server
Use the Backup and Restore Manager to supervise the backup settings in the
Building Operation system. You can also open this view in any 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
Building Operation server backups.

Enable Automation Select to enable the Enterprise Server to purge the oldest backup
Server purge of an Automation Server automatically when a new backup for
that server is stored.

Number of Automation Enter the maximum number of backups that the Enterprise
Server backup sets to Server can store for each Automation Server.
store

Enable Enterprise Select to enable the Enterprise Server to purge the oldest backup
Server purge automatically when a new backup is stored.

Number of local Enter the maximum number of backups that the system can
backup sets to store store for the Enterprise Server.

IT 04-13008-01-en, October 2012

746
 31 Backup and Restore User Interface
31.4 Backup and Restore Manager on an Automation Server

31.4 Backup and Restore Manager on an

Automation Server
Use the Backup and Restore Manager to view the backup status of an
Automation Server.

Figure: Backup and Restore Manager on an Automation Server

Table: Backup and Restore Manager on an Automation Server

Component Description

Status Displays the current status, such as backing

up.

Last backup Displays the date and time of the last

successful backup.

04-13008-01-en, October 2012 IT

747
31 Backup and Restore User Interface
31.5 Backup Options Dialog Box

31.5 Backup Options Dialog Box

Use the Backup Options dialog box to select the 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

Component Description

Backup set name Type the text that you want to add to the beginning of the file name to
prefix help identify the backup set.

Backup set name Type the text that you want to add to the end of the file name to help
suffix identify the backup set.

Click to include all the listed servers in the backup operation. You can
also manually include or exclude a server using the Include check box.

Click to exclude all the servers selected for the backup operation.

Click to add the same backup set description entered for one server to
all the other backup sets, such as Final Configuration.

Click to add the same content type chosen for one 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 server to all the other backup sets, such as Final Configuration
and Configuration only.

Server name Displays the name of the server.

Include Select the servers that you want to include in the backup.

Backup set name Displays the name of the backup set that you entered.

IT 04-13008-01-en, October 2012

748
 31 Backup and Restore User Interface
31.5 Backup Options Dialog Box

Continued
Component Description

Backup content Select the type of data that you want to back up for the 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 Type a backup comment up to 255 characters that helps identify the
description type, content, or purpose of the scheduled backup.

04-13008-01-en, October 2012 IT

749
31 Backup and Restore User Interface
31.6 Backup Rule Properties – Basic Tab

31.6 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 Click to open the Backup Rule dialog box where you
enter a backup rule that can act as a lead backup rule.

IT 04-13008-01-en, October 2012

750
 31 Backup and Restore User Interface
31.7 Backup Rules View

31.7 Backup Rules View

Use the Backup rules view to add, edit, or remove backup rules. You can also
modify the backup schedule associated with the backup rule. In addition, you can
select a backup rule that can act as a lead rule.

Figure: Backup Rules view

Table: Backup Rules View

Number Description

Use the Backup Rules toolbar to create, edit, or remove backup

sets. For more information, see section 31.8 “Backup Rules
Toolbar” on page 752.

Use the Backup Rules list to modify backup schedules or set up

lead rules. For more information, see section 31.9 “Backup Rules
List” on page 753.

04-13008-01-en, October 2012 IT

751
31 Backup and Restore User Interface
31.8 Backup Rules Toolbar

31.8 Backup Rules Toolbar

Use the Backup rules toolbar to add, edit, or remove backup rules.
Button Description

Add backup rule

Click to open the Create Object wizard
where you create a backup rule. For more
information, see section 29.3 “Creating a
Backup Rule” on page 718.

Edit backup rule

Click to open the Backup rule dialog box
where you modify a backup rule. For more
information, see section 29.4 “Editing a
Backup Rule” on page 720.

Remove backup rule

Click to delete a backup rule. For more
information, see section 29.5 “Deleting a
Backup Rule” on page 722.

IT 04-13008-01-en, October 2012

752
 31 Backup and Restore User Interface
31.9 Backup Rules List

31.9 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

Component Description

Name Displays the name of the backup rule.

Path Displays the location of the backup rule on

the server.

Lead rule Click to open the Edit Backup Rule dialog

box where you enter a backup rule that can
act as a lead backup rule. For more
information, see section 31.15 “Backup Rule
Dialog Box” on page 761.

Schedule Click to open the Schedule Editor where

you modify the backup schedule contained
in the backup rule. For more information, see
WebHelp.

04-13008-01-en, October 2012 IT

753
31 Backup and Restore User Interface
31.10 Backup Schedule Properties – Basic Tab

31.10 Backup Schedule Properties – Basic Tab

Use the Basic tab to change the type of data that you want to back up. You can
modify but not delete this backup schedule.

Figure: Basic tab

Table: Basic Tab

Component Description

Name Type the name of the object to create.

Description Type a description that explains what the

object is used for.

Type Displays the schedule type.

Foreign Address

IT 04-13008-01-en, October 2012

754
 31 Backup and Restore User Interface
31.10 Backup Schedule Properties – Basic Tab

Continued
Component Description

Modified Displays the date and time when the object

was last modified.

Note 1 You can add text in the Note 1 and Note 2

boxes. The text in these boxes are text
strings and do not affect the object. The
text in these boxes can be used in a graphic
or when searching.

Note 2 You can add text in the Note 1 and Note 2

boxes. The text in these boxes are text
strings and do not affect the object. The
text in these boxes can be used in a graphic
or when searching.

Validation Validation helps you to keep track of the

object you have validated. You can set the
validation to None
None, Failed
Failed, and
Successful
Successful. The settings in this box are text
strings and do not affect the object. The
settings can be used when searching.

References Displays the objects that refer to this object.

Value The value associated with an event.

Previous transition time Displays the date and time the value most
recently changed.

Time since previous transition Displays the amount of time in minutes that
has elapsed since the value last changed,
rounded to the next minute.

Next transition value Displays what the Value property will be

when it next changes.

Time to next transition Displays the amount of time in minutes

before the value changes.

Following transition value Displays the subsequent value following the

next transition value.

Following transition time Displays the subsequent date and time

following the next transition time.

Time to following transition Displays the amount of time in minutes

before the value changes to the following
transition value.

Remove past events Select True to enable the system to

automatically purge obsolete schedule
events.

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.

04-13008-01-en, October 2012 IT

755
31 Backup and Restore User Interface
31.10 Backup Schedule Properties – Basic Tab

Continued
Component Description

Lead object Select a lead schedule to reference.

IT 04-13008-01-en, October 2012

756
 31 Backup and Restore User Interface
31.11 Backup Set Properties – Basic Tab

31.11 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 Automation Server or the
Enterprise 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 Building Operation server that can be
restored using this backup set.

04-13008-01-en, October 2012 IT

757
31 Backup and Restore User Interface
31.12 Backup Sets View

31.12 Backup Sets View

Use the Backup sets view to browse a list of backup sets on a Building Operation
server.

Figure: Backup sets view

Table: Backup Sets View

Number Description

Use the List View toolbar to navigate in a list, to group and sort
objects in a list, and to view the properties of a selected object in
a list. For more information, see WebHelp.

Use the AS Archives folder to view the backup sets that belong
to an Automation Server.

Use the Local folder to view the backup sets that belong to an
Enterprise Server.

IT 04-13008-01-en, October 2012

758
 31 Backup and Restore User Interface
31.13 Backup Status Dialog Box

31.13 Backup Status Dialog Box

The Backup Status dialog box displays the progress and status of a manual
backup. Once the backup starts, the process cannot be stopped but you can close
this informational dialog box at any time.

Figure: Backup Status dialog box

Table: Backup Status Dialog Box

Component Description

Name Displays the name of the object.

Status Displays the current backup status.

Progress Displays the progress of the backup.

Note
The Backup Status dialog box does not appear during a scheduled backup.
However, you can open the Backup and Restore Manager from the Control Panel
on the Tools menu to view the current status of a scheduled backup.

04-13008-01-en, October 2012 IT

759
31 Backup and Restore User Interface
31.14 Control Panel – Backup and Archiving

31.14 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 a server.

Figure: Control Panel – Backup and archiving

Table: Control Panel – Backup and Archiving

Component Description

Backup Rules Click to open the Backup Rules view where you manage
backup rules. You can also modify the backup schedule
associated with the backup rule. For more information, see
section 31.7 “Backup Rules View” on page 751.

Backup Sets Click to open the Backup Sets view where you manage
backup sets. For more information, see section 31.12
“Backup Sets View” on page 758.

Backup and Restore Click to open the Backup and Restore Manager where you
Manager view current backup and restore statuses and configure Purge
settings for an Enterprise Server. For more information, see
section 31.3 “Backup and Restore Manager on the Enterprise
Server” on page 746.

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

IT 04-13008-01-en, October 2012

760
 31 Backup and Restore User Interface
31.15 Backup Rule Dialog Box

31.15 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 Click to open the Backup Rule dialog box where you enter a
backup rule that can act as a lead backup rule.

Enabled Select Yes to enable the backup rule.

04-13008-01-en, October 2012 IT

761
31 Backup and Restore User Interface
31.16 Enterprise Engineering System Tree Icons

31.16 Enterprise Engineering System Tree

Icons
The following table describes the Enterprise Engineering icons in the System Tree.

Table: Enterprise Engineering System Tree Icons

Icon Description

Backup
Indicates a backup rule or backup schedule. For more information, see
section 29.1 “Scheduled Backups” on page 715.

Document
Indicates a document. For more information, see WebHelp.

IT 04-13008-01-en, October 2012

762
 31 Backup and Restore User Interface
31.17 Restore Options Dialog Box

31.17 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 server.

Figure: Restore Options dialog box

Table: Restore Options Dialog Box

Component Description

Available restore Displays a list of date-stamped backup sets for the selected server.
points
Select the type of data that you want to restore for the selected
server:
• Configuration only
only: Restores only configuration and custom
object type data.
• All data
data: Restores the configuration, historical, and custom
object types data.
The Backup sets are color coded:
• Black text indicates that the backup set is compatible with the
current version of the server. The system highlights the selection
in blue.
• Red text indicates that the backup set is incompatible with the
current version of the server. The system highlights the selection
in red.

Import Backup Click to import the backup set to a Building Operation server. In a
Set multi-server configuration, you can import both Automation Server
and Enterprise Server backup sets to the Enterprise Server.

04-13008-01-en, October 2012 IT

763
31 Backup and Restore User Interface
31.18 Restore Status Dialog Box

31.18 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-13008-01-en, October 2012

764
 31 Backup and Restore User Interface
31.19 Backup and Restore Folder Properties

31.19 Backup and Restore Folder Properties

Use the Backup and Restore Folder Properties view or dialog box to configure
and view the general and object-reference properties. For more information, see
WebHelp.

Figure: Backup and Restore Folder Properties

04-13008-01-en, October 2012 IT

765
Schneider Electric | Buildings Division
www.schneider-electric.com/buildings

© 2012 Schneider Electric. All rights reserved.

04-13008-01-en
October 2012