System Reference Guide (Oct 2013)

StruxureWare
System
Reference Guide
04-14005-04-en
October 2013
StruxureWare
System
Reference Guide
04-14005-04-en
October 2013
Copyright © 2013 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 ......................................................... 37
1.1 Purpose of This Guide ................................................................. 39
1.2 How This Guide is Organized ...................................................... 40
1.3 Typographical Conventions ......................................................... 41
2 Additional Information .................................................. 43

2.1 Where to Find Additional Information ........................................... 45
2.2 Regulatory Notices ...................................................................... 46
Reference
3 Building Operation ....................................................... 49
3.1 Building Operation Overview ....................................................... 51
3.1.1 Work Interface Overview ........................................................... 51
3.1.2 Server Overview ....................................................................... 51
3.1.3 Function Overview ................................................................... 51
3.1.4 Engineering Tools Overview ..................................................... 51
3.1.5 Protocol Overview .................................................................... 51
3.1.6 Hardware Overview .................................................................. 51
3.1.7 Licensing, Installation, and Localization Overview ..................... 52
3.1.8 System Upgrade Overview ....................................................... 52
3.2 Work Interface Overview ............................................................. 53
3.2.1 WebStation Overview ............................................................... 53
3.2.2 WorkStation Overview ............................................................... 53
3.2.3 Technician Tool Overview ......................................................... 53
3.2.4 WebHelp Overview .................................................................. 53
3.3 Function Overview ...................................................................... 54
3.3.1 Alarm Overview ........................................................................ 54
3.3.2 Schedules Overview ................................................................. 54
3.3.3 Trend Overview ........................................................................ 54
3.3.4 User Account Management Overview ...................................... 54
3.3.5 Backup and Restore Overview ................................................. 54
3.3.6 Document Overview ................................................................. 55
3.3.7 Search Overview ...................................................................... 55
04-14005-04-en, October 2013 System

5
3.3.8 Shortcuts Overview .................................................................. 55
3.4 Engineering Tools Overview ....................................................... 56
3.4.1 Spreadsheet Overview .............................................................. 56
3.4.2 Bindings Overview ................................................................... 56
3.4.3 Text Reports Overview .............................................................. 56
3.4.4 Import and Export Overview ..................................................... 56
3.4.5 Script Overview ........................................................................ 56
3.4.6 Function Block Editor Overview ................................................ 57
3.4.7 Graphics Editor Overview ......................................................... 57
3.4.8 WebReports Overview ............................................................. 57
3.5 Protocols Overview ..................................................................... 58
3.5.1 BACnet Overview ..................................................................... 58
3.5.2 b3 BACnet Device Overview .................................................... 58
3.5.3 LonWorks Overview ................................................................. 58
3.5.4 MNL LonWorks Device Overview ............................................. 58
3.5.5 Xenta LonWorks Device Overview ............................................ 58
3.5.6 Modbus Overview .................................................................... 59
3.5.7 I/NET Overview ......................................................................... 59
3.5.8 MicroNet Overview .................................................................... 59
3.5.9 NETWORK 8000 Overview ....................................................... 59
3.5.10 I/O Modules Overview .............................................................. 59
3.5.11 Web Service Overview .............................................................. 59
3.6 Licensing, Installation, and Localization Overview ........................ 60
3.6.1 Licensing Overview .................................................................. 60
3.6.2 Installation Overview ................................................................. 60
3.6.3 Regional and Language Overview ............................................ 60
4 Installation ................................................................... 61
4.1 Installation Overview ................................................................... 63
4.1.1 Installation Packages ................................................................ 63
4.1.2 Products ................................................................................... 63
4.1.3 Installation Folder ...................................................................... 63
4.1.4 Installation Example .................................................................. 64
4.1.5 Installation Reparation ............................................................... 64
4.1.6 Reinstall .................................................................................... 64
4.1.7 System Upgrade Overview ........................................................ 64
4.1.8 Uninstallation ............................................................................ 64
4.1.9 Version Numbers and Parallel Installations ................................. 64
4.1.10 Software Administrator .............................................................. 65
4.2 Products ..................................................................................... 66
4.2.1 WorkStation .............................................................................. 66
4.2.2 Graphics Editor ......................................................................... 66
4.2.3 Script Editor .............................................................................. 66
4.2.4 Menta Editor ............................................................................. 67
4.2.5 Function Block Editor ................................................................ 67
4.2.6 WorkPlace Tech ........................................................................ 67
4.2.7 Enterprise Server ...................................................................... 68
System 04-14005-04-en, October 2013

6
4.2.8 Software Administrator .............................................................. 68
4.2.9 Device Administrator ................................................................. 68
4.2.10 License Administrator ............................................................... 68
4.2.11 License Server .......................................................................... 68
4.2.12 WebReports ............................................................................. 69
4.2.13 Language Package ................................................................... 69
4.3 Installation Example .................................................................... 70
4.4 Version Numbers and Parallel Installations ................................... 72
4.5 Installing the License Administrator and the License Server ......... 74
4.6 Installing WorkStation and Client Tools ........................................ 78
4.7 Installing a Language Pack .......................................................... 83
4.8 Installing the Enterprise Server .................................................... 86
4.9 Installing the Device Administrator ............................................... 92
5 Installation Repair ......................................................... 97

5.1 Installation Reparation ................................................................. 99
5.2 Repairing the License Administrator and the License Server ...... 100
5.3 Repairing WorkStation and Client Tools Installation ................... 106
5.4 Repairing the Enterprise Server ................................................. 111
5.5 Repairing the Device Administrator Installation ........................... 118
6 Reinstallation ............................................................. 123

6.1 Reinstallation ............................................................................ 125
6.2 Reinstalling the License Administrator and the License Server ... 126
6.3 Reinstalling WorkStation and Client Tools .................................. 134
6.4 Reinstalling the Enterprise Server .............................................. 140
6.5 Reinstalling the Device Administrator Installation ........................ 148
7 Computer Maintenance ............................................. 153

7.1 Replace Enterprise Server or WebReports Computer Workflow . 155
7.1.1 Preparation ............................................................................. 155
7.1.2 Install Building Operation Software .......................................... 156
7.1.3 Restore the Enterprise Server Database .................................. 156
7.1.4 WebReports Migration Preparation ......................................... 158
7.1.5 Install WebReports .................................................................. 159
8 Uninstallation ............................................................. 163

8.1 Uninstallation ............................................................................ 165
8.2 Uninstalling the License Administrator ....................................... 166
8.3 Uninstalling the License Server .................................................. 169
8.4 Uninstalling a Language Package .............................................. 174
8.5 Uninstalling WorkStation ........................................................... 176
8.6 Uninstalling Enterprise Server .................................................... 178
8.7 Uninstalling the Device Administrator ......................................... 183
9 Installation User interface ........................................... 187

9.1 Installation Wizard – Choose Components Page ....................... 189
9.2 Installation Wizard – Installation Type Page ................................ 191
9.3 Installation Wizard – License Server Configuration Page ............ 192

7
9.4 Server Installation Wizard – Configuration Page ......................... 193
10 Licensing Introduction ............................................... 195

10.1 Licensing Overview ................................................................... 197
10.1.1 License System ...................................................................... 197
10.1.2 License Management .............................................................. 197
10.1.3 Service and Maintenance ........................................................ 197
10.2 License System ........................................................................ 198
10.2.1 License Activation Server ........................................................ 198
10.2.2 License Server ........................................................................ 198
10.2.3 License Administrator ............................................................. 198
10.2.4 Licenses ................................................................................. 199
10.3 License Management ................................................................ 200
10.3.1 License System Installation and Configuration ......................... 200
10.3.2 Network License Management ................................................ 201
10.3.3 Local License Management .................................................... 201
10.4 Service and Maintenance ......................................................... 202
10.4.1 License Service Maintenance .................................................. 202
10.4.2 License Maintenance .............................................................. 202
10.4.3 Diagnostics ............................................................................. 202
10.5 License Maintenance ................................................................ 204
10.5.1 Local License Removal ........................................................... 204
10.5.2 Network License Return .......................................................... 204
10.5.3 Lost License ........................................................................... 204
10.5.4 License Repair ........................................................................ 204
10.5.5 License Backup ...................................................................... 204
10.6 Licenses ................................................................................... 205
10.6.1 End User License Agreement .................................................. 205
10.6.2 Local Licenses ........................................................................ 205
10.6.3 Network Licenses .................................................................. 206
10.6.4 Time-Limited Licenses ............................................................ 206
10.6.5 Permanent License ................................................................. 206
10.6.6 License Selection Process ...................................................... 206
10.7 Viewing Activated Licenses ...................................................... 207
10.8 Editing Registration Details ........................................................ 208
10.9 License Selection Process ........................................................ 210
10.10 Order Information Request ........................................................ 211
10.11 Lost License ............................................................................. 213
10.12 License Repair .......................................................................... 214
10.13 License Backup ........................................................................ 215
10.14 Backing Up Licenses ................................................................ 216
10.15 Restoring Licenses .................................................................... 217
11 Type of Licenses ........................................................ 219

11.1 Network Licenses .................................................................... 221
11.2 Network License Management .................................................. 225
11.2.1 Order Information Request ...................................................... 225

8
11.2.2 Network Licenses Activation ................................................... 225
11.2.3 Enterprise Server Address Configuration ................................. 225
11.2.4 WorkStation and Client Tools Address Configuration ............... 226
11.2.5 Network License Upgrade ....................................................... 226
11.3 Network Licenses Activation ..................................................... 227
11.4 Network License Return ............................................................ 229
11.5 Activating Network Licenses .................................................... 231
11.6 Removing a Local License or Returning a Network License ....... 234
11.7 Network License Upgrade ......................................................... 236
11.8 Upgrading Network Licenses .................................................... 238
11.9 Repairing a Network License .................................................... 242
11.10 Local Licenses .......................................................................... 244
11.11 Local License Management ...................................................... 245
11.11.1 Local License Activation .......................................................... 245
11.12 Activating a Local License ........................................................ 246
12 Licensing Configuration and Diagnostics .................... 249

12.1 Enterprise Server Address Configuration ................................... 251
12.2 WorkStation and Client Tools Address Configuration ................. 253
12.3 Viewing Diagnostic Information .................................................. 254
12.4 Copying Diagnostics to the Clipboard ....................................... 255
13 License Server and License Administrator .................. 257

13.1 License Server .......................................................................... 259
13.1.1 Flexnet License Manager, License Server Manager ................. 259
13.2 Starting the License Server ........................................................ 260
13.3 Stopping the License Server ..................................................... 261
13.4 Restarting the License Server .................................................... 262
13.5 Flexnet License Administrator, License Server Manager ............ 263
13.5.1 License Server Port Number ................................................... 264
13.5.2 FLEXnet License Administrator Port Number ........................... 265
13.6 Accessing Flexnet lmadmin ....................................................... 266
13.7 Changing the Flexnet lmadmin License Server Manager Port
Number .................................................................................... 267
13.8 License Server Address ............................................................ 268
13.9 Configuring the Address to the License Server .......................... 270
13.10 License Server Reset ................................................................ 272
13.11 Resetting the License Server ..................................................... 273
13.12 Configuring License Server Recovery Settings ........................ 275
13.13 License Server Maintenance ..................................................... 277
13.13.1 License Server Address Change ............................................. 277
13.13.2 License Server Reinstallation .................................................. 277
13.13.3 License Server Replacement ................................................... 277
13.13.4 License Server Reset .............................................................. 279
13.14 License Administrator ............................................................... 280
13.14.1 Registration Details ................................................................. 280
13.14.2 License Server Address .......................................................... 280
13.15 Starting License Administrator ................................................... 281

9
14 Licensing User Interface ............................................. 283
14.1 Registration Details View ........................................................... 285
14.2 Licenses View .......................................................................... 287
14.3 Licenses View Toolbar .............................................................. 288
14.4 Licenses View Icons .................................................................. 289
14.5 Licenses View Columns ............................................................ 290
14.6 Add License Dialog Box ............................................................ 291
14.7 License Activation Dialog Box ................................................... 292
14.8 License Progress Dialog Box ..................................................... 294
14.9 License Server Address View .................................................... 295
14.10 Diagnostics View ....................................................................... 296
15 Software Administrator .............................................. 297

15.1 Software Administrator ............................................................. 299
15.1.1 Service ................................................................................... 299
15.1.2 Ports ...................................................................................... 299
15.1.3 Database Location .................................................................. 299
15.1.4 Enterprise Server System Log ................................................. 299
15.2 Starting Software Administrator ................................................. 300
15.3 Configuring Server Port Settings ............................................... 301
15.4 Starting the Server Windows Service ......................................... 302
15.5 Stopping the Server Windows Service ....................................... 303
15.6 Restarting the Server Windows Service ..................................... 304
15.7 Enterprise Server System Log ................................................... 305
15.8 Viewing Enterprise Server System Log ...................................... 306
15.9 Software Administrator – Enterprise Server View ....................... 307
16 Localization Language and Units ................................ 309

16.1 Regional and Language Overview ............................................. 311
16.1.1 Language and Translation Packages ....................................... 311
16.1.2 Value Presentation .................................................................. 311
16.1.3 Time and Time Zone ............................................................... 311
16.2 Configuring Regional Settings ................................................... 312
16.3 Language Packages ................................................................. 313
16.3.1 Languages in WorkStation ...................................................... 313
16.3.2 Languages in WebStation ....................................................... 313
16.4 Changing WorkStation Language .............................................. 314
16.5 Adding a Language in WebStation ............................................ 315
16.6 Changing the Language in WebStation ..................................... 316
16.7 Value Presentation .................................................................... 317
16.7.1 Units ....................................................................................... 317
16.7.2 Metric Prefixes ........................................................................ 317
16.7.3 Precision Format ..................................................................... 317
16.8 Units ......................................................................................... 318
16.8.1 Delta Temperature Conversion ............................................... 318
16.9 Adding or Changing a Unit and Prefix for a Value ....................... 319
16.10 Metric Prefixes .......................................................................... 322

10
16.11 Precision Format ....................................................................... 323
16.12 Adding a Unit Conversion Exception ......................................... 324
16.13 Removing a Unit Conversion Exception ..................................... 326
17 Localization Time and Time Zone ............................... 327

17.1 Time and Time Zone ................................................................. 329
17.1.1 Network Time ......................................................................... 329
17.1.2 Time and Time Zone Configuration in WorkStation .................. 329
17.1.3 Time and Time Zone Configuration in Enterprise Server ........... 329
17.1.4 Time and Time Zone Configuration in Automation Server ......... 329
17.2 Lead and Shadow Relationship ................................................. 330
17.2.1 Synchronize Network Time Settings ........................................ 331
17.2.2 Synchronize Time Zone Settings ............................................. 331
17.2.3 Synchronize Schedules and Calendars ................................... 331
17.2.4 Set Inheritance Between Graphic Elements ............................. 331
17.3 Time and Time Zone Configuration in WorkStation .................... 332
17.3.1 Server Time in WorkStation ..................................................... 332
17.4 Time and Time Zone Configuration in Enterprise Server ............. 333
17.5 Time and Time Zone Configuration in Automation Server ........... 334
17.6 Changing the Time Zone of an Enterprise Server or Automation
Server ....................................................................................... 335
17.7 Creating a Custom Time Zone of an Enterprise Server or Automation
Server ....................................................................................... 337
17.8 Configuring Enterprise Server and WorkStation Date and Time .. 339
17.9 Synchronizing the Automation Server Clock ............................. 340
17.10 Manually Changing the Automation Server Time and Date ......... 342
17.11 Network Time ........................................................................... 344
17.11.1 Network Time on WorkStation and Enterprise Server .............. 344
17.11.2 Network Time Server on Automation Server ............................ 344
17.12 Synchronize Network Time Settings .......................................... 345
17.13 Synchronizing Time Settings on Multiple Automation Servers .... 346
17.14 Synchronize Time Zone Settings ............................................... 349
17.15 Synchronizing Time Zone Settings on Multiple Automation
Servers ..................................................................................... 350
18 Localization User Interface ......................................... 351

18.1 Unit Selection Dialog Box .......................................................... 353
18.2 Date and Time Properties – Basic Tab ....................................... 354
18.3 Date and Time Properties – Time Tab ........................................ 355
18.4 Time Zone Properties – Basic Tab ............................................ 356
18.5 Time Zone Properties – Zone Info Tab ....................................... 357
18.6 Enterprise Server – Date & Time View ........................................ 359
18.7 Automation Server – Date & Time View ..................................... 361
18.8 Add or Remove Languages Dialog Box ..................................... 363
18.9 Unit Conversion Exceptions View .............................................. 364
19 User Account Management ....................................... 365

19.1 User Account Management Overview ....................................... 367

11
19.1.1 User Accounts and User Account Groups ............................... 368
19.1.2 Domains ................................................................................. 368
19.1.3 Software Permissions ............................................................. 368
19.1.4 Log on Methods ..................................................................... 368
19.1.5 Workspace Management ........................................................ 368
19.1.6 Automatic Logoff .................................................................... 369
19.1.7 Guest Log On in WebStation ................................................... 369
19.2 Opening the Account Management Control Panel ..................... 370
19.3 Creating a User Account ........................................................... 371
19.4 User Accounts and User Account Groups ................................. 375
19.4.1 Window Active Directory User Groups ..................................... 376
19.4.2 WorkStation Account Management ......................................... 377
19.5 Editing a User Account Profile ................................................... 378
19.6 Renaming a User Account ........................................................ 381
19.7 Disabling a User Account .......................................................... 383
19.8 Enabling a Disabled User Account ............................................. 386
19.9 Setting an Expiration Date for a User Account ........................... 389
19.10 Removing the Expiration Date for a User Account ...................... 392
19.11 Deleting a User Account ............................................................ 394
19.12 Automatic Logoff ...................................................................... 396
19.13 Setting the Automatic Logoff Time ............................................ 397
20 User Account Groups ................................................ 399

20.1 Windows Active Directory User Groups ..................................... 401
20.2 Creating a User Account Group ................................................ 403
20.3 Editing the Description of a User Account Group ....................... 409
20.4 Adding a User Account to a User Account Group ..................... 411
20.5 Removing a User Account from a User Account Group ............. 414
20.6 Reviewing the User Account Group Memberships for a User
Account .................................................................................... 417
20.7 Adding a User Account Group to a User Account Group ........... 419
20.8 Removing a User Account Group from another User Account
Group ....................................................................................... 422
20.9 Reviewing the User Account Group Memberships for a User
Account Group ......................................................................... 425
20.10 Preventing a Group of Users from Exiting WorkStation .............. 427
20.11 Enabling a Group of Users to Exit Workstation ........................... 429
20.12 Deleting a User Account Group ................................................. 431
21 Domains .................................................................... 433

21.1 Domains ................................................................................... 435
21.1.1 Windows Active Directory Domain ........................................... 436
21.1.2 Server Local Domain ............................................................... 437
21.1.3 Administration Accounts in Server Local Domain ..................... 437
21.2 Log On Methods ....................................................................... 438
21.2.1 Log On as a Windows User ..................................................... 438
21.2.2 Log On as a Building Operation User ....................................... 438
21.2.3 Password Administration ........................................................ 438

12
21.3 Guest Log On in WebStation ..................................................... 439
21.4 Creating and Configuring a Domain ........................................... 440
21.5 Editing the Windows Domain Name .......................................... 444
21.6 Editing the Description of a Domain ........................................... 446
21.7 Editing the Maximum Logon Attempts ....................................... 448
21.8 Assigning a Server to a Domain ................................................. 450
21.9 Removing a Server from a Domain ............................................ 452
21.10 Deleting a Domain ..................................................................... 454
21.11 Administration Accounts in Server Local Domain ....................... 456
21.11.1 Admin Account ....................................................................... 456
21.11.2 Reports Administrator Account ............................................... 456
22 Software Permissions ................................................ 457

22.1 Software Permissions ............................................................... 459
22.1.1 Path Permissions .................................................................... 459
22.1.2 Command Permissions ........................................................... 459
22.1.3 Software Permission Rules ...................................................... 459
22.1.4 Software Permissions and User Account Groups .................... 459
22.1.5 Software Permissions Summary .............................................. 460
22.2 Software Permissions and User Account Groups ...................... 461
22.3 Software Permission Rules ........................................................ 463
22.4 Path Permissions ...................................................................... 464
22.5 Command Permissions ............................................................ 467
22.6 Assigning Software Permissions to a User Account ................... 469
22.7 Editing the Software Permissions of a User Account .................. 472
22.8 Assigning Software Permissions to a User Account Group ........ 475
22.9 Editing the Software Permissions of a User Account Group ....... 480
23 Login Configuration .................................................... 485

23.1 Password Administration .......................................................... 487
23.2 Editing a User Account Password ............................................. 488
23.3 Allowing Users to Change their Password ................................. 490
23.4 Changing Your Password ......................................................... 492
23.5 Turning off Remember Me On This Computer ........................... 493
23.6 Forcing a User to Change the Password at Next Logon ............. 494
23.7 Preventing Users from Changing Their Passwords .................... 496
23.8 Resetting the Administrator Password ....................................... 498
24 Workspaces .............................................................. 499

24.1 Workspace Management .......................................................... 501
24.1.1 Predefined Workspaces .......................................................... 501
24.1.2 Workspace Components and Customization .......................... 502
24.1.3 WebStation in Kiosk Mode ...................................................... 502
24.2 Predefined Workspaces ............................................................ 503
24.3 Workspace Components and Customization ............................ 504
24.3.1 Workspace Customization ...................................................... 504
24.3.2 Workspace Content References .............................................. 505
24.3.3 Panel Components ................................................................. 505

13
24.4 Workspace Customization ........................................................ 506
24.5 Workspace Content References ................................................ 507
24.6 Panel Components ................................................................... 508
24.7 Creating a Workspace ............................................................... 509
24.8 Editing the Layout of a Workspace ............................................ 513
24.9 Editing the Description of a Workspace ..................................... 516
24.10 Adding a Component to a Workspace ....................................... 518
24.11 Removing a Component from a Workspace .............................. 522
24.12 Editing a Workspace Component .............................................. 524
24.13 Adding a Workspace to a User Account Group ......................... 527
24.14 Removing a Workspace from a User Account Group ................. 529
24.15 Reviewing the Workspace Memberships for a User Account
Group ....................................................................................... 531
24.16 Creating a Panel ....................................................................... 533
24.17 Editing a Panel .......................................................................... 537
24.18 WebStation in Kiosk Mode ........................................................ 538
24.18.1 Configure WebStation to Run in Kiosk Mode ........................... 538
24.19 Configuring WebStation to Run in Kiosk Mode .......................... 540
25 Audit Trails ................................................................. 543

25.1 WorkStation Account Management .......................................... 545
25.1.1 Audit Trailing of User Activity ................................................... 545
25.1.2 WorkStation Account Validation .............................................. 545
25.2 Audit Trailing of User Activity ..................................................... 546
25.3 Disabling Audit Trail for a Group of Users ................................... 547
25.4 Enabling Audit Trail for a Group of Users ................................... 549
25.5 Viewing an Audit Trail Log ......................................................... 551
25.6 WorkStation Account Validation ................................................ 553
26 User Management User Interface ............................... 555

26.1 User Management System Tree Icons ....................................... 559
26.2 Domain Properties .................................................................... 560
26.3 Profile Properties ....................................................................... 561
26.4 Workspace Properties ............................................................... 562
26.5 Pane Properties ........................................................................ 564
26.6 Panel Properties ........................................................................ 565
26.7 Building Operation WorkStation Window ................................... 566
26.8 Domain Control Panel ............................................................... 568
26.9 Account Management Control Panel ......................................... 569
26.10 Select Default Workspace Window ............................................ 572
26.11 Change Password Dialog Box ................................................... 573
26.12 Domain Wizard – Authentication Page ....................................... 574
26.13 Domain Wizard – Domain Members Page ................................. 575
26.14 Domain Wizard – Domain Policies Page .................................... 576
26.15 Domain – Summary Tab ........................................................... 577
26.16 Domain – Policies Tab ............................................................... 578
26.17 Domain – Domain Members Tab ............................................... 579
26.18 User Account – Summary Tab .................................................. 580

14
26.19 User Account – Group Membership Tab ................................... 581
26.20 User Account – Profile Tab ........................................................ 583
26.21 User Account – Software Permissions Tab ................................ 584
26.22 User Account – Audit Trailing Events Tab .................................. 585
26.23 User Account Group Properties ................................................ 586
26.24 User Account Properties ........................................................... 587
26.25 User Account Group Wizard – Users Belonging to this Group
Page ......................................................................................... 589
26.26 User Account Group Wizard – Workspaces Belonging to this Group
Page ......................................................................................... 591
26.27 User Account Group Wizard – Windows Group Name and Group
Policies Page ............................................................................ 593
26.28 User Account Group – Summary Tab ........................................ 595
26.29 User Account Group – Policies Tab ........................................... 596
26.30 User Account Group – Group Membership Tab ........................ 597
26.31 User Account Group – Software Permissions Tab ..................... 599
26.32 User Account Group – Workspaces Tab ................................... 601
26.33 User Account Wizard – General Page ........................................ 602
26.34 User Account Wizard – Member Of Page .................................. 603
26.35 User Account Management Folder Properties ........................... 605
26.36 Workspace Wizard – Workspace Configuration Page ................ 606
26.37 Workspace Wizard – Pane Configuration Page .......................... 608
26.38 Workspace – Summary Tab ...................................................... 609
26.39 Workspace – Content Tab ........................................................ 610
26.40 Workspace – Members Tab ...................................................... 612
26.41 Edit Layout Workspace ............................................................. 613
26.42 Panel Wizard – Panel Configuration Page .................................. 614
26.43 Domains Properties ................................................................... 615
26.44 Local Properties ........................................................................ 616
26.45 Work Area Window Properties .................................................. 617
26.46 Create Work Area Window Wizard – Name Page ...................... 618
27 Alarms Introduction .................................................... 619

27.1 Alarm Overview ......................................................................... 621
27.1.1 Alarm States ........................................................................... 621
27.1.2 Building Operation Alarm Types .............................................. 621
27.1.3 Alarm Functions ...................................................................... 621
27.1.4 Alarm Objects in Multiple Servers ............................................ 622
27.1.5 Alarms Pane and Alarm View Customization ........................... 622
27.1.6 Mass Create ........................................................................... 622
27.2 Alarm States ............................................................................. 623
27.3 Alarm Functions ........................................................................ 624
27.3.1 Time Delay .............................................................................. 624
27.3.2 Shunt Variable ......................................................................... 624
27.3.3 Deadband .............................................................................. 624
27.3.4 Alarm Messages ..................................................................... 624
27.3.5 Priority .................................................................................... 624
27.3.6 Categories .............................................................................. 625

15
27.3.7 Acknowledgement .................................................................. 625
27.3.8 User Actions ........................................................................... 625
27.3.9 Notifications ............................................................................ 625
27.3.10 Automatic Assignment ............................................................ 625
27.3.11 Unit of Measure in Alarms ....................................................... 626
27.3.12 Attachments ........................................................................... 626
27.4 Alarm Objects in Multiple Servers .............................................. 627
27.5 Alarms Pane and Alarm View Customization .............................. 628
27.6 Styling the Alarm States in the Alarms Pane and Alarm Views .... 629
27.7 Alarm Filter Conditions .............................................................. 632
27.8 Creating a Filtered Alarm View ................................................... 637
27.9 Filter Condition Wildcards ......................................................... 639
27.10 Displaying Alarm View on an Alarm ............................................ 641
27.11 Alarm Handling Issues ............................................................... 642
28 Alarm Types ............................................................... 643

28.1 Alarm Types .............................................................................. 645
28.1.1 Change of State Alarm ............................................................ 645
28.1.2 Out of Range Alarm ................................................................. 645
28.1.3 Out of Reference Range Alarm ................................................ 645
28.1.4 Multistate Alarm ...................................................................... 645
28.1.5 Matching Text String Alarm ..................................................... 646
28.1.6 Variable Status Alarm .............................................................. 646
28.1.7 Sum Alarm .............................................................................. 646
28.1.8 Enumeration Alarm ................................................................. 646
28.1.9 System Information Alarms ..................................................... 646
28.2 Change of State Alarm .............................................................. 647
28.3 Creating a Change of State Alarm ............................................ 648
28.4 Multistate Alarm ........................................................................ 655
28.5 Creating a Multistate Alarm ....................................................... 656
28.6 Matching Text String Alarm ....................................................... 663
28.7 Creating a Matching Text String Alarm ...................................... 664
28.8 Variable Status Alarm ................................................................ 670
28.9 Creating a Variable Status Alarm ............................................... 671
28.10 Out of Range Alarm ................................................................... 677
28.11 Creating an Out of Range Alarm ................................................ 678
28.12 Out of Reference Range Alarm .................................................. 686
28.13 Creating an Out of Reference Range Alarm ............................... 687
28.14 Sum Alarm ................................................................................ 695
28.15 Creating a Sum Alarm ............................................................... 696
28.16 Enumeration Alarm ................................................................... 702
28.17 Creating an Enumeration Alarm ................................................. 703
28.18 System Information Alarms ....................................................... 709
28.19 System Information Alarms List ................................................. 712
28.19.1 A-D ......................................................................................... 712
28.19.2 E-L ......................................................................................... 713
28.19.3 M-NW8 R ............................................................................... 714

16
28.19.4 NW8 R .................................................................................... 715
28.19.5 NW8 Ro-NW8 Z ..................................................................... 716
28.19.6 P-S ......................................................................................... 716
28.19.7 T-W ........................................................................................ 717
28.20 Configuring the Description of an Alarm ..................................... 718
28.21 Configuring Attachments of an Alarm ........................................ 719
28.22 Removing Attachments from an Alarm ...................................... 720
29 Alarms Functions ....................................................... 721

29.1 Time Delay ................................................................................ 723
29.2 Configuring the Delay Time of an Alarm ..................................... 724
29.3 Shunt Variable ........................................................................... 725
29.4 Editing the Shunt Variable ......................................................... 726
29.5 Deadband ................................................................................ 727
29.6 Alarm Messages ....................................................................... 728
29.7 Configuring the Alarm Message of an Alarm .............................. 729
29.8 Priority ...................................................................................... 730
29.9 Configuring the Priority of an Alarm ............................................ 731
29.10 Categories ................................................................................ 732
29.11 Creating a Category .................................................................. 733
29.12 Configuring the Category of an Alarm ........................................ 735
29.13 Editing a Category ..................................................................... 736
29.14 Acknowledgement .................................................................... 738
29.14.1 No Acknowledge .................................................................... 738
29.14.2 Single Acknowledge ................................................................ 738
29.14.3 Extended Acknowledge .......................................................... 738
29.14.4 System Information Alarms ..................................................... 738
29.14.5 ............................................................................................... 738
29.15 Configuring the Acknowledgement Type of an Alarm ................. 739
29.16 No Acknowledgement ............................................................... 740
29.17 Single Acknowledgement .......................................................... 742
29.18 Extended Acknowledgement .................................................... 744
29.19 User Actions ............................................................................. 746
29.19.1 Comments ............................................................................. 746
29.19.2 Cause Notes ........................................................................... 746
29.19.3 Action Notes ........................................................................... 746
29.19.4 Checklists ............................................................................... 746
29.19.5 Summary of User Actions ........................................................ 747
29.20 Configuring Forced User Action ................................................. 748
29.21 Alarm Attachment ..................................................................... 749
29.22 Adding an Attachment to an Alarm ............................................ 750
29.23 Notifications .............................................................................. 752
29.23.1 E-mail Notification ................................................................... 752
29.23.2 Write to File Notification ........................................................... 752
29.23.3 Substitution Codes for Notification .......................................... 753
29.24 Creating an E-mail Notification .................................................. 754
29.25 Setting Up a Write to File Notification ......................................... 758

17
29.26 Selecting the Schneider Electric E-mail Server for E-mail
Notifications .............................................................................. 761
29.27 Substitution Codes for Notifications ........................................... 763
29.28 Automatic Assignment .............................................................. 767
29.29 Creating an Automatic Assignment ........................................... 768
29.30 Unit of Measure in Alarms .......................................................... 770
29.31 Configuring the Limits of an Alarm ............................................. 771
29.32 Configuring the Flashing of an Alarm ......................................... 772
29.33 Configuring the Audibility of an Alarm ........................................ 773
29.34 Configuring the Audibility of an Alarm in Reset State .................. 774
30 User Actions .............................................................. 777

30.1 Comments ................................................................................ 779
30.2 Cause Notes ............................................................................. 780
30.3 Creating a Cause Note .............................................................. 781
30.4 Editing a Cause Note ................................................................ 783
30.5 Adding a Cause Note to an Alarm ............................................. 785
30.6 Action Notes ............................................................................. 786
30.7 Creating an Action Note ............................................................ 787
30.8 Editing an Action Note ............................................................... 789
30.9 Adding an Action Note to an Alarm ............................................ 791
30.10 Checklists ................................................................................. 792
30.11 Creating a Checklist .................................................................. 793
30.12 Editing a Checklist ..................................................................... 795
30.13 Adding a Checklist to an Alarm .................................................. 797
31 Alarms User Interface ................................................. 799

31.1 Alarms Pane and Alarm View .................................................... 803
31.2 Alarms Pane and Alarm View Toolbar ........................................ 804
31.3 Alarms Pane and Alarm View Icons ........................................... 806
31.4 Alarm and Event Details View ................................................... 807
31.5 Add/Remove Columns Dialog Box (Alarms) ............................... 808
31.6 Alarm System Tree Icons .......................................................... 813
31.7 Change of State Alarm Properties – Basic Tab .......................... 815
31.8 Change of State Alarm Properties – Advanced Tab ................... 817
31.9 Multistate Alarm Properties – Basic Tab .................................... 819
31.10 Multistate Alarm Properties – Advanced Tab ............................. 821
31.11 Matching Text String Alarm Properties – Basic Tab ................... 823
31.12 Matching Text String Alarm Properties – Advanced Tab ............ 825
31.13 Out of Range Alarm Properties – Basic Tab ............................... 827
31.14 Out of Range Alarm Properties – Advanced Tab ........................ 829
31.15 Out of Reference Range Alarm Properties – Basic Tab .............. 831
31.16 Out of Reference Range Alarm Properties – Advanced Tab ....... 833
31.17 Sum Alarm Properties – Basic Tab ............................................ 835
31.18 Sum Alarm Properties – Advanced Tab ..................................... 837
31.19 Enumeration Alarm Properties – Basic Tab ................................ 839
31.20 Enumeration Alarm Properties – Advanced Tab ......................... 841
31.21 Variable Status Alarm Properties – Basic Tab ............................ 843

18
31.22 Variable Status Alarm Properties – Advanced Tab ..................... 845
31.23 Function Block Program Internal Alarm Properties - Basic Tab .. 847
31.24 Function Block Program Internal Alarm Properties - Advanced
Tab ........................................................................................... 849
31.25 Create Alarm Wizard – Presentation Page ................................. 851
31.26 Create Alarm Wizard – User Action Page ................................... 853
31.27 Create Alarm Wizard – Attachment Page ................................... 855
31.28 Create Change of State Alarm Wizard – Alarm Trigger Page ...... 856
31.29 Create Multistate Alarm Wizard – Alarm Trigger Page ................ 857
31.30 Create Matching Text String Alarm Wizard – Alarm Trigger
Page ......................................................................................... 859
31.31 Create Out of Range Alarm Wizard – Alarm Trigger Page .......... 861
31.32 Create Out of Reference Range Alarm Wizard – Alarm Trigger
Page ......................................................................................... 863
31.33 Create Sum Alarm Wizard – Alarm Trigger Page ........................ 865
31.34 Create Enumeration Alarm Wizard – Alarm Trigger Page ........... 867
31.35 Create Variable Status Alarm Wizard – Alarm Trigger Page ........ 868
31.36 Create Attachment Wizard – Configure Attachment Page .......... 870
31.37 Alarm Trigger Properties - Basic Tab ......................................... 871
31.38 Alarm Trigger Properties – Range Tab ....................................... 872
31.39 Alarm Trigger Properties – Value tab ......................................... 873
31.40 Alarm Trigger Properties – Value tab ......................................... 874
31.41 Attachment Properties .............................................................. 875
31.42 Alarm Control Panel Properties .................................................. 876
31.43 User Action Properties .............................................................. 877
31.44 Alarm Styles View ...................................................................... 878
31.45 Alarm Styles Properties ............................................................. 879
31.46 Acknowledged Style Properties ................................................. 880
31.47 Alarm Style Properties ............................................................... 881
31.48 Disabled Style Properties .......................................................... 882
31.49 Fault Style Properties ................................................................ 883
31.50 Reset Style Properties ............................................................... 884
31.51 Alarm Control Panel – Categories View ..................................... 885
31.52 Add Category Dialog Box .......................................................... 886
31.53 Edit Category Dialog Box .......................................................... 887
31.54 Category Properties .................................................................. 888
31.55 Categories Properties ............................................................... 889
31.56 Alarm Control Panel – Cause Notes View .................................. 890
31.57 Add Cause Note Dialog Box ...................................................... 891
31.58 Edit Cause Note Dialog Box ...................................................... 892
31.59 Cause Notes Properties ............................................................ 893
31.60 Cause Note Group Properties ................................................... 895
31.61 Cause Note Properties .............................................................. 896
31.62 Alarm Control Panel – Action Notes View .................................. 897
31.63 Add Action Note Dialog Box ...................................................... 898
31.64 Edit Action Note Dialog Box ...................................................... 899
31.65 Action Notes Properties ............................................................ 900

19
31.66 Action Note Group Properties ................................................... 902
31.67 Action Note Properties .............................................................. 903
31.68 Alarm Control Panel – Checklists View ...................................... 904
31.69 Add Checklist Dialog Box .......................................................... 905
31.70 Edit Checklist Dialog Box .......................................................... 907
31.71 Add Checklist Step Dialog Box .................................................. 909
31.72 Edit Checklist Step Dialog Box .................................................. 910
31.73 Checklists Properties ................................................................ 911
31.74 Checklist Properties .................................................................. 912
31.75 Checklist Step Properties .......................................................... 913
31.76 Alarm – Basic Settings View ...................................................... 914
31.77 Select Conditions Dialog Box – Alarm Filter Properties ............... 915
31.78 Create Email Notification Wizard – Email Notification Page ........ 916
31.79 Email Notification View .............................................................. 918
31.80 Email Notification Properties ...................................................... 920
31.81 Create Write to File Notification Wizard – Write to File Notification
Page ......................................................................................... 921
31.82 Write to File Notification View .................................................... 923
31.83 Write to File Notification Properties ............................................ 925
31.84 Create Assignment Wizard – Assignment Page ......................... 926
31.85 Assignment View ...................................................................... 928
31.86 Assignment Properties .............................................................. 930
31.87 Alarm Properties ....................................................................... 931
31.88 Object Specific Event View Toolbar ........................................... 932
31.89 Progress View ........................................................................... 933
31.90 Alarm Handling Properties ......................................................... 934
31.91 Alarm Properties ....................................................................... 935
32 Events ....................................................................... 937

32.1 How Events Work .................................................................... 939
32.1.1 Archive Overview .................................................................... 939
32.2 Events Pane and Event View Customization .............................. 940
32.3 Styling a Certain Event in the Events Pane or Event View ........... 941
32.4 Event Filter Conditions .............................................................. 944
32.5 Applying an Event Filter ............................................................. 950
32.6 Creating a Filtered Event View ................................................... 952
32.7 Filter Condition Wildcards ......................................................... 954
33 Events User Interface ................................................. 957

33.1 Object Specific Event View ........................................................ 959
33.2 Event Styles Dialog Box ............................................................ 960
33.3 Event View Properties ............................................................... 961
33.4 Add/Remove Columns Dialog Box (Events) ............................... 962
33.5 Select Conditions Dialog Box – Events Filter Properties ............. 967
33.6 EventLog Properties - Basic Tab ............................................... 968
34 Trend Log Introduction ............................................... 969

34.1 Trend Overview ......................................................................... 971

20
34.1.1 Trend Log Types ..................................................................... 973
34.1.2 Trend Log Functions ............................................................... 973
34.1.3 Trend Units ............................................................................. 973
34.1.4 Trend Log List ......................................................................... 973
34.1.5 Trend Charts ........................................................................... 973
34.1.6 Move or Copy Trend Logs or Extended Trend Logs ................. 974
34.1.7 Mass Create ........................................................................... 974
34.2 Clearing a Trend Log ................................................................. 975
34.3 Editing or Commenting a Trend Log Record ............................. 976
34.4 Displaying the History of a Trend Log Record ............................ 977
34.5 Trend Units ............................................................................... 978
34.6 Enabling a Trend Log ................................................................ 980
34.7 Disabling a Trend Log ............................................................... 981
34.8 Editing the Activation Method in a Trend Log ............................. 982
35 Trend Log Types ........................................................ 983

35.1 Trend Log Types ....................................................................... 985
35.1.1 Interval Trend Logs ................................................................ 987
35.1.2 Meter Trend Logs ................................................................... 987
35.1.3 Change of Value Trend Logs ................................................... 987
35.1.4 Variable Triggered Trend Logs ................................................ 987
35.1.5 Manual Trend Logs ................................................................ 987
35.1.6 Implicit Trend Logs ................................................................. 988
35.2 Interval Trend Logs .................................................................. 989
35.2.1 Interval Trend Log Delta .......................................................... 991
35.3 Interval Trend Log Delta ............................................................ 994
35.4 Creating an Interval Trend Log .................................................. 997
35.5 Configuring an Interval Trend Log ............................................ 1003
35.6 Editing the Interval of an Interval Trend Log .............................. 1004
35.7 Editing the Delta in an Interval Trend Log ................................. 1005
35.8 Meter Trend Logs ................................................................... 1006
35.9 Creating a Meter Trend Log and Associated Objects .............. 1009
35.10 Creating a Meter Trend Log .................................................... 1027
35.11 Managing Replacement of a Meter ......................................... 1031
35.12 Configuring a Meter Trend Log ................................................ 1033
35.13 Displaying Meter Change History ............................................. 1034
35.14 Change of Value Trend Logs ................................................... 1035
35.15 Creating a Change of Value Trend Log ................................... 1038
35.16 Configuring a Change of Value Trend Log ............................... 1043
35.17 Variable Triggered Trend Logs ................................................ 1044
35.18 Creating a Variable Triggered Trend Log .................................. 1047
35.19 Configuring a Variable Triggered Trend Log ............................. 1050
35.20 Manual Trend Logs ................................................................. 1051
35.21 Creating a Manual Trend Log .................................................. 1053
35.22 Configuring a Manual Trend Log ............................................. 1056
35.23 Adding a Trend Log Record to a Manual Trend Log ................. 1057
35.24 Implicit Trend Logs ................................................................. 1058

21
36 Trend Log Functions ................................................ 1059
36.1 Trend Log Functions ............................................................... 1061
36.1.1 Log Record Storage .............................................................. 1061
36.1.2 Activation Methods ............................................................... 1061
36.1.3 Extended Trend Logs ............................................................ 1061
36.2 Log Record Storage ................................................................ 1062
36.3 Activation Methods ................................................................. 1063
36.3.1 Always active ........................................................................ 1063
36.3.2 Variable Controlled ................................................................ 1063
36.3.3 Start at activation time ........................................................... 1065
36.4 Extended Trend Logs ............................................................. 1067
36.4.1 Archive Overview .................................................................. 1070
36.5 Creating an Extended Trend Log ............................................. 1071
36.6 Configuring an Extended Trend Log ........................................ 1074
36.7 Editing the Threshold Property of an Extended Trend Log ....... 1075
36.8 Editing the Maximum Transfer Interval Property of an Extended
Trend Log ............................................................................... 1076
36.9 Editing the Number of Log Records for a Trend Log ................ 1077
36.10 Editing an Extended Trend Log to be Included in Reports ........ 1078
36.11 Manually Transferring Records to the Extended Trend Log ...... 1079
37 Trend Charts ............................................................ 1081

37.1 Trend Charts ........................................................................... 1083
37.1.1 Trend Chart Series ................................................................ 1089
37.1.2 Trend Chart Axes in WorkStation .......................................... 1089
37.1.3 Trend Chart Axes in WebStation ........................................... 1089
37.1.4 Real-Time Plotting ................................................................. 1089
37.1.5 Time Zone Modes in a Trend Chart ....................................... 1089
37.1.6 Calculation Methods ............................................................. 1089
37.1.7 Temporary Trend Charts ....................................................... 1090
37.2 Configuring a Trend Chart ....................................................... 1091
37.3 Showing Trend Chart Grid Lines .............................................. 1094
37.4 Adding a Trend Log Series to a Trend Chart ............................ 1096
37.5 Adding a Real-Time Trend Series to a Trend Chart .................. 1097
37.6 Editing the Trend Chart Settings .............................................. 1101
37.7 Activating Trend Chart Live Update ......................................... 1102
37.8 Trend Chart Axes .................................................................... 1103
37.9 Scroll the Trend Chart X-Axis to the Current Time .................... 1105
37.10 Configuring the X-Axis with a Relative Time Span .................... 1106
37.11 Configuring the X-Axis with an Absolute Time Span ................. 1107
37.12 Manually Configuring the Y-Axis Scale .................................... 1108
37.13 Automatically Configuring the Y-Axis Scale ............................. 1109
37.14 Assigning a Series to a Y-Axis ................................................. 1110
37.15 Real-Time Plotting ................................................................... 1111
37.16 Creating a Real-Time Plot Trend Chart .................................... 1112
37.17 Creating a Trend Chart that Monitors a Variable in Real-Time .. 1113
37.18 Trend Chart Series .................................................................. 1117

22
37.19 Creating a Trend Chart that Monitors a Trend Log Series ......... 1119
37.20 Attaching a Calculation Method to a Trend Chart Series .......... 1123
37.21 Time Zone Modes in a Trend Chart ......................................... 1125
37.21.1 Local Time ............................................................................ 1125
37.21.2 Predefined Time Zone ........................................................... 1126
37.22 Configuring the Trend Chart Time Zone .................................. 1128
37.23 Temporary Trend Charts ......................................................... 1129
37.24 Opening a Trend Log in a Temporary Trend Chart .................. 1130
37.25 Saving a Temporary Trend Chart ............................................. 1131
38 Trend Log Lists ........................................................ 1133

38.1 Trend Log Lists ....................................................................... 1135
38.1.1 Time Zone Modes in a Trend Log List .................................... 1137
38.1.2 Calculation Methods ............................................................. 1137
38.1.3 Temporary Trend Log Lists ................................................... 1137
38.2 Creating a Trend Log List ........................................................ 1138
38.3 Configuring a Trend Log List ................................................... 1141
38.4 Time Zone Modes in a Trend Log List ...................................... 1142
38.4.1 Local Time Zone ................................................................... 1142
38.4.2 Server Time Zone .................................................................. 1142
38.4.3 UTC Time Zone ..................................................................... 1143
38.5 Displaying the Trend Log List Time Stamps with Fractions ....... 1145
38.6 Configuring the Trend Log List Time Zone .............................. 1146
38.7 Calculation Methods ............................................................... 1148
38.7.1 Maximum ............................................................................. 1148
38.7.2 Minimum .............................................................................. 1149
38.7.3 Average ................................................................................ 1149
38.7.4 Summary .............................................................................. 1150
38.7.5 Delta ..................................................................................... 1151
38.7.6 Delta over Period .................................................................. 1152
38.7.7 Meter Consumption .............................................................. 1152
38.8 Attaching a Calculation Method to a Trend Log List ................. 1153
38.9 Temporary Trend Log Lists ..................................................... 1155
38.10 Saving a Temporary Trend Log List ......................................... 1156
39 Trends User interface ............................................... 1157

39.1 Trend Log System Tree Icons .................................................. 1159
39.2 Actions Menu – Activation Submenu ....................................... 1160
39.3 Actions Menu – View Submenu ............................................... 1161
39.4 Actions Menu - View Submenu - Trend Charts Submenu ........ 1162
39.5 Actions Menu - View Submenu - Trend Log Lists Submenu .... 1163
39.6 Actions Menu – Modification Submenu ................................... 1164
39.7 Interval Trend Log Properties .................................................. 1165
39.8 Meter Trend Log Properties .................................................... 1167
39.9 Change of Value Trend Log Properties .................................... 1169
39.10 Variable Triggered Trend Log Properties ................................. 1171
39.11 Manual Trend Log Properties ................................................. 1173

23
39.12 Extended Trend Log Properties .............................................. 1174
39.13 Trend Chart Properties ........................................................... 1176
39.14 Trend Log List Properties ........................................................ 1178
39.15 Manage Replacement of Meter Dialog Box .............................. 1180
39.16 Meter Change History Dialog Box ............................................ 1182
39.17 Trend Chart View .................................................................... 1184
39.18 Trend Chart Toolbar ................................................................ 1186
39.19 Trend Chart Event Icons .......................................................... 1188
39.20 Trend Chart Navigation Bar ..................................................... 1190
39.21 Series Tab Shortcut Menu ....................................................... 1191
39.22 Trend Chart Settings Dialog Box – Axes Tab ........................... 1193
39.23 Trend Chart Settings Dialog Box – Series Tab ......................... 1195
39.24 Trend Chart Settings Dialog Box – Calculation Tab .................. 1197
39.25 Trend Chart Series Properties ................................................. 1198
39.26 Real Time Trend Series Properties ........................................... 1200
39.27 Trend Log List View ................................................................ 1201
39.28 Add/Remove Columns Dialog Box (Trends) ............................. 1203
39.29 Trend Log List Toolbar ............................................................ 1204
39.30 Trend Log List Event Icons ...................................................... 1206
39.31 Trend Log List – Log Info View ................................................ 1208
39.32 Trend Log List Shortcut Menu ................................................. 1209
39.33 Add Trend Log Record Dialog Box .......................................... 1210
39.34 Edit/Comment Trend Log Record Dialog Box .......................... 1211
39.35 Create Trend Log Wizard – Configure Interval Trend Log Page 1212
39.36 Create Trend Log Wizard – Configure Meter Trend Log Page .. 1213
39.37 Create Trend Log Wizard – Configure Change of Value Trend Log
Page ....................................................................................... 1214
39.38 Create Trend Log Wizard – Configure Variable Triggered Trend
Log ......................................................................................... 1215
39.39 Create Trend Log Wizard – Configure Manual Log Page .......... 1216
39.40 Create Trend Log Wizard – Configure Extended Trend Log
Page ....................................................................................... 1217
39.41 Create Trend Log Wizard – Configure Trend Chart Page ......... 1218
39.42 Create Trend Log Wizard – Configure Real-Time Trend Series
Page ....................................................................................... 1220
39.43 Create Trend Log Wizard – Configure Trend Log Series Page . 1221
39.44 Create Trend Log Wizard – Configure Trend Log List Page ...... 1222
39.45 Create Trend Log Wizard – Connect Objects to the Trend Log
Page ....................................................................................... 1223
39.46 Trend Log Wizard – Initial Meter Settings Page ........................ 1224
40 Mass Create Alarms and Trends .............................. 1225

40.1 Mass Create .......................................................................... 1227
40.1.1 Object or Property Variable Type ........................................... 1227
40.1.2 Suffix and Prefix .................................................................... 1228
40.1.3 Mass Create Unit Management ............................................. 1228
40.1.4 Mass Create from Properties with the Search Method ........... 1228
40.1.5 Mass Create Path Options .................................................... 1228

24
40.2 Mass Create Unit Management .............................................. 1229
40.3 Object or Property Variable Type ............................................. 1230
40.4 Suffix and Prefix ...................................................................... 1232
40.5 Mass Create Path Options ...................................................... 1233
40.6 Mass Creating Alarms ............................................................ 1234
40.7 Mass Creating Alarms Using the Search Method ..................... 1236
40.8 Mass Creating Trend Logs ...................................................... 1239
40.9 Mass Creating Trend Logs Using the Search Method .............. 1241
40.10 Mass Creating Extended Trend Logs ...................................... 1244
40.11 Mass Creating Extended Trend Logs Using the Search
Method ................................................................................... 1246
40.12 Mass Create Object Wizard – Name Page ............................... 1248
41 Schedules Introduction ............................................ 1251

41.1 Schedules Overview ............................................................... 1253
41.1.1 Schedule Editor Overview ..................................................... 1253
41.1.2 Priorities ............................................................................... 1253
41.1.3 Schedule Types .................................................................... 1253
41.1.4 Schedule Events ................................................................... 1253
41.1.5 Calendars in WorkStation ...................................................... 1254
41.1.6 Schedule and Calendar Synchronization ............................... 1254
41.1.7 Schedule Bindings ................................................................ 1254
41.2 Schedule Bindings .................................................................. 1255
41.2.1 Binding Examples ................................................................. 1255
41.3 Configuring a Schedule as a Shadow ..................................... 1256
42 Schedule Editor ....................................................... 1257

42.1 Schedule Editor Overview ....................................................... 1259
42.1.1 Basic View of the Schedule Editor ......................................... 1259
42.1.2 Advanced View of the Schedule Editor .................................. 1259
42.1.3 Schedule Colors .................................................................. 1259
42.2 Basic View of the Schedule Editor ........................................... 1260
42.3 Advanced View of the Schedule Editor ................................... 1261
42.3.1 Mode .................................................................................... 1261
42.3.2 View ..................................................................................... 1261
42.3.3 Combined ............................................................................ 1262
42.4 Time Zones ............................................................................. 1263
42.5 Priorities ................................................................................. 1264
42.5.1 Exception Events .................................................................. 1264
42.6 Editing an Event Priority ........................................................... 1266
42.7 Configuring a Time Value Pair for a Schedule ........................... 1268
42.8 Setting the Time Increments in the Server Time Bar ................. 1269
42.9 Modifying a Time Value Bar in the Graphic View ...................... 1270
42.10 Modifying a Schedule Using the Text View ............................... 1271
42.11 Modifying a Schedule Using the Graphic View ......................... 1273
42.12 Schedule Colors in WorkStation .............................................. 1274
42.12.1 Basic Schedule View ............................................................. 1274
42.12.2 Advanced Schedule View ...................................................... 1275

25
43 Schedule Types ....................................................... 1277
43.1 Schedule Types ..................................................................... 1279
43.1.1 Analog Schedules ................................................................. 1279
43.1.2 Digital Schedules .................................................................. 1279
43.1.3 Multistate Schedules ............................................................. 1279
43.2 Digital Schedules .................................................................... 1280
43.3 Creating a Digital Schedule ..................................................... 1281
43.4 Binding a Digital Value to a Digital Schedule ............................ 1282
43.5 Multistate Schedules ............................................................... 1284
43.6 Creating a Multistate Schedule ................................................ 1285
43.7 Binding a Multistate Value to a Multistate Schedule ................. 1286
43.8 Analog Schedules ................................................................... 1287
43.9 Creating an Analog Schedule .................................................. 1288
43.10 Binding an Analog Value to an Analog Schedule ...................... 1289
44 Schedule Events ...................................................... 1291

44.1 Schedule Events ..................................................................... 1293
44.1.1 Weekly Events in WorkStation ............................................... 1293
44.1.2 Weekly Events in WebStation ................................................ 1293
44.1.3 Exception Events in WorkStation ........................................... 1293
44.1.4 Exception Events in WebStation ............................................ 1293
44.1.5 Priorities ............................................................................... 1294
44.1.6 Time Zones ........................................................................... 1294
44.2 Displaying Client Time and Server Time in a Schedule ............. 1295
44.3 Deleting a Date List Entry from a Calendar .............................. 1296
44.4 Weekly Events in WorkStation ................................................. 1297
44.5 Exception Events in WorkStation ............................................. 1298
44.5.1 Date Exception Events .......................................................... 1298
44.5.2 Date Range Exception Events ............................................... 1298
44.5.3 Calculated Exception Events ................................................. 1299
44.5.4 Calendar Exception Events ................................................... 1299
44.6 Editing a Date Exception Event ................................................ 1300
44.7 Editing a Date Range Exception Event ..................................... 1303
44.8 Editing a Calculated Exception Event ...................................... 1306
44.9 Adding a Date Range Exception Event .................................... 1309
44.10 Adding a Calculated Exception Event ...................................... 1312
44.11 Adding a Weekly Event ........................................................... 1314
44.12 Adding a Calendar Exception Event ........................................ 1315
44.13 Adding a Date Exception Event .............................................. 1318
45 Calendars ................................................................ 1321

45.1 Calendar Editor Overview ........................................................ 1323
45.2 Calendars in WorkStation ........................................................ 1324
45.2.1 Calendar Editor Overview ...................................................... 1324
45.2.2 Calendar Events .................................................................... 1324
45.3 Calendar Events ..................................................................... 1326
45.3.1 Date Calendar Events ........................................................... 1326

26
45.3.2 Date Range Calendar Events ................................................ 1326
45.3.3 Calculated Calendar Events .................................................. 1327
45.4 Creating a Calendar ................................................................ 1328
45.5 Adding a Date Calendar Event ................................................. 1330
45.6 Adding a Date Range Calendar Event ...................................... 1332
45.7 Adding a Calculated Date Calendar Event ............................... 1334
45.8 Configuring a Calendar as a Shadow ...................................... 1336
45.9 Storing Expired Calendar Events ............................................. 1337
45.10 Editing a Date Calendar Event ................................................. 1338
45.11 Editing a Date Range Calendar Event ...................................... 1340
45.12 Editing a Calculated Date Calendar Event ................................ 1342
45.13 Schedule and Calendar Synchronization ................................. 1344
46 Schedules User Interface ......................................... 1345

46.1 Schedule Editor – Basic View .................................................. 1347
46.2 Basic Schedule Editor Toolbar ............................................... 1348
46.3 Advanced Schedule Editor – Graphic View ............................. 1349
46.4 Advanced Schedule Editor Toolbar ........................................ 1350
46.5 Edit Effective Period Dialog Box .............................................. 1351
46.6 Edit Exception Dialog Box ...................................................... 1352
46.7 Edit Time Value Period Dialog Box .......................................... 1353
46.8 Snap To Menu ........................................................................ 1354
46.9 Show Client Time Zone .......................................................... 1355
46.10 Schedule Properties – Basic Tab ............................................. 1356
46.11 Schedule Event Properties Dialog Box – Weekly View ............. 1358
46.12 Schedule Event Properties Dialog Box – Single Date Exception View
............................................................................................... 1360
46.13 Schedule Event Properties Dialog Box – Date Range Exception View
............................................................................................... 1362
46.14 Schedule Event Properties Dialog Box – Calculated Exception
View ....................................................................................... 1364
46.15 Schedule Event Properties Dialog Box – Calendar Reference View
............................................................................................... 1366
46.16 Calendar Editor View ............................................................... 1368
46.17 Calendar Editor Toolbar .......................................................... 1369
46.18 Calendar Properties – Basic Tab ............................................. 1370
46.19 Edit Calendar Entry Dialog Box – Add Date ............................. 1371
46.20 Edit Calendar Entry Dialog Box – Date Range ......................... 1372
46.21 Edit Calendar Entry Dialog Box – Calculated Date .................. 1373
47 WorkStation ............................................................. 1375

47.1 WorkStation ............................................................................ 1377
47.1.1 Flexible Workspace ............................................................... 1377
47.1.2 User rights ............................................................................ 1378
47.2 System Tree Pane ................................................................... 1379
47.3 List View ................................................................................. 1381
47.4 Control Panel .......................................................................... 1382
47.5 Opening Control Panel ............................................................ 1383

27
47.6 Quick Filter ............................................................................. 1384
47.7 Hyperlinks ............................................................................... 1387
47.8 Creating a Hyperlink ................................................................ 1388
47.9 Utilities .................................................................................... 1390
47.9.1 Signal Generator ................................................................... 1390
47.9.2 Simple Math Operators ......................................................... 1390
48 Building Operation Objects ...................................... 1391

48.1 Object Types .......................................................................... 1393
48.2 Object Names ......................................................................... 1394
48.3 Object Properties .................................................................... 1395
48.4 Opening an Object in a New Window ...................................... 1397
48.5 Object Tab Display .................................................................. 1398
48.6 Showing the Same Tab While Navigating Between Objects ..... 1399
48.7 Showing Non-Presentation Objects in the System Tree Pane .. 1400
48.8 Multi-edit ................................................................................ 1401
48.9 Editing Multiple Objects ........................................................... 1402
48.10 Move, Copy, Paste, Rename, and Delete ................................ 1403
48.11 Deleting an Object ................................................................... 1404
48.12 Renaming a Folder or Object ................................................... 1405
48.13 Creating a Folder .................................................................... 1406
48.14 Copying a Folder or Object ...................................................... 1407
48.15 Viewing Related Trends .......................................................... 1408
49 Archive .................................................................... 1409

49.1 Archiving Overview ................................................................. 1411
49.1.1 Archive Log Files ................................................................... 1411
49.1.2 Archiving Formats and Storage ............................................. 1412
49.1.3 Archive Folders, Files, and Names ......................................... 1412
49.1.4 Archiving Server Compatibility ............................................... 1412
49.1.5 System Alarms for Archiving .................................................. 1412
49.1.6 Manual and Scheduled Archiving .......................................... 1413
49.2 Archiving Server Compatibility ................................................. 1414
49.3 Enabling the Archiving Function and Defining the Archive
Folder ..................................................................................... 1415
49.4 Archive Directory Does Not Exist ............................................. 1416
49.4.1 Solution ................................................................................ 1416
49.5 Archiving Formats and Storage ............................................... 1417
49.5.1 Archive Storage and Validation .............................................. 1417
49.6 Manual and Scheduled Archiving ............................................ 1418
49.7 Manually Creating an Archive .................................................. 1419
49.8 Creating a Scheduled Archive ................................................. 1422
49.9 Removing Extended Trend Logs from the Archive ................... 1425
49.10 Removing Events from the Archive .......................................... 1426
49.11 Archive Folders, Files, and Names ........................................... 1427
49.11.1 Archive Folder Names ........................................................... 1427
49.11.2 Archive System Resource Files ............................................. 1427
49.11.3 File Names for Extended Trend Log Archives ........................ 1428

28
49.11.4 File Names for Events Log Archives ....................................... 1428
49.11.5 Unique Archive File Names .................................................... 1428
49.11.6 Archive Log Contents ............................................................ 1428
49.12 Archive Log Contents ............................................................. 1429
49.12.1 Columns and Descriptions .................................................... 1429
49.12.2 Event and Alarm Enumerations ............................................. 1432
49.12.3 Trend Log Enumerations ....................................................... 1433
49.13 Event and Alarm Enumerations ............................................... 1434
49.13.1 Alarm State ........................................................................... 1434
49.13.2 Assigned State ...................................................................... 1434
49.13.3 BACnet Alarm Type .............................................................. 1434
49.13.4 Basic Evaluation State ........................................................... 1435
49.13.5 Disabled Cause ..................................................................... 1435
49.13.6 Evaluation State .................................................................... 1436
49.13.7 Hidden ................................................................................. 1436
49.13.8 Previous Alarm State ............................................................. 1436
49.13.9 System Alarm ID ................................................................... 1437
49.13.10 System Event ID ................................................................... 1437
49.14 System Alarm ID Enumerations ............................................... 1438
49.15 System Event ID Enumerations ............................................... 1447
49.16 Trend Log Enumerations ......................................................... 1454
49.17 System Alarms For Archiving ................................................... 1456
50 Archive User Interface .............................................. 1457

50.1 Archive Settings Manager Dialog Box ...................................... 1459
50.2 Add Extended Trend Logs Dialog Box ..................................... 1461
50.3 Archiving Settings Properties – Basic Tab ............................... 1462
50.4 Archiving Settings Properties – Content Tab ............................ 1463
50.5 Archive Icons in the System Tree ............................................. 1464
50.6 Event Archive File ................................................................... 1465
50.7 Trend Log Archive File ............................................................. 1468
51 Search ..................................................................... 1471

51.1 Search Overview ..................................................................... 1473
51.1.1 Simple Search ...................................................................... 1473
51.1.2 Advanced Search ................................................................. 1473
51.1.3 Saved Search ....................................................................... 1473
51.2 Simple Search ........................................................................ 1474
51.2.1 Wildcard Search ................................................................... 1474
51.2.2 Search Result List ................................................................. 1475
51.3 Performing a Search Using Simple Search ............................. 1476
51.4 Saving a Search ...................................................................... 1477
51.5 Advanced Search ................................................................... 1478
51.5.1 Wildcard Search ................................................................... 1478
51.5.2 Object Types Search ............................................................. 1478
51.5.3 Properties Conditions Search ................................................ 1479
51.5.4 Setpoint Search Example ...................................................... 1479

29
51.5.5 Non-Validated Programs Search Example ............................. 1479
51.5.6 Search Result List ................................................................. 1479
51.6 Properties Conditions Search .................................................. 1480
51.6.1 ............................................................................................. 1480
51.7 Search for Objects Using Advanced Search ............................ 1482
51.8 Setpoint Search Example ........................................................ 1484
51.9 Non-Validated Programs Search Example ............................... 1487
52 WorkStation User Interface ...................................... 1491

52.1 Basic Functionality Icons in the System Tree Pane ................... 1495
52.2 File Menu ............................................................................... 1496
52.3 File Menu – New Submenu ..................................................... 1498
52.4 Edit Menu ............................................................................... 1509
52.5 Actions Menu .......................................................................... 1511
52.6 Actions Menu – Activation Submenu ....................................... 1518
52.7 Actions Menu – Advanced Submenu ...................................... 1519
52.8 Actions Menu – Advanced Commands Submenu ................... 1520
52.9 Actions Menu – Modification Submenu ................................... 1521
52.10 Actions Menu – View Submenu ............................................... 1522
52.11 Actions Menu - View Submenu - Watch Submenu .................. 1523
52.12 Actions Menu – Actions Submenu .......................................... 1524
52.13 Watch Select Property Dialog Box ........................................... 1525
52.14 Add/Remove Columns Dialog Box (Watch Pane) ..................... 1526
52.15 Tools Menu ............................................................................. 1527
52.16 Options Dialog Box ................................................................. 1528
52.17 Control Panel View .................................................................. 1529
52.18 Progress View – Advanced ..................................................... 1532
52.18.1 Detail View ............................................................................ 1532
52.19 Progress View – Simple .......................................................... 1534
52.19.1 Simple Progress View ........................................................... 1534
52.19.2 Detail View ............................................................................ 1534
52.20 Operation Details Dialog Box ................................................... 1536
52.21 Error Details – Progress View .................................................. 1537
52.22 Create Object Wizard – Naming the Object Page .................... 1538
52.23 List View Toolbar ..................................................................... 1540
52.24 System Tree Pane Toolbar ...................................................... 1541
52.25 Confirm Delete Dialog Box ...................................................... 1542
52.26 Delete Object Dialog Box ........................................................ 1543
52.27 Rename Object Dialog Box ..................................................... 1544
52.28 General Properties – Basic Tab ............................................... 1545
52.29 General Properties – References Tab ...................................... 1547
52.30 Retain Level ........................................................................... 1548
52.31 Configure Dialog Box - Configuration Tab ................................ 1549
52.32 Configure Dialog Box – Operation Tab .................................... 1551
52.33 Search Icons ........................................................................... 1552
52.34 Search View ............................................................................ 1553
52.35 Search View Toolbar ............................................................... 1555

30
52.36 Search Toolbar ....................................................................... 1556
52.37 Add/Remove Columns Dialog Box (Search) ............................. 1557
52.38 Select Folder Dialog Box ......................................................... 1558
52.39 Select Types Dialog Box ......................................................... 1559
52.40 Select Conditions Dialog Box .................................................. 1560
52.41 Add/Remove Columns Dialog Box (System Tree Pane) ........... 1561
52.42 Analog Value Properties .......................................................... 1562
52.43 Digital Value Properties ........................................................... 1563
52.44 Multistate Value Properties ...................................................... 1564
52.45 String Value Properties ............................................................ 1565
52.46 Signal Generator Dialog Box ................................................... 1566
52.47 Simple Math Operator Dialog Box ........................................... 1567
52.48 Create Hyperlink Wizard – Assign the URL Page ..................... 1568
52.49 Select Object Dialog Box ......................................................... 1569
52.50 Select Object and Properties Dialog Box ................................. 1570
52.51 Progress View ......................................................................... 1571
52.52 System Object Properties ....................................................... 1572
52.53 System Control Panel Properties ............................................. 1573
52.54 Commit Page .......................................................................... 1574
52.55 Related Trends Properties Dialog ............................................ 1575
53 Shortcuts ................................................................ 1577

53.1 Shortcuts Overview ................................................................. 1579
53.2 Shortcut Functionality ............................................................. 1580
53.3 User Access to Shortcuts and Targets .................................... 1581
53.4 Shortcut Presentation ............................................................. 1582
53.5 Viewing Shortcuts ................................................................... 1583
53.6 Viewing Shortcut Properties .................................................... 1584
53.7 Shortcut Creation ................................................................... 1585
53.7.1 Shortcuts in Servers and Folders ........................................... 1585
53.7.2 Shortcuts to Objects and Points ............................................ 1585
53.8 Creating a Shortcut ................................................................. 1586
53.9 Configuring the Target of a Shortcut ........................................ 1587
53.10 Editing Shortcuts .................................................................... 1588
54 Shortcuts User Interface .......................................... 1589

54.1 Shortcuts Icon ........................................................................ 1591
54.2 Create Shortcut Wizard – Shortcut Target Page ...................... 1592
54.3 Shortcut Properties – Basic Tab .............................................. 1593
55 Documents .............................................................. 1595

55.1 Documents Overview .............................................................. 1597
55.2 Creating a Document .............................................................. 1598
56 Documents User Interface ........................................ 1599

56.1 Document Properties – Basic Tab ........................................... 1601
56.2 New Document Wizard – Import Document Page ................... 1602
57 Backup and Restore ................................................ 1603

31
57.1 Backup and Restore Overview ................................................ 1605
57.1.1 Backup ................................................................................. 1605
57.1.2 Restore ................................................................................. 1605
57.1.3 BACnet Backup and Restore ................................................ 1605
57.1.4 Archiving Overview ................................................................ 1606
57.1.5 Comparison of Backup and Restore Methods ....................... 1606
57.2 Comparison of Backup and Restore Methods ........................ 1607
57.3 Local Backup and Restore of Building Operation Servers ........ 1608
57.3.1 Local Backup and Restore of a Standalone Automation
Server ................................................................................... 1608
57.3.2 Local Backup and Restore of an Enterprise Server ................ 1609
57.4 Remote Backup and Restore of Automation Servers ............... 1610
58 Backups .................................................................. 1611

58.1 Backup ................................................................................... 1613
58.1.1 Types of Data ....................................................................... 1613
58.1.2 Backup Sets ......................................................................... 1613
58.1.3 Scheduled Backups .............................................................. 1613
58.1.4 Manual Backups ................................................................... 1614
58.1.5 Mass Backup ........................................................................ 1614
58.1.6 System Backup .................................................................... 1614
58.1.7 Backup Status ...................................................................... 1614
58.2 Types of Data .......................................................................... 1615
58.3 Backup Status ........................................................................ 1616
58.4 Checking the Backup Status of a Server ................................. 1617
58.5 Manual Backups ..................................................................... 1618
58.5.1 Backup Set Naming .............................................................. 1618
58.5.2 Local Backup and Restore of Building Operation Servers ...... 1618
58.5.3 Remote Backup and Restore of Automation Servers ............. 1619
58.6 Mass Backup .......................................................................... 1620
58.7 Backing Up Servers Manually .................................................. 1621
58.8 System Backup ...................................................................... 1624
59 Backup Sets ........................................................... 1627

59.1 Backup Sets ........................................................................... 1629
59.1.1 Backup Set Storage and Protection ...................................... 1630
59.1.2 Backup Set Import from WorkStation .................................... 1630
59.1.3 Automatic Purge of Backup Sets .......................................... 1630
59.2 Backup Set Storage and Protection ........................................ 1631
59.3 Locating the Local Backup Path on the Enterprise Server ........ 1633
59.4 Copying an Enterprise Server Backup Set to WorkStation ....... 1634
59.5 Copying an Automation Server Backup Set to WorkStation ..... 1636
59.6 Copying a Backup Set to the Enterprise Server Local
Directory ................................................................................. 1638
59.7 Backup Set Import from WorkStation ...................................... 1640
59.8 Importing a Backup Set to an Enterprise Server ....................... 1641
59.9 Importing a Backup Set to an Automation Server .................... 1643
59.10 Automatic Purge of Backup Sets ............................................. 1644

32
59.11 Configuring Purge Settings on an Enterprise Server ................. 1645
59.12 Deleting a Backup Set from the Enterprise Server .................... 1646
60 Scheduled Backups ................................................ 1649

60.1 Scheduled Backups ................................................................ 1651
60.1.1 Backup Rules ....................................................................... 1651
60.1.2 Backup Schedules ................................................................ 1652
60.1.3 Synchronized Backups ......................................................... 1652
60.2 Backup Rules ......................................................................... 1653
60.3 Creating a Backup Rule .......................................................... 1654
60.4 Editing a Backup Rule ............................................................. 1656
60.5 Deleting a Backup Rule ........................................................... 1658
60.6 Removing a Lead Rule from a Backup Rule ............................. 1659
60.7 Backup Schedules .................................................................. 1660
60.8 Editing a Backup Schedule ..................................................... 1661
60.9 Synchronized Backups ........................................................... 1662
60.10 Synchronizing Server Backups on a Network .......................... 1663
61 Restore .................................................................... 1665

61.1 Restore ................................................................................... 1667
61.1.1 Restored Data ....................................................................... 1667
61.1.2 Automation Server Replacement Using Restore .................... 1667
61.2 Restored Data ......................................................................... 1668
61.3 Restoring a Server .................................................................. 1670
61.4 Restoring an Automation Server from the Enterprise Server ..... 1672
61.5 Automation Server Replacement Using Restore ...................... 1674
62 Backup and Restore User Interface .......................... 1677

62.1 Backup and Restore Manager Properties (Enterprise Server) – Basic
Tab ......................................................................................... 1679
62.2 Backup and Restore Manager Properties (Automation Server) –
Basic Tab ............................................................................... 1680
62.3 Backup and Restore Manager on the Enterprise Server ........... 1681
62.4 Backup and Restore Manager on an Automation Server .......... 1682
62.5 Backup Options Dialog Box .................................................... 1683
62.6 Create Object Wizard – Configure Backup Rule Page .............. 1685
62.7 Backup Rule Properties – Basic Tab ....................................... 1686
62.8 Backup Rules View ................................................................. 1687
62.9 Backup Rules Toolbar ............................................................. 1688
62.10 Backup Rules List ................................................................... 1689
62.11 Backup Schedule Properties – Basic Tab ................................ 1690
62.12 Backup Set Properties – Basic Tab ......................................... 1692
62.13 Backup Sets View ................................................................... 1693
62.14 Backup Status Dialog Box ....................................................... 1694
62.15 Control Panel – Backup and Archiving ..................................... 1695
62.16 Backup Rule Dialog Box .......................................................... 1696
62.17 Backup and Restore System Tree Icons .................................. 1697
62.18 Restore Options Dialog Box .................................................... 1698

33
62.19 Restore Status Dialog Box ...................................................... 1699
62.20 Backup and Restore Folder Properties .................................... 1700

34
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 the Building Operation system, such as
installation, alarms, and trends. This information is intended to help you understand
the Building Operation system and user interface, as well as how to perform tasks in
the system.

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

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

41
2 Additional Information
Topics
Where to Find Additional Information
Regulatory Notices
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
• System 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
• Creating and Configuring a LonWorks Network with MNL LonWorks Devices
Tutorial Guide

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

46
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 Building Operation
Topics
Building Operation Overview
Work Interface Overview
Function Overview
Engineering Tools Overview
Protocols Overview
Licensing, Installation, and Localization Overview
3.1 Building Operation Overview

StruxureWare Building Operation is an integration platform for monitoring, control,
and management of energy, lighting, fire safety, security and HVAC.
3.1.1 Work Interface Overview

You use interfaces to set up, manage and operate Building Operation on a daily
basis.
For more information, see section 3.2 “Work Interface Overview” on page 53.
3.1.2 Server Overview

Building Operation servers are used to engineer and supervise building automation
systems.
For more information, see the Server Overview topic on WebHelp.
3.1.3 Function Overview

Building Operation gives you a number of functions to monitor and manage your
facilities.
For more information, see section 3.3 “Function Overview” on page 54.
3.1.4 Engineering Tools Overview

You engineering your system using the engineering tools.
For more information, see section 3.4 “Engineering Tools Overview ” on page 56.
3.1.5 Protocol Overview

Building Operation supports the major communication protocols in building
automation and security management.
For more information, see section 3.5 “Protocols Overview” on page 58.
3.1.6 Hardware Overview

Building Operation is a system that can be designed for a vast number of
applications. There are many components, for both hardware and software, and
they can be used in numerous ways.
For more information, see the Hardware Overview topic on WebHelp.

51
3.1.7 Licensing, Installation, and Localization

Overview
To be able to run Building Operations you need to install and licensing the software.
For more information, see section 3.6 “Licensing, Installation, and Localization
Overview” on page 60.
3.1.8 System Upgrade Overview

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

52
3.2 Work Interface Overview
3.2 Work Interface Overview

You use interfaces to set up, manage and operate Building Operation on a daily
basis.
3.2.1 WebStation Overview

WebStation is your web-based interface to your Building Operation system. You
use WebStation to perform work on a daily basis in Building Operation.
For more information, see the WebStation Overview topic on WebHelp.
3.2.2 WorkStation Overview

WorkStation is your main interface to your Building Operation system. You use
WorkStation to perform all work on a daily basis in Building Operation.
For more information, see the WorkStation Overview topic on WebHelp.
3.2.3 Technician Tool Overview

Technician Tool is used to access the functions in Building Operation. You use
Technician Tool to view and monitor all work on a daily basis in Building Operation.
For more information, see the Technician Tool Overview topic on WebHelp.
3.2.4 WebHelp Overview

In WebHelp, you find information on how to set up, manage, and operate Building
Operation. WebHelp is continuously updated. You can browse and search for
information about your specific Building Operation product and version.
For more information, see the WebHelp Overview topic on WebHelp.

53
3.3 Function Overview

Building Operation gives you a number of functions to monitor and manage your
facilities.
3.3.1 Alarm Overview

You use an alarm to monitor a variable and to alert you if the monitored variable
matches the configured alarm conditions.
For more information, see section 27.1 “Alarm Overview” on page 621.
3.3.2 Schedules Overview

A schedule is a sequence of events that determines when essential events occur in
a building automation system: doors locking or unlocking, temperature raised or
lowered, or equipment turned on or off.
For more information, see section 41.1 “Schedules Overview” on page 1253.
3.3.3 Trend Overview

The function of a trend log is to log the variable that it is connected to and store the
records.
For more information, see section 34.1 “Trend Overview” on page 971.
3.3.4 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.
For more information, see section 19.1 “User Account Management Overview” on
page 367.
3.3.5 Backup and Restore Overview

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.
For more information, see section 57.1 “Backup and Restore Overview” on page
1605.

54
3.3.6 Document Overview

A Document is a container in which you can upload (import) a file for use in Building
Operation. You can upload all types of files, including reports, forms, images, and
video clips.
For more information, see section 55.1 “Documents Overview” on page 1597.
3.3.7 Search Overview

Use Search in WorkStation to find and view objects in the database.
For more information, see section 51.1 “Search Overview” on page 1473.
3.3.8 Shortcuts Overview

In Building Operation, you can create shortcuts to objects in the System Tree pane.
A shortcut is a link to a target server, folder, or other object and is simply a pointer
to an object which acts as if it is that object.
For more information, see section 53.1 “Shortcuts Overview” on page 1579.

55
3.4 Engineering Tools Overview

You engineering your system using the engineering tools.
3.4.1 Spreadsheet Overview

You use the Spreadsheet view to create and edit multiple objects and to save time.
For more information, see the Spreadsheet Overview topic on WebHelp.
3.4.2 Bindings Overview

A binding is a connection between two or more variables for data exchange. In its
simplest form, a binding consists of a source and a destination. The source supplies
the value to the destination.
For more information, see the Bindings Overview topic on WebHelp.
3.4.3 Text Reports Overview

A text report contains, in textual format, the attributes of selected properties of an
object (or a number of objects). Each text report is displayed in its own text report
view in the Work area when you drag-and-drop an object or a group of objects into
the text report view.
For more information, see the Text Reports Overview topic on WebHelp.
3.4.4 Import and Export Overview

A solution or application is a user-created object or group of objects that perform a
control process. Examples of creatable objects in Building Operation include
networks, devices, programs, binding templates, graphics, trends, and alarms.
For more information, see the Import and Export Overview topic on WebHelp.
3.4.5 Script Overview

Script programs are text-based instructions that tell the server to take some kind of
action to control a building.
For more information, see the Script Overview topic on WebHelp.

56
3.4.6 Function Block Editor Overview

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.
For more information, see the Function Block Editor Overview topic on WebHelp.
3.4.7 Graphics Editor Overview

You can use Graphics Editor to create and edit graphics representing a site and the
devices that make up the site.
For more information, see the Graphics Editor Overview topic on WebHelp.
3.4.8 WebReports Overview

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

57
3.5 Protocols Overview

Building Operation supports the major communication protocols in building
automation and security management.
3.5.1 BACnet Overview

Building Operation is a native BACnet system with features that enable you to
create and manage an interoperable BACnet building automation system according
to the ASHRAE Standard. Building Operation features and components support the
BACnet services in all five of the BACnet interoperability areas.
For more information, see the BACnet Overview topic on WebHelp.
3.5.2 b3 BACnet Device Overview

b3 BACnet devices are a family of intelligent, programmable, stand-alone devices
that provide Direct Digital Control of air handlers and systems as well as individual
terminal units: VAV boxes, fan powered introduction units, unit ventilators, and heat
pumps.
For more information, see the b3 BACnet Device Overview topic on WebHelp.
3.5.3 LonWorks Overview

LonWorks is a fieldbus standard that is used for the automation of various functions
within buildings, such as lighting and HVAC. The platform is built on an open,
scalable protocol, called LonTalk that was developed by Echelon Corporation and
supported by LonMark International.
For more information, see the LonWorks Overview topic on WebHelp.
3.5.4 MNL LonWorks Device Overview

MNL LonWorks devices are a family of programmable, stand-alone devices that
provide direct digital control in a building's environmental control system. MNL
LonWorks devices consist of standard MNL LonWorks devices and MNL-800
LonWorks devices. MNL devices are complemented by S-Link sensors, which are
designed specifically for use with these devices.
For more information, see the MNL LonWorks Device Overview topic on WebHelp.
3.5.5 Xenta LonWorks Device Overview

The Xenta 280/300/401 LonWorks devices are a family of programmable, stand-
alone devices that provide Direct Digital Control of air handlers and systems as well
as individual terminal units.
For more information, see the Xenta LonWorks Device Overview topic on WebHelp.

58
3.5.6 Modbus Overview

Modbus is a master/slave protocol used for communicating with industrial
hardware. The protocol works by one master device requesting data from (or
writing data to) one or more slave devices.
For more information, see the Modbus Overview topic on WebHelp.
3.5.7 I/NET Overview

I/NET is an integrated building management system that uses software and a mix of
hardware to provide environmental control, access control, and energy
management solutions. I/NET uses a proprietary, token-passing communication
protocol, operating in a tiered LAN architecture.
For more information, see the I/NET Overview topic on WebHelp.
3.5.8 MicroNet Overview

MicroNet provides control of Heating, Ventilation, and Air Conditioning (HVAC)
devices such as fan coil units, heat pumps, rooftop units, boilers, and air handling
units
For more information, see the MicroNet Overview topic on WebHelp.
3.5.9 NETWORK 8000 Overview

The NETWORK 8000 system is a modular and integrated facility management
system.
For more information, see the NETWORK 8000 Overview topic on WebHelp.
3.5.10 I/O Modules Overview

All modules connect to a hardware terminal base backplane. When the I/O module
is installed on that terminal base, Building Operation associates the I/O module with
the position of the terminal base. There are a maximum of 32 positions per I/O bus
that any terminal base can occupy.
For more information, see the I/O Modules Overview topic on WebHelp.
3.5.11 Web Service Overview

Web Services are programmable applications accessible from standard Internet
protocols. You can use Web Services to consume information, such as
temperature from a weather service.
For more information, see the Web Services Overview topic on WebHelp.

59
3.6 Licensing, Installation, and Localization Overview
3.6 Licensing, Installation, and Localization

Overview
To be able to run Building Operations you need to install and licensing the software.
3.6.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.
For more information, see section 10.1 “Licensing Overview” on page 197.
3.6.2 Installation Overview

The Building Operation products are installed using installation packages.
For more information, see section 4.1 “Installation Overview” on page 63.
3.6.3 Regional and Language Overview

WorkStation presents language, date, time, currency, unit, and decimals according
to the user’s operating system settings.
For more information, see section 16.1 “Regional and Language Overview” on page
311.

60
4 Installation
Topics
Installation Overview
Products
Installation Example
Version Numbers and Parallel Installations
Installing the License Administrator and the License Server
Installing WorkStation and Client Tools
Installing a Language Pack
Installing the Enterprise Server
Installing the Device Administrator
4 Installation
4.1 Installation Overview

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.
4.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.
4.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 4.2 “Products” on page 66.
4.1.3 Installation Folder

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

63
4 Installation
4.1.4 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 4.3 “Installation Example” on page 70.
4.1.5 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.
For more information, see section 5.1 “Installation Reparation” on page 99.
4.1.6 Reinstall
To replace your current version, you start with the installation package of the
product you want to reinstall. If the installation package recognizes an earlier
installation of the 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 6.1 “Reinstallation ” on page 125.
4.1.7 System Upgrade Overview

A system upgrade can include an Enterprise Server, Reports Server, one or more
Automation Servers and WorkStations, and the supporting administrator software,
such as Device Administrator.
For more information, see the System Upgrade Overview topic on WebHelp.
4.1.8 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 165.
4.1.9 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.

64
4 Installation
For more information, see section 4.4 “Version Numbers and Parallel Installations”
on page 72.
4.1.10 Software Administrator

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

65
4 Installation
4.2 Products
4.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.
4.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
10.6 “Licenses” on page 205.
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 section 47.1 “WorkStation” on page 1377.
4.2.2 Graphics Editor

You can use Graphics Editor to create and edit graphics representing a site and the
devices that make up the site.
Important
You have to have a valid Graphics Editor license to start the Graphics Editor. For
more information, see section 10.6 “Licenses” on page 205.
The installation of Graphics Editor is bundled into the WorkStation installation

package.
For more information, see the Graphics Editor Overview topic on WebHelp.
4.2.3 Script Editor

Script Editor is a text programming tool you use to create Script programs that
control and monitor building automation systems. For example, in WorkStation, you
can create a basic program, called OfficeLights, to control lighting and ventilation in
a room based on occupancy.
Important
Ensure that you have a working and available Script license. A working license is
required to start Script. For more information, see section 10.6 “Licenses” on
page 205.

66
4 Installation
4.2 Products
The installation of Script Editor is bundled into the WorkStation installation package.
For more information, see the Script Editor Workflow topic on WebHelp.
4.2.4 Menta Editor

Menta Editor is a graphical programming tool for Xenta 208/300/401 LonWorks
device, which you use to create function block programs that control and monitor
building automation systems. For example, you create a program to control an air
handling unit.
Important
Ensure that you have a working and available Menta Editor license. A working
license is required to start the Menta Editor software. For more information, see
section 10.6 “Licenses” on page 205.
The installation of Menta Editor is bundled into the WorkStation installation

package.
TAC Menta, Technical Manual (04-00030).
4.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 10.6 “Licenses” on page 205.
The installation of Function Block Editor is bundled into the WorkStation installation
package.
For more information, see the Function Block Editor Overview topic on WebHelp.
4.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 10.6 “Licenses” on page 205.

67
4 Installation
4.2 Products
The installation of WorkPlace Tech is bundled into the WorkStation installation

package.
For more information, see the WorkPlace Tech Overview topic on WebHelp.
4.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
For more information, see the Enterprise Server topic on WebHelp.
4.2.8 Software Administrator

4.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 the Automation Server Firmware topic on WebHelp.
4.2.10 License Administrator

The License Administrator administers the activation, return, and repair of licenses.
For more information, see section 13.14 “License Administrator” on page 280.
4.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 13.1 “License Server” on page 259.

68
4 Installation
4.2 Products
The License Server Installation is bundled into the License Administration installation
package.
4.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 the WebReports Introduction topic on WebHelp.
4.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 section 16.3 “Language Packages” on page 313.

69
4 Installation
4.3 Installation Example

the license server.
License files used to activate time-limited local licenses can be distributed under
certain circumstances.
For more information, see section 11.10 “Local Licenses” on page 244.
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

70
4 Installation
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 11.2 “Network License
Management” on page 225.
• 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.

71
4 Installation
4.4 Version Numbers and Parallel Installations
4.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.

72
4 Installation
4.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.

73
4 Installation
4.5 Installing the License Administrator and the License Server
4.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 4.2 “Products” on page 66.
To install the License Administrator and License Server

1. Double-click on the License Administrator installation file to start the
installation wizard.
2. Click Yes, to confirm that you want to run the License Administrator
installation package.
3. Click Next.
Continued on next page

74
4 Installation
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree.
5. Browse to the folder where you want to install License Administrator and
License Server and then click Next.
Note
• This step only appears for the first Building Operation product
you install.
• Building Operation products that you install after this product,
are installed in the installation folder you selected for this
product.

75
4 Installation
6. Select the components you want to install and then click Next.
7. In the License Server Address box, type @ and then type the address to
the license server.
Note
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License
Servers.
8. Click Install.

76
4 Installation
9. Click Next.
Note
Click Show details to follow the progress of the installation.
10. Click 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 13.12 “Configuring License Server Recovery Settings ” on page 275.

77
4 Installation
4.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 10.6 “Licenses” on page 205.
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.
2. Click Yes, to confirm that you want to run the Workstation installation pakage.

78
4 Installation
3. Click Next.
then click I Agree.

79
4 Installation
5. Browse to the folder where you want to install WorkStation and client tools
and then click Next.
Note
you install.
product.
6. Select the components that you want to install and then click Next.

80
4 Installation
the license server.
Note
567@localhost.
Servers.
8. Click Install.
9. Click Next.

81
4 Installation
10. Click Finish.
Note

82
4 Installation
4.7 Installing a Language Pack

You install language packs to support languages other than English.
Note
• A WorkStation installation is a prerequisite to install additional language
packs.
• The version of the language pack to install must correspond with your
Workstation version.
To install language pack

1. Double-click on the language pack installation file to start the installation
wizard.
2. Click Yes, to confirm that you want to run the Workstation installation pakage.
3. Click Next.

83
4 Installation
then click I Agree.
5. Click Next.
Note

84
4 Installation
6. Click Finish.
The language to display in WorkStation is determined by the operating system

language on which the WorkStation is installed.

85
4 Installation
4.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
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.

86
4 Installation
3. Click Next.
then click I Agree.

87
4 Installation
5. Browse to the folder where you want to install Enterprise Server and then
click Next.
Note
you install.
product.
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 contain ASCII and Unicode
characters.

88
4 Installation
7. Click Next.
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 number 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.

89
4 Installation
the License Server.
Note
567@localhost.
Servers.
13. Click Install.

14. Click Next.
Note

90
4 Installation
15. Click Finish.

91
4 Installation
4.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.
To install the Device Administrator

1. Double-click on the Device Administrator installation file to start the installation
wizard.
2. Click Yes, to confirm that you want to run the Device Administrator installation
pakage.
3. Click Next.

92
4 Installation
then click I Agree.
5. Browse to the folder where you want to install Device Administrator and
click Next.
Note
you install.
product.

93
4 Installation
6. Select Device Administrator and then click Next.
7. Click Next.
Note

94
4 Installation
8. Click Finish.

95
5 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
5.1 Installation Reparation
5.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.

99
5.2 Repairing the License Administrator and the License Server
5.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.
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.

100
3. Select Stop.
6. Click Next.

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

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

installation.
10. Click Next.

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


103
the license server.
Note
567@localhost.
Servers.
14. Click Install.

15. Click Next.
Note

104
16. Click Finish.

105
5.3 Repairing WorkStation and Client Tools Installation
5.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.
To repair the WorkStation and client tool installation

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

106
3. Click Next.
then click I Agree.

107
5. Select the components that you want to repair and then click Next.
6. Select Repair current version.
7. Click Next.

108
the license server.
Note
567@localhost.
Servers.
9. Click Install.
10. Click Next.
Note

109
11. Click Finish.

110
5.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.
To repair the Enterprise Server

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

111
5. Click Stop Service.

wizard.
package.

112
8. Click Next.
then click I Agree.

113
10. Select Enterprise Server and then click Next.
11. Click Next.

114
12. In the Enterprise Server Installation Type, select Repair current

version to repair the current Enterprise Server installation.
13. Click Next.

17. Click Next.

115
the license server.
Note
567@localhost.
Servers.
19. Click Install.

20. Click Next.
Note

116
21. Click Finish.

117
5.5 Repairing the Device Administrator Installation
5.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.
To repair the Device Administrator installation

wizard.
package.

118
3. Click Next.
then click I Agree.

119
6. Select Repair current version.
7. Click Next.
8. Click Next.
Note

120
9. Click Finish.

121
6 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
6 Reinstallation
6.1 Reinstallation
6.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 58.7 “Backing Up Servers Manually”
on page 1621.
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.

125
6 Reinstallation
6.2 Reinstalling the License Administrator and the License Server
6.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.
To reinstall the License Administrator and License Server

Note
2. Right-click Building Operation x.x License Server.
3. Select Stop.

126
6 Reinstallation
6. Click Next.

127
6 Reinstallation
then click I Agree.
8. Select the components you want to reinstall and then click Next.

128
6 Reinstallation
9. Select Uninstall current version before reinstalling to reinstall the

current License Administrator installation.
10. Click Next.

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


129
6 Reinstallation
the license server.
Note
567@localhost.
Servers.
14. Click Install to start the installation procedure of License Administrator.


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

before the new version is installed.
16. Click Close.
Note

131
6 Reinstallation
17. Click Uninstall to uninstall the current installation of License Server before
the new version is installed.
18. Click Close.

132
6 Reinstallation
19. Click Next.
20. Click Finish to close the installation wizard.

133
6 Reinstallation
6.3 Reinstalling WorkStation and Client Tools
6.3 Reinstalling WorkStation and Client

Tools
You reinstall WorkStation and client tools to replace your current installation with a
fresh copy.
Important
For reinstallation, it is assumed that you already have working and available
WorkStation, Graphics, Script, and Menta / Function Block licenses. A working
license for each product is required to start and log on. If necessary, acquire the
needed licenses. For more information, see section 10.6 “Licenses” on page 205.
Note
When reinstalling the WorkStation, additional language packages are removed.
To reinstall WorkStation and client tool installation

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

134
6 Reinstallation
3. Click Next.
then click I Agree.

135
6 Reinstallation
5. Select the components that you want to reinstall and then click Next.
6. Select Uninstall current version before reinstalling.
7. Click Next.

136
6 Reinstallation
the license server.
Note
567@localhost.
Servers.
9. Click Install.
10. Click Uninstall to remove you current installation.

137
6 Reinstallation
11. Click Close.
Note
12. Click Next.

138
6 Reinstallation
13. Click Finish.

139
6 Reinstallation
6.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 15.5 “Stopping the Server
Windows Service” on page 303.
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 58.7 “Backing Up Servers Manually”
on page 1621.
To reinstall the Enterprise Server

1. Ensure that you have a backup of the Enterprise Server data.

140
6 Reinstallation

wizard.
package.

141
6 Reinstallation
9. Click Next.
then click I Agree.

142
6 Reinstallation
11. Select Enterprise Server and then click Next.
12. Click Next.

143
6 Reinstallation
13. Select Uninstall current version before reinstalling and then click
Next.
17. Click Next.

144
6 Reinstallation
the license server.
Note
567@localhost.
Servers.
19. Click Install.


145
6 Reinstallation
20. Click Uninstall to uninstall the current installation of Enterprise Server before
the new version is installed.
21. Click Close.
Note

146
6 Reinstallation
22. Click Next.
23. Click Finish.

147
6 Reinstallation
6.5 Reinstalling the Device Administrator Installation
6.5 Reinstalling the Device Administrator

Installation
You reinstall the Device Administrator to replace your current installation with a fresh
copy.
To reinstall the Device Administrator installation

wizard.
package.
3. Click Next.

148
6 Reinstallation
then click I Agree.

149
6 Reinstallation
6. Select Uninstall current version before reinstalling.
7. Click Next.
8. Click Uninstall to remove you current installation.
9. Click Close.
Note

150
6 Reinstallation
10. Click Next.

151
6 Reinstallation
11. Click Finish.

152
7 Computer Maintenance
Topics
Replace Enterprise Server or WebReports Computer
Workflow
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 workflow 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
58.8 “System Backup” on page 1624.
Stop Enterprise Server Windows service

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

155
Stop License Server Windows service

If you are upgrading the License Server, stop the License Server Windows service.
For more information, see section 13.3 “Stopping the License Server” on page 261.
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 4.8 “Installing the
Enterprise Server” on page 86.
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.

156
Figure: Restore Enterprise Database flowchart
Stop Reporting Agent Windows service

If your system includes WebReports, stop the Reporting Agent Windows service.
For more information, see the Stopping a Windows Service topic on WebHelp.
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 61.3 “Restoring a
Server” on page 1670.

157
Verify TCP protocol and server communication

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

Use Software Administrator (or the Services tool) to verify that the Enterprise Server
Windows service is running, which ensures that extended trend logging restarts.
For more information, see section 15.4 “Starting the Server Windows Service” on
page 302.
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 58.8
“System Backup” on page 1624.
Install WorkStation Language Pack

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

If you are using a language pack for WebStation, install the language pack and then
change the language in WebStation.
For more information, see section 4.7 “Installing a Language Pack” on page 83.
For more information, see section 16.6 “Changing the Language in WebStation” on
page 316.
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.

158
Figure: WebReports Migration Preparation flowchart
Detach WebReports database

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

Use Task Scheduler to export all the Reports schedules to a USB memory device.
For more information, see the Transferring Reports Schedules topic on WebHelp.
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.

159
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 the Configuring Windows Roles and Features
topic on WebHelp.
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 the Attaching a WebReports Database topic on WebHelp.

160
Confirm administrator role memberships for WebReports database

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

Run the WebReports installation package to install the WebReports Installer. For
more information, see the Installing the WebReports Installer topic on WebHelp.
Install WebReports and select upgrade option

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

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

161
8 Uninstallation
Topics
Uninstallation
Uninstalling the License Administrator
Uninstalling the License Server
Uninstalling a Language Package
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 11.6
“Removing a Local License or Returning a Network License” on page 234.
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 58.7 “Backing Up Servers Manually” on page 1621.
Client tools and language packages are uninstalled together with the uninstallation
of WorkStation.

165
8 Uninstallation
8.2 Uninstalling the License Administrator

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

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

166
8 Uninstallation
3. Select Schneider Electric StruxureWare Building Operation License

Administrator and then click Uninstall.
4. Click Uninstall.

167
8 Uninstallation
5. Click Close.
Note

168
8 Uninstallation
8.3 Uninstalling the License Server

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

1. Ensure that you have returned all activated network licenses before you
uninstall the License Server.
Note

169
8 Uninstallation
3. Right-click Building Operation License Server.
4. Select Stop.

170
8 Uninstallation

171
8 Uninstallation
7. Select Schneider Electric StruxureWare Building Operation License

Server and then click Uninstall.
8. Click Uninstall.

172
8 Uninstallation
9. Click Close.
Note

173
8 Uninstallation
8.4 Uninstalling a Language Package

You uninstall a language package before you uninstall Workstation.
To uninstall a language package


174
8 Uninstallation
3. Select the Schneider Electric StruxureWare Building Language Pack

and then click Uninstall.
4. Click Uninstall.

175
8 Uninstallation
8.5 Uninstalling WorkStation

You uninstall WorkStation to permanently remove the application from your
computer or server.
Important
Before you uninstall WorkStation, make sure that you do not have any language
pack installed. If you have language packs installed, you must uninstall them
before you uninstall WorkStation.
Note
• Client tools are uninstalled together with the uninstallation of WorkStation.
To uninstall WorkStation

176
8 Uninstallation
3. Select the Schneider Electric StruxureWare Building Operation

WorkStation and then click Uninstall.
4. Click Uninstall.
5. Click Close.

177
8 Uninstallation
8.6 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 58.7 “Backing Up Servers Manually” on page 1621.
To uninstall Enterprise Server

1. Ensure that you have a backup of the Enterprise Server data.

178
8 Uninstallation

179
8 Uninstallation

180
8 Uninstallation

Enterprise Server and then click Uninstall.
10. Click Uninstall.

181
8 Uninstallation
11. Click Close.
Note

182
8 Uninstallation
8.7 Uninstalling the Device Administrator

You uninstall a Device Administrator to permanently remove the application from
your computer or server.
To uninstall the Device Administrator


183
8 Uninstallation

Device Administrator and then click Uninstall.
4. Click Uninstall.

184
8 Uninstallation
5. Click Close.
Note

185
9 Installation User interface
Topics
Installation Wizard – Choose Components Page
Installation Wizard – Installation Type Page
Installation Wizard – License Server Configuration Page
Server Installation Wizard – Configuration Page
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 connect to Automation Servers
and upgrade them.
License Administrator Select to install the License Administrator,

which you use to configure and maintain the
license system.
License Server Select to install the license server, which you

use to manage network licenses.
WorkStation Select to install WorkStation, which you use

to configure and supervise your Building
Operation system.
Graphics Editor Select to install Graphics Editor, which you

use to create and edit graphics that
represent a site or device.
Script Editor Select to install Script Editor, which you use

to create custom script program for your
Building Automation System.

189
9.1 Installation Wizard – Choose Components Page
Continued
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 install Workplace Tech Editor,

which you use to program, modify, and
compile control applications for MNL
LonWorks devices.
Enterprise Server Select to install Enterprise Server, which you

use to administer your Building Operation
site. Software Administrator is also installed.

190
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

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.

191
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

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.

192
9.4 Server Installation Wizard – Configuration Page
9.4 Server Installation Wizard –

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

HTTP Port Type the port number that the Enterprise

Server listens to when communicating
through the Hypertext Transfer Protocol.
HTTPS Port Type the port number that the Enterprise

Server Server listens to when
communicating through a secure version of
the Hypertext Transfer Protocol.
TCP Port Type the port number that the Enterprise

through the Transmission Control Protocol.

193
10 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
10.1 Licensing Overview
10.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.
10.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 10.2 “License System” on page 198.
10.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 10.3 “License Management” on page 200.
10.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 10.4 “Service and Maintenance ” on page 202.

197
10.2 License System
10.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.
10.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.
10.2.2 License Server

server.
10.2.3 License Administrator


198
10.2 License System
10.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 10.6 “Licenses” on page 205.

199
10.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.
10.3.1 License System Installation and Configuration

the license server.
For more information, see section 4.3 “Installation Example” on page 70.

200
10.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 11.2 “Network License Management” on page
225.
10.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 computer. The
local license cannot be distributed and shared between different computers as the
network license can.
For more information, see section 11.11 “Local License Management” on page
245.

201
10.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.
10.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 13.13 “License Server Maintenance” on page
277.
10.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 10.5 “License Maintenance” on page 204.
10.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.

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

203
10.5 License Maintenance
10.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.
10.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.
10.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 11.4 “Network License Return” on page 229.
10.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 10.11 “Lost License” on page 213.
10.5.4 License Repair

A license can in several ways become damaged. Use the License Administrator to
repair a damaged network license on the license server where the damaged license
is located. Local licenses cannot be repaired. Instead you have to remove the
damaged local licenses and reactivate the licenses from new license files.
For more information, see section 10.12 “License Repair” on page 214.
10.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.
This backup is primarily intended for cases when hardware or the operating system
malfunctions.
For more information, see section 10.13 “License Backup” on page 215.

204
10.6 Licenses
10.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 used to activate time-limited local licenses can be distributed under
certain circumstances.
For more information on how to order licenses, please contact your Building
Operation vendor.
10.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.
10.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 used to activate local licenses can only be used once per computer and is
typically time-limited.

205
10.6 Licenses
10.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 network-wide.
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 11.1 “Network Licenses ” on page 221.
10.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.
These licenses are distributed as local licenses.
Note
To avoid critical stops, purchase permanent licenses before the time limited-
licenses expire.
10.6.5 Permanent License

A permanent license does not expire.
Note
To avoid critical stops, purchase permanent licenses before the time limited-
licenses expire.
10.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 10.9 “License Selection Process” on page 210.

206
10.7 Viewing Activated Licenses
10.7 Viewing Activated Licenses

You view all the activated licenses on a license server, WorkStation, or Enterprise
Server.
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.

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

208
7. In the Telephone number box, type the telephone number to the account
manager that supplied the license.
8. Click OK.
9. Click 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.

209
10.9 License Selection Process
10.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.

210
10.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
Figure: Work flow when requesting order information

211
Table: Request Order Information

Number Description
1 The Entitlement ID, which contains the

licenses to activate, is entered into the
License Administrator.
2 The License Administrator sends the

entitlement ID to the License Activation
Server.
3 The License Activation Server sends the

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

212
10.11 Lost License
10.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.

213
10.12 License Repair
10.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 network license

214
10.13 License Backup
10.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.
This backup is primarily intended for cases when hardware or the operating system
malfunctions.
Backed up licenses can only be restored on the same license server that the files
were backed up from. If you plan to move the licenses to another 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 10.12 “License Repair” on page 214.

215
10.14 Backing Up Licenses
10.14 Backing Up Licenses

You back up licenses to easily restore them if something unexpected happens.
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 folder:
• Windows XP: \Documents and Settings\All Users\Application
Data\FLEXnet
3. Copy all files in the FLEX-net folder that start with taclic_ and paste the files
onto your external backup resource.

216
10.15 Restoring Licenses
10.15 Restoring Licenses

You restore the license data from a backup to restore a corrupt or non-functioning
license server.
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:
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 11.9
“Repairing a Network License ” on page 242.
You now restart the license server so you can check out the restored licenses. For
more information, see section 13.4 “Restarting the License Server” on page 262.

217
11 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
11 Type of Licenses
11.1 Network Licenses

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

221
11 Type of Licenses
Figure: A network license is activated on a license server and can be checked out by any
computer in the network.

222
11 Type of 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 license 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.

223
11 Type of 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.

224
11 Type of Licenses
11.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
11.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 10.10 “Order Information Request” on page 211.
11.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 11.3 “Network Licenses Activation” on page 227.
11.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 12.1 “Enterprise Server Address Configuration”
on page 251.

225
11 Type of Licenses
11.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 12.2 “WorkStation and Client Tools Address
Configuration” on page 253.
11.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 11.7 “Network License Upgrade” on page 236.

226
11 Type of Licenses
11.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.

227
11 Type of Licenses
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.

228
11 Type of Licenses
11.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.

229
11 Type of Licenses
Note
• All licenses that were activated in same transaction are returned to the
License Activation Server.

230
11 Type of Licenses
11.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.
To activate network licenses

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

231
11 Type of 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.
5. In the Activate column, select the number of license to activate.
6. Click Activate.

232
11 Type of Licenses
7. Click 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.

233
11 Type of Licenses
11.6 Removing a Local License or Returning a Network License
11.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

2. Select the local license to remove or the network license to return.
3. On the Licenses toolbar, click the Remove/return license button .


234
11 Type of Licenses
11.6 Removing a Local License or Returning a Network License
4. Click Yes.
5. Click Close.
6. Click Restart now, to apply the changes to the license server.

235
11 Type of Licenses
11.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.

236
11 Type of Licenses
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.

237
11 Type of Licenses
11.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 11.7 “Network License Upgrade” on page 236.
To upgrade network licenses


238
11 Type of 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.

239
11 Type of 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.
7. Click Yes to confirm that all network licenses with the old version, included in
the entitlement, are returned to the License Activation Server.

240
11 Type of Licenses
8. Click Close.
9. Click Restart now, to restart the license server and make the upgraded
licenses available for checkout.

241
11 Type of Licenses
11.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 10.12 “License Repair” on page 214.
To repair a network license

2. Select the network license that you want to repair.
3. On the Licenses toolbar, click the Repair license button .

4. Click Yes.

242
11 Type of Licenses
5. Click Close.
6. Click Restart now, to restart the license server and make the repaired
licenses available for checkout.
The license is now repaired and available to be checked out.

243
11 Type of Licenses
11.10 Local Licenses
11.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 used to activate local licenses can only be used once per computer and is
typically time-limited.
Figure: A local license is activated on the computer that will use it and cannot be shared
with other computers.
For more information on how to order additional licenses, please contact your
Schneider Electric vendor.
Note
After removing a local license, you must restart the computer or server before a
similar network license can be checked out.

244
11 Type of Licenses
11.11 Local License Management
11.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 computer. The
local license cannot be distributed and shared between different computers as the
network license can.
For more information on how to order additional license files or license files for client
tools, please contact your Building Operation vendor.
11.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

245
11 Type of Licenses
11.12 Activating a Local License

You activate a local license on a WorkStation, client tool, or Enterprise Server
computer, to have as a substitute until you have set up a Building Operation system
with available network licenses.
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.
To activate a local license

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

246
11 Type of Licenses
3. Select the license file and then click Open.
4. Click Close.

247
11 Type of Licenses
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.

248
12 Licensing Configuration and
Diagnostics
Topics
Enterprise Server Address Configuration
WorkStation and Client Tools Address Configuration
Viewing Diagnostic Information
Copying Diagnostics to the Clipboard
12 Licensing Configuration and Diagnostics
12.1 Enterprise Server Address Configuration
12.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.

251
12.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 15.8 “Viewing Enterprise
Server System Log” on page 306.

252
12.2 WorkStation and Client Tools Address Configuration
12.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.

253
12.3 Viewing Diagnostic Information
12.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.
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.

254
12.4 Copying Diagnostics to the Clipboard
12.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.
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.

255
13 License Server and License
Administrator
Topics
License Server
Starting the License Server
Stopping the License Server
Restarting the License Server
Flexnet License Administrator, License Server Manager
Accessing Flexnet lmadmin
Changing the Flexnet lmadmin License Server Manager Port
Number
License 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 License Administrator
13 License Server and License Administrator
13.1 License Server
13.1 License Server

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
13.12 “Configuring License Server Recovery Settings ” on page 275.
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 13.14
“License Administrator” on page 280.
13.1.1 Flexnet License Manager, License Server

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

259
13.2 Starting the License Server
13.2 Starting the License Server

You manually start the license server, if the service does not start automatically with
the operating system.
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.
3. Select Start.
For more information about the Service management console, please refer to the
operating system manufacturer’s manual.

260
13.3 Stopping the License Server
13.3 Stopping the License Server

You manually stop the license server, if the service is running.
To stop the license server

1. On the license server computer, open the Service management console.
3. Select Stop.

261
13.4 Restarting the License Server
13.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.
To restart the license server

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

262
13.5 Flexnet License Administrator, License Server Manager
13.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.

263
Figure: FLEXnet License Administrator, Administration part.

For more information about FLEXnet License Administrator, click the FLEXnet
License Administrator Help button .
13.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.

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

265
13.6 Accessing Flexnet lmadmin
13.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.
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.
For more information, click the Flexnet lmadmin Help button .

266
13.7 Changing the Flexnet lmadmin License Server Manager Port Number
13.7 Changing the Flexnet lmadmin License

Server Manager Port Number
You change the port number of the Flexnet lmadmin license server manager if the
default port 8888 is dedicated to other application or blocked by your firewall.
To change the Flexnet 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, 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 Flexnet lmadmin license server manager, open a web browser and
type in the address to the license server with the new port number.

267
13.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
14650@192.166.248.2 Connects to license server 192.166.248.2

through port 14650
To separate license server addresses in License Administrator, use a semicolon.

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

269
13.9 Configuring the Address to the License Server
13.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 11.6 “Removing a Local License or Returning a
Network License” on page 234.
For more information, see section 11.2 “Network License Management” on page
225.
To configure the address to the license server

1. In License Administrator, click the Licenses server address view.

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

271
13.10 License Server Reset
13.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
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.

272
13.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 13.10 “License Server Reset” on page 272.
To reset the license server

2. Select all network licenses.
3. On the Licenses toolbar, click the Remove/return license button .


273
4. Click Yes.
5. Click 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:
Data\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.

274
13.12 Configuring License Server Recovery Settings
13.12 Configuring License Server Recovery

Settings
You configure the license server recovery settings to ensure that the license server
restarts if it unexpectedly stops.
To configure the license server recovery settings

Note
In Windows, open the Run dialog box and type services.msc.
3. Select Properties.

275
13.12 Configuring License Server Recovery Settings
4. Click the Recovery tab.
5. In the First failure box, select Restart the Service.

6. In the Second failure box, select Restart the Service.
7. In the Subsequent failures box, select Restart the Service.
8. Click OK.

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

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

278
13.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 13.10 “License Server Reset” on page 272.

279
13.14 License Administrator
13.14 License Administrator

13.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 of 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.
13.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.
Important
You have to add an 'at' sign (@) in front of the license server host address or DNS
name. Failing to do so means that Building Operation applications will not be able
to check out licenses from the license server.

280
13.15 Starting License Administrator
13.15 Starting License Administrator

You start License Administrator to administer the licenses on the license server and
define the address to the license servers for all licensed Building Operation
products.
To start License Administrator

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

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

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


285
Continued
Telephone number Type the phone number of the account


286
14.2 Licenses View
14.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 14.3 “Licenses View Toolbar” on
page 288.
Use the Licenses view columns to view

information about activated licenses. For
more information, see section 14.5
“Licenses View Columns” on page 290.
Use the Licenses view icons to get

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

287
14.3 Licenses View Toolbar
14.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.

288
14.4 Licenses View Icons
14.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.

289
14.5 Licenses View Columns
14.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.

290
14.6 Add License Dialog Box
14.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

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.

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

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.

292
Continued
Activate (button) Click to activate the selected number of

licenses.

293
14.8 License Progress Dialog Box
14.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

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.

294
14.9 License Server Address View
14.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

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.

295
14.10 Diagnostics View
14.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.

296
15 Software Administrator
Topics
Software Administrator
Starting Software Administrator
Configuring Server Port Settings
Starting the Server Windows Service
Stopping the Server Windows Service
Restarting the Server Windows Service
Enterprise Server System Log
Viewing Enterprise Server System Log
Software Administrator – Enterprise Server View
15.1 Software Administrator
15.1 Software Administrator

Other Enterprise Server settings, for example e-mail service, time, and time zone
settings are configured through WorkStation.
15.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.
15.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.
15.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.
15.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.

299
15.2 Starting Software Administrator
15.2 Starting Software Administrator

You start Software Administrator to be able to configure the port settings of the
Enterprise Server or the Project Configuration Server.
To start Software Administrator

1. Click Start, point to All Programs, and then click Schneider Electric
StruxureWare.

300
15.3 Configuring Server Port Settings
15.3 Configuring Server Port Settings

You configure server HTTP and TCP ports to define the communication of the
different protocols. In the Software Administrator you can configure either the ports
of the Enterprise Server.
To configure server ports

1. In Software Administrator, click the tab of the Enterprise Server.

3. In the HTTP Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Protocol.
4. In the HTTPS Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Secure Protocol.
5. In the TCP Port box, type the port number that the server listens to when
communicating through the Transmission Control Protocol.
6. Click Apply.
7. Click Start Service.

301
15.4 Starting the Server Windows Service
15.4 Starting the Server Windows Service

You start the server manually in case you previously have stopped it.
Important
Ensure that you have a working and available license. A working license is
required to start the server. For more information, see section 10.6 “Licenses” on
page 205.
Note
• An Enterprise Server is automatically started when installed and when
Windows is started.
To start the server Windows service

1. In the Software Administrator, click the tab of the Enterprise Server.

302
15.5 Stopping the Server Windows Service
15.5 Stopping the Server Windows Service

You stop the Enterprise Server to configure the port settings or to repair,
upgrade, or reinstall the Enterprise Server.
To stop the Server Windows service

1. In Software Administrator, click Stop Service.

303
15.6 Restarting the Server Windows Service
15.6 Restarting the Server Windows Service

You restart the Enterprise Server to reset or apply new settings.
Important
Ensure that you have a working and available server license. A working license is
required to start the server. For more information, see section 10.6 “Licenses” on
page 205.
To restart the server Windows service

1. In the Software Administrator, click the tab of the server that you want to
restart.

304
15.7 Enterprise Server System Log
15.7 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.

305
15.8 Viewing Enterprise Server System Log
15.8 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 15.7 “Enterprise Server System Log” on page
305.
To view the Enterprise Server system log

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

306
15.9 Software Administrator – Enterprise Server View
15.9 Software Administrator – Enterprise

Server View
Use the Enterprise Server view to start and stop the Enterprise Server service
Table: Enterprise Server View

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

through the Hypertext Transfer Protocol.
HTTPS Port Type the port number that the Enterprise

through the Hypertext Transfer Protocol
Secure.
TCP Port Type the port number that the Enterprise

through the Transmitting Control Protocol.
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.

307
16 Localization Language and
Units
Topics
Regional and Language Overview
Configuring Regional Settings
Language Packages
Changing WorkStation Language
Adding a Language in WebStation
Changing the Language in WebStation
Value Presentation
Units
Adding or Changing a Unit and Prefix for a Value
Metric Prefixes
Precision Format
Adding a Unit Conversion Exception
Removing a Unit Conversion Exception
16 Localization Language and Units
16.1 Regional and Language Overview
16.1 Regional and Language Overview

WorkStation presents language, date, time, currency, unit, and decimals according
to the user’s operating system settings.
The date, time, or value format can differ between clients that have the same
language and cultural convention.
For example, a user customizes the French date setting to yyyy-mm-dd in the
operating system. The next time WorkStation starts on this client, all dates are
displayed as yyyy-mm-dd instead of the French standard dd/mm/yyyy. Other
clients with French original settings still display dates with the French standard
dd/mm/yyyy.
16.1.1 Language and Translation Packages

Building Operation supports a lot of different languages. To be able to install a new
language you need a language pack.
16.1.2 Value Presentation

Building Operation handles values and numbers with the highest precision. The unit
of a value is converted according to the user’s operating system where WorkStation
is installed. Units of measure are not converted in the following WorkStation
screens:
• Alarms and trend logs in wizards
• Customized alarm views
• Alarm and trend log properties panes
For more information, see section 16.7 “Value Presentation” on page 317.
16.1.3 Time and Time Zone

A time zone is a region on the earth that has a uniform standard time, usually
referred to as the local time. Local time is the UTC time plus the current time zone
offset for the considered location. Some time zones also have an offset called DST
added during the summer period. The DST offset is typically +1 hour.
For more information, see section 17.1 “Time and Time Zone” on page 329.

311
16.2 Configuring Regional Settings
16.2 Configuring Regional Settings

You change the presentation of date, units of measure, time, and time zone in
WorkStation or Enterprise Server by changing your operating system regional
settings.
For more information, see section 16.1 “Regional and Language Overview” on page
311.
To change regional settings

1. Close all Building Operation-related applications.
2. For more information on how to change the regional settings, please refer to
the manufacturer’s manual for the operating system.
Next time WorkStation starts, the new regional settings are used.

312
16.3 Language Packages
16.3 Language Packages

Building Operation supports a lot of different languages. To be able to install a new
language you need a language pack.
16.3.1 Languages in WorkStation

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.
The operating system language of the computer on which WorkStation is installed
determines the language that WorkStation displays in. For example, if the language
of an operating system is Spanish, WorkStation is displayed in Spanish, provided
that the Spanish language packages are installed
WorkStation and servers are built on a multilingual language platform that supports
all characters included in the Basic Multilingual Plan, http://unicode.org.
Some operating systems support multi-language use which means that you can
change the language of the operating system. For more information, refer to the
manufacturer’s manual for the operating system.
The language packages are version sensitive, the version of the language package
must correspond with the version of WorkStation. If you upgrade your current
WorkStation, you must also upgrade your language package version.
16.3.2 Languages in WebStation

The default language in WebStation is English but this can be changed. The
language pack for the language has to be installed on the Building Operation server
you are connected to using WebStation. Changing the language settings in
WebStation only affects the language in your web browser.
The language setting uses session cookies. When you clear the web browser's
cache so that the cookie is deleted, you have to change the language once again.
You can change back to the original language or another language if the language
pack for the selected language is installed on the server you are connected to.
To be able to install a language pack on the server, you need the language pack file
supplied by Schneider Electric.

313
16.4 Changing WorkStation Language
16.4 Changing WorkStation Language

You change the language of WorkStation by changing the language of the
operating system. You also need to have the corresponding language package
installed on your WorkStation.
To change workstation language

2. For more information on how to change your operating system language, refer
to the manufacturer’s manual for the operating system.

314
16.5 Adding a Language in WebStation
16.5 Adding a Language in WebStation

You add a language to WebStation so that the user is able to change to this
language.
Important
To add a language in WebStation, you must log on with a user account that
belongs to a user account group that has the property May access device
configuration selected in the Policies view.
Note
When the Enterprise Server or Automation Server is upgraded, the language pack
in WebStation must be added once again.
To add a language in WebStation

1. In WebStation, log on to the Building Operation server you want to add the
language to.
2. On the main toolbar, on the Settings menu, click Add or remove
language.
3. Click Add.
4. Browse to the language pack .zip file for the language you want to add.
5. Click Open.
6. Click OK.

315
16.6 Changing the Language in WebStation
16.6 Changing the Language in WebStation

You change the language in WebStation to adapt WebStation to a new region.
For more information, see the Regional Settings topic on WebHelp.
To change the language in WebStation

1. In WebStation, on the Main toolbar, click Settings.
2. Click Change regional settings.
3. Select the language you want to use.
4. Click OK.

316
16.7 Value Presentation
16.7 Value Presentation

Building Operation handles values and numbers with the highest precision. The unit
of a value is converted according to the user’s operating system where WorkStation
is installed. Units of measure are not converted in the following WorkStation
screens:
16.7.1 Units
Building Operation supports both the SI metric system and the US Customary
System for units of measurement. The operating system regional settings on which
WorkStation is installed determine whether SI units or US Imperial units are
displayed. The conversion between the two measurement systems is managed
automatically. Units of measure are not converted in the following WorkStation
screens:
For more information, see section 16.8 “Units” on page 318.
16.7.2 Metric Prefixes

WorkStation supports the metric prefix range from yocta (10-24) to yotta (1024). The
use of a prefix is optional and is defined together with the unit.
For more information, see section 16.10 “Metric Prefixes” on page 322.
16.7.3 Precision Format

Values in Building Operation are stored in the Building Operation database with all
input decimals. If a stored value consists of more decimals than the operating
system is defined to display, the value is rounded off according to the operating
system settings before it is displayed in WorkStation.
For more information, see section 16.11 “Precision Format” on page 323.

317
16.8 Units
16.8 Units
Building Operation supports both the SI metric system and the US Customary
System for units of measurement. The operating system regional settings on which
WorkStation is installed determine whether SI units or US Imperial units are
displayed. The conversion between the two measurement systems is managed
automatically. Units of measure are not converted in the following WorkStation
screens:
For example, the temperature 42,82 °C is stored in Building Operation. A
WorkStation on an operating system with the US Customary System converts the
temperature and displays it as 109.08 °F.
To display the original unit of a value in WorkStation, open the Properties pane for
the value and go to the Unit selection dialog box.
Important
• Building Operation converts the unit of a variable independent of its context.
To correctly convert a delta temperature, the unit of the delta value must
belong to the unit category Temperature Diff.
16.8.1 Delta Temperature Conversion

The conversion between Celsius and Fahrenheit or Fahrenheit and Kelvin is not a
simple coefficient (multiplier) like other unit categories as for example length,
pressure, currency, and Energy. Due to the conversion formula when for example
converting an absolute Fahrenheit temperature to Celsius, T°F=T°C x 9/5 + 32, you
have both a multiplier and an offset to consider. To correctly convert a delta
temperature from Fahrenheit to Celsius you have to use the formula DT°F = 9/5
DT°C.
For more information, see the Delta Temperature Conversion topic on WebHelp.

318
16.9 Adding or Changing a Unit and Prefix for a Value
16.9 Adding or Changing a Unit and Prefix

for a Value
You define and change the unit and its prefix for a value to ensure that the value is
correct calculated.
To add or change a unit and prefix for a value

1. In WorkStation, in the System Tree pane, select the value or point you want
to configure.
2. On the File menu, click Properties.
3. Click the Value Configuration button .

319
4. Select the Configured box that is in front of the Unit box.
5. In the Unit box, click the Browse button .

6. Select the unit.

320
7. In the Prefix box, select the prefix of the unit.

8. Click Select.
9. In the Value dialog box, click OK.
10. In the Properties dialog box, click OK.

321
16.10 Metric Prefixes
16.10 Metric Prefixes

WorkStation supports the metric prefix range from yocta (10-24) to yotta (1024). The
use of a prefix is optional and is defined together with the unit.
10n Decimal Prefix Symbol
10-24 0.000 000 000 000 yocto y

000 000 000 001
10-21 0.000 000 000 000 zepto z

000 000 001
10-18 0.000 000 000 000 atto a

000 001
10-15 0.000 000 000 000 femto f

001
10-12 0.000 000 000 001 pico p
10-9 0.000 000 001 nano n
10-6 0.000 001 micro µ
10-3 0.001 milli m
- - - -
103 1 000 kilo K
106 1 000 000 mega M
109 1 000 000 000 giga G
1012 1 000 000 000 000 tera T
1015 1 000 000 000 000 peta P

000
1018 1 000 000 000 000 exa E

000 000
1021 1 000 000 000 000 zetta Z

000 000 000
1024 1 000 000 000 000 yotta Y

000 000 000 000
If a value has, for example, kilo as prefix, it is presented in WorkStation with the k-
prefix independent of the number of decimals. When conversion of a unit that has a
prefix, WorkStation removes the prefix and presents the converted value in the
operating system settings default measurement unit without the prefix.
For example, A value of 15 is created with the unit set to meter and with the milli
prefix (10-3), which gives 15 millimeter. A WorkStation on an operating system with
US Customary converts the value to 0.016 yards. This is because of the milli prefix
(10-3) is removed and the Building Operation US customary default length unit is
yard.

322
16.11 Precision Format
16.11 Precision Format

Values in Building Operation are stored in the Building Operation database with all
input decimals. If a stored value consists of more decimals than the operating
system is defined to display, the value is rounded off according to the operating
system settings before it is displayed in WorkStation.
For example, you enter the length 6.5282 m (21.4179 ft) to a variable in Building
Operation. When you press Enter or OK, the value changes to 6.53 m (21.41 ft).
This becouse of your operating system, in this example, is defined to display only
two decimals The input value 6.5282 m (21.4179 ft) is stored in the Building
Operation database but is round off to 6.53 m (21.41 ft) when it is displayed.
Note
• The rounded value is only a display value and is not used by Building
Operation in calculations or other operations.
If an integer value exceeds 12 digits (1012), both positive and negative numbers,
WorkStation displays the value in scientific notation. The number of digits for a
decimal number before it is displayed in scientific notation is decided by the regional
settings of the operating system settings where WorkStation is installed.

323
16.12 Adding a Unit Conversion Exception

You add unit conversion exceptions to override regional settings within a domain.
To add a unit conversion exception

1. In WorkStation, on the Tools menu, click Control Panel.
2. Click Domain.
3. In the Domains list, select a domain for the unit conversion exception.
4. Click Unit Conversion Exceptions.
5. Click Add.

324
6. In the Unit Selection dialog box, select the unit for which you want a
conversion exception.
7. Click Select.
8. In the SI Display Unit column, enter how the configured unit will be
displayed on an SI metric system.
9. In the US Display Unit column, enter how the configured unit will be
displayed on a US customary system.
10. Click the Save button .

325
16.13 Removing a Unit Conversion Exception
16.13 Removing a Unit Conversion Exception

You remove unit conversion exceptions to return to regional default settings within a
domain.
To remove a unit conversion exception

2. Click Domain.
3. In the Domains list, select the domain where you want to remove a unit
conversion exception.
4. Click Unit Conversion Exceptions.
5. Select the entry, that is the unit conversion exception, that you want to
remove.
6. Click Remove.

326
17 Localization Time and Time
Zone
Topics
Time and Time Zone
Lead and Shadow Relationship
Time and Time Zone Configuration in WorkStation
Time and Time Zone Configuration in Enterprise Server
Time and Time Zone Configuration in Automation Server
Changing the Time Zone of an Enterprise Server or
Automation Server
Creating a Custom Time Zone of an Enterprise Server or
Automation Server
Configuring Enterprise Server and WorkStation Date and
Time
Synchronizing the Automation Server Clock
Manually Changing the Automation Server Time and Date
Network Time
Synchronize Network Time Settings
Synchronizing Time Settings on Multiple Automation Servers
Synchronize Time Zone Settings
Synchronizing Time Zone Settings on Multiple Automation
Servers
17 Localization Time and Time Zone
17.1 Time and Time Zone
17.1 Time and Time Zone

17.1.1 Network Time

Consistent date and timestamping across a network is critical for system wide
access control, security, communications, scheduling, alarms, and events. Network
time uses the NTP protocol that provides the correct current UTC time.
For more information, see section 17.11 “Network Time” on page 344.
17.1.2 Time and Time Zone Configuration in

WorkStation
In WorkStation, all times are by default displayed in local time. This means that a
time, independent of its source, is displayed in the same time zone as the operating
system on which WorkStation is installed. By configuring the operating system time
and time zone settings, you configure how times are displayed in WorkStation. For
more information, please refer to the manufacturer’s manual for the operating
system.
For more information, see section 17.3 “Time and Time Zone Configuration in
WorkStation” on page 332.

Enterprise Server
The Enterprise Server time and date settings are configured through the operating
system settings on which the Enterprise Server is installed. The time zone offset,
configured through the Enterprise Server, is added by Building Operation to the
UTC time. The Enterprise Server time zone settings are therefore independent of
the operating system time zone settings.

Automation Server
To adjust the Automation Server time, time zone, and DST, you have to access the
Automation Server through a WorkStation.
Automation Server” on page 334.

329
17.2 Lead and Shadow Relationship

For some objects on the Enterprise Server and Automation Server, for example the
time zone object and schedule object, you can establish a lead and shadow
relationship. You can also establish lead and shadow relationships between graphic
elements. A shadow object automatically synchronizes settings from its connected
lead object. A lead and shadow relationship can only be established between
objects of the same kind.
For example, an Enterprise Server and three individual Automation Servers are
located in same time zone region. Instead of individually configuring all the servers
time zone, a lead and shadow relationship is established. The Enterprise Server is
the lead object and the three Automation Servers are shadow objects. With this
relationship, the Enterprise Server time zone settings are reflected and used by the
three Automation Servers.
Figure: Changes in the lead object are automatically reflected in the connected shadow
objects
When you set up a lead and shadow relationship, you define which object is the
lead object in the properties of the shadow object. For example, to synchronize an
Automation Server object with an Enterprise Server object, you define the lead
object, in this case the Enterprise Server object, in the properties of the Automation
Server.

330
A server on a higher level, such as an Enterprise Server, typically acts as the lead.
However, a lead and shadow relationship can be established between two
Automation Servers.
17.2.1 Synchronize Network Time Settings

You can establish a lead and shadow relationship to synchronize the time on all
your Automation Servers with the same network time server. The Date and Time
object on the lead server contains the network time server addresses that are
inherited by shadow servers.
For more information, see section 17.12 “Synchronize Network Time Settings” on
page 345.
17.2.2 Synchronize Time Zone Settings

You can establish a lead and shadow relationship to synchronize the time zone
settings on all your Enterprise Servers and Automation Servers. The Time Zone
object on the lead server contains the time zone settings that are inherited by
shadow servers.
For more information, see section 17.14 “Synchronize Time Zone Settings” on page
349.
17.2.3 Synchronize Schedules and Calendars

When you configure a schedule that controls events in a single part of a building,
you might also want the same events to occur in other areas of the building. You
can establish a lead and shadow relationship to synchronize the events in
schedules and dates in calendars.
For more information, see section 45.13 “Schedule and Calendar Synchronization”
on page 1344.
17.2.4 Set Inheritance Between Graphic Elements

When you design a graphic, you might want to apply the same properties on
several graphic elements. You can establish a lead and shadow relationship to
apply a property of one element on one or several other elements located deeper
down in the hierarchy.

331
17.3 Time and Time Zone Configuration in WorkStation
17.3 Time and Time Zone Configuration in

WorkStation
In WorkStation, all times are by default displayed in local time. This means that a
time, independent of its source, is displayed in the same time zone as the operating
system on which WorkStation is installed. By configuring the operating system time
and time zone settings, you configure how times are displayed in WorkStation. For
more information, please refer to the manufacturer’s manual for the operating
system.
Figure: WorkStation displays all times as local time, according to the operating system
settings on which WorkStation is installed.
For example, a WorkStation in Athens surveys a server in New York. WorkStation in
Athens has a Greek operating system, which is configured to Eastern European
Summer Time (UTC +2h) with +1h DST offset. The New York server triggers an
alarm at 07:43 Eastern time. WorkStation instantly reports the alarm but presents
the alarm with the timestamp 14:43 which is the local time in Greece.
Some features in WorkStation, such as trend log and schedule, allow you to change
the displayed time to UTC or server local time.
17.3.1 Server Time in WorkStation

The exception in WorkStation is the Local Date & Time property for the time on
an Automation Server where the time is displayed in local server time and not in the
perspective of WorkStation and its operating system.

332
17.4 Time and Time Zone Configuration in Enterprise Server

Enterprise Server
The Enterprise Server time and date settings are configured through the operating
system settings on which the Enterprise Server is installed. The time zone offset,
configured through the Enterprise Server, is added by Building Operation to the
UTC time. The Enterprise Server time zone settings are therefore independent of
the operating system time zone settings.
Figure: The Enterprise Server uses the operating system clock on which the server is
installed. Time zone offset and DST are then added by Building Operation to the UTC
time.
To adjust your operating system clock, refer to your manufacturer’s manual for the
operating system. The Enterprise Server time zone is configured on the Enterprise
Server through WorkStation
Note
• The Date and Time synchronization for Automation Server do not
affect the Enterprise Server clock. For more information, see section 17.12
“Synchronize Network Time Settings” on page 345.

333
17.5 Time and Time Zone Configuration in Automation Server

Automation Server
When adjusting the server clock, you can either set the time manually or you can
refer to a network time server that automatically synchronizes the clock. Beside
predefined time zones, you can also customize the Automation Server time zone
settings.
When adjusting the Automation Server time through WorkStation, it is the
Automation Server operating system clock you adjust. Building Operation has a
transparent layer above the Automation Server operating system which manages
the information about the time zone and DST time offset.
Figure: The Automation Server uses the operating system clock to which Building
Operation adds the time zone offset and DST
Instead of configuring the time of each Automation Server, you can create a lead
and shadow relationship that makes it possible to configure several Automation
Servers through a single Enterprise Server.

334
17.6 Changing the Time Zone of an Enterprise Server or Automation Server
17.6 Changing the Time Zone of an

Enterprise Server or Automation Server
You change the time zone of an Enterprise Server or Automation Server to adjust
the UTC offset according to the region where the server is located.
To change the time zone of an Enterprise Server or

Automation Server
2. In the Server box, select the server you want to configure.
3. Click Network time and time zones.


335
17.6 Changing the Time Zone of an Enterprise Server or Automation Server
4. Select Predefined time zone and then select the time zone the server is
located in.
5. On the File menu, click Save.

If your time zone is not listed, you can create and configure a custom time zone.

336
17.7 Creating a Custom Time Zone of an Enterprise Server or Automation Server
17.7 Creating a Custom Time Zone of an

Enterprise Server or Automation Server
If your time zone is not listed in Predefined time zone, you create and configure
a custom time zone for the Enterprise Server or Automation Server.
For more information, see section 17.1 “Time and Time Zone” on page 329.
To customize a time zone of an Enterprise Server or

Automation Server
1. On the Tools menu, click Control Panel.
2. In the Control Panel, in the Server box, select the server you want to
configure.


337
17.7 Creating a Custom Time Zone of an Enterprise Server or Automation Server
4. Select Custom time zone.
5. In the Description box, type a description of the time zone.

6. In the UTC offset box, select in hours and minutes the time zone offset from
UTC.
Note
• The UTC offset is positive east of Greenwich. For example, the
time offset for Eastern Time is UTC -05:00 hours.
7. Select This custom time zone uses daylight saving time to have the
time zone automatically updated for daylight saving time.
8. In the Time adjustment box, select the daylight saving time offset in
minutes.
9. In the Start column, select the month, week, day, and time the daylight saving
time starts.
10. In the End column, select the month, week, day, and time the daylight saving
time ends.

338
17.8 Configuring Enterprise Server and WorkStation Date and Time
17.8 Configuring Enterprise Server and

WorkStation Date and Time
You adjust the date and time of an Enterprise Server or WorkStation through the
operating system where the server or client is installed.
WorkStation” on page 332.
To configure the Enterprise Server and WorkStation date and

time
2. For more information on how to adjust the date and time, refer to the
manufacturer’s manual for the operating system.
Note
The time zone settings for an Enterprise Server are configured through
WorkStation and not the operating system.

339
17.9 Synchronizing the Automation Server Clock
17.9 Synchronizing the Automation Server

Clock
You configure the Automation Server to synchronize its clock with a network time
server.
For more information, see section 17.11 “Network Time” on page 344.
To synchronize the Automation Server clock

2. In the Server box, select the Automation Server you want to configure.

4. In the Automation Server Date & time view, select Network time
synchronization.

340
17.9 Synchronizing the Automation Server Clock
5. In the Primary time server box, type the address to the primary time server
that you want to synchronize the Automation server clock with.
6. In the Secondary time server box, type the address to the time server that
you want to synchronize the Automation Server clock with if the primary time
server is not available.

341
17.10 Manually Changing the Automation Server Time and Date
17.10 Manually Changing the Automation

Server Time and Date
You manually adjust the Automation Server clock if it is not synchronized with a
network time server.
Note
• The Automation Server Date & Time view displays the local time in the
perspective of the Automation Server time zone settings and not in the
perspective of WorkStation.
Automation Server” on page 334.
To manually changing the Automation Server time and date

2. In the Server box, select the Automation Server you want to configure.


342
17.10 Manually Changing the Automation Server Time and Date
4. In the Automation Server Date & time view, click Manually adjust date &
time.
5. In the Local date & time boxes, enter the date and time of the Automation
Server.

343
17.11 Network Time
17.11 Network Time

Consistent date and timestamping across a network is critical for system wide
access control, security, communications, scheduling, alarms, and events. Network
time uses the NTP protocol that provides the correct current UTC time.
17.11.1 Network Time on WorkStation and Enterprise

Server
The network time settings on WorkStation and Enterprise Server are configured
through the operating system settings on which WorkStation or Enterprise Server is
installed. For more information on how to configure network time settings, refer to
the manufacturer’s manual for the operating system.
17.11.2 Network Time Server on Automation Server

To configure an Automation Server network time settings you have to log on to the
Automation Server through WorkStation. When logged in, the Automation Server
has a Date & Time view where you configure the network time server addresses.
When configuring the Automation Server network time server address you can
define two time server addresses, primary time server and secondary time server. If
the Automation Server fails to connect to the primary time server, it tries to
synchronize its clock with the secondary.

344
17.12 Synchronize Network Time Settings
17.12 Synchronize Network Time Settings

You can establish a lead and shadow relationship to synchronize the time on all
your Automation Servers with the same network time server. The Date and Time
object on the lead server contains the network time server addresses that are
inherited by shadow servers.
Figure: The Date and Time object is found in the server System, Time Settings folder.
The date and time lead object is configured through the Control Panel - Network
time and time zones on the Enterprise Server.
The Network time synchronization on shadow Automation Servers option
on the Enterprise Server contains the addresses that are inherited by all shadow
Automation Servers. If you disable this option, established shadow and lead
relationships consist but the shadow Automation Servers do not synchronize its
network time server addresses with the lead Enterprise Server. Instead, the
Automation Servers use their own time settings.
Note
• The addresses in the Automation Server - Date & Time do not affect the
Enterprise Server time and date settings. For more information, see section
17.11 “Network Time” on page 344.

345
17.13 Synchronizing Time Settings on Multiple Automation Servers
17.13 Synchronizing Time Settings on Multiple

Automation Servers
You define the primary and secondary network time server settings for connected
shadow Automation Servers on the Enterprise Server.
For more information, see section 17.12 “Synchronize Network Time Settings” on
page 345.
To synchronize time settings on multiple Automation Servers

2. In the Server box, select the Enterprise Server that you want to synchronize
the Automation Server time settings with.


346
4. In the Enterprise Server Date & Time view, under Network time
synchronization on shadow Automation Servers, click Enable.
5. In the Primary time server box, type the address to the time server that you
want to synchronize the shadow Automation Servers clocks with.
6. In the Secondary time server box, type the address to the time server that
you want to synchronize shadow Automation Servers clocks with if the
primary time server is not available.
8. In the Search box, type “Date and Time” to search for the date and time object
on all connected servers in your Building Operation system.
9. Click the Search button .

10. In the Search view, select the servers with the time and date you want to
synchronize with the Enterprise Server time server settings.
11. Click the Show/Hide Property Grid button .


347
12. Click the Time tab.
13. In the Lead object box, enter /[Enterprise Server Name]/System/Time

Settings/Date and Time.

348
17.14 Synchronize Time Zone Settings
17.14 Synchronize Time Zone Settings

You can establish a lead and shadow relationship to synchronize the time zone
settings on all your Enterprise Servers and Automation Servers. The Time Zone
object on the lead server contains the time zone settings that are inherited by
shadow servers.
Figure: Time Xone object on an Enterprise Server

The time zone lead object is configured through the Control Panel - Network
time and time zone, on the Enterprise Server.

349
17.15 Synchronizing Time Zone Settings on Multiple Automation Servers
17.15 Synchronizing Time Zone Settings on

Multiple Automation Servers
You define the time zone settings for connected shadow Automation Servers by
changing the lead Enterprise Server time zone settings.
For more information, see section 17.14 “Synchronize Time Zone Settings” on page
349.
To synchronize the time zone settings on multiple Automation

Servers
1. In WorkStation, in the Search box, type “Time Zone” to search for the time
zone object on all connected servers in your Building Operation system.

3. In the Search view, select the servers with the time zone you want to
synchronize with the Enterprise Server time zone settings.
4. Click the Show/Hide Property Grid button .

5. Click the Zone Info tab.
6. In the Lead object box, enter /[Enterprise Server Name]/System/Time

Settings/Time Zone.

350
18 Localization User Interface
Topics
Unit Selection Dialog Box
Date and Time Properties – Basic Tab
Date and Time Properties – Time Tab
Time Zone Properties – Basic Tab
Time Zone Properties – Zone Info Tab
Enterprise Server – Date & Time View
Automation Server – Date & Time View
Add or Remove Languages Dialog Box
Unit Conversion Exceptions View
18.1 Unit Selection Dialog Box
18.1 Unit Selection Dialog Box

Use the Unit Selection dialog box to define the unit and metric prefix of a value.
Figure: Unit sekection dialog box
Table: Unit Selection Dialog Box

Filter Type the name of the category or unit you

are searching for.
Units Select the category and unit of the value.
Prefix Select the prefix of the unit.
Selected unit Displays the defined unit with prefix.

353
18.2 Date and Time Properties – Basic Tab
18.2 Date and Time Properties – Basic Tab

Use the Basic tab to configure the properties of the Time object.
Figure: Basic tab

354
18.3 Date and Time Properties – Time Tab
18.3 Date and Time Properties – Time Tab

Use the Time tab to configure the network time server addresses or establish a
lead and shadow relationship on Automation Servers or Enterprise Servers.
Figure: Time tab
Table: Time Tab

Use external NTP server Select Enabled to define the primary and
secondary NTP server addresses for
connected shadow Automation Servers.
NTP Server 1 Type the address to the primary time server

to which the shadow Automation Servers
date and time object synchronizes its clock
against.
NTP Server 2 Type the address to the secondary time

server to which the shadow Automation
Servers date and time object synchronizes
its clock against.
Lead object Enter the object that acts as the lead for this
object.

355
18.4 Time Zone Properties – Basic Tab
18.4 Time Zone Properties – Basic Tab

Use the Basic tab to configure the properties of the Time zone object.
Figure: Basic tab

356
18.5 Time Zone Properties – Zone Info Tab

Use the Zone Info tab to configure the time zone settings or establish a lead and
shadow relationship on Automation servers or Enterprise servers.
Figure: Zone info tab
Table: Zone Info Tab

Time zone Select the time zone the server belongs to.
Use custom time zone Select Enabled to configure and use a

custom time zone.
Lead object Enter the object that acts as the lead for this
object.

357
Continued
Description Type a description or name for the

customized time zone DST settings.
GMT offset - hours Select the time difference the time zone has
from GMT in hours.
GMT offset - minutes Select the time difference the time zone has
from GMT in minutes.
Daylight saving time Select Enable if the custom time zone uses
daylight saving time.
DST Delta (Minutes) Select the time adjustment, in minutes, for

the daylight saving time.
DST Start Month Select the month that daylight saving time
starts.
DST Start Week Select the week of the month that daylight
saving time starts.
DST Start Day Select the day of the week that daylight
saving time starts.
DST Start Hour Select the hour of the day that daylight
saving time starts.
DST Start Minute Select the minute of the hour that daylight
saving time starts.
DST End Month Select the month that daylight saving time
ends.
DST End Week Select the week that daylight saving time
ends.
DST End Day Select the day of the week that daylight
saving time ends.
DST End Hour Select the hour of the day that daylight
saving time ends.
DST End Minute Select the minute of the hour that daylight
saving time ends.

358
18.6 Enterprise Server – Date & Time View

Use the Date & Time view to configure shadow Automation Servers network time
settings, and the time zone of the Enterprise Server.
Figure: Date & time view
Table: Date & Time View

Enable Select to define the primary and secondary

network time server addresses for
connected shadow Automation Servers.
Primary time server Type the address to the primary time server
to which the shadow Automation Servers
date and time object synchronizes its clock
against.
Secondary time server Type the address to the secondary time

server to which the shadow Automation
Servers date and time object synchronizes
its clock against.

359
Continued
Disable Select to disable all Automation Server date

and time shadow relationships and use the
Automation Servers own date and time
configurations.
Predefined time zone Select the time zone the server belongs to.
Custom time zone Select to manually define the server time

zone.

UTC offset Select the time difference the time zone has
from UTC in the hours and minutes boxes.
This custom time zone uses daylight Select to enable the daylight saving time
saving time settings for the custom time zone.
Time adjustment Select the time adjustment, in minutes, for

Month - Start Select the month that daylight saving time

starts.
Week - Start Select the week of the month that daylight

saving time starts.
Day - Start Select the day of the week that daylight

saving time starts.
Time - Start Select the time that daylight saving time

starts.
Month - End Select the month that daylight saving time

ends.
Week - End Select the week that daylight saving time

ends.
Day - End Select the day of the week that daylight

saving time ends.
Time- End Select the time that daylight saving time

ends.

360
18.7 Automation Server – Date & Time View

Use the Date & Time view to configure the Automation Server time and time zone.
Figure: Date & Time view
Table: Date & Time View

Network time synchronization Select to synchronize the server clock with a

network time server.
Primary time server Type the address to the primary time server
to which the Automation Server
synchronizes its clock against.
Secondary time server Type the address to the secondary time

server to which the Automation Server
synchronizes its clock against.
Manually adjust date & time Select to manually set the server clock.

361
Continued
Local date & time Enter the date and time you want to set the
server clock to. This time is displayed in
server local time.
Predefined time zone Select the time zone the server belongs to.
Custom time zone Select to manually define the server time

zone.

UTC offset Select the time difference the time zone has
from UTC in the hours and minutes boxes.
This custom time zone uses daylight Select to enable the daylight saving time
saving time settings for the custom time zone.
Time adjustment Select the time adjustment, in minutes, for

Month - Start Select the month that daylight saving time

starts.
Week - Start Select the week of the month that daylight

saving time starts.
Day - Start Select the day of the week that daylight

saving time starts.
Time - Start Select the time that daylight saving time

starts.
Month - End Select the month that daylight saving time

ends.
Week - End Select the week that daylight saving time

ends.
Day - End Select the day of the week that daylight

saving time ends.
Time- End Select the time that daylight saving time

ends.

362
18.8 Add or Remove Languages Dialog Box
18.8 Add or Remove Languages Dialog Box

Use the Add or remove languages dialog box to add or remove language that
can be selected in WebStation.
Figure: Add or remove languages dialog box
Table: Add or Remove Languages Dialog Box

Add Click to add a language to the list. For more

information, see section 16.3 “Language
Packages” on page 313.
Remove Click to remove the selected language. For

“Language Packages” on page 313.

363
18.9 Unit Conversion Exceptions View
18.9 Unit Conversion Exceptions View

Use the Unit Conversion Exceptions view to override regional settings within a
domain.
Figure: Unit Conversion Exceptions view
Configured Unit Enter the configured unit that will trigger a

conversion exception. The configured unit is
the unit that is native to the value/object
before being localized by operating systems.
SI Display Unit Enter how the configured unit will be

displayed on an SI metric system.
US Display Unit Enter how the configured unit will be

displayed on a US customary system.
Note
Users in a domain become subjects to added unit conversion exceptions the next
time they log on.

364
19 User Account Management
Topics
User Account Management Overview
Opening the Account Management Control Panel
Creating a User Account
User Accounts and User Account Groups
Editing a User Account Profile
Renaming a User Account
Disabling a User Account
Enabling a Disabled User Account
Setting an Expiration Date for a User Account
Removing the Expiration Date for a User Account
Deleting a User Account
Automatic Logoff
Setting the Automatic Logoff Time
19.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

367
• The user account has defined software permissions, either defined on the
individual account or inherit from the user account group
19.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 19.4 “User Accounts and User Account Groups”
on page 375.
19.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 21.1 “Domains” on page 435.
19.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 22.1 “Software Permissions” on page 459.
19.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 21.2 “Log On Methods” on page 438.
19.1.5 Workspace Management

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 section 24.1 “Workspace Management” on page 501.

368
19.1.6 Automatic Logoff

The automatic logoff function makes it possible to decide when a user is
automatically logged off after a specified time of inactivity.
For more information, see section 19.12 “Automatic Logoff” on page 396.
19.1.7 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 21.3 “Guest Log On in WebStation” on page 439.

369
19.2 Opening the Account Management Control Panel
19.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 section 47.4 “Control Panel” on page 1382.
To open the Account Management control panel

2. Click Account management.

370
19.3 Creating a User Account

You create and configure a user account for each person requiring access to
Building Operation.
on page 375.
To create a user account

2. In the Server box, select a server for the user account.


371
4. In the Domain box, select the domain the account is to be created in.
5. In the User Accounts area, click Add.

6. In the Name box, type a name for the user account.
7. In the Description box, type a description.

8. Click Next.

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

373
15. In the Password box, type a password for the user.
16. In the Confirm Password box, type the password again.

17. Click Create.
18. Click OK.

374
19.4 User Accounts and User Account Groups
19.4 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
23.1 “Password Administration” on page 487.
• 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 21.1 “Domains” on
page 435.
• Manage accounts at the domain level using a default administrator account.
For more information, see section 21.11 “Administration Accounts in Server
Local Domain” on page 456.
• Track user activity at the user-account level. For more information, see section
25.2 “Audit Trailing of User Activity” on page 546.
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.

375
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.
19.4.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 20.1 “Windows Active Directory User Groups” on
page 401.

376
19.4.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 25.1 “WorkStation Account Management” on
page 545.

377
19.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.
on page 375.
To edit a user account profile

2. On the Control Panel, in the Server list box, select the server where the
user account is located.


378
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.
7. Click the Profile tab.

379
8. Edit the user account profile information.

380
19.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.
on page 375.
To rename a user account

2. In the Server list, select the server containing the user account you are
renaming.


381
4. Click List users.
5. Select the user account you want to rename.
6. On the Edit menu, click Rename.

7. In the Object Name box, type a new name for the user account.
8. Click OK.

382
19.7 Disabling a User Account

You disable a user account to prevent the user from accessing WorkStation.
on page 375.
To disable a user account

2. In the Server list, select the server containing the user account you want to
disable.

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

384
7. In the Disabled box, select True to disable the account.

385
19.8 Enabling a Disabled User Account

You enable a disabled user account to give the user access to WorkStation.
on page 375.
To enable a disabled user account

enable.

386
5. In the User Accounts list, select the user account.
6. Click Summary.

387
7. In the Disabled box, select False to enable the account.

388
19.9 Setting an Expiration Date for a User Account
19.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.
on page 375.
To set an expiration date for a user account

set an expiration date for.


389

6. Click Summary.

390
7. In the Expires on boxes, select the date and the time when you want the
user account to expire.

391
19.10 Removing the Expiration Date for a User Account
19.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.
on page 375.
To remove the expiration date for a user account

2. In the Server list, select the server containing the user account for which you
are removing the expiration date.

392
19.10 Removing the Expiration Date for a User Account

6. Click Summary.
7. In the Expires on boxes, remove the date and time settings for the account.

393
19.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.
on page 375.
To delete a user account

2. On the Control Panel, in the Server list box, select the server with the
domain the user account belongs to.


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

395
19.12 Automatic Logoff
19.12 Automatic Logoff

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

396
19.13 Setting the Automatic Logoff Time
19.13 Setting the Automatic Logoff Time

Use the automatic logoff function to avoid unauthorized users and ensure that
WorkStation users do not occupy a license they are not using.
For more information, see section 19.12 “Automatic Logoff” on page 396.
To set the automatic logoff time

2. In the Server list, select the server containing the user account group you
want to set the auto log off time for.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Policies.
7. Select Automatic logoff and select the time in the minutes box.

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

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

402
20.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 22.2 “Software Permissions and User Account
Groups” on page 461.
To create a user account group

2. In the Server box, select a server for the user account group.


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

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.

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

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

16. Click Next.

406
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. Select Automatic logoff and enter the time in the minutes box if you want
the users in the user account group to be logged off after a defined time of
inactivity. For more information, see section 19.12 “Automatic Logoff” on page
396.
22. 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 21.4
“Creating and Configuring a Domain” on page 440.
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.

407
23. 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.
24. Click Create.

408
20.3 Editing the Description of a User Account Group
20.3 Editing the Description of a User

Account Group
You edit the description of a user account group to reflect changes in the
organization.
on page 375.
To edit the description of a user account group

want to edit the description for.


409
20.3 Editing the Description of a User Account Group
5. In the User Account Groups list, select the user account group you want to
edit the description for.
6. Click Summary.
7. In the Description box, type a new description for the user account group.

410
20.4 Adding a User Account to a User Account Group
20.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.
on page 375.
To add a user account to a user account group

2. On the Control Panel, in the Server list, select the server where the user
account is located.


411
5. In the User Accounts list, select the user account you wish to add to a user
account group.
6. Click Group membership.

412
7. In the Available User Account Groups list, select a user account group
and click the Add button .

413
20.5 Removing a User Account from a User Account Group
20.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.
on page 375.
To remove a user account from a user account group

2. In the Server list, select the server containing the user account whose user
account group membership you want to remove.


414


415
7. In the Selected User Account Groups list, select the user account group
you want to remove, and click the Remove button .

416
20.6 Reviewing the User Account Group Memberships for a User Account
20.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.
on page 375.
To review the group memberships for a user account

review the user account group memberships for.
3. Click Account Management.


417
20.6 Reviewing the User Account Group Memberships for a User Account
5. In the User Account list, select the user account.


418
20.7 Adding a User Account Group to a User Account Group
20.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.
on page 375.
To add a user account group to a user account group

want to add to another user account group.


419

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

421
20.8 Removing a User Account Group from another User Account Group
20.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.
on page 375.
To remove a user account group from another user account

group
2. In the Server list, select the server that contain the user account group with
the user account group membership you want to remove.


422

423
you are removing the user account group from and click the Remove button

424
20.9 Reviewing the User Account Group Memberships for a User Account Group
20.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.
on page 375.
To review the user account group memberships for a user

account group
2. In the Server list, select the server containing the user account group whose
group membership you want to view.


425
20.9 Reviewing the User Account Group Memberships for a User Account Group
6. Click Group Membership.

426
20.10 Preventing a Group of Users from Exiting WorkStation
20.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.
on page 375.
To prevent a group of users from exiting WorkStation

members you want to prevent from exiting WorkStation.


427
20.10 Preventing a Group of Users from Exiting WorkStation
6. Click Policies.
7. Clear the May close User Interface box.

428
20.11 Enabling a Group of Users to Exit Workstation
20.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.
on page 375.
To enable a group of users to exit WorkStation

2. In the Server list, select the server containing the user account group.


429
20.11 Enabling a Group of Users to Exit Workstation
6. Click Policies.
7. Select the May close User Interface box.

430
20.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.
on page 375.
To delete a user account group

2. On the Control Panel, in the Server list, select the server with the domain
the user account group belongs to.


431
delete.


432
21 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
21 Domains
21.1 Domains
21.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.

435
21 Domains
21.1 Domains
Figure: Building Operation domain and its components.
Note
You cannot change the name of a domain that is shared between servers.
21.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.

436
21 Domains
21.1 Domains
21.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.
21.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 21.11 “Administration Accounts in Server Local
Domain” on page 456.

437
21 Domains
21.2 Log On Methods
21.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.
21.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 the Logging on to WorkStation using your Windows Credentials
topic on WebHelp.
You can also log on using another Windows account that is mapped in Building
Operation. For more information, see the Logging on to WorkStation as another
Windows User topic on WebHelp.
21.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
the Logging on to WorkStation as a Building Operation User topic on WebHelp.
You also select which Building Operation domain and server that you want to
access. For more information, see section 19.4 “User Accounts and User Account
With a Building Operation user account, you can also connect directly to the local
domain of a server. For more information, see section 21.11 “Administration
Accounts in Server Local Domain” on page 456.
21.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 23.1 “Password Administration” on page 487.

438
21 Domains
21.3 Guest Log On in WebStation
21.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.

439
21 Domains
21.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.
To create and configure a domain

2. In the Server box, select a server for which you want to create a domain.
3. Click Domain.

440
21 Domains
4. Click Add.
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.
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.

441
21 Domains
9. Click 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.

442
21 Domains

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

443
21 Domains
21.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.
To edit the Windows domain name

2. In the Server box, select the server where the domain is located.
3. Click Domain.

444
21 Domains
4. In the Domains box, select the domain that you want to edit.
5. Click Summary.
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.

445
21 Domains
21.6 Editing the Description of a Domain

You edit the description of a domain to specify what the domain is used for.
To edit the description of a domain

3. Click Domain.

446
21 Domains
4. In the Domains box, select the domain for which you wish to edit the
description.
5. Click Summary.
6. In the Description box, type a description for the domain.

447
21 Domains
21.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.
To edit the maximum logon attempts

3. Click Domain.

448
21 Domains
4. In the Domains box, select the domain that you want to edit.
5. Click Policies.
6. In the Maximum logon attempts box, enter a new number.
7. On the File menu, click the Save.

449
21 Domains
21.8 Assigning a Server to a Domain

You assign a server to a domain in the live system to extend your current domain.
To assign a server to a domain

2. Click Domain.
3. In the Domains list, select the domain you are adding a server to.
4. Click Domain members.


450
21 Domains
5. In the Available Servers list, select a server and click the Add button .

451
21 Domains
21.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.
To remove a server from a domain

2. Click Domain.
3. In the Domains list, select a domain.

452
21 Domains
4. Click Domain members.

5. In the Selected Servers list, select the server, and click the Remove button

453
21 Domains
21.10 Deleting a Domain

You delete a domain that is not anymore necessary in the Building Operation
system.
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
2. In the Server list, select the server where the domain you are deleting is
located.
3. Click Domain.

454
21 Domains
4. In the Domain list, select the domain you are deleting.

6. Click Yes.

455
21 Domains
21.11 Administration Accounts in Server Local Domain
21.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.
21.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.
21.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 the WebReports User Accounts topic on WebHelp.

456
22 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
22.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.
22.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 sub levels
unless you set a new permission level for a sub level.
For more information, see section 22.4 “Path Permissions” on page 464.
22.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 22.5 “Command Permissions ” on page 467.
22.1.3 Software Permission Rules

Software permissions provide members of user account groups with certain rights
and privileges.
For more information, see section 22.3 “Software Permission Rules” on page 463.
22.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.

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

460
22.2 Software Permissions and User Account Groups
22.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 22.1
“Software Permissions” on page 459.
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.

461
22.2 Software Permissions and User Account Groups
Figure: Software permissions and workspaces are assigned to user account groups

462
22.3 Software Permission Rules
22.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.

463
22.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 sub levels
unless you set a new permission level for a sub level.
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.
Example 1
A user has the permission Full Access to the folder Building A. The user account
group also has Read permissions to the folder Building B, but No access to the
subfolders 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

Example 2
A user account group has the permission Full Access to the Enterprise Server and
No Access to the Servers folder on the Enterprise Server. A single user account has
Full Access permissions to Automation Server 1, but No Access to Automation
Servers 2 and 3. The No Access permission on the Servers folders makes it
possible to give specific user accounts access to specific Automation Servers in
that folder.

464
Figure: Path permissions to servers on different 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 21.11 “Administration Accounts in Server Local Domain”
on page 456.

465
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 subfolders, except the Domains folder, are always
accessible to a user even when the path permission for the folders is set to No
Access. This means that a user can always at least navigate and view the objects in
the System Tree and its subfolders.
Note
The Domains folder is the only folder within the System folder with restricted
access for users with the path permission No Access.
Figure: The Domains folder is the only folder of the System subfolders that can be
restricted by the path permission.

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

467
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 22.1 “Software Permissions” on page 459.

468
22.6 Assigning Software Permissions to a User Account
22.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.
To assign software permissions to a user account

2. On the Control Panel, in the Server list, select the server where the user
account is located.


469
5. In the User Accounts list, select the user account you wish to assign path
permissions.
6. Click Software 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.


470
9. Click the path you have created, and select a permission level in the
Permission drop-down list.

471
22.7 Editing the Software Permissions of a User Account
22.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.
To edit the software permissions of a user account



472
5. In the User Accounts list box, select the user account you wish to edit path
permissions.
6. Click Software 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.


473
9. Click the path you have created.
10. In the Permission column, select a permission level.

474
22.8 Assigning Software Permissions to a User Account Group
22.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.
To assign software permissions to a user account group

2. In the Server box, select a server for the user account group.


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

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


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

478
12. In the Permission box for the command, select a permission level.

479
22.9 Editing the Software Permissions of a User Account Group
22.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.
To edit the software permissions of a user account group

2. In the Server box, select the server where the user account group is located.


480
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, click Software 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.


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

482
12. In the Permission box for the command, select a permission level.

483
23 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
23.1 Password Administration
23.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.

487
23.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.
To edit a user account password



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

489
23.3 Allowing Users to Change their Password
23.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.
To allow users to change their password

users you want to allow to change their passwords.


490
23.3 Allowing Users to Change their Password
5. In the User Account Groups list, select a user account group.

6. Click Policies.
7. Select the May change Password box.

491
23.4 Changing Your Password
23.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.
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.

492
23.5 Turning off Remember Me On This Computer
23.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 21.2 “Log On Methods” on page 438.
To turn off Remember me on this Computer

1. In WorkStation, on the File menu, select Log Off.
2. In the Building Operation WorkStation window, clear Remember me
on this computer.
3. Log on again to activate the change.

493
23.6 Forcing a User to Change the Password at Next Logon
23.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.
To force a user to change the password at next logon

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.


494
23.6 Forcing a User to Change the Password at Next Logon

6. Click Summary.
7. In the Force password change box, select True to force the user to
change the password at next logon.

The Force password change box is automatically set to False when the user
changes their password.

495
23.7 Preventing Users from Changing Their Passwords
23.7 Preventing Users from Changing Their

Passwords
You prevent a group of users from changing their passwords.
To prevent users from changing their passwords

2. In the Server list box, select the server containing the user account group
whose members you want to prevent from changing their passwords.


496
23.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.
7. Clear the May change Password box.

497
23.8 Resetting the Administrator Password
23.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.
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.

498
24 Workspaces
Topics
Workspace Management
Predefined Workspaces
Workspace Components and Customization
Workspace 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
24 Workspaces
24.1 Workspace Management

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.
24.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 24.2 “Predefined Workspaces” on page 503.

501
24 Workspaces
24.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 24.3 “Workspace Components and
Customization” on page 504.
24.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 24.18 “WebStation in Kiosk Mode” on page 538.

502
24 Workspaces
24.2 Predefined Workspaces
24.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.

503
24 Workspaces
24.3 Workspace Components and Customization
24.3 Workspace Components and

Customization
A workspace consists of panes, windows, and a work area that can be customized
to suit a user's specific needs. Dialog boxes are presented on top of the
workspace.
Figure: Workspace components

WorkStation positions panes at the edges of the main window. You can lock,
release, and move these components to another location. You can also display and
stack several panes on top of each other.
Building Operation provides several predefined workspace panes, which are
accessible through the View menu:
• System Tree pane
• Watch
• Events
• Alarms
24.3.1 Workspace Customization

You customize the workspace layout to control access and suit the specific
requirements of a user account group. For example, you hide or show panes and
toolbars. You can save a workspace layout on the server. In this case, the layout
becomes the default workspace layout for all users in the user account group the
workspace belongs to. An individual user can modify the workspace layout on the

504
24 Workspaces
24.3 Workspace Components and Customization
local computer. In this case, the modified workspace layout is accessible only to
that user account. A user-modified layout overrides the default workspace layout for
that user account. Workspaces are task oriented, which means that a user can
switch workspaces during a single WorkStation session.
For more information, see section 24.4 “Workspace Customization” on page 506.
24.3.2 Workspace Content References

Workspace content references are used to customize the workspace by referring
the content you want to display in the workspace panes and Work Area window.
For more information, see section 24.5 “Workspace Content References” on page
507.
24.3.3 Panel Components

You use a panel to combine different viewable windows, for example, a graphic,
trend chart, report, or another panel into a seamless view. A panel consists of one
or several panes and one work area. The panel is available through the System
Tree pane and opens as a window in the work area of the current workspace.
For more information, see section 24.6 “Panel Components” on page 508.

505
24 Workspaces
24.4 Workspace Customization
24.4 Workspace Customization

You customize the workspace layout to control access and suit the specific
requirements of a user account group. For example, you hide or show panes and
toolbars. You can save a workspace layout on the server. In this case, the layout
becomes the default workspace layout for all users in the user account group the
workspace belongs to. An individual user can modify the workspace layout on the
local computer. In this case, the modified workspace layout is accessible only to
that user account. A user-modified layout overrides the default workspace layout for
that user account. Workspaces are task oriented, which means that a user can
switch workspaces during a single WorkStation session.
You can configure a workspace to contain a limited number of views to which users
have access. Specifically, you can add, edit, move, or remove the following panes
and windows:
• Graphics
• Alarms, Events, and Watch
• Basic and Advanced Schedules
• Function Block Programs
• Trend Log Lists and 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.
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 22.1 “Software Permissions” on page 459.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 section 22.2 “Software
Permissions and User Account Groups” on page 461.Software Permissions and
User Account Groups

506
24 Workspaces
24.5 Workspace Content References
24.5 Workspace Content References

Workspace content references are used to customize the workspace by referring
the content you want to display in the workspace panes and Work Area window.
When you add a content reference to a workspace, you refer the object in one of
the following ways:
• System absolute: This option creates a path that refers to a specific object or
property in the system. The full address is enclosed in the path and the path
starts from the root level of the system. For example, the path /Server
1/University X/Building A/Graphic1 refers to a graphic named Graphic1 in the
folder Building A under the folder University X on Server 1. This option means
that the content of the workspace will be the same regardless of which server
you are logged on to.
• Server absolute: This option creates a path that refers to a specific object or
property on a server. The address to the server is enclosed in the path and the
path starts from the root level of the server the user is logged on to. For
example, the reference ~/Building A/Alarm View1 refers to an Alarm View in the
folder Building A on the server the used is logged on to. This option means that
the content of the workspace depends on the server you are logged on to.
• Relative: This option creates a path that is relative to the target. The path starts
from the current location and is relative to that location. Relative paths behave
like the server absolute option when it comes to workspace components. For
example, ../../Graphics/Graphic1 refers to a graphic named Graphic1 in the
Graphics folder one level up. This option means that the content of the
workspace depends on the server you are logged on to.

507
24 Workspaces
24.6 Panel Components
24.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 pane and opens as a window in the work area of the current workspace.
Figure: Example of panel components

In the procedure when creating a panel, you link existing objects to the panes or
workspace that is added within the panel. Therefore you have to first create the
object, for example a trend chart, before you add or rather link in the object into the
panel. You can define whether to show or hide a pane's toolbar.
Note
• A panel 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.

508
24 Workspaces
24.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.
To create a workspace
2. In the Server box, select the server where you want to create the workspace.


509
24 Workspaces
4. In the Domain box, select the server where you want to create the
workspace.
5. In the Workspaces area, click 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.

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

511
24 Workspaces
13. In the Name box, type a name for the pane.

14. In the Description box, type a description for the pane.
15. Click Next.
16. In the 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.
21. In the Workspace wizard, click Create.

512
24 Workspaces
24.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.
To edit the layout of a workspace

2. In the Server box, select the server where the workspace is located.


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

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

515
24 Workspaces
24.9 Editing the Description of a Workspace

You edit the description of a workspace to specify what the workspace is used for.
To edit the description of a workspace

2. In the Server list, select the server where the workspace is located.


516
24 Workspaces
5. In the Workspaces list, select the workspace.

6. Click Summary.
7. In the Description box, type a new description for the workspace.

517
24 Workspaces
24.10 Adding a Component to a Workspace

You add a component to a workspace to extend the content and usage of the
workspace.
To add a component to a workspace



518
24 Workspaces

6. Click Content.
7. Click Add.

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

520
24 Workspaces
13. In the Default dock position box, select the dock position of the
component.
14. In the Default visibility box, select Visible to display the graphic in the
workspace.
16. In the Initial path box, select the System Tree location of the component to
add to the workspace.
17. Click Create.

521
24 Workspaces
24.11 Removing a Component from a Workspace
24.11 Removing a Component from a

Workspace
You remove a component from a workspace to reduce components and the usage
of the workspace.
To remove a component from a workspace



522
24 Workspaces
24.11 Removing a Component from a Workspace
5. In the Workspaces list, select the workspace you want to configure.

6. Click Content.
7. In the Components list, select the component you want to remove from the
workspace.
8. Click Remove.

523
24 Workspaces
24.12 Editing a Workspace Component

You edit the workspace components to adapt the usage of the workspace.
To edit a workspace component



524
24 Workspaces

6. Click Content.
7. In the Components list, select the component you want to edit.
8. Click Edit.

525
24 Workspaces
9. Edit the workspace component properties.

526
24 Workspaces
24.13 Adding a Workspace to a User Account Group
24.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.
To add a workspace to a user account group

want to add the workspace to.


527
24 Workspaces
24.13 Adding a Workspace to a User Account Group
add a workspace to.
6. Click Workspaces.
7. In the Available Workspaces list, select the workspace you want to add to
the user account group and click the Add button .

528
24 Workspaces
24.14 Removing a Workspace from a User Account Group
24.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.
To remove a workspace from a user account group

2. In the Server list, select the server containing the workspace for which you
want to remove the link to a user account group.


529
24 Workspaces
24.14 Removing a Workspace from a User Account Group

6. Click User Account Groups.
you want to remove the workspace from, and click the Remove button .

530
24 Workspaces
24.15 Reviewing the Workspace Memberships for a User Account Group
24.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.
To review the workspace memberships for a user account

group
want to review the workspace memberships for.


531
24 Workspaces
24.15 Reviewing the Workspace Memberships for a User Account Group
6. Click Workspaces.

532
24 Workspaces
24.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.
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, and then 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.

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

534
24 Workspaces
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.
15. In the Initial path box, enter the path to the object you are adding to the
panel.

535
24 Workspaces
16. Click Create.

17. In the Work area initial path box, enter the initial object that displays when
viewing this panel.
18. In the Show toolbars box, select Yes to display the toolbar for the object
listed in the initial path.
19. Click Create.

536
24 Workspaces
24.17 Editing a Panel
24.17 Editing a Panel

You edit the properties of the panel and the components included in the panel to
rearange its appearance.
To edit a panel
1. In WorkStation, in the System Tree pane, select the panel you want to edit.
2. Click Properties.
3. In the Properties pane, edit the properties of the panel.
4. Click OK.
5. Click Close.

537
24 Workspaces
24.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 21.3 “Guest Log On in WebStation”
on page 439.
24.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:

538
24 Workspaces
Figure: The properties dialog for a shortcut opening WebStation in kiosk mode.

539
24 Workspaces
24.19 Configuring WebStation to Run in Kiosk Mode
24.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 24.18 “WebStation in Kiosk Mode” on page 538.
To configure WebStation to run in kiosk mode

1. Right-click on the desktop, point to New, and click Shortcut.
2. In the Type the location of the item box, click Browse.
3. In the Browse for File or Folders box, browse to iexplore.
4. Click OK.
5. Add "-k" after the address to iexplore.
6. Click Next.
7. In the Type name for this shortcut box, type the name, for example
WebStation in Kiosk Mode.
8. Click 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.

540
24 Workspaces
24.19 Configuring WebStation to Run in Kiosk Mode
13. Click Shortcut.

14. Paste the address, within quotation marks, in the Target box after the
command -k.
15. Click OK.

541
25 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
25 Audit Trails
25.1 WorkStation Account Management
25.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.
25.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 25.2 “Audit Trailing of User Activity” on page 546.
25.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 25.6 “WorkStation Account Validation” on page
553.

545
25 Audit Trails
25.2 Audit Trailing of User Activity
25.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

546
25 Audit Trails
25.3 Disabling Audit Trail for a Group of Users
25.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.
To disable audit trail for a group of users

2. In the Server list, select the server containing the user account group for
which you want to disable audit trail.


547
25 Audit Trails
25.3 Disabling Audit Trail for a Group of Users
6. Click Policies.
7. Clear the Enable Audit Trailing box.

548
25 Audit Trails
25.4 Enabling Audit Trail for a Group of Users
25.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.
To enable audit trail for a group of users

2. In the Server list, select the server containing the user account group for
which you want to enable audit trail.


549
25 Audit Trails
25.4 Enabling Audit Trail for a Group of Users
5. In the User Account Groups list, select a user account group.

6. Click Policies.
7. On the Policies tab, select Enable Audit Trailing.

550
25 Audit Trails
25.5 Viewing an Audit Trail Log

You open an audit trail log to view the activities of a specific user.
To view an audit trail log

2. In the Server list, select the server containing the user account for which you
want to view the audit trail log.


551
25 Audit Trails

6. Click Audit Trailing Events.
7. In the Show Events box, select an interval of events to view.
8. Click the Refresh button .

552
25 Audit Trails
25.6 WorkStation Account Validation
25.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.

553
26 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 Members 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 Policies Page
User Account Group – Summary Tab
User Account Group – Policies Tab
User Account Group – Group Membership Tab
User Account Group – Software Permissions Tab
User Account Group – Workspaces Tab
User Account Wizard – General Page
User Account Wizard – Member Of Page
User Account Management Folder Properties
Workspace Wizard – Workspace Configuration Page
Workspace Wizard – Pane Configuration Page
Workspace – Summary Tab
Workspace – Content Tab
Workspace – Members Tab
Edit Layout Workspace
Panel Wizard – Panel Configuration Page
Domains Properties
Local Properties
Work Area Window Properties
Create Work Area Window Wizard – Name Page
26 User Management User Interface
26.1 User Management System Tree Icons
26.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 24.6 “Panel
Components” on page 508.
Folder of User Accounts

Indicates that the folder contains user
accounts. For more information, see section
19.4 “User Accounts and User Account
User Account
Indicates that the object is a user account.
For more information, see section 19.4 “User
Accounts and User Account Groups” on
page 375.
Domain
Indicates that the object is a domain. For
“Domains” on page 435.
User Account Groups

Indicates that the object is a user account
group. For more information, see section
Workspace
Indicates that the object is a workspace. For
“Workspace Management” on page 501.

559
26.2 Domain Properties
26.2 Domain Properties

Use the Domain properties to configure the properties of a domain.
Figure: Domain properties
Table: Domain Properties

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 20.1 “Windows Active Directory User

560
26.3 Profile Properties
26.3 Profile Properties

Use the Profile properties to edit the information about the user the account
belongs to.
Figure: Profile properties
Table: Profile Properties

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.

561
26.4 Workspace Properties

Use the Workspace properties to configure the properties of a workspace.
Figure: Workspace properties
Table: Workspace Properties

Add Click to add a pane to the workspace. For

more information, see section 52.22 “Create
Object Wizard – Naming the Object Page”
on page 1538.
Edit Click to edit a workspace pane. For more

information, see section 26.5 “Pane
Properties” on page 564.
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.

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

563
26.5 Pane Properties
26.5 Pane Properties

Use the Pane properties to configure the settings of the pane.
Figure: Pane properties
Table: Pane Properties

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.

564
26.6 Panel Properties
26.6 Panel Properties

Use the Panel properties to configure the properties of a panel.
Figure: Panel properties
Table: Panel Properties

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.

“Create Object Wizard – Naming the Object
Page” on page 1538.
Edit Click to edit a pane component. For more

Remove Click to remove a panel component.

565
26.7 Building Operation WorkStation Window
26.7 Building Operation WorkStation

Window
Use the Building Operation WorkStation window to log on to WorkStation.
Figure: Building Operation WorkStation
Table: Building Operation WorkStation

Windows domain\user name Click to log on to WorkStation using the

Windows credentials of the current Windows
account. For more information, see section
Other user Click to log on to WorkStation as another

Windows user or using a Building Operation
User name Type the user name.
Password Type the password.

566
26.7 Building Operation WorkStation Window
Continued
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 21.1 “Domains” on
page 435.
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 Click to open the WebHelp home page. For
Building Operation more information, see the WebHelp
Overview topic on WebHelp.

567
26.8 Domain Control Panel
26.8 Domain Control Panel

Use the Domain Control Panel to create and configure domains.
Table: Domain Control Panel

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 section 52.22 “Create
on page 1538.
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 26.9 “Account Management Control
Panel” on page 569.
Summary Click to open the Summary tab for the

domain. For more information, see section
26.15 “Domain – Summary Tab” on page
577.
Policies Click to open the Policies tab where you edit

the policies of the domain. For more
information, see section 26.16 “Domain –
Policies Tab” on page 578.
Domain members Click to open the Domain members tab

where you add and remove servers from the
domain. For more information, see section
26.17 “Domain – Domain Members Tab” on
page 579.

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

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
on page 1538.
Delete (user account) Click to delete a user account. For more

information, see section 52.25 “Confirm
Delete Dialog Box” on page 1542.
List users Click to open the user accounts list view

where you can select a user account. For
more information, see section 47.3 “List
View” on page 1381.

569
Continued
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 26.18 “User Account – Summary
Tab” on page 580.
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 26.19 “User
Account – Group Membership Tab” on page
581.
Software permissions (user account) Click to open the Software Permissions tab
where you can edit or assign individual
software permissions to the selected user
26.21 “User Account – Software
Permissions Tab” on page 584.
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 26.22 “User
Account – Audit Trailing Events Tab” on
page 585.
User Account Groups Select a user account group.
Add (user account groups) Click to add a new user account group. For
on page 1538.
Delete (user account group) Click to delete a user account group. For
“Confirm Delete Dialog Box” on page 1542.
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 section
47.3 “List View” on page 1381.
Summary (user account groups) Click to open the user account groups
Summary tab where you can edit the
description of the group. For more
Account Group – Summary Tab” on page
595.
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
26.30 “User Account Group – Group
Membership Tab” on page 597.

570
Continued
Software permissions Click to open the Software Permissions tab

where you can edit the software permissions
of the user account group. For more
Account Group – Software Permissions
Tab” on page 599.
Workspaces (user account groups) Click to open the Workspaces tab where
you edit the workspace membership
settings for a user account group. For more
Account Group – Workspaces Tab” on page
601.
Policies Click to open the Policies tab where you can

edit the policies of the user account group.
“User Account Group – Policies Tab” on
page 596.
Workspaces Select a workspace.
Add (workspaces) Click to add a new workspace. For more

on page 1538.
Delete (workspaces) Click to delete a workspace. For more

List workspaces Click to open the Workspace menu where

you can select a workspace. For more
information, see section 47.3 “List View” on
page 1381.
Summary (workspaces) Click to open the workspace Summary tab

where you can edit the description of the
workspace. For more information, see
section 26.38 “Workspace – Summary Tab”
on page 609.
User account groups (workspaces) Click to open the workspace Members tab
where you edit the group membership of the
section 26.40 “Workspace – Members Tab”
on page 612.
Content Click to open the Content tab where you edit

the content of the workspace. For more
information, see section 26.39
“Workspace – Content Tab” on page 610.
Edit layout Click to open the view where you edit the
layout of the workspace. For more
information, see section 26.41 “Edit Layout
Workspace” on page 613.

571
26.10 Select Default Workspace Window
26.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

Select Default Workspace Select a default workspace in the list of

workspaces available to you.

572
26.11 Change Password Dialog Box
26.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

Present password Type your present password.
New password Type your new password.
Confirm new password Type your new password again.

573
26.12 Domain Wizard – Authentication Page
26.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



574
26.13 Domain Wizard – Domain Members Page
26.13 Domain Wizard – Domain Members

Page
Use the Domain Members page to add servers to the domain.
Figure: Domain members page
Table: Domain Members Page

Available Servers List of all available servers.
Servers that are members of this List of all servers in the domain.
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.

575
26.14 Domain Wizard – Domain Policies Page
26.14 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

Maximum logon attempts Select the maximum number of failed logon

attempts that a user can make before
WorkStation is temporarily locked.

576
26.15 Domain – Summary Tab
26.15 Domain – Summary Tab

Use the Summary tab to edit the description and domain controller password for a
domain.
Figure: Summary tab
Table: Summary Tab

Description Type a description of the object.

Domain Controller Displays the path and name of the domain

controller.

577
26.16 Domain – Policies Tab
26.16 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

Maximum logon attempts Enter the maximum number of failed logon

attempts a user can make before the user´s
account is temporarily locked.

578
26.17 Domain – Domain Members Tab
26.17 Domain – Domain Members Tab

Use the Domain Members tab to add and remove servers to and from the
domain.
Figure: Doamin members tab
Table: Domain Members Tab

Available Servers List of all available servers.
Servers that are members of this List of all servers in the domain.
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.

579
26.18 User Account – Summary Tab
26.18 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

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.

580
26.19 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

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.

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

582
26.20 User Account – Profile Tab
26.20 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

Work E-mail address Type the work e-mail address of the user.

583
26.21 User Account – Software Permissions Tab
26.21 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

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.

584
26.22 User Account – Audit Trailing Events Tab
26.22 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

Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see the Group and Sort Objects
topic on 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 section 47.6 “Quick
Filter ” on page 1384.

585
26.23 User Account Group Properties
26.23 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

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

586
26.24 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

Add Click to create a new user profile. For more

on page 1538.
Edit Click to edit a user profile. For more

information, see section 26.3 “Profile
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.

587
Continued
Confirm Password Type a password for the user account.


588
26.25 User Account Group Wizard – Users Belonging to this Group Page
26.25 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

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.

589
26.25 User Account Group Wizard – Users Belonging to this Group Page
Continued
Remove all
Click to remove all user accounts from the
user account group.

590
26.26 User Account Group Wizard – Workspaces Belonging to this Group Page
26.26 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

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.

591
26.26 User Account Group Wizard – Workspaces Belonging to this Group Page
Continued
Remove
Click to remove a workspace from the user
account group.
Remove all
Click to remove all workspaces from the user
account group.

592
26.27 User Account Group Wizard – Windows Group Name and Group Policies Page
26.27 User Account Group Wizard – Windows

Group Name and Group Policies Page
Use the Windows Group Name and Group Policies page to map a Windows
Active Directory and enter policies for the group.
Note
• The default setting is that all options on the Policies page are selected.
Figure: Windows group name and group policies page
Table: Windows Group Name and Group Policies Page

User Interactivity Select to let users log off and close

WorkStation.
Audit trailing Select to enable audit trailing for users

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

593
26.27 User Account Group Wizard – Windows Group Name and Group Policies Page
Continued
Automatic logoff Select to log off users in this group after a

defined time of inactivity. For more
information, see section 19.12 “Automatic
Logoff” on page 396.

page 401.

594
26.28 User Account Group – Summary Tab
26.28 User Account Group – Summary Tab

Use the Summary tab to edit the description of a user account group.
Figure: Summary tab
Table: Summary Tab

Description Type a description of the object.
Windows Domain Displays the name of the Windows domain

this user account group is mapped to.

page 401.

595
26.29 User Account Group – Policies Tab
26.29 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

May close User Interface Select to let users log off and close
WorkStation.
Enable Audit Trailing Select to enable audit trailing for users

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
Automatic logoff Select to log off users in this group after a

defined time of inactivity. For more
information, see section 19.12 “Automatic
Logoff” on page 396.

596
26.30 User Account Group – Group Membership Tab
26.30 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

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.

597
26.30 User Account Group – Group Membership Tab
Continued
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
Remove all
Click to remove all user accounts or user
account groups from the list of selected user

598
26.31 User Account Group – Software Permissions Tab
26.31 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

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.
Delete
Click to remove a path. For more
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.

599
26.31 User Account Group – Software Permissions Tab
Continued
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.

600
26.32 User Account Group – Workspaces Tab
26.32 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

Available Workspaces Lists workspaces that are available to add to

Selected Workspaces Lists workspaces that are available to add to

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.

601
26.33 User Account Wizard – General Page
26.33 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

Work E-mail address Type the e-mail address of the user.

Confirm Password Type a password for the user account.

602
26.34 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

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.

603
Continued
Remove all
Click to remove all user account groups from
the user account.

604
26.35 User Account Management Folder Properties
26.35 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 section 52.28 “General Properties – Basic Tab” on page 1545.
Figure: User Account management folder properties

605
26.36 Workspace Wizard – Workspace Configuration Page
26.36 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


workspace.

the workspace.

workspace.

workspace.

workspace.

workspace.
Root path (Applies to Address Bar and Enter the path to the workspace component.
System Tree)

606
26.36 Workspace Wizard – Workspace Configuration Page
Continued
Listed components Lists the standard components included in

the workspace. Select a component and
click the Add, Edit or Remove button.
Add Click to add a new component to the

section 52.22 “Create Object Wizard –
Naming the Object Page” on page 1538.
Edit Click to edit a component. The workspace

properties pane is displayed. For more
Remove Click to remove a component.

607
26.37 Workspace Wizard – Pane Configuration Page
26.37 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

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 26.36 “Workspace Wizard –
Workspace Configuration Page” on page
606.

608
26.38 Workspace – Summary Tab
26.38 Workspace – Summary Tab

Use the Summary tab to edit the description of the workspace.
Figure: Summary tab
Table: Summary Tab

Name Displays the name of the workspace.
Description Displays the description of the workspace.
Location Displays the location of the workspace.

609
26.39 Workspace – Content Tab

Use the Content tab to edit the content and layout of a workspace.
Figure: Content tab
Table: Content Tab


workspace.

the workspace.

workspace.

workspace.

workspace.

workspace.
Root path (Applies to Address Bar and Displays the path to the basic node of the
System Tree) workspace. For more information, see
section 24.5 “Workspace Content
References” on page 507.

610
Continued
Add Click to open the Create Object Wizard,

where yoou add a new component to the
Edit Click to edit a pane. For more information,

see section 26.5 “Pane Properties” on page
564.
Remove Click to remove a component.

611
26.40 Workspace – Members Tab
26.40 Workspace – Members Tab

Use the Members tab to edit the workspace user account group associations.
Figure: Members tab
Table: Members tab

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.

612
26.41 Edit Layout Workspace
26.41 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.

613
26.42 Panel Wizard – Panel Configuration Page
26.42 Panel Wizard – Panel Configuration

Page
Use the Panel Configuration page to add components to the panel.
Figure: Panel configuration page
Table: Panel Configuration Page

Add Click to add a new component to the panel.

Edit Click to edit the properties of a component.

“Pane Properties” on page 564.
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.

614
26.43 Domains Properties
26.43 Domains Properties

Use the Domains properties to configure the Building Operation domains.
Figure: Domains properties
Table: Domains Properties

Default Logon Domain Select the domain the user logs on to by

default. For more information, see section
21.1 “Domains” on page 435.

615
26.44 Local Properties
26.44 Local Properties

Use the Local properties to configure the local Building Operation domain.
Figure: Local properties
Table: Local Properties

Maximum logon attempts Enter the maximum number of failed logon

attempts a user can make before the user´s
account is temporarily locked.

616
26.45 Work Area Window Properties
26.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 24.3 “Workspace
Components and Customization” on page
504.

617
26.46 Create Work Area Window Wizard – Name Page
26.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

Initial path Enter the path of the default object to be

presented the Work Area Window.
“Workspace Components and

618
27 Alarms Introduction
Topics
Alarm Overview
Alarm States
Alarm Functions
Alarm Objects in Multiple Servers
Alarms Pane and Alarm View Customization
Styling the Alarm States in the Alarms Pane and Alarm
Views
Alarm Filter Conditions
Creating a Filtered Alarm View
Filter Condition Wildcards
Displaying Alarm View on an Alarm
Alarm Handling Issues
27.1 Alarm Overview
27.1 Alarm Overview

You use an alarm to monitor a variable and to alert you if the monitored variable
matches the configured alarm conditions.
You can configure an alarm to send a message to a specified user or user group
when the alarm is triggered or force the user that acknowledges the alarm to write a
cause note. You can also configure the alarm to flash and play a sound when it is
triggered.
Suppose you want to monitor the temperature of a freezer protector on a
compressor. You create an alarm that triggers when the temperature drops too
low. A message is automatically sent to an assigned operator who acknowledges
the alarm and corrects the problem.
Figure: Triggered, reset, and acknowledged alarms presented in Alarms pane
27.1.1 Alarm States

An alarm is always in a certain alarm state. The state of the alarm is presented in the
alarm properties, in the Alarms pane, or in the Alarm Views.
For more information, see section 27.2 “Alarm States” on page 623.
27.1.2 Building Operation Alarm Types

An alarm compares the value from a monitored variable with the conditions of the
alarm. Different types of alarms handle different types of variables and different
forms of evaluation.
For more information, see section 28.1 “Alarm Types” on page 645.
27.1.3 Alarm Functions

You can monitor variables and configure the alarms in many different ways. You
can, for example, connect the alarm to a shunt variable, add dead band to the
alarm limit, or configure the priority of the alarm.
For more information, see section 27.3 “Alarm Functions” on page 624.

621
27.1 Alarm Overview
27.1.4 Alarm Objects in Multiple Servers

In a multi-server system, you create alarm objects on the Enterprise Server. These
objects, such as checklists and action notes, are inherited by the Automation
Servers that are connected to that Enterprise Server. The copies on the connected
Automation Servers are read-only, so in order to edit them you must edit their
source objects on the Enterprise Server. One advantage with this is that you can
display the objects and their content on the tier level server even if the top server
goes offline.
For more information, see section 27.4 “Alarm Objects in Multiple Servers” on page
627.
27.1.5 Alarms Pane and Alarm View Customization

You use the Alarms pane and the Alarm View to view and administer alarms. When
an alarm is triggered, it is displayed in the Alarms pane or Alarm Views together with
information about the alarm. You can edit the Alarm View filter to display the Alarm
View only when certain alarms are triggered. You can create and use more than one
Alarm View. The Alarms pane and each Alarm View can be customized with an
alarm filter to show information that is relevant to the user who supervises the
Alarms. Customized settings are lost when you perform a system upgrade.
For more information, see section 27.5 “Alarms Pane and Alarm View
27.1.6 Mass Create

You use the mass create feature to create multiple identical alarms or trend logs for
different objects, instead of creating the alarms or trend logs one by one. From
trend logs, you can mass create extended trend logs.
For more information, see section 40.1 “Mass Create ” on page 1227.

622
27.2 Alarm States
27.2 Alarm States

An alarm is always in a certain alarm state. The state of the alarm is presented in the
alarm properties, in the Alarms pane, or in the Alarm Views.
Table: Alarm States

Alarm State Description
Normal state Idle state where the alarm monitors the

variable.
Alarm state When an alarm is triggered, the state of the

alarm changes from the normal state to
alarm state.
Disable state You can disable an alarm when the alarm is

triggered by faulty reasons, the alarm
toggles between the alarm state and reset
state, or maintenance will trigger the alarm.
A Disabled alarm can be hidden in the
Alarms pane or Alarm Views. To reset the
alarm, you have to show hidden alarms and
then enable it. When you show disabled
alarms, enabled alarms are hidden.
Disabled alarms are displayed in the system
tree with an icon that indicates that the alarm
is disabled.
Reset state The monitored variable has returned to a

value that is within the normal condition of
the alarm, but the alarm has to be
acknowledged by a user before the alarm
returns to normal state.
Acknowledge state A user or user group has acknowledged the

alarm.
Fault state If a BACnet device reports values that it

knows are not trustworthy, the monitoring
alarm is put in fault state.
You can configure the alarm in different ways whether or not a user has to
acknowledge the alarm before it returns to normal state.
For more information, see section 29.14 “Acknowledgement” on page 738.

623
27.3 Alarm Functions

You can monitor variables and configure the alarms in many different ways. You
can, for example, connect the alarm to a shunt variable, add dead band to the
alarm limit, or configure the priority of the alarm.
27.3.1 Time Delay

Time delay prevents unintentional activation-deactivation cycles. You can delay the
time before the alarm is triggered when the alarm state goes from normal state to
alarm state and when it goes from alarm state to reset state.
For more information, see section 29.1 “Time Delay” on page 723.
27.3.2 Shunt Variable

A shunt variable is a binary value that works as an on/off switch for the alarm.
For more information, see section 29.3 “Shunt Variable” on page 725.
27.3.3 Deadband
Deadband is an area of the alarm range where no reset action occurs. The purpose
of the deadband is to prevent unintentional activation-deactivation cycles.
For more information, see section 29.5 “Deadband” on page 727.
27.3.4 Alarm Messages

When configuring the alarm, you can write a message that displays in the Alarms
pane, Events pane, Alarm Views, and Event Views when an alarm is triggered or
reset.
For more information, see section 29.6 “Alarm Messages” on page 728.
27.3.5 Priority
When configuring an alarm, you define the priority of the alarm. The priority is used
to inform the operator of the importance of the triggered alarm. The priority is
displayed in the Alarms pane, Events pane, Alarm Views, and Event Views.
For more information, see section 29.8 “Priority” on page 730.

624
27.3.6 Categories
You can group together alarms in categories to simplify the identification of the
alarm. When the alarm is triggered, the category name is displayed together with
the alarm in the Alarms pane, Events pane, Alarm Views, and Event Views.
For more information, see section 29.10 “Categories” on page 732.
27.3.7 Acknowledgement
When an alarm is triggered, you acknowledge the alarm to indicate to other users
that you have responded to the alarm and intend to troubleshoot the problem that
caused the alarm. The name of the user that acknowledges the alarm is displayed
in the Alarms pane, Events pane, Alarm Views, and Event Views.
For more information, see section 29.14 “Acknowledgement” on page 738.
27.3.8 User Actions

You can add information when handling a trigger alarm. For example, you can add
a comment to the alarm or open an action note that is connected to the alarm.
When configuring an alarm, you can force the user to perform different actions
when handling a triggered alarm.
For more information, see section 29.19 “User Actions” on page 746.
27.3.9 Notifications
User notifications are used for notifying users or user groups that a certain alarm
event has occurred in the system. The notification contains a prewritten message
that is either sent in an E-mail or written to a text file. When setting up the
notification, you write the message and then configure the conditions that execute
the writing or sending action.
For more information, see section 29.23 “Notifications” on page 752.
27.3.10 Automatic Assignment

A triggered alarm can be automatically assigned to a specific user or user group
that is most suited to correct the problem. An assigned alarm indicates to other
users that someone is working with the problem that caused the alarm. The name
of the user that is assigned to the alarm and the assignment status are displayed in
the Alarms pane, Events pane, Alarm Views and Event Views.
For more information, see section 29.28 “Automatic Assignment” on page 767.

625
27.3.11 Unit of Measure in Alarms

When creating an alarm, the alarm limit and deadband values inherit the unit of the
monitored variable. You can change the unit of the alarm to any unit within the same
unit category as the monitored variable.
Note
You cannot define a unit to an alarm that monitors a unitless variable.
For more information, see section 29.30 “Unit of Measure in Alarms” on page 770.
27.3.12 Attachments
You can add attachments to alarm objects, except system information alarms. An
attachment is a link pointing to an object in the system, such as a report, a voice
message, or a trend chart. When an alarm is triggered that has an attachment, a
paperclip icon is displayed in the Alarms pane and Alarm Views. It is also possible to
configure the attachment to display when the alarm is triggered.

626
27.4 Alarm Objects in Multiple Servers
27.4 Alarm Objects in Multiple Servers

In a multi-server system, you create alarm objects on the Enterprise Server. These
objects, such as checklists and action notes, are inherited by the Automation
Servers that are connected to that Enterprise Server. The copies on the connected
Automation Servers are read-only, so in order to edit them you must edit their
source objects on the Enterprise Server. One advantage with this is that you can
display the objects and their content on the tier level server even if the top server
goes offline.
Note
When a top server is connected to a tier level server, all existing checklists, action
notes, cause notes, and categories on the tier level server are removed and
replaced with the objects from the top server.

627
27.5 Alarms Pane and Alarm View Customization
27.5 Alarms Pane and Alarm View

Customization
You use the Alarms pane and the Alarm View to view and administer alarms. When
an alarm is triggered, it is displayed in the Alarms pane or Alarm Views together with
information about the alarm. You can edit the Alarm View filter to display the Alarm
View only when certain alarms are triggered. You can create and use more than one
Alarm View. The Alarms pane and each Alarm View can be customized with an
alarm filter to show information that is relevant to the user who supervises the
Alarms. Customized settings are lost when you perform a system upgrade.
In the Alarms pane and Alarm Views, you can also open a detailed view to inspect
all properties for a selected alarm.
Figure: The Alarms pane

Through the control panel, you can customize the appearance of different alarm
states that are displayed in the Alarms pane and Alarm Views. For example, you can
change the font style, font size, background color, and font color.
You can also configure the alarm to flash or play a sound when it is triggered.

628
27.6 Styling the Alarm States in the Alarms Pane and Alarm Views
27.6 Styling the Alarm States in the Alarms

Pane and Alarm Views
You style the appearance of the different alarm states in the Alarms pane and Alarm
Views to easily separate the alarm states from each other.
To style the alarm states in the Alarms pane and Alarm Views
2. On the Control Panel, click Alarm appearance.
3. In the Alarm Styles view, double-click the alarm state you want to style.

629
4. In the Font box, click the Browse button.
5. Select the font, font style, and font size that you want to use in the Alarms
pane and Alarm Views.
6. Click OK.
7. In the Background color box, click the Browse button.

630
8. Select the color for the background of the alarm state row.
9. Click OK.
10. In the Font color box, click the Browse button.
11. Select the color for the font of the alarm state text.
12. Click OK.

631
27.7 Alarm Filter Conditions

Alarm filter conditions are used to set up the conditions for the alarms you want to
be displayed in an Alarms pane or an Alarm View. You also use alarm filter
conditions to determine the conditions that have to be met before a sum alarm is
triggered, an e-mail notification is sent, a write to file notification is written, or an
alarm is automatically assigned to a user. You can use wildcards when setting up
filter conditions. For more information, see section 32.7 “Filter Condition Wildcards ”
on page 954.
Table: Alarm Filter Conditions

Acknowledge time Enter the property to filter by the time and

date the alarm was acknowledged.
Acknowledged by Type the property to filter by the name of the

user that acknowledged the alarm.
Wildcards can be used. For more
information, see section 32.7 “Filter
Condition Wildcards ” on page 954.
Acknowledgement required Select the property to filter BACnet alarms

by whether the notification requires
acknowledgement. True specifies that an
acknowledgement is required.
Alarm state Select the property to filter alarms by the

present state of the alarm.
Alarm text Type the property to filter alarms by the

alarm messages that are added to the alarm.
Assigned state Select the property to filter alarms that have

been assigned to and accepted by any user
or group.
Assigned to domain Type the property to filter alarms by the

domain of the user or group that the alarm is
assigned to. Wildcards can be used. For
more information, see section 32.7 “Filter
Assigned to ID Type the property to filter alarms by the ID of

the user or group that the alarm is assigned
to. Wildcards can be used. For more
Assigned to name Type the property to filter alarms by the

name of the user or group that the alarm is

632
Continued
BACnet alarm type Select the property to filter alarms by the

BACnet alarm that monitors a variable within
a BACnet network.
BACnet notification Enter the property to filter alarms by the

BACnet Notification Class of the event.
BACnet notification type Select the property to filter alarms by the

BACnet notification, whether the notification
is an event or an alarm.
Basic evaluation state Select the property to filter alarms by the

current evaluation state of the alarm. True
indicates that the alarm is triggered.
Category Type the property to filter alarms by the

category name of the alarm. Wildcards can
be used. For more information, see section
32.7 “Filter Condition Wildcards ” on page
954.
Command value Enter the property to filter alarms by the

value that was commanded.
Confirmed notification Select the property to filter alarms by the

request requires acknowledgement, by the
recipient's computer.
Count Enter the property to filter alarms by the

number of times the alarm has toggled
between the alarm and reset state.
Deadband Enter the property to filter alarms by the

deadband value of the alarm.
Device name Type the property to filter events by the

name of the I/NET device that generated the
alarm. Wildcards can be used. For more
Disabled cause Select the property to filter alarms by the

cause of the disabled alarm. An alarm is
either disabled by user, shunt variable, or if
the alarm is incorrectly configured.
Error limit Enter the property to filter alarms by the

difference limit that was exceeded.
Evaluation state Select the property to filter alarms by the

present evaluation state of the alarm. For
example, Upper limit alarm is displayed
when the monitored value reaches the upper
alarm limit.

633
Continued
Event from state Select the property to filter alarms by the

BACnet From State. The From State
indicates the Event State of the object prior
to the occurrence of the event that initiated
the notification.
EWS ID Type the property to filter alarms by the ID

the alarm has on the external system.
EWS source ID Type the property to filter alarms by the

external ID of the object that generated the
alarm. Wildcards can be used. For more
Exceeded limit Enter the property to filter alarms by the limit

that was exceeded.
Exceeding value Enter the property to filter alarms by the

value that exceeded a limit.
Feedback value Enter the property to filter alarms by the

value that differs from the Command value.
First name Type the property to filter alarms by the first

name of the individual whose key/card was
used at the I/NET door point. Wildcards can
954.
Hidden Select the property to filter alarms by the

visible status. True is displayed when the
object is hidden.
Individual Enter the property to filter alarms by the

individual number of the individual whose
key/card was used at the I/NET door point.
Last name Type the property to filter alarms by the last

954.
Logging Select the property to filter alarms by

whether or not associated alarm events are
generated and recorded in the Event log.
Message text Select the property to filter alarms by a

message of up to 64 characters that has
been assigned to the I/NET point.

634
Continued
Monitored variable Type the property to filter alarms by the

monitored variable. Wildcards can be used.
For more information, see section 32.7 “Filter
New mode Enter the property to filter alarms by the new

mode of the referenced object.
New state Enter the property to filter alarms by the new

state of the referenced property.
New value Type the property to filter alarms by the new

value of the referenced property. Wildcards
can be used. For more information, see
section 32.7 “Filter Condition Wildcards ” on
page 954.
Operation expected Enter the property to filter alarms by the next

operation requested by the referenced
object.
Possible operator actions Select the property to filter alarms by the

possible actions one can perform on the
record, given permissions.
Previous alarm state Select the property to filter alarms by the

previous state of the alarm.
Priority Enter the property to filter alarms by the

current priority level of the alarm state.
Process ID Enter the property to filter alarms by the

unique process ID in the receiving device for
which a BACnet notification is intended.
Referenced bit string Type the property to filter alarms by the new
value of the referenced bit string property.
Referenced value Enter the property to filter alarms by the

value of the referenced property.
Setpoint value Enter the property to filter alarms by the

value of the reference variable.
Source Type the property to filter alarms by the path

of the source object. Wildcards can be used.
Source name Type the property to filter alarms by the

external name of the object that generated
the alarm. Wildcards can be used. For more

635
Continued
Source server Type the property to filter alarms by the path

where the alarm is located. Wildcards can be
used. For more information, see section 32.7
“Filter Condition Wildcards ” on page 954.
Status flags Select the property to filter alarms by the

status flag.
System alarm ID Select the property to filter alarms by the

alarm ID generated by the system.
Tenant Enter the property to filter alarms by the

tenant number of the individual whose
Timestamp Enter the property to filter alarms by the time

and date.
Triggered time Enter the property to filter alarms by the time

and date of the last state transfer from
normal state to alarm state.
Type Select the property to filter alarms by the

type of the object.
Value at change Type the property to filter alarms by the value

of the monitored variable. Wildcards can be

636
27.8 Creating a Filtered Alarm View

You create an Alarm View to apply an alarm filter that displays only those alarms the
user needs to see.
To create a filtered Alarm View

1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the Alarm View.
2. On the File menu, point to New and then click View.
3. In the object type list, click Alarm View.
4. In the Name box, type a name for the Alarm View.

5. In the Description box, type a description for the Alarm View.
6. Click Create.
7. In the System Tree pane, select the Alarm View you created.
8. On the Actions menu, click Edit Alarm Filter to filter the Alarm View.

637
9. Click the Add condition button and select a condition type.
10. Type the condition for the filter.
11. Click the Add row button to add another condition of the same type.
12. Type the condition for the filter.
Tip
• You can add different condition types by clicking the Add
condition button . For example, you can filter on

categories, alarm state, and alarm text.
13. Click OK.

638
27.9 Filter Condition Wildcards

A wildcard is one or more characters used to simplify the process of setting up filter
conditons. You use wildcards to subsitute characters or combinations of characters
in object properties, such as names or descriptions. For example, instead of setting
up five filter conditions for values with names beginning with a, b, c, d, or e, you can
set up one single filter condition for values with a name beginning with any of the
charachters in the range [a-e].
Table: Wildcard Characters

Character Description
* Use to match any combination of

characters, including no character
? Use to match any one character exactly
[ Use to begin a SET, that is, a number of

characters or a range
] Use to end a SET
[] Use to match any one character specified

within the SET, that is, enclosed by the
brackets
! Use to exclude the characters or range(s) of

a SET
- Use in a range within a SET: 0-9, a-z, A-Z
\ Use to ignore the wildcard character and

search for it as any other character
Any other character has to match exactly.

You can specify any number of characters or a range within brackets. In this case,
the filter includes one character specified within the brackets and any number of
characters specified outside the brackets.
Examples:
*at - Matches "at" and all objects ending with "at"
?t - Matches all two-character objects ending with "t"
[CB]at - Matches "Cat" and "Bat", that is, objects beginning with any one character
specified within the SET and ending with "at"
[A-C]at - Matches "Aat", "Bat", and "Cat"
[CB][au]t - Matches "Cat", "Cut", "Bat", and "But"
[!a-b0-1q]at - Matches all three-character objects ending with 'at' except "aat",
"bat", "0at", "1at" and "qat"
\\ - Matches "\"
b\\t - Matches ”b\t”

639
Table: Wildcard Availability for Different Features

Feature * ? [b] [a-c] [\]] [!a-c]
Alarm View Yes Yes Not Not Not Not

Filter available available available available
Conditions
Event View Yes Yes Yes Yes Not Not

Filter available available
Conditions
Sum Alarm Yes Yes Yes Yes Yes Yes

Filter
Conditions
Notification Yes Yes Yes Yes Yes Yes

s Filter
Condition
Assignmen Yes Yes Yes Yes Yes Yes

ts Filter
Conditions

640
27.10 Displaying Alarm View on an Alarm
27.10 Displaying Alarm View on an Alarm

You configure an Alarm View to automatically open in a new window when an alarm
is triggered.
To display Alarm View on an alarm

1. In the Alarms pane, right-click anywhere.
2. Point to Alarm view settings.
3. Select Display alarm view to automatically open the Alarm View when an
alarm is triggered.

641
27.11 Alarm Handling Issues
27.11 Alarm Handling Issues

When an alarm is triggered it appears in the alarm list. You can, for example,
acknowledge, disable, or hide alarms in the alarm list. An acknowledged alarm
disappears from the alarm list when it has been reset to normal state.
If the alarm database is lost, which happens after an upgrade, or if it gets corrupt,
for example, because the server crashes, all alarms are re-evaluated. The alarms
that are still active are resent to the alarm database. However, the information that
an alarm has been acknowledged, disabled, or hidden is gone and you have repeat
the operation you performed on the alarm before the data loss. If you are to
upgrade your system, you need to take notes to be able to see which alarms you
have to reacknowledge, disable, and so on, to get the alarm list back to the state it
was in before the event that caused the data loss occured.
When an alarm has been triggered and reset to normal state without having been
acknowledged, the alarm remains in the alarm list until it is acknowledged. If the
alarm then is lost, an alarm refresh does not make the alarm reappear in the alarm
list. The alarm is reset, thus, it has no alarm state to send. If you need an event log
record of the alarm being acknowledged, you have to acknowledge the alarm
before you upgrade the system.
Most system information alarms are only messages. That is, they cannot be in an
alarm state, thus, an alarm refresh does not make the system information alarm
reappear in the alarm list. If you need an event log record of the alarm being
acknowledged, you have to acknowledge the alarm before you upgrade the
system.

642
28 Alarm Types
Topics
Alarm Types
Change of State Alarm
Creating a Change of State Alarm
Multistate Alarm
Creating a Multistate Alarm
Matching Text String Alarm
Creating a Matching Text String Alarm
Variable Status Alarm
Creating a Variable Status Alarm
Out of Range Alarm
Creating an Out of Range Alarm
Out of Reference Range Alarm
Creating an Out of Reference Range Alarm
Sum Alarm
Creating a Sum Alarm
Enumeration Alarm
Creating an Enumeration Alarm
System Information Alarms
System Information Alarms List
Configuring the Description of an Alarm
Configuring Attachments of an Alarm
Removing Attachments from an Alarm
28 Alarm Types
28.1 Alarm Types
28.1 Alarm Types

An alarm compares the value from a monitored variable with the conditions of the
alarm. Different types of alarms handle different types of variables and different
forms of evaluation.
The alarms can monitor values from external sources, such as LonWorks and
BACnet devices, as well as values from Automation Servers and Enterprise Servers.
Some alarms are also based on system information, such as device restart or
network status.
28.1.1 Change of State Alarm

The change of state alarm monitors the state changes of digital variables. You
configure the alarm to trigger when the variable changes its state to true or to false.
For more information, see section 28.2 “Change of State Alarm” on page 647.
28.1.2 Out of Range Alarm

When setting up an out of range alarm, you configure the normal range of the
monitored variable. If the variable goes below the lower limit or above the upper limit
of the normal range, the alarm is triggered.
For more information, see section 28.10 “Out of Range Alarm” on page 677.
28.1.3 Out of Reference Range Alarm

The out of reference range alarm monitors variable movements comparing to a
reference variable. By setting an upper deviation limit and lower deviation limit, you
configure the tolerance the monitored variable can vary from the reference variable
before the alarm is triggered. The upper alarm limit of the monitored variable is
equal to the reference point current value plus the upper deviation limit. The lower
alarm limit of the monitored variable is equal to the reference point current value
minus the lower deviation limit.
For more information, see section 28.12 “Out of Reference Range Alarm” on page
686.
28.1.4 Multistate Alarm

The multistate alarm monitors a variable and triggers the alarm if the variable is
between the configured alarm range or equal to a single value. You can add several
ranges or single values to trigger the alarm.
For more information, see section 28.4 “Multistate Alarm” on page 655.

645
28 Alarm Types
28.1 Alarm Types
28.1.5 Matching Text String Alarm

A matching text string alarm evaluates if the monitored value equals the given text
strings.
For more information, see section 28.6 “Matching Text String Alarm” on page 663.
28.1.6 Variable Status Alarm

The variable status alarm monitors the status of a variable. The alarm is triggered
when the value of the monitored variable is either forced or overridden. If you
configure the alarm to trigger on both force and override, the alarm is triggered
immediately when the variable changes to one of the two statuses.
For more information, see section 28.8 “Variable Status Alarm” on page 670.
28.1.7 Sum Alarm

A sum alarm can be seen as a collection of alarms that have one or several
common denominators. The conditions you use to filter out which alarms the sum
alarm monitors are the same conditions you use to filter the Alarms pane or an
Alarm View. You can use wildcards when setting up filter conditions. For more
information, see section 32.7 “Filter Condition Wildcards ” on page 954.
For more information, see section 28.14 “Sum Alarm” on page 695.
28.1.8 Enumeration Alarm

An enumeration is a variable with labeled values; different variables have different
enumerations. When configuring an enumeration alarm, you configure the variable
and its enumerations to monitor.
For more information, see section 28.16 “Enumeration Alarm” on page 702.
28.1.9 System Information Alarms

System information alarms monitor system entities, such as online status for servers
or field devices. The system information alarms are generated by Building
Operation. Users cannot create new system alarms. The possible causes of a
system alarm are gathered in an enumeration called System alarm ID. When a
system alarm is triggered, the cause of the alarm is indicated in the System alarm ID
column in the Alarms pane or Alarm View. Some system alarms have additional
information in the Alarm text column.
For more information, see section 28.18 “System Information Alarms” on page 709.

646
28 Alarm Types
28.2 Change of State Alarm
28.2 Change of State Alarm

The change of state alarm monitors the state changes of digital variables. You
configure the alarm to trigger when the variable changes its state to true or to false.
Figure: Change of state alarm when the monitored variable goes true
Figure: Change of state alarm when the monitored variable goes false
For example, you set up a change of state alarm that monitors a ventilation fan. If
the fan breaks or stops working, the alarm is triggered.
You can configure the change of state alarms using shunt variable and time delay.

647
28 Alarm Types
28.3 Creating a Change of State Alarm

You create a change of state alarm to trigger an alarm when a variable, such as a
switch, is either true or false.
For more information, see section 28.2 “Change of State Alarm” on page 647.
To create a change of state alarm

you want to create the alarm.
2. On the File menu, point to New and then click Alarm.
3. In the object type list, select Change of State Alarm.
4. In the Name box, type a name for the alarm.

5. In the Description box, type a description for the alarm.
6. Click Next.

648
28 Alarm Types
7. Select the state of the monitored variable that triggers the alarm:
• Click True to trigger the alarm when the monitored variable is equal to
True.
• Click False to trigger the alarm when the monitored variable is equal to
False.
8. In the Monitored variable box, enter the variable that the alarm monitors.
9. In the Disable alarm box, select whether or not to create the alarm in
disabled mode.
10. Under Time delay and shunt variable, in the Alarm delay box, enter the
time delay.
11. In the Reset delay box, enter the time delay.

649
28 Alarm Types
12. In the Shunt variable box, enter the shunt variable.
13. Click Next.

14. In the Alarm message box, type the message to display when the
monitored variable exceeds the alarm limit.
15. In the Reset message box, type the message to display when the alarm is
reset.
16. In the Alarm priority box, enter the priority for the alarm state.

650
28 Alarm Types
17. Select the Same priority check box to let the Reset priority box inherit
the value in the Alarm priority box.
18. In the Reset priority box, enter the priority for the reset state.
19. Under Category and Alerts, in the Category box, enter a category for the
alarm.
20. Select the Flashing alert check box to make the alarm flash in the Alarms
pane and Alarm Views when it is triggered.
21. Select the Audible alert check box to make the alarm sound when it is
triggered.
22. Click Next.


651
28 Alarm Types
23. Select the type of acknowledgement to use:

• Click No when the alarm does not need to be acknowledged.
• Click Single when the alarm needs to be acknowledged in the alarm
state.
• Click Extended when the alarm needs to be acknowledged in the alarm
state and the reset state.
24. In the Cause note group box, enter a cause note group that you want to
connect to the alarm.
25. In the Action note group box, enter an action note group that you want to
26. In the Checklist box, enter a checklist that you want to connect to the alarm.
27. Select the When acknowledging an alarm: Comment check box to
force the user to add a comment to the alarm before the alarm can be
acknowledged.
28. Select the When acknowledging an alarm: Cause note check box to
force the user to edit the connected cause note before the alarm can be
acknowledged.
29. Select the When acknowledging an alarm: Action note check box to
force the user to edit the connected action note before the alarm can be
acknowledged.
30. Select the When acknowledging an alarm: Checklist check box to force
the user to go through the connected checklist before the alarm can be
acknowledged.

652
28 Alarm Types
31. Under Required user actions, select the check boxes for Comment,
Cause note, and Action note to specify how the user should respond to
the listed actions.
32. Click Next.


653
28 Alarm Types
33. Click the Add attachment button to add an attachment.
34. In the Select Object dialog box, select the object you want to attach to the
alarm.
35. Click Select.
36. On the Attachment page, in the Display on alarm column, select the
check box to automatically open the attachment when the alarm is triggered.
37. Click Create.

654
28 Alarm Types
28.4 Multistate Alarm
28.4 Multistate Alarm

The multistate alarm monitors a variable and triggers the alarm if the variable is
between the configured alarm range or equal to a single value. You can add several
ranges or single values to trigger the alarm.
Note
• The trigger values and the monitored variable must be integer.
Figure: Multistate alarm triggers an alarm when the monitored variable goes inside the
configured range or a single value.
For example, you have a function block program with an output variable that
generates integer values for different states. By using a multistate alarm, you can
monitor a specific value or several value ranges.
You can configure multistate alarms using shunt variable and time delay. For more
information, see section 27.3 “Alarm Functions” on page 624.

655
28 Alarm Types
28.5 Creating a Multistate Alarm

You create a multistate alarm to trigger an alarm when a variable is within a set
range.
To create a multistate alarm

3. In the object type list, select Multistate Alarm.

6. Click Next.
7. Click Add row.

656
28 Alarm Types
8. Click between to change the interval to a specific value.
9. Click the Set unit button to add a unit to the alarm limits and deadband.
Note
• To define a unit of the alarm, the monitored variable must have a
defined unit.

657
28 Alarm Types
10. In the Unit selection dialog box, select a unit.
11. In the Prefix box, select a prefix for the unit.

12. Click Select.
13. Under Trigger alarm when variable is box, in the number boxes, enter the
interval or the specific value of the monitored variable that triggers the alarm.
14. Click Add row to add another interval or specific value to the alarm criteria.
15. In the Monitored variable box, enter the variable that the alarm is to
monitor.
disabled mode.
17. In the Alarm delay box, enter the time delay before the alarm is triggered.
18. In the Reset delay box, enter the time delay before the alarm is reset.
19. In the Shunt variable box, enter the boolean variable that enables or
disables the alarm.
20. Click Next.

658
28 Alarm Types
21. In the Alarm message box, enter the message to display when the
monitored variable goes with or is equal to the alarm limits.
22. In the Reset message box, enter the message to display when the alarm is
reset.
23. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
24. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
25. In the Reset priority box, enter the priority of the alarm when it is reset.
26. In the Category box, enter the category that the alarm belongs to.
27. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
28. Select Audible alert to make the alarm sound when it is triggered.
29. Click Next.

659
28 Alarm Types
30. Select how the user has to acknowledge the alarm.

• Select No when the alarm does not need to be acknowledged.
• Select Single when the alarm needs to be acknowledged once, either in
the alarm state or reset state.
• Select Extended when the alarm needs to be acknowledged in both the
alarm state and the reset state.
31. In the Cause note group box, select the cause note group that you want to
32. In the Action note group box, select the action note group that you want to
33. In the Checklist box, select the checklist that you want to connect to the
alarm.
acknowledged.

660
28 Alarm Types
acknowledged.
acknowledged.
acknowledged.
Cause note, and Action note to specify how the user should respond to
the listed actions.
39. Click Next.
40. Click the Add attachment button to add an attachment to the alarm.

661
28 Alarm Types
alarm and then click Select.
42. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
43. Click Create.

662
28 Alarm Types
28.6 Matching Text String Alarm
28.6 Matching Text String Alarm

A matching text string alarm evaluates if the monitored value equals the given text
strings.
Note
• The text string is case sensitive and must be written exactly as the monitored
variable text output.
• Wildcards cannot be used in the text string.
For example, a script program inside a b3 Continuum system generates text strings
that you want to monitor. You configure the matching text string alarm to trigger an
alarm when a certain string is sent from the device.
Matching text string alarms can be configured using shunt variable and time delay.

663
28 Alarm Types
28.7 Creating a Matching Text String Alarm

You create a matching text string alarm to trigger an alarm when a variable is equal
to one or more text strings.
To create a matching text string alarm

3. In the object type list, select Matching Text String Alarm.

6. Click Next.
7. Under Trigger alarm when variable is, in the equals to box, type the text
string that has to match with the monitored variable text output to trigger the
alarm.
Note
• The text string is case sensitive and must be written exactly as
the monitored variable text output.
• Wildcards cannot be used in the text string.

664
28 Alarm Types
8. Click Add row to add another text string.

disabled mode.
disables the alarm.
14. Click Next.

665
28 Alarm Types
reset.
Alarm priority box.
23. Click Next.

666
28 Alarm Types
24. Select how the user has to acknowledge the alarm:

alarm.
acknowledged.

667
28 Alarm Types
acknowledged.
acknowledged.
acknowledged.
Cause note, and Action note to force the user to act on the listed actions.
33. Click Next.
34. To add an attachment to the alarm, click the Add attachment button .

668
28 Alarm Types
37. Click Create.

669
28 Alarm Types
28.8 Variable Status Alarm
28.8 Variable Status Alarm

The variable status alarm monitors the status of a variable. The alarm is triggered
when the value of the monitored variable is either forced, overridden or offline. If you
configure the alarm to trigger on all statuses, the alarm is triggered immediately
when the variable changes to one of the statuses.
The override status indicates that the value of a variable is adjusted by the I/O
hardware, and is not the measured value. For more information, see the Output
Override Status topic on WebHelp.
The force status indicates that the value of a variable is adjusted by the software,
and is not the measured value. For more information, see the Force and Release
Buttons topic on WebHelp.
The offline status indicates that the device with the monitored value is offline.
For example, you can use the variable status alarm to get a notification when a
technician overrides the variable on an I/O module.
You can configure the variable status alarms using shunt variable and time delay.
Monitored Value in Alarms Pane or Alarm View

The Value at change column, in the Alarms pane or Alarm View, displays the value
of the monitored variable when the alarm changed state. For a variable status
alarm, the Value at change column displays the status of the monitored variable:
• (Blank: Neither forced nor overridden)
• Forced
• Overridden
• Offline
• Both forced and overridden
Figure: The text in the Value at change column shows that the status of the variable is
forced

670
28 Alarm Types
28.9 Creating a Variable Status Alarm

You create a variable status alarm to trigger an alarm when the status of a variable
is changed to override or force.
To create a variable status alarm

3. In the object type list, select Variable Status Alarm.

6. Click Next.

671
28 Alarm Types
7. Select Forced to trigger the alarm when the monitored variable status
changes to force.
8. Select Overridden to trigger the alarm when the monitored variable status
changes to override.
9. Select Offline to trigger the alarm when the device with the monitored
variable is offline.
disabled mode.
disables the alarm.
15. Click Next.

672
28 Alarm Types
reset.
Alarm priority box.
24. Click Next.

673
28 Alarm Types

alarm.
acknowledged.

674
28 Alarm Types
acknowledged.
acknowledged.
acknowledged.
34. Click Next.

675
28 Alarm Types
38. Click Create.

676
28 Alarm Types
28.10 Out of Range Alarm
28.10 Out of Range Alarm

When setting up an out of range alarm, you configure the normal range of the
monitored variable. If the variable goes below the lower limit or above the upper limit
of the normal range, the alarm is triggered.
Figure: Out of range alarm triggers an alarm when the monitored variable goes outside the
configured range.
For example, you set up an out of range alarm that monitors the temperature in a
server room. The alarm is triggered when the temperature goes outside the range of
20 °C to 25 °C (68 °F to 77 °F).
You can configure out of range alarms using shunt variable, time delay, and
deadband. For more information, see section 27.3 “Alarm Functions” on page 624.

677
28 Alarm Types
28.11 Creating an Out of Range Alarm

You create an out of range alarm to trigger an alarm when a variable, such as a
temperature, is not within its specified range.
For more information, see section 28.10 “Out of Range Alarm” on page 677.
To create an out of range alarm

3. In the object type list, select Out of Range Alarm.

6. Click Next.

678
28 Alarm Types
7. In the Upper limit box, enter an upper limit for the alarm.
8. In the Lower limit box, enter a lower limit for the alarm.
9. In the Deadband box, enter a deadband for the alarm.
11. Click the Set unit button to enter or change the unit of measure for the
alarm limits and deadband.
Note
• If the monitored value has a unit of measurement defined, the
alarm limits and deadband are assigned that unit by default.

679
28 Alarm Types
12. Select the unit of measure.

14. Click Select.
disabled mode.
time delay.
17. In the Reset delay box, enter the time delay.

680
28 Alarm Types
18. In the Shunt variable box, enter the digital variable that enables or disables
the alarm.
19. Click Next.

20. In the Messages area, in the Above upper limit message box, type the
message to display when the alarm exceeds the upper limit.
21. In the Below lower limit message box, type the message to display when
the alarm falls below the lower limit.

681
28 Alarm Types
reset.
23. In the Priorities area, in the Above upper limit priority box, enter the
priority for the upper limit of the alarm state.
Above upper limit priority box.
25. In the Below lower limit priority box, enter the priority for the lower limit of
the alarm state.
26. In the Reset priority box, enter the priority for the reset state.
27. Under Category and Alerts, in the Category box, enter a category for the
alarm.
28. Select the Flashing alert check box to make the alarm flash in the Alarms
pane and Alarm Views when it is triggered.
29. Select the Audible alert check box to make the alarm sound when it is
triggered.
30. Click Next.


682
28 Alarm Types

state.
32. In the Cause note group box, enter the cause note group that you want to
33. In the Action note group box, enter the action note group that you want to
34. In the Checklist box, enter the checklist that you want to connect to the
alarm.
acknowledged.
acknowledged.
acknowledged.
acknowledged.

683
28 Alarm Types
39. Under Required user action, select the check boxes for Comment,
40. Click Next.


684
28 Alarm Types
41. Click the Add attachment button to add an attachment.
alarm.
43. Click Select.
45. Click Create.

685
28 Alarm Types
28.12 Out of Reference Range Alarm

The out of reference range alarm monitors variable movements comparing to a
reference variable. By setting an upper deviation limit and lower deviation limit, you
configure the tolerance the monitored variable can vary from the reference variable
before the alarm is triggered. The upper alarm limit of the monitored variable is
equal to the reference point current value plus the upper deviation limit. The lower
alarm limit of the monitored variable is equal to the reference point current value
minus the lower deviation limit.
Note
• An out of range alarm with upper deviation limit, lower deviation limit, and
deadband set to zero must meticulously follow the reference variable to not
trigger the alarm.
Figure: Out of reference alarm triggers an alarm when the monitored variable goes outside
the upper or lower deviation limit of the reference variable.
For example, you have a reference variable that is designed to follow the optimal
room temperature in a office. By connecting the reference variable and the variable
from a thermistor, placed in the office, to an out of reference range alarm, you can
set up the alarm to trigger when the temperature differs more than 5 °C (41°F) from
the reference variable.
You can configure out of reference range alarms using shunt variable, time delay,
and deadband. For more information, see section 27.3 “Alarm Functions” on page
624.

686
28 Alarm Types
28.13 Creating an Out of Reference Range Alarm
28.13 Creating an Out of Reference Range

Alarm
You create an out of reference range alarm to trigger an alarm when a variable,
such as a temperature, differs from a reference value.
To create an out of reference range alarm

3. In the object type list, select Out of Reference Range Alarm.

6. Click Next.

687
28 Alarm Types
7. In the Upper deviation limit box, enter the upper limit the monitored
variable is allowed to deviate from the reference variable before the alarm is
triggered.
8. In the Lower deviation limit box, enter the lower limit the monitored variable
is allowed to deviate from the reference variable before the alarm is triggered.
9. In the Deadband box, enter the range the monitored variable has to pass
within the normal range before the alarm is reset.
11. Click the Set unit button to select the unit of measure for the alarm limits
and deadband.
Note
• If the monitored value has a unit of measurement defined, the
alarm limits and deadband are assigned that unit by default.

688
28 Alarm Types
12. Select the unit of measure.

14. Click Select.
15. In the Reference variable box, enter the reference variable to compare with
the monitored variable.
disabled mode.
time delay before the alarm is triggered.

689
28 Alarm Types
19. In the Shunt variable box, enter the digital variable that enables or disables
the alarm.
20. Click Next.

21. In the Messages area, in the Above upper limit message box, type the
message to display when the monitored variable exceeds the upper alarm
limit.

690
28 Alarm Types
22. In the Below lower limit message box, type the message to display when
the monitored variable falls below the lower alarm limit.
reset.
24. In the Priorities area, in the Above upper limit priority box, enter the
priority of the alarm when the monitored variable exceeds the upper alarm
limit.
Above upper limit priority box.
26. In the Below lower limit priority box, enter the priority of the alarm when
the monitored variable falls bellow the lower alarm limit.
27. In the Reset priority box, enter the priority for alarm when it is reset.
28. Under Category and Alerts, in the Category box, enter the category that
the alarm belongs to.
30. Select Audible alert to make a sound when the alarm is triggered.
31. Click Next.


691
28 Alarm Types

• Click Single when the alarm needs to be acknowledged once, either in
• Click Extended when the alarm needs to be acknowledged in both the
33. In the Cause note group box, enter the cause note group that you want to
34. In the Action note group box, enter the action note group that you want to
35. In the Checklist box, enter the checklist that you want to connect to the
alarm.
acknowledged.
acknowledged.
acknowledged.
acknowledged.

692
28 Alarm Types
41. Click Next.


693
28 Alarm Types
45. Click Create.

694
28 Alarm Types
28.14 Sum Alarm
28.14 Sum Alarm

A sum alarm can be seen as a collection of alarms that have one or several
common denominators. The conditions you use to filter out which alarms the sum
alarm monitors are the same conditions you use to filter the Alarms pane or an
Alarm View. You can use wildcards when setting up filter conditions. For more
information, see section 32.7 “Filter Condition Wildcards ” on page 954.
For example, when an alarm is triggered you want to light a red operating lamp.
Instead of connecting all alarms in the system to the indication lamp, you create a
sum alarm and connect it to the indication lamp. You reduce the amount of alarms
by configuring the sum alarm to only trigger when alarms with a certain priority and
category are triggered.

695
28 Alarm Types
28.15 Creating a Sum Alarm

You create a sum alarm to monitor alarms with one or more common
denominators. The alarm is triggered when one of the monitored alarms changes its
state to alarm state.
To create a sum alarm

3. In the object type list, select Sum Alarm.

6. Click Next.

696
28 Alarm Types
7. Click the Add condition button to add a denominators that sort out the
alarms to monitor.
8. Enter the necessary information to specify the option that sorts out the alarms
to monitor.
disabled mode.
disables the alarm.
13. Click Next.

697
28 Alarm Types
reset.
Alarm priority box.
22. Click Next.

698
28 Alarm Types

alarm.
acknowledged.

699
28 Alarm Types
acknowledged.
acknowledged.
acknowledged.
32. Click Next.

700
28 Alarm Types
36. Click Create.

701
28 Alarm Types
28.16 Enumeration Alarm
28.16 Enumeration Alarm

An enumeration is a variable with labeled values; different variables have different
enumerations. When configuring an enumeration alarm, you configure the variable
and its enumerations to monitor.
For example, you create an enumeration alarm that monitors the reliability variable
of an I/O point. The alarm is configured to trigger when the reliability variable has an
enumeration that indicates the value generated by the I/O point is unreliable.
Figure: Alarm wizard example when creating an enumeration alarm that monitors the
reliability enumeration value of an I/O variable.
Enumeration alarms can be configured using shunt variable and time delay. For
more information, see section 27.3 “Alarm Functions” on page 624.

702
28 Alarm Types
28.17 Creating an Enumeration Alarm

You create an enumeration alarm to monitor the enumerations of a variable.
To create an enumeration alarm

1. In WorkStation, in the System Tree pane, select the folder or Building
Operation server where you want to create the alarm.
3. In the object type list, select Enumeration Alarm.

6. Click Next.

703
28 Alarm Types
7. In the Monitored variable box, enter the object and its enumeration type
that the alarm monitors.
8. Under Trigger alarm when variable is, select the enumeration options of
the enumeration type that triggers the alarm.
disabled mode.
disables the alarm.
13. Click Next.

704
28 Alarm Types
reset.
Alarm priority box.
22. Click Next.

705
28 Alarm Types

alarm.
acknowledged.

706
28 Alarm Types
acknowledged.
acknowledged.
acknowledged.
31. Under Required User Actions, select the check boxes for Comment,
32. Click Next.

707
28 Alarm Types
36. Click Create.

708
28 Alarm Types
28.18 System Information Alarms

System information alarms monitor system entities, such as online status for servers
or field devices. The system information alarms are generated by Building
Operation. Users cannot create new system alarms. The possible causes of a
system alarm are gathered in an enumeration called System alarm ID. When a
system alarm is triggered, the cause of the alarm is indicated in the System alarm ID
column in the Alarms pane or Alarm View. Some system alarms have additional
information in the Alarm text column.
For example, a Building Operation system information alarm notifies the user when
a Xenta device becomes offline.
System information alarms have the category 'System Alarm'. If a System
information alarm has an alarm text, this texts always begins with “System alarm:”.
System information alarms are usually handled similarly to other alarms. After
acknowledging a system information alarm, the cause of the alarm must be
corrected before the alarm state changes to reset and then returns to normal state.
Figure: System information alarm acknowledgement loop where the alarm is

acknowledged in alarm state

709
28 Alarm Types
Figure: System information alarm acknowledgement loop where the alarm is

acknowledged in reset state
Simple system alarms are system alarms with a simplified state handling. When you
acknowledge a simple system alarm, it disappears from the Alarms pane,
regardless of the current alarm state. For example, a simple system alarm notifies
the user when a server or field device performs a warm start.

710
28 Alarm Types
Figure: Simple system alarm acknowledgement loop where the alarm is acknowledged in
alarm state

711
28 Alarm Types
28.19 System Information Alarms List

You use System Information Alarm IDs to filter the content of the Alarms pane or an
Alarm View. You also use System Information Alarm IDs to set up email
notifications, that is, emails that are sent to a recipient when a specific alarm
condition is met.
28.19.1 A-D
Listed below are the System Information Alarms with IDs that begin with the letters
A-D.
A B C D
A log data transfer BACnet did not start Can not enable Database update
was missed archiving failed
A log sample was BACnet server failure Cannot verify lead Defective protocol
missed object status implementation
Alarm signal trigger Bad lead object Communication Device offline

buffer full reference failed
Archive directory Bad lead object type Communication Duplicate device

does not exist! failed Authentication address
error
Archive directory Communication Duplicate device

does not exist! failed Authorization identifier
Retrying in 5 minutes! error
Archive path must be Communication Duplicate device

set to enable failed Configuration name
archiving error
Archiving is not Communication Duplicate network

enabled failed Domain is not identifier
available
Communication Duplicate of local

failed Hostname is network
invalid
Communication
failed Unexpected
Server fullpath
Communication
failed Unexpected
Server type
Communication
failed Version
Mismatch
CWS Alarm Poll

failed

712
28 Alarm Types
Continued
A B C D
CWS Browse failed
CWS GetHistory
failed
CWS GetObject
failed
CWS Method Error
CWS Value Poll failed
28.19.2 E-L
E-L.
E F I L
Email service Failed to create Incorrect lead object Log full

configuration error object back-reference
Email service failed to Failed to initialize Invalid archive path Log stopped
connect to SMTP references because it is full
server
Email service failed to Failure backing up Invalid archiving Log variable error
login to SMTP server server database format
Email service failed to Failure restoring Invalid device Logging started

send message server database address
Email service no Failure retrieving Invalid device Logging stopped

recipient email backup set from identifier
address remote server
Email service no File I/O error IO error when

sender and recipient generating archive
email address
Email service no IO error when writing

sender email address to archive temporary
Error in log definition IO error, cannot write

to archive directory!
IO error, cannot write

to archive directory!
Retrying in 5 minutes!
IO error, not enough

space left in the
archive directory!

713
28 Alarm Types
Continued
E F I L
IO error, not enough

space left in the
archive directory!
Retrying in 5 minutes!
IO module offline
IP connection offline
28.19.3 M-NW8 R
M-N.
M Ne - No NW8 A-D NW8 E-R
Module type NETWORK 8000 NW8 Application NW8 EEprom

mismatch message error 1 checksum error
NETWORK 8000 NW8 Application NW8 EEprom

message end error 16 memory error
Network offline NW8 Application NW8 Freeze error

error 2
New application NW8 Application NW8 Hot water

program error 4 potentiometer
No file name set NW8 Application NW8 Induction

modified auxilary
potentiometer
No valid Blueprint File NW8 AS1 diagnostic NW8 Joins LCM

network event
Not enough flash NW8 ASD message NW8 Joins network

memory for log event
Not enough RAM NW8 AT1 diagnostic NW8 Leaves LCM

memory for log network event
NW8 AT2 diagnostic NW8 Leaves network

event
NW8 Command NW8 Leaves/joins

failure LCM network
NW8 Configuration NW8 Leaves/joins

error network
NW8 Damper range NW8 Maximum flow

error potentiometer
NW8 Database NW8 Minimum flow

initialized potentiometer

714
28 Alarm Types
Continued
M Ne - No NW8 A-D NW8 E-R
NW8 Database NW8 Missing

modified changeover input
NW8 Device cold NW8 No U-Link

reset communication
NW8 Device reset NW8 Press sensor
NW8 Device warm NW8 Pressure error

reset
NW8 Duct NW8 RAM failure

temperature
NW8 Duct NW8 Relay failure

temperature out of
range
28.19.4 NW8 R
Listed below are the System Information Alarms with IDs that begin with the letter
N.
NW8 Relay failure NW8 Relay failure NW8 Relay failure NW8 Relay failure
01-12 13-24 25-36 37-48
NW8 Relay failure 01 NW8 Relay failure 13 NW8 Relay failure 25 NW8 Relay failure 37

715
28 Alarm Types
28.19.5 NW8 Ro-NW8 Z

Listed below are the System Information Alarms with IDs that begin with the letter
N.
NW8 Ro - Se NW8 Sensor NW8 Sensor NW8 Se - Z
failure GCS 01-10 failure GCS 21-31
NW8 ROM failure NW8 Sensor failure NW8 Sensor failure NW8 Sensor input
GCS 01 GCS 21 failure
NW8 ROM failure NW8 Sensor failure NW8 Sensor failure NW8 Setpoint out of
GCS 02 GCS 22 range
NW8 Sensor failure NW8 Sensor failure NW8 Sensor failure NW8 Space setpoint
end GCS 03 GCS 23
NW8 Sensor failure NW8 Sensor failure NW8 Space

GCS 04 GCS 24 temperature
NW8 Sensor failure NW8 Sensor failure NW8 System fault 32

GCS 05 GCS 25
NW8 Sensor failure NW8 Sensor failure NW8 UI diagnostic

GCS 06 GCS 26
NW8 Sensor failure NW8 Sensor failure NW8 UI1 diagnostic

GCS 07 GCS 27

GCS 08 GCS 28

GCS 09 GCS 29

GCS 10 GCS 30
NW8 Sensor failure NW8 UI5 diagnostic

GCS 31
NW8 UI6 diagnostic
NW8 UI7 diagnostic
NW8 UI8 diagnostic
NW8 Unrecognized
command
NW8 Zone
temperature out of
range
28.19.6 P-S
P-S.

716
28 Alarm Types
Continued
P Se-Sh Si-Sy
Parser failed See gap after 0x200 Sigma system schedule

executed
Port offline Serial port in use Signal alarm
Server configuration error Signal Event
Server not restarted Backup Subnet offline

in process
Server not restarted Other System cold start
Server not restarted Restore System cold start initiated by

in process operator
Server offline System factory reset
Server restarted System warm start
Shadow update failed System warm start initiated

by operator
28.19.7 T-W
T-W.
T U W
Task 1 CPU limit reached, Unable to access lead object Wrong alarm unit
disabling real time priority
Task 2 CPU limit reached, Unable to access shadow

disabling real time priority object
Task period extended Unhandled buffer ready

notification
Too many log definitions Unit is locked
Unit is unlocked

717
28 Alarm Types
28.20 Configuring the Description of an Alarm
28.20 Configuring the Description of an Alarm

You configure the description of an alarm to make it easier to identify the object.
To configure the description of an alarm

1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the Basic Settings tab.
3. In the Description box, type a description for the object.

718
28 Alarm Types
28.21 Configuring Attachments of an Alarm
28.21 Configuring Attachments of an Alarm

You attach files of different types to an alarm to be presented when the alarm is
triggered.
To configure the attachments of an alarm

1. In WorkStation, in the System Tree pane, select the alarm object you want
to configure.
2. Click the Attachment tab.
Note
• Click the Navigate to button to open the selected

attachment in a new dialog box.
4. Click the Remove attachment button to remove an attachment from

the alarm.

719
28 Alarm Types
28.22 Removing Attachments from an Alarm
28.22 Removing Attachments from an Alarm

You remove an attachment from an alarm to meet the unique needs of your site
To remove an attachment from an alarm

1. In the System Tree pane, select the alarm object from which you want to
remove an attachment.
2. In the Attachment view, select the attachment you want to remove.
Note
• Click the Navigate to button to open the selected

attachment in a new dialog box.
3. Click the Remove attachment button to permanently remove the

attachment from the list.

720
29 Alarms Functions
Topics
Time Delay
Configuring the Delay Time of an Alarm
Shunt Variable
Editing the Shunt Variable
Deadband
Alarm Messages
Configuring the Alarm Message of an Alarm
Priority
Configuring the Priority of an Alarm
Categories
Creating a Category
Configuring the Category of an Alarm
Editing a Category
Acknowledgement
Configuring the Acknowledgement Type of an Alarm
No Acknowledgement
Single Acknowledgement
Extended Acknowledgement
User Actions
Configuring Forced User Action
Alarm Attachment
Adding an Attachment to an Alarm
Notifications
Creating an E-mail Notification
Setting Up a Write to File Notification
Selecting the Schneider Electric E-mail Server for E-mail
Notifications
Substitution Codes for Notifications
Automatic Assignment
Creating an Automatic Assignment
Unit of Measure in Alarms
Configuring the Limits of an Alarm
Configuring the Flashing of an Alarm
Configuring the Audibility of an Alarm
Configuring the Audibility of an Alarm in Reset State
29 Alarms Functions
29.1 Time Delay
29.1 Time Delay

Time delay prevents unintentional activation-deactivation cycles. You can delay the
time before the alarm is triggered when the alarm state goes from normal state to
alarm state and when it goes from alarm state to reset state.
For example, an out of range alarm is configured with a 2 second time delay before
the alarm is triggered, and a 3 second time delay before the alarm is reset. The
monitored variable alarm exceeds the upper limit for 1 second before it returns to a
value below the upper limit, but this does not trigger the alarm. The alarm is
triggered when the variable has been in alarm state for more than 2 seconds. When
the problem is corrected, the alarm must remain in normal state for longer than 3
seconds to reset.
Figure: Alarm with time delay

Time delay can be added to all Building Operation alarms except for system
information alarms.

723
29 Alarms Functions
29.2 Configuring the Delay Time of an Alarm
29.2 Configuring the Delay Time of an Alarm

You configure the time delay of an alarm to meet the unique needs of your site.
To configure the delay time of an alarm

1. In WorkStation, in the System Tree pane, select the alarm object you want
to configure.
2. Click the Alarm Trigger tab.
3. In the Alarm delay box, enter the time delay before an alarm is triggered.
4. In the Reset delay box, enter the time delay before an alarm is reset.
5. In the Changes have been made dialog box, click Yes to save the
changes.

724
29 Alarms Functions
29.3 Shunt Variable
29.3 Shunt Variable

A shunt variable is a binary value that works as an on/off switch for the alarm.
If the shunt variable is true, the alarm is disabled.
Figure: Alarm variable that is disabled by a shunt variable

A shunt variable can be set for every type of alarm except for sum alarms and
information system alarms.

725
29 Alarms Functions
29.4 Editing the Shunt Variable
29.4 Editing the Shunt Variable

You add or edit the shunt variable that is connected to an alarm, to enable or
disable the alarm.
To edit the shunt variable

1. In the System Tree pane, select the alarm for the shunt variable you want to
edit.
2. In the Alarm Trigger view, in the Shunt variable box, enter a digital
variable that is used as a shunt variable.
changes.

726
29 Alarms Functions
29.5 Deadband
29.5 Deadband
Deadband is an area of the alarm range where no reset action occurs. The purpose
of the deadband is to prevent unintentional activation-deactivation cycles.
For example, an out of range alarm has an upper limit of 10 and the deadband is 2.
The monitored variable must be equal to or fall below 8 (10-2) before the triggered
alarm is reset.
Figure: The monitored variable has to reach the limit of the deadband before the alarm is
reset.
Deadband can be set for out of range alarms and out of reference range alarms.

727
29 Alarms Functions
29.6 Alarm Messages
29.6 Alarm Messages

When configuring the alarm, you can write a message that displays in the Alarms
pane, Events pane, Alarm Views, and Event Views when an alarm is triggered or
reset.
For example, you configure a multistate range alarm to display the text “The unit is
too hot” when the alarm is triggered and “The unit temperature is back to normal”
when the alarm is reset.
In the alarm message you can use substitution codes to spell out current object
values. Substitution codes are usually used to spell out current object values.
Table: Alarm Message Substitution Codes

@(F) Displays the full path of the monitored

variable.
@(O) Displays the monitored variable name.
@(P) Displays the monitored property.
@(V) Displays the value of the monitored variable

at the time of the state change.
For example, you create an alarm that is monitoring a temperature object named
T64. You write an alarm message that says: “The point @(O) is too hot.” When the
temperature value increases to 35, the alarm is triggered. The alarm with its alarm
message is presented in the Alarms pane and Alarm Views: “The point T64 is too
hot.”

728
29 Alarms Functions
29.7 Configuring the Alarm Message of an Alarm
29.7 Configuring the Alarm Message of an

Alarm
You configure the text of the alarm message that displays when the alarm is
triggered.
To configure the alarm message of an alarm

configure.
2. Click the Presentation tab.
3. Under Alarm message, type the alarm message for the different alarm
criterias.
changes.

729
29 Alarms Functions
29.8 Priority
29.8 Priority
When configuring an alarm, you define the priority of the alarm. The priority is used
to inform the operator of the importance of the triggered alarm. The priority is
displayed in the Alarms pane, Events pane, Alarm Views, and Event Views.
You can configure different priority levels for different states in the alarm. The default
priority number of an alarm is 100. However, you can change this number to any
integer between 0 and 999. You define what is high priority and what is low priority.
For example, you create two alarms, alarm A and B. Alarm A is more critical than
Alarm B. Therefore, it is given a higher priority level when the alarm is triggered but a
lower priority if the alarm is reset. When both alarms are triggered at the same time,
the priority levels of the alarms can guide the operator towards which alarm to work
with first. When the problem that triggered the alarm with highest priority is
corrected, the alarm goes to the reset state that has a lower priority than the
second alarm.

730
29 Alarms Functions
29.9 Configuring the Priority of an Alarm
29.9 Configuring the Priority of an Alarm

You configure the priority level of the different alarm states to meet the unique
needs of your site.
To configure the priority of an alarm

configure.
3. Under Priorities, select the Same priority check box to enter the same
priority.
4. In the Priorities boxes, enter the priority for each alarm state.
changes.

731
29 Alarms Functions
29.10 Categories
29.10 Categories
You can group together alarms in categories to simplify the identification of the
alarm. When the alarm is triggered, the category name is displayed together with
the alarm in the Alarms pane, Events pane, Alarm Views, and Event Views.
For example, you create a category called “Building A” and add all alarms
represented in the building to this category. Another example could be that you
create a category called “Door alarm” and select this category for every door alarm
in the system.

732
29 Alarms Functions
29.11 Creating a Category

You create a category to group alarms so that alarms are more easily identified.
For more information, see section 29.10 “Categories” on page 732.
To create a category
2. In the Server box, select the server where you want to create the category.
3. In the Alarm handling area, click Categories.
4. Click the Categories tab, and then click the Add category button .

733
29 Alarms Functions
5. In the Name box, type the name of the new category.
6. In the Description box, type a description for the category.

7. Click OK.

734
29 Alarms Functions
29.12 Configuring the Category of an Alarm
29.12 Configuring the Category of an Alarm

You configure a different category for an alarm to meet the unique needs of your
site.
To configure the category of an alarm

configure.
3. In the Category box, enter a category for the alarm.

735
29 Alarms Functions
29.13 Editing a Category

You edit an existing category to change the name or the descriptions of the
categories that alarms can be a member of, and to simplify the identification of
alarms in the system.
To edit a category
2. On the Control Panel, click Categories.
3. In the Categories tab, select the category you want to edit.

736
29 Alarms Functions
4. Click the Edit category button .
Note
• To permanently remove a category from the categories list, click
the Remove category button .
5. In the Edit Category dialog box, in the Name box, type a name for the
category.
6. In the Description box, type a description for the category

7. Click OK.

737
29 Alarms Functions
29.14 Acknowledgement
29.14 Acknowledgement
When an alarm is triggered, you acknowledge the alarm to indicate to other users
that you have responded to the alarm and intend to troubleshoot the problem that
caused the alarm. The name of the user that acknowledges the alarm is displayed
in the Alarms pane, Events pane, Alarm Views, and Event Views.
Alarms can be configured to be acknowledged in different ways. The transition
between alarm states depends on the Basic evaluation property of the alarm.
29.14.1 No Acknowledge
When you select the acknowledgment type No acknowledgement, the triggered
alarm returns to normal state and disappears from the alarm view when the
monitored variable no longer meets the criteria to trigger the alarm. You select this
user action when the user only needs to see a status and does not need to take any
action on the alarm, for example, to see if a space is occupied or not.
For more information, see section 29.16 “No Acknowledgement” on page 740.
29.14.2 Single Acknowledge

When you select the acknowledgment type Single acknowledgment, the user
needs to acknowledge the alarm in the alarm view before the alarm returns to
normal state and disappears from the alarm view.
For more information, see section 29.17 “Single Acknowledgement” on page 742.
29.14.3 Extended Acknowledge

When you select the acknowledgement type Extended acknowledgment, the user
needs to acknowledge the alarm in the alarm view in reset state, before the alarm
returns to normal state and disappears from the alarm view.
For more information, see section 29.18 “Extended Acknowledgement” on page
744.
29.14.4 System Information Alarms

No acknowledgement type can be set for simple system alarms. You have to
acknowledge the alarm to send it back to Normal state. If you do not acknowledge
the alarm, it remains in Alarm state. For more information, see section 28.18
“System Information Alarms” on page 709.
29.14.5

738
29 Alarms Functions
29.15 Configuring the Acknowledgement Type of an Alarm
29.15 Configuring the Acknowledgement

Type of an Alarm
You configure the properties of an alarm to meet the unique needs of your site.
To configure the acknowledgement type of an alarm

configure.
2. Click the User Action tab.
3. Select the Aknowledgement type:
state.
changes.

739
29 Alarms Functions
29.16 No Acknowledgement
When you select the acknowledgment type No acknowledgement, the triggered
alarm returns to normal state and disappears from the alarm view when the
monitored variable no longer meets the criteria to trigger the alarm. You select this
user action when the user only needs to see a status and does not need to take any
action on the alarm, for example, to see if a space is occupied or not.
Figure: No acknowledgement loop where the alarm does not have to be acknowledged
before the alarm returns to normal state.
The user can acknowledge the alarm in the alarm view to let other users know that
the alarm has been noted. The acknowledgment is optional and the alarm does not
require an acknowledgement to return to normal state.

740
29 Alarms Functions
Figure: No acknowledgement loop where the alarm is acknowledged before it returns to

normal state.

741
29 Alarms Functions
29.17 Single Acknowledgement

When you select the acknowledgment type Single acknowledgment, the user
needs to acknowledge the alarm in the alarm view before the alarm returns to
normal state and disappears from the alarm view.
If the user acknowledges the alarm when it is in alarm state, the alarm is set to
acknowledged state. When the problem that triggered the alarm is corrected, that is
when the monitored variable no longer meets the criteria to trigger the alarm, the
alarm returns to normal state.
Figure: Single acknowledgement loop where the alarm is acknowledged in alarm state
If the user did not acknowledge the alarm when it was in alarm state, and the
monitored variable no longer meets the criteria to trigger the alarm, the alarm is set
to reset state. The user needs to acknowledge the alarm in reset state to make it
return to normal state. In this case, the alarm can toggle between alarm state and
reset state several times before a user acknowledges the alarm.

742
29 Alarms Functions
Figure: Single acknowledgement loop where the alarm is acknowledged in reset state

743
29 Alarms Functions
29.18 Extended Acknowledgement

When you select the acknowledgement type Extended acknowledgment, the user
needs to acknowledge the alarm in the alarm view in reset state, before the alarm
returns to normal state and disappears from the alarm view.
If the user acknowledges the alarm when it is in alarm state, the alarm is set to
acknowledged state. When the problem that triggered the alarm is corrected, that is
when the monitored variable no longer meets the criteria to trigger the alarm, the
alarm is set to reset state. The user needs to acknowledge the alarm in reset state
to make it return to normal state.
Figure: Extended acknowledgement loop where the alarm reset state has to be
acknowledged before the alarm returns to normal state
If the user did not acknowledge the alarm when it was in alarm state and the
monitored variable no longer meets the criteria to trigger the alarm, the alarm is set
to reset state. The user needs to acknowledge the alarm in reset state to make it
return to normal state. In this case, the alarm can toggle between alarm state and
reset state several times before a user acknowledges the alarm.

744
29 Alarms Functions
Figure: Extended acknowledgement loop where the alarm toggles between alarm state
and reset state

745
29 Alarms Functions
29.19 User Actions
29.19 User Actions

You can add information when handling a trigger alarm. For example, you can add
a comment to the alarm or open an action note that is connected to the alarm.
When configuring an alarm, you can force the user to perform different actions
when handling a triggered alarm.
You can add several comments and connect cause notes, action notes, and
checklist items to a single alarm.
Note
When a top server is connected to a tier level server, all existing checklists, action
notes, cause notes, and categories on the tier level server are removed and
replaced with the objects from the top server.
29.19.1 Comments
Use comments to save written information about an alarm. Comments can be
added and viewed at any time. A comment is automatically tagged with the user
name and a time and date stamp. Useful comments could be the cause of the
alarm and how it was taken care of. Information like this can be of great help the
next time the same alarm is triggered.
For more information, see section 30.1 “Comments” on page 779.
29.19.2 Cause Notes

A cause note specifies the problem that caused the alarm. Cause notes are
grouped by category, with possible alarm causes listed in each group. When an
alarm is triggered, you can easily report the causes that triggered the alarm by
selecting the predefined alternatives.
For more information, see section 30.2 “Cause Notes” on page 780.
29.19.3 Action Notes

Action notes are grouped by category, with possible actions that may correct the
problem listed in each category. An action note specifies the actions that you used
to correct the problem that caused the alarm.
For more information, see section 30.6 “Action Notes” on page 786.
29.19.4 Checklists
A checklist is a set of steps that guides the user to which action to take when an
alarm is triggered. If an alarm goes to normal state, the corresponding checklist is
also reset and each step has to be checked again.
For more information, see section 30.10 “Checklists” on page 792.

746
29 Alarms Functions
29.19 User Actions
29.19.5 Summary of User Actions

Table: User Actions
User Action Description Use
Comments User added written Use comments to save

information to a triggered written information to an
alarm. alarm. For example, what
triggered the alarm or how
was the alarm solved.
Cause Notes A predefined list of the Use the cause notes to easily
problems that can have report the cause that
caused the alarm. triggered the alarm.
Action Notes A predefined list of possible Use the action notes to easily
actions that can correct the report the actions that were
problem. taken to correct the problem
that triggered the alarm.
Checklists A predefined list of steps that Use the checklist to navigate

guides the user to solve the the user step-by-step to
problem that can have solve the problem.
triggered the alarm.

747
29 Alarms Functions
29.20 Configuring Forced User Action
29.20 Configuring Forced User Action

You force the user to perform certain actions when working with alarms to meet the
unique needs of your site.
To configure forced user actions

configure.
2. Click the User Action tab.
3. Under Required user action, select the check boxes for Comment,
changes.

748
29 Alarms Functions
29.21 Alarm Attachment
29.21 Alarm Attachment

Alarms can have attachments. The attachment can be a link pointing to an object in
the system, for example, a report, a trend chart, or a schedule. The attachment can
also be a graphic, a Microsoft Word file, a PDF file, a video recording, a voice
message, or a pop-up window that contains information regarding the alarm.
In WebStation, you can open attachments that refer to objects in the system. In
WorkStation, you can also open other types of attachments, provided that the
program or editor associated with the attachment is locally installed on your
computer. For example, if the attachment is a PDF file, you can open the file if
Adobe Reader or a similar program is installed on your computer.

749
29 Alarms Functions
29.22 Adding an Attachment to an Alarm

You add an attachment, for example a .pdf file or a trend log, to assist the user
when diagnosing or solving the problem that caused the alarm.
For more information, see the Concept Title topic on WebHelp.
To add an attachment to an alarm

1. In the Alarm View of the alarm, click the Attachment tab.
3. In the Select Object dialog box, browse to the item you want to attach to the
alarm.
4. Click Select.

750
29 Alarms Functions
(In FM: TaskClosing) The selected attachment appears in the Attachment list of the
alarm and is attached when the alarm is triggered.

751
29 Alarms Functions
29.23 Notifications
29.23 Notifications
User notifications are used for notifying users or user groups that a certain alarm
event has occurred in the system. The notification contains a prewritten message
that is either sent in an E-mail or written to a text file. When setting up the
notification, you write the message and then configure the conditions that execute
the writing or sending action.
29.23.1 E-mail Notification

The notification is sent by E-mail through the SMTP protocol when the configured
condition is satisfied. You can either use a predefined SMTP server provided by
Schneider Electric or use your own SMTP server.
For example, you create an E-mail notification with the message "An alarm is
triggered in building C, please acknowledge immediately". You configure the
notification to be sent to a security group's E-mail address when any alarm in
building C is triggered. For more information, see section 31.79 “Email Notification
When writing the text message, you can use substitution codes to add current
system information. For more information, see section 29.27 “Substitution Codes
for Notifications” on page 763.
Note
If the server fails to send an E-mail notification, this is indicated by a system
information alarm. For more information, see section 28.18 “System Information
Alarms” on page 709.
29.23.2 Write to File Notification

With a write to file notification, the message is appended to a text file. If the text file
exists, a new row is added with the notification. If the file does not exist, a new text
file is created. If your database is located on an Enterprise Server, the text file is
located in the notifications folder in the database folder. In Software
Administrator, you can see where the Enterprise Server database folder is located.
For more information, see section 15.1 “Software Administrator” on page 299. If
your database is located on an Automation Server, you have to use a Secure Copy
Program to locate the text file in the Automation Server file system at
/opt/tac/db/notifications.
You can use the write to file notification, for example, to trigger a third party
software program when a specific text-string is written to the file by a Building
Operation server. For more information, see section 31.82 “Write to File Notification
Substitution codes can be used in the notification text. For more information, see
section 29.27 “Substitution Codes for Notifications” on page 763.

752
29 Alarms Functions
29.23 Notifications
29.23.3 Substitution Codes for Notification

Substitution codes are codes that represent a dynamic value and are preferably
used to spell out the current object values.
For more information, see section 29.27 “Substitution Codes for Notifications” on
page 763.

753
29 Alarms Functions
29.24 Creating an E-mail Notification

You create an E-mail notification to send an E-mail message when an alarm event
occurs.
To create an E-mail notification

you want to create the notification.
2. On the File menu, point to New and then click Notification.
3. In the object type list, select Email Notification.
4. In the Name box, type a name for the notification.

5. In the Description box, type a description for the notification.
6. Click Next.

754
29 Alarms Functions
7. In the Status box, select Enabled to activate the E-mail notification.
8. In the Notify on transition to boxes, select the alarm status for when to
generate the notification.
9. In the E-mail address box, type the E-mail address of the recipient of the E-
mail messages.
10. In the Subject box, type the subject of the E-mail message.
11. In the Text box, type the notification message, which can include substitution
codes. For more information, see section 29.27 “Substitution Codes for
Notifications” on page 763.

755
29 Alarms Functions
12. Click the Add condition button and select the condition type that is to
generate the E-mail notification.
13. Type the condition for the E-mail notification.
15. Type the condition for the E-mail notification.
Tip
• You can add different condition types by clicking the Add
condition button . For example, you can filter on

categories, alarm state, and alarm text.

756
29 Alarms Functions
16. Click Create.

757
29 Alarms Functions
29.25 Setting Up a Write to File Notification

You set up a write to file notification to write a message in a text file when a certain
alarm event occurs.
To set up a write to file notification

you want to create the notification.
2. On the File menu, point to New and then click Notification.
3. Select Write to File Notification.
4. In the Name box, type a name for the notification.

5. In the Description box, type a description for the notification.
6. Click Next.

758
29 Alarms Functions
7. In the Status box, select Enable to activate the write to file notification.
8. In the Notify on transition to boxes, select the alarm status for when to
generate the notification.
9. In the File name box, type the name of the file where the message is written.
Note
• If a file already exists with this name, the system writes the
message in the end of the file. If it does not exist, the system
creates a new file..
• The file is located in the database folder. For more information,
see section 15.1 “Software Administrator” on page 299.
10. In the Text box, type the message that is written to the notification file.
Note
• You can use substitution codes to let the system automatically
write system information in the notification message.
11. Click the Add condition button to set up the events that generate the
writing action and select an event category.
12. Enter the settings of the event category that generate the writing action.
Note
• You can add several event categories to specify when to write
the notification.

759
29 Alarms Functions
14. Click Create.

760
29 Alarms Functions
29.26 Selecting the Schneider Electric E-mail Server for E-mail Notifications
29.26 Selecting the Schneider Electric E-mail

Server for E-mail Notifications
You configure an Automation Server or Enterprise Server to connect to and send E-
mail notifications through the Schneider Electric E-mail Server, which is an SMTP
server hosted by Schneider Electric.
Note
• Any available SMTP server can be used to send E-mail notifications. For more
information, see the Selecting and Specifying an E-mail Server for E-mail
Notifications topic on WebHelp.
For more information, see the Server Communication topic on WebHelp.
To select the Schneider Electric E-mail server for E-mail

notifications
1. In WorkStation, in the System Tree pane, select the server that you want to
configure.
3. Click the E-mail tab.

761
29 Alarms Functions
29.26 Selecting the Schneider Electric E-mail Server for E-mail Notifications
4. In the Select E-mail server box, select Schneider Electric E-mail

Server to use the SMTP server hosted by Schneider Electric.
5. In the Sender E-mail box, type a sender address for the E-mail messages
that are generated by this Building Operation server. The sender E-mail
address is the receiver of replies.
6. In the Maximum queue size box, enter the maximum number of E-mail
messages that is allowed in the queue.
7. In the Maximum retry count box, enter the number of attempts to send an
E-mail message that are performed before cancelling the E-mail message.
8. In the Retry time box, enter the number of minutes between each attempt.
9. In the Host box, confirm that the Schneider Electric E-mail Server address is
smtpservice.tac.com.
10. In the SMTP port box, confirm that the port number is 25.
11. Click OK.

762
29 Alarms Functions
29.27 Substitution Codes for Notifications

Substitution codes are codes that represent a dynamic value and are preferably
used to spell out the current object values.
The substitution codes for E-mail notification texts can be used in the E-mail subject
and message. For write to file notifications, the substitution codes can be used in
the message but not in the file name. A substitution code for notifications has the
form @([property]) where [property] is replaced by one of the alarm properties. If you
use a substitution code that is invalid for the specific alarm event, the substitution
code is replaced by an empty string.
Table: Substitution Codes for Notifications

Code Description
@(AcknowledgedBy) Writes the user that acknowledged the

alarm.
@(AcknowledgeTime) Writes the time the alarm was

acknowledged.
@(AckRequired) Writes an indicator if the BACnet alarm

requires acknowledgement.
@(AlarmState) Writes the present state of the alarm.
@(AlarmText) Writes the alarm messages that is added to

the alarm.
@(AssignedID) Writes the unique ID of the user the alarm is

assigned to.
@(AssignedState) Writes the current assigned state the alrm is

in. The possible values are Unassigned,
Assigned, and Accepted.
@(AssignedTo) Writes the name of the user or group that the

alarm is assigned to.
@(AssignedToDomain) Writes the domain of the user or group that

the alarm is assigned to.
@(BACnetEventType) Writes the BACnet event type for this alarm.
@(BACnetNotificationType) Writes whether the BACnet notification was

an alarm or event.
@(BasicEvaluationState) Writes if the alarm is active or not.
@(Category) Writes the category name of the alarm.
@(CommandValue) Writes the value which was commanded for

a BACnet command failure alarm.
@(ConfirmedNotification) Writes an indication whether a BACnet

notification was issued as a confirmed or
unconfirmed BACnet message.

763
29 Alarms Functions
Continued
Code Description
@(Count) Writes the number of times the alarm has

toggled between the alarm and reset states.
@(Deadband) Writes the value of the deadband used for

limit checking for BACnet out of range
alarms.
@(DeviceName) Writes the name of the I/NET device that

generated the event.
@(DisabledCause) Writes the cause of the alarm being

disabled. An alarm can be disabled by User,
Shunt variable, and System. If the alarm isn't
configured correctly it can be disabled by
System.
@(ErrorLimit) Writes the difference limit that was exceeded

for BACnet floating limit alarms.
@(EvaluationState) Writes the present evaluation state of the

alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.
@(EventFromState) Writes the event state of the object prior to

the occurence of the alarm condition for
BACnet alarms.
@(EWSid) Writes the EcoStruxure Web Service

identification of the alarm on the external
system.
@(EWSSourceId) Writes the EcoStruxure Web Service

identification of the external object that
generated the alarm.
@(ExceededLimit) Writes the value of the limit that was

exceeded for BACnet out of range alarms.
@(ExceedingValue) Writes the value that exceeded a limit for

BACnet out of range alarms.
@(FeedbackValue) Writes the value that differs from the

commanded value for a BACnet command
failure alarm.
@(FirstName) Writes the first name of the individual whose

@(Hidden) Writes the visible status of an object. False

is displayed when the object is shown.
@(IndivNdx) Writes the individual number of the individual

whose key/card was used at the I/NET door
point.
@(LastName) Writes the last name of the individual whose


764
29 Alarms Functions
Continued
Code Description
@(Logging) Writes whether the alarm should be logged

or not.
@(MessageText) Writes the text of an I/NET action or dispatch

message, if there is one.
@(MonitoredObject->DESCR) Writes the description property of the

monitored object.
@(MonitoredObject->NAME) Writes the name property of the monitored

object.
@(MonitoredObject->NOTE1) Writes the note 1 property of the monitored

object.
@(MonitoredObject->NOTE2) Writes the note 2 property of the monitored

object.
@(MonitoredValue) Writes the value the monitored variable had

when the alarm was triggered.
@(MonitoredVariable) Writes the path of the monitored variable.
@(NewMode) Writes the new mode of the monitored

object for a BACnet change of value alarm.
@(NewState) Writes the new state of the monitored object

for a BACnet change of state or change of
life safety alarm.
@(NewValue) Writes the new value of the monitored

property for a BACnet change of value
alarm.
@(NotificationClass) Writes the distribution information of an

alarm notification within a BACnet system.
@(OperationExpected) Writes the next operation requested by the

monitored object for a BACnet change of life
safety alarm.
@(PossibleOperatorActions) Writes the possible actions one can perform

on the record, given permissions.
@(PreviousAlarmState) Writes the previous alarm state.
@(Priority) Writes the current priority level of the alarm

state.
@(ProcessId) Writes the process identifier configured by

the notification for a BACnet alarm.
@(ReferencedBitString) Writes the new value of the monitored

bitstring property for a BACnet change of
bitstring alarm.
@(SEQNO) Writes the sequence number of the record.

765
29 Alarms Functions
Continued
Code Description
@(SetpointValue) Writes the value of the setpoint when the

alarm condition occured for a BACnet
floating limit alarm.
@(Source) Writes the path of the source object.
@(SourceName) Writes the name of the source object that

generated the alarm.
@(SourceObject->DESCR) Writes the description property of the source

object.
@(SourceObject->NAME) Writes the name property of the source

object.
@(SourceObject->NOTE1) Writes the note 1 property of the monitored

object.
@(SourceObject->NOTE2) Writes the note 2 object of the monitored

object.
@(SourceServer) Writes the path to the server where the

source object is located.
@(StatusFlags) Writes the status flag of the object.
@(SystemAlarmId) Writes the alarm ID generated by the

system.
@(TenantNdx) Writes the tenant number of the individual

whose key/card was used at the I/NET door
point.
@(TimeStamp) Writes the time and date when the event

was generated.
@(TriggeredTimestamp) Writes the time and date of the last state

transfer from normal state to alarm state.
@(TYPE) Writes the record type.
For example, you configure a write to file notification that is sent when an alarm is
triggered. For notification text, you write "The room became too hot at
@(TriggeredTimestamp)". If the alarm is triggered at the time 2015-02-12 13:51:36,
the notification file will contain the text: "The room became too hot at 2015-02-12
13:51:36."

766
29 Alarms Functions
29.28 Automatic Assignment
29.28 Automatic Assignment

A triggered alarm can be automatically assigned to a specific user or user group
that is most suited to correct the problem. An assigned alarm indicates to other
users that someone is working with the problem that caused the alarm. The name
of the user that is assigned to the alarm and the assignment status are displayed in
the Alarms pane, Events pane, Alarm Views and Event Views.
When creating an automatic assignment, you configure the condition that needs to
occur before Building Operation sends the assignment request. For example, a
condition could be when any alarm in a specific category group changes its state
from normal state to alarm state.
You can apply a schedule or other multistate variable to enable or disable the
automatic assignment. This multistate variable could be used to assign an alarm to
different users depending on the time. The variable you connect to the assignment
must contain an active value grater than zero.
For example, a calendar is configured to generate the value 2 between 06:30-18:00
and the value 4 between 18:00-06:30. The calendar is connected to two
assignments with the same conditions. One assignment sends an assignment
request to the ordinary operator when the calendar generates value 2. The other
assignment is active when the calendar generates value 4, and sends the
assignment request to the night watch. If an alarm is triggered at 20:00 that fulfills
the condition of the two assignments, an assign request is automatically sent to the
night watch.

767
29 Alarms Functions
29.29 Creating an Automatic Assignment

You create an automatic assignment to automatically assign alarms to a specific
user or user group.
For more information, see section 29.28 “Automatic Assignment” on page 767.
To create an automatic assignment

Operation server where you want to create the assignment.
2. On the File menu, point to New and then click Assignment.
3. In the Name box, enter a name for the assignment.
4. In the Description box, type a description for the assignment.

5. Click Next.
6. In the Status box, select whether to enable or disable the assignment.

768
29 Alarms Functions
7. In the Assigned to box, enter the user or user group that is the receiver of the
assignment request.
8. In the Active value box, enter the multistate value that activates the
assignment.
9. In the Schedule box, enter the schedule or other multistate variable that
contains the value that is used to activate the assignment.
10. Click the Add Condition button to set up the conditions that generate
the assignment.
11. Enter the settings of the condition.
Tip
You can add several assignment conditions to specify when to write
the assignment.
12. Click the Add row button to add another condition of the same condition
type.
13. Click Create.

769
29 Alarms Functions
29.30 Unit of Measure in Alarms
29.30 Unit of Measure in Alarms

When creating an alarm, the alarm limit and deadband values inherit the unit of the
monitored variable. You can change the unit of the alarm to any unit within the same
unit category as the monitored variable.
Note
You cannot define a unit to an alarm that monitors a unitless variable.
If the unit of a monitored variable is replaced by a unit within the same unit category
as the unit of the alarm, Building Operation automatically handles the conversion. If
the unit of the monitored variable is replaced by a unit that belongs to another unit
category, the alarm is disabled by Building Operation. Building Operation triggers a
system alarm to notify that the alarm is disabled due to an impossible unit
conversion.

770
29 Alarms Functions
29.31 Configuring the Limits of an Alarm
29.31 Configuring the Limits of an Alarm

You configure the limits of an alarm to adjust when an alam triggers or resets.
To configure the limits of an alarm

configure.
2. Click the Alarm Trigger tab.
3. In the Alarm limit boxes, enter the limits for the alarm.
changes.

771
29 Alarms Functions
29.32 Configuring the Flashing of an Alarm
29.32 Configuring the Flashing of an Alarm

You configure an alarm to flash in the Alarms pane and Alarm view when it is
triggered, so that the operator can see the alarm more easily.
To configure the flashing of an alarm

configure.
3. Select Flashing to make the alarm flash in the Alarms pane and Alarm Views
when it is triggered.

772
29 Alarms Functions
29.33 Configuring the Audibility of an Alarm
29.33 Configuring the Audibility of an Alarm

You configure an alarm to make a sound when it is triggered so that the operator
can hear the alarm.
To configure the audibility of an alarm

configure.

773
29 Alarms Functions
29.34 Configuring the Audibility of an Alarm in Reset State
29.34 Configuring the Audibility of an Alarm in

Reset State
You configure an alarm to make a sound when it is in reset state and alarm state so
that the operator can hear the alarm.
To configure the audibility of an alarm in reset state

configure.
4. Click the Save button

5. In the computer file system, locate the file named
SE.SBO.WorkStation.exe.config in the folder where WorkStation is installed.
6. Open the SE.SBO.WorkStation.exe.config file in a text editor.

774
29 Alarms Functions
29.34 Configuring the Audibility of an Alarm in Reset State
7. On the row saying: <add key="AudibleAlertOnResetState"

value="false"/>, replace the word "false" with "true" to make the alert
audible when an alarm is in reset state.
8. On the File menu, click Save to save the changes you made to the file.
9. Restart WorkStation.

775
30 User Actions
Topics
Comments
Cause Notes
Creating a Cause Note
Editing a Cause Note
Adding a Cause Note to an Alarm
Action Notes
Creating an Action Note
Editing an Action Note
Adding an Action Note to an Alarm
Checklists
Creating a Checklist
Editing a Checklist
Adding a Checklist to an Alarm
30 User Actions
30.1 Comments
30.1 Comments
Use comments to save written information about an alarm. Comments can be
added and viewed at any time. A comment is automatically tagged with the user
name and a time and date stamp. Useful comments could be the cause of the
alarm and how it was taken care of. Information like this can be of great help the
next time the same alarm is triggered.
Figure: A comment is added to a triggered alarm

Writing a comment is either voluntary or mandatory. You can configure the alarm so
the user is required to write a comment when certain events occur, such as when
an alarm is disabled.

779
30 User Actions
30.2 Cause Notes
30.2 Cause Notes

A cause note specifies the problem that caused the alarm. Cause notes are
grouped by category, with possible alarm causes listed in each group. When an
alarm is triggered, you can easily report the causes that triggered the alarm by
selecting the predefined alternatives.
Figure: Add Cause Notes dialog box

Reporting the cause of the alarm is either voluntary or mandatory. You can
configure the alarm so the user is required to report the causes when certain events
occur, such as when an alarm is disabled.
Cause notes can be of great use the next time the same alarm is triggered or when
extracting alarm statistics.

780
30 User Actions
30.3 Creating a Cause Note

You create a cause note to connect it to an alarm, and to simplify the reporting of
the causes that triggered the alarm.
To create a cause note

2. On the Control Panel, click Cause notes.
3. In the Cause notes view, click the Add cause note button .

781
30 User Actions
4. In the Add Cause Note dialog box, in the Name box, type the name of the
new cause note.
5. In the Group name box, type a name to create a new group or select an
existing group that the new cause note belongs to.
6. In the Description box, type a description for the cause note.
7. Click OK.

782
30 User Actions
30.4 Editing a Cause Note

You edit an existing cause note to change the name or the descriptions, or add the
cause note to another cause note group.
To edit a cause note

2. On the Control Panel, click Cause notes.
3. In the Cause notes view, select the cause note you want to edit.

783
30 User Actions
4. Click the Edit cause note button .
Note
• To permanently remove a cause note from the cause notes list,
click the Remove cause note button .
5. In the Edit Cause Note dialog box, in the Name box, type a name for the
cause note.
existing group.
7. In the Description box, type a description for the cause note
8. Click OK.

784
30 User Actions
30.5 Adding a Cause Note to an Alarm
30.5 Adding a Cause Note to an Alarm

You add a cause note to an alarm to report the cause of the alarm.
To add a cause note to an alarm

1. In the System Tree pane, select the alarm object to which you want to add a
cause note.
2. In the User action view, in the Cause note group box, enter the cause
note you want to add to the alarm.

To add a cause note to an alarm you must have created one in advance and
defined its content.

785
30 User Actions
30.6 Action Notes
30.6 Action Notes

Action notes are grouped by category, with possible actions that may correct the
problem listed in each category. An action note specifies the actions that you used
to correct the problem that caused the alarm.
Figure: Add Action Notes dialog box

Reporting the actions that were taken is either voluntary or mandatory. You can
configure the alarm so the user is required to report the actions when certain events
occur, such as when an alarm is disabled.
Action notes can be of great use the next time the same alarm is triggered or when
extracting alarm statistics.

786
30 User Actions
30.7 Creating an Action Note

You create an action note to connect it to an alarm, and to simplify the reporting of
actions taken when correcting the problem that triggered the alarm.
To create an action note

2. On the Control Panel, click Action notes.
3. In the Action notes view, click the Add action note button .

787
30 User Actions
4. In the Add Action Note dialog box, in the Name box, type the name of the
new action note.
existing group.
6. In the Description box, type a description for the action note.
7. Click OK.

788
30 User Actions
30.8 Editing an Action Note

You edit an existing action note to change the name or the descriptions, or to add
the action note to another group.
To edit an action note

2. On the Control Panel, click Action notes.
3. In the Action notes view, select the action note you want to edit.

789
30 User Actions
4. Click the Edit action note button .
Note
• To permanently remove an action note from the action notes list,
click the Remove action note button .
5. In the Edit Action Note dialog box, in the Name box, type a name for the
action note.
existing group.
7. In the Description box, type a description for the action note.
8. Click OK.

790
30 User Actions
30.9 Adding an Action Note to an Alarm
30.9 Adding an Action Note to an Alarm

You add an action note to an alarm to troubleshoot and report the problem that
triggered the alarm.
To add an action note to an alarm

1. In the System Tree pane, select the alarm object to which you want to add
an action note.
2. In the User action view, in the Action note group box, enter the action
note you want to add to the alarm.

To add a checklist to an alarm you must have created one in advance and defined
its content.

791
30 User Actions
30.10 Checklists
30.10 Checklists
A checklist is a set of steps that guides the user to which action to take when an
alarm is triggered. If an alarm goes to normal state, the corresponding checklist is
also reset and each step has to be checked again.
Figure: Checklist dialog box

Checklists can be voluntary or mandatory. You can force the user to check each
step in the checklist before the alarm can be acknowledged.

792
30 User Actions
30.11 Creating a Checklist

You create a checklist to connect it to an alarm, and to guide the user when
troubleshooting a triggered alarm.
To create a checklist
2. On the Control Panel, click Checklists.
3. In the Checklist view, click the Add checklist button .

793
30 User Actions
4. In the Add Checklist dialog box, in the Name box, type the name of the new
checklist.
5. In the Description box, type a description for the checklist.
6. Click the Add step button .

7. In the Add Checklist Step dialog box, in the Name box, type the text for the
step to create.
8. Click OK.
Note
• You can add several steps to the checklist.
9. In the Add Checklist dialog box, click OK.

794
30 User Actions
30.12 Editing a Checklist

You edit a checklist to change the description of a step, or to rearrange the step
order.
To edit a checklist
2. On the Control Panel, click Checklists.
3. In the Checklist view, click the Edit checklist button .
Note
• To permanently remove a checklist, click the Remove
checklist button .

795
30 User Actions
4. In the Edit Checklist dialog box, in the Name box, type the name of the
new checklist.
5. In the Description box, type a description for the checklist.
6. Select a step in the checklist and click the Edit step button to edit the
checklist step.
Note
• In the Edit checklist step dialog box you can add new steps
to the checklist by clicking the Add step button, or remove
existing steps by clicking the Remove step button .
7. In the Edit checklist step dialog box, in the Name box, type the new text
for the step.
8. Click OK.
9. Select a step in the checklist and click the Move step up button to
move the step upwards in the checklist.
10. Select a step in the checklist and click the Move step down button to
move the step downwards in the checklist.
11. In the Edit Checklist dialog box, click OK.

796
30 User Actions
30.13 Adding a Checklist to an Alarm
30.13 Adding a Checklist to an Alarm

You add a checklist to an alarm to troubleshoot the problem that triggered the
alarm.
To add a checklist to an alarm

1. In the System Tree pane, select the alarm object to which you want to add a
checklist.
2. In the User Action view, in the Checklist box, enter the checklist you want
to add to the alarm.

To add a cause note to an alarm you must have created one in advance and
defined its content.

797
31 Alarms User Interface
Topics
Alarms Pane and Alarm View
Alarms Pane and Alarm View Toolbar
Alarms Pane and Alarm View Icons
Alarm and Event Details View
Add/Remove Columns Dialog Box (Alarms)
Alarm System Tree Icons
Change of State Alarm Properties – Basic Tab
Change of State Alarm Properties – Advanced Tab
Multistate Alarm Properties – Basic Tab
Multistate Alarm Properties – Advanced Tab
Matching Text String Alarm Properties – Basic Tab
Matching Text String Alarm Properties – Advanced Tab
Out of Range Alarm Properties – Basic Tab
Out of Range Alarm Properties – Advanced Tab
Out of Reference Range Alarm Properties – Basic Tab
Out of Reference Range Alarm Properties – Advanced Tab
Sum Alarm Properties – Basic Tab
Sum Alarm Properties – Advanced Tab
Enumeration Alarm Properties – Basic Tab
Enumeration Alarm Properties – Advanced Tab
Variable Status Alarm Properties – Basic Tab
Variable Status Alarm Properties – Advanced Tab
Function Block Program Internal Alarm Properties - Basic
Tab
Function Block Program Internal Alarm Properties -
Advanced Tab
Create Alarm Wizard – Presentation Page
Create Alarm Wizard – User Action Page
Create Alarm Wizard – Attachment Page
Create Change of State Alarm Wizard – Alarm Trigger Page
Create Multistate Alarm Wizard – Alarm Trigger Page
Create Matching Text String Alarm Wizard – Alarm Trigger
Page
Create Out of Range Alarm Wizard – Alarm Trigger Page
Create Out of Reference Range Alarm Wizard – Alarm
Trigger Page
Create Sum Alarm Wizard – Alarm Trigger Page
Create Enumeration Alarm Wizard – Alarm Trigger Page
Create Variable Status Alarm Wizard – Alarm Trigger Page
Create Attachment Wizard – Configure Attachment Page
Alarm Trigger Properties - Basic Tab
Alarm Trigger Properties – Range Tab
Alarm Trigger Properties – Value tab
Alarm Trigger Properties – Value tab
Attachment Properties
Alarm Control Panel Properties
User Action Properties
Alarm Styles View
Alarm Styles Properties
Acknowledged Style Properties
Alarm Style Properties
Disabled Style Properties
Fault Style Properties
Reset Style Properties
Alarm Control Panel – Categories View
Add Category Dialog Box
Edit Category Dialog Box
Category Properties
Categories Properties
Alarm Control Panel – Cause Notes View
Add Cause Note Dialog Box
Edit Cause Note Dialog Box
Cause Notes Properties
Cause Note Group Properties
Cause Note Properties
Alarm Control Panel – Action Notes View
Add Action Note Dialog Box
Edit Action Note Dialog Box
Action Notes Properties
Action Note Group Properties
Action Note Properties
Alarm Control Panel – Checklists View
Add Checklist Dialog Box
Edit Checklist Dialog Box
Add Checklist Step Dialog Box
Edit Checklist Step Dialog Box
Checklists Properties
Checklist Properties
Checklist Step Properties
Alarm – Basic Settings View
Select Conditions Dialog Box – Alarm Filter Properties
Create Email Notification Wizard – Email Notification Page
Email Notification View
Email Notification Properties
Create Write to File Notification Wizard – Write to File Notification
Page
Write to File Notification View
Write to File Notification Properties
Create Assignment Wizard – Assignment Page
Assignment View
Assignment Properties
Alarm Properties
Object Specific Event View Toolbar
Progress View
Alarm Handling Properties
Alarm Properties

Use the Alarms pane and Alarm View to survey and manage alarms.
Figure: Alarms pane
Table: Alarms Pane and Alarm View

Number Description
Use the toolbar to acknowledge, hide, show

and comment alarms. For more information,
see section 31.2 “Alarms Pane and Alarm
View Toolbar” on page 804.
Use the columns to sort, show, and hide

information about the triggered alarms. For
more information, see the Add/Remove
Columns Dialog Box topic on WebHelp.
Use the list to get information about a

triggered alarm and its current status. For
more information, see section 31.3 “Alarms
Pane and Alarm View Icons” on page 806.

803
31.2 Alarms Pane and Alarm View Toolbar

Use the Alarms pane and Alarm View toolbar to manage the alarms.
Table: Alarms Pane and Alarm View Toolbar

Button Description
Acknowledge
Click to acknowledge alarm state or reset
state.
For more information, see the Alarm
Acknowledgement topic on WebHelp.
Enable alarm
Click to enable the alarm. If the alarm state
changed, for example, from alarm state to
normal state during the time the alarm was
disabled, the alarm is given the new state
once it is enabled.
For more information, see the Disable and
Enable Alarms topic on WebHelp.
Disable alarm
Click to disable the alarm. The alarm is
inactivated and cannot be acknowledged or
reset until it is enabled.
Unhide alarm
Click to show the alarm.
For more information, see the Hide and
Show Alarms topic on WebHelp.
Hide alarm
Click to hide the alarm in the Alarms pane or
Alarm View. The alarm is still logged in the
Event log.
Add comment
Click to add a comment to the alarm.
For more information, see the Alarm
Comments topic on WebHelp.
Add cause note

Click to add a cause note to the alarm.
For more information, see the Cause Notes
topic on WebHelp.

804
Continued
Button Description
Add action note

Click to add an action note to the alarm.
For more information, see the Action Notes
topic on WebHelp.
Checklist
Click to view the checklist for the alarm.
For more information, see the Checklists
topic on WebHelp.
Show disabled alarms

Click to toggle between showing and hiding
disabled alarms.
Show hidden alarms

Click to toggle between hiding alarms and
showing hidden alarms.
Show alarm
Click to open the settings of the alarm in the
Work Area.
Save current settings

Click to save the settings.
Group box
topic on WebHelp.
Alarm filter
Click to select the conditions for the alarm
display in the Alarms pane. For more
information, see section 27.7 “Alarm Filter
Conditions” on page 632.
Detail view
Use the Detail view button to display detailed
information about all properties of a selected
event, in an added view. For more
information, see section 31.4 “Alarm and
Event Details View ” on page 807.
For more information, see the Alarm and
Event Details topic on WebHelp.

805
31.3 Alarms Pane and Alarm View Icons
31.3 Alarms Pane and Alarm View Icons

Use the alarm state icons in the Alarms pane and Alarm View to get information
about the state of the alarms.
Table: Alarms Pane and Alarm View Icons

Icon Description
Normal
Indicates that the alarm is idle and the
variable the alarm monitors does not satisfy
the configured alarm criteria. For more
information, see section 27.2 “Alarm States”
on page 623.
Alarm
Indicates that an alarm is triggered. For more
on page 623.
Acknowledged
Indicates that a user has acknowledged the
alarm. The problem that caused the alarm
has not been corrected. For more
on page 623.
Reset
Indicates that the problem that caused the
alarm is corrected. A user needs to
acknowledge the alarm to change the alarm
state to normal. For more information, see
section 27.2 “Alarm States” on page 623.
Disabled
Indicates that the alarm is disabled by a
user. Disabled alarms are by default hidden
in the Alarms pane and Alarm View. For
more information, see section 27.2 “Alarm
States” on page 623.
Fault
Indicates that the value reported from
hardware, such as a BACnet device, is not
trustworthy. For more information, see
section 27.2 “Alarm States” on page 623.
Attachment
Indicates that the alarm has an object
attached. For more information, see section
29.21 “Alarm Attachment” on page 749.

806
31.4 Alarm and Event Details View
31.4 Alarm and Event Details View

Use the Detail view to view all properties of a selected alarm or event.
Figure: Detail view (here in the Alarms pane)
Table: Alarm Details View

Quick filter Enter a word or a character to filter on. For

Change orientation of the panel

Select the orientation of the Detail view that
you want to use. For more information, see
the Changing the Detail View Orientation
topic on WebHelp.
Increase font size

Click to increase the font size of the view.
Decrease font size

Click to decrease the font size of the view.
Property Displays all possible columns of the selected

alarm or event.
Value Displays the value.

807
31.5 Add/Remove Columns Dialog Box (Alarms)
31.5 Add/Remove Columns Dialog Box

(Alarms)
Use the Add/Remove Columns dialog box to add or remove columns from the
Alarms pane or an alarm view.
Figure: Add/Remove Columns dialog box
Table: Add/Remove Columns Dialog Box

Acknowledge time Select to display the time and date when the
alarm was acknowledged. For more
information, see the Alarm
Acknowledged by Select to display the name of the individual

who acknowledged the alarm. For more
information, see the Alarm
Acknowledgement required Select to display the required

acknowledgement to acknowledge the
alarm. For more information, see the Alarm
Alarm state Select to display the state of the alarm. For

Alarm text Select to display the alarm message that is

added to the alarm. For more information,
see section 29.6 “Alarm Messages” on page
728.

808
Continued
Assigned state Select to display the assigned state of the

alarm. For more information, see the Alarm
Assignment topic on WebHelp.
Assigned to domain Select to display the domain of the user or

user group that an alarm is assigned to. For
Assigned to ID Select to display the ID of the user or group

that an alarm was assigned to.
Assigned to name Select to display the name of the user or

user group that an alarm has been assigned
to.
BACnet alarm type Select to display the BACnet alarm type of

the alarm that monitored a variable within a
BACnet network.
BACnet notification Select to display the distribution information

of an alarm notification within a BACnet
system
BACnet notification type Select to display the distribution information

type of an alarm notification within a BACnet
system..
Basic evaluation state Select to display the basic evaluation state of

an alarm. The value True indicates that an
alarm is triggered.
Category Select to display the alarm category name.
Command value Select to display the value that was

commanded.
Confirmed notification Select to display whether or not the Building

Operation server that received transmission
of data has sent a confirmation to the
sending device that the data has been
received.
Count Select to display the number of times an

alarm has toggled between the alarm and
reset state. For more information, see the
Count topic on WebHelp.
Deadband Select to display the deadband value of the

alarm.
Device name Select to display the name of the I/NET

device that generated the alarm.
Disabled cause Select to display the cause of why the alarm

has been disabled. Alarm can be disabled by
a user, a shunt variable, or, if incorrectly
configured, by the system.

809
Continued
Error limit Select to display the difference limit that was

exceeded.
Evaluation state Select to display the evaluation state of an

displayed if the monitored variable reached
Event from state Select to display the event state after the
occurrence that initiated the notification.
EWS ID Select to display the EcoStruxure Web

Service identification of the alarm in the
external system.
EWS source ID Select to display the EcoStruxure Web

Service identification of the external object
that generated the alarm.
Exceeded limit Select to display the limit that was

exceeded.
Exceeding value Select to display the value that exceeded the

limit.
Feedback value Select to display the value that differs from

the Command value.
First name Select to display the first name of the

individual whose key/card was used at the
I/NET door point.
Hidden Select to display the visible status of an

object. False is displayed when an object is
shown.
Individual Select to display the individual number of the

I/NET door point.
Last name Select to display the last name of the

I/NET door point.
Logging Select to display whether or not associated

alarm events are generated and recorded in
the event log.
Message text Select to display the text of an I/NET action

or dispatch message, if there is one.
Monitored variable Select to display the path of the monitored

variable.
New mode Select to display the new mode of the

referenced object.

810
Continued
New state Select to display the new state of the

referenced object.
New value Select to display the new value of the

referenced property.
Operation expected Select to display the next operation

requested by the referenced object.
Possible operator actions Select to display the actions available to the

operator.
Previous alarm state Select to display the previous alarm state of

an alarm.
Priority Select to display the priority of an alarm.
Process ID Not used.
Reference bit string Select to display the new value of the

referenced bitstring property.
Sequence number Select to display the alarm sequence

number on the present server.
Setpoint value Select to display the value of the reference

variable.
Source Select to display path of the source object.
Source name Select to display the name of the source

object.
Source server Select to display the server path of the

source object.
Status flags Select to display the status flag of the object.
System alarm ID Select to display the alarm ID generated by

the system.
Tenant Select to display tenant number of the

I/NET door point.
Timestamp Select to display the time and date when the

alarm was generated.
Triggered time Select to filter alarms by the time and date

the alarm went from normal state to alarm
state.
Type Select to display the alarm type. For more

information, see section 52.28 “General
Properties – Basic Tab” on page 1545.

811
Continued
Value at change Select to display the value the monitored

variable had when the alarm was triggered.

812
31.6 Alarm System Tree Icons

This section describes the icons in WorkStation.
Icon Description
Alarm control panel

Contains the alarm handling and alarm style
objects. For more information, see section
27.1 “Alarm Overview” on page 621.
Alarm
Indicates that the object is an alarm. For
Types” on page 645.
Alarm handling
Indicates alarm handling objects that can be
connected to an alarm. For more
information, see section 27.3 “Alarm
Functions” on page 624.
Disabled alarm
Indicates that the alarm has been disabled.
The icon is displayed regardless of how the
larm got disabled. For more information, see
section 27.1 “Alarm Overview” on page 621.
Action note
Indicates the object is an action note. For
more information, see section 30.6 “Action
Notes” on page 786.
Category
Indicates the object is a category that you
can use to group together alarms. For more
information, see the Categories topic on
WebHelp.
Cause note
Indicates the object is a cause note. For
more information, see section 30.2 “Cause
Notes” on page 780.
Checklists
Indicates the object is a checklist. For more
information, see section 30.10 “Checklists”
on page 792.
Alarm style
Indicates the object controls the visual style
of an alarm state in the Alarms pane and
Alarm Views. For more information, see
section 27.5 “Alarms Pane and Alarm View

813
Continued
Icon Description
Assignment
Indicates the object is an assignment. For
“Automatic Assignment” on page 767.
Notification
Indicates the object is an E-mail notification
or a Write to file notification. For more
“Notifications” on page 752.

814
31.7 Change of State Alarm Properties – Basic Tab
31.7 Change of State Alarm Properties –

Basic Tab
Use the Basic tab to view or edit the basic properties of a change of state alarm.
Figure: Basic tab
Table: Basic Tab

Alarm state Displays the present state of the alarm. For

Basic evaluation state Displays False when the alarm is in its

normal state.
Evaluation state Displays the present evaluation state of the


815
31.7 Change of State Alarm Properties – Basic Tab
Continued
Disabled cause Displays the cause for the alarm being

disabled:
• Shunt variable means that the alarm
has been disabled by a shunt variable
• User means that the alarm has been
disabled by the user
• System means that the alarm has
been disabled by the system
Reset delay (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Shunt variable Enter the shunt variable that is used to

enable or disable the alarm.
Alarm message Type the message to display when the alarm

is triggered.
Alarm priority Enter the priority level of the alarm.
Reset message Type the message to display when the alarm

is reset.
Reset priority Enter the priority level of the alarm when it is

reset.
Monitored variable Enter the path to the variable that is

monitored by the alarm.
Trigger value Select True to trigger the alarm when the

monitored value changes to true.

816
31.8 Change of State Alarm Properties – Advanced Tab
31.8 Change of State Alarm Properties –

Advanced Tab
Use the Advanced tab to change the alarm properties of a change of state alarm.
Figure: Advanced tab
Table: Advanced Tab

Acknowledgement type Select the type of acknowledgement for the

alarm.
Flashing alert Select to display a flashing alert in the Alarms

pane and the Alarm Views when the alarm is
triggered.
Audible alert Select to make an audible alert when the

alarm is triggered.
Category Enter the category that the alarm belongs to.
Cause note group Enter the cause note group that is used by
the alarm.

817
31.8 Change of State Alarm Properties – Advanced Tab
Continued
Action note group Enter the action note group that is used by
the alarm.
Checklist Enter the checklist that belongs to the alarm.
Checklist required Select to force the user to check each step

in the checklist before the alarm can be
acknowledged.
Disable alarm Select to disable the alarm, for example,

before deployment.
Edit (Action Requirements) Click to open the property pane of the

selected user action where you edit the user
action. For more information, see section
31.43 “User Action Properties” on page 877.
Add (Attachments) Click to start the Attachment Wizard where

you can add an attachment. For more
on page 1538.
Edit (Attachments) Click to open the property pane of the

selected attachment where you configure
the attachment. For more information, see
section 31.41 “Attachment Properties” on
page 875.
Remove (Attachments) Click to remove an attachment that is

connected to the alarm.

818
31.9 Multistate Alarm Properties – Basic Tab

Use the Basic tab to view or edit the basic properties of a multistate alarm.
Figure: Basic tab
Table: Basic Tab



normal state.


819
Continued

disabled:
is triggered.


Add Click to create a new alarm trigger item,

either an integer or range value. For more
on page 1538.
Edit Click to edit the alarm trigger item.

“Alarm Trigger Properties – Range Tab” on
page 872.
“Alarm Trigger Properties – Value tab” on
page 873.
Remove Click to remove an alarm trigger item.

is triggered.

is reset.

reset.

820
31.10 Multistate Alarm Properties – Advanced Tab
31.10 Multistate Alarm Properties – Advanced

Tab
Use the Advanced tab to change the alarm properties of a multistate alarm.
Table: Advanced Tab


alarm.

triggered.

alarm is triggered.
the alarm.

821
31.10 Multistate Alarm Properties – Advanced Tab
Continued
the alarm.

acknowledged.

before deployment.


on page 1538.

page 875.


822
31.11 Matching Text String Alarm Properties – Basic Tab
31.11 Matching Text String Alarm Properties –

Basic Tab
Use the Basic tab to view or edit the basic properties of a matching text string
alarm.
Figure: Basic tab
Table: Basic Tab



normal state.


823
31.11 Matching Text String Alarm Properties – Basic Tab
Continued

disabled:
is triggered.


is triggered.

is reset.

reset.

Add Click to create a new alarm trigger item. For

on page 1538.
Edit Click to edit the alarm trigger item. For more

Trigger Properties – Range Tab” on page
872.

824
31.12 Matching Text String Alarm Properties – Advanced Tab
31.12 Matching Text String Alarm Properties –

Advanced Tab
Use the Advanced tab to change the alarm properties of a matching text string
alarm.
Table: Advanced Tab


alarm.

triggered.

alarm is triggered.
the alarm.

825
31.12 Matching Text String Alarm Properties – Advanced Tab
Continued
the alarm.

acknowledged.

before deployment.


on page 1538.

page 875.


826
31.13 Out of Range Alarm Properties – Basic Tab
31.13 Out of Range Alarm Properties – Basic

Tab
Use the Basic tab to view or edit the basic properties of an out of range alarm.
Figure: Basic tab
Table: Basic Tab



normal state.


827
31.13 Out of Range Alarm Properties – Basic Tab
Continued

disabled:

is triggered.
Above upper limit message Type the message to display when the
variable exceeds the upper limit of the alarm.
Above upper limit priority Enter the priority level of the alarm when the
variable exceeds the upper limit.
Below lower limit message Type the message to display when the
variable falls below the lower limit.
Below lower limit priority Enter the priority level of the alarm when the

is reset.

reset.

Lower limit Enter the lowest value the monitored variable

can decrease to before the alarm is
triggered.
Upper limit Enter the highest value the monitored

variable can increase to before the alarm is
triggered.
Deadband Enter the range the monitored variable has

to pass within the normal range before the
alarm is reset.

828
31.14 Out of Range Alarm Properties – Advanced Tab
31.14 Out of Range Alarm Properties –

Advanced Tab
Use the Advanced tab for changing the alarm properties of an out of range alarm.
Table: Advanced Tab


alarm.

triggered.

alarm is triggered.

829
31.14 Out of Range Alarm Properties – Advanced Tab
Continued
the alarm.
the alarm.

acknowledged.

before deployment.


on page 1538.

page 875.


830
31.15 Out of Reference Range Alarm Properties – Basic Tab

Properties – Basic Tab
Use the Basic tab to view or edit the basic properties of an out of reference range
alarm.
Figure: Basic tab
Table: Basic Tab



normal state.


831
31.15 Out of Reference Range Alarm Properties – Basic Tab
Continued

disabled:

is triggered.

is reset.

reset.

Reference variable Enter the reference variable that is compared

with the monitored variable.
Lower deviation limit Enter the lowest value the monitored variable
triggered.
Upper deviation limit Enter the highest value the monitored

triggered.

alarm is reset.

832
31.16 Out of Reference Range Alarm Properties – Advanced Tab

Properties – Advanced Tab
Use the Advanced tab to change the alarm properties of an out of reference range
alarm.
Table: Advanced Tab


alarm.

triggered.

alarm is triggered.

833
31.16 Out of Reference Range Alarm Properties – Advanced Tab
Continued
the alarm.
the alarm.

acknowledged.

before deployment.


on page 1538.

page 875.


834
31.17 Sum Alarm Properties – Basic Tab

Use the Basic tab to view or edit the basic properties of a sum alarm.
Figure: Basic tab
Table: Basic Tab



normal state.


835
Continued

disabled:
is triggered.


is triggered.

is reset.

reset.

836
31.18 Sum Alarm Properties – Advanced Tab

Use the Advanced tab to change the alarm properties of a sum alarm.
Table: Advanced Tab


alarm.

triggered.

alarm is triggered.

837
Continued
the alarm.
the alarm.

acknowledged.

before deployment.


on page 1538.

page 875.


838
31.19 Enumeration Alarm Properties – Basic Tab
31.19 Enumeration Alarm Properties – Basic

Tab
Use the Basic tab to view or edit the basic properties of an enumeration alarm.
Figure: Basic tab
Table: Basic Tab



normal state.


839
31.19 Enumeration Alarm Properties – Basic Tab
Continued

disabled:
is triggered.


Add Click to create a new alarm trigger item,

either an integer or range value. For more
on page 1538.
Edit Click to edit the alarm trigger item. For more

Trigger Properties – Range Tab” on page
872.

is triggered.

is reset.

reset.

840
31.20 Enumeration Alarm Properties – Advanced Tab
31.20 Enumeration Alarm Properties –

Advanced Tab
Use the Advanced tab to change the alarm properties of an enumeration alarm.
Table: Advanced Tab


alarm.

triggered.

alarm is triggered.

841
31.20 Enumeration Alarm Properties – Advanced Tab
Continued
the alarm.
the alarm.

acknowledged.

before deployment.


on page 1538.

page 875.


842
31.21 Variable Status Alarm Properties – Basic Tab
31.21 Variable Status Alarm Properties – Basic

Tab
Use the Basic tab to view or edit the basic properties of a variable status alarm.
Figure: Basic tab
Table: Basic Tab



normal state.


843
31.21 Variable Status Alarm Properties – Basic Tab
Continued

disabled:
is triggered.


is triggered.

is reset.

reset.

Trigger when variable is Select the statuses of the monitored variable

that trigger the alarm.

844
31.22 Variable Status Alarm Properties – Advanced Tab
31.22 Variable Status Alarm Properties –

Advanced Tab
Use the Advanced tab to change the alarm properties of a variable status alarm.
Table: Advanced Tab


alarm.

triggered.

alarm is triggered.

845
31.22 Variable Status Alarm Properties – Advanced Tab
Continued
the alarm.
the alarm.

acknowledged.

before deployment.


on page 1538.

page 875.


846
31.23 Function Block Program Internal Alarm Properties - Basic Tab
31.23 Function Block Program Internal Alarm

Properties - Basic Tab
Use the Basic tab to view or edit the basic properties of a function block program
internal alarm. For more information, see section 52.28 “General Properties – Basic
Tab” on page 1545.
Figure: Basic tab
Table: Basic Tab



normal state.


847
31.23 Function Block Program Internal Alarm Properties - Basic Tab
Continued

disabled:
Delay to reset (s) Enter the time, in seconds, the alarm has to
Delay to alarm (s) Enter the time, in seconds, the alarm has to
is triggered.

Trigger value Select the statuses of the monitored variable

that trigger the alarm.


is triggered.

is reset.

reset.

848
31.24 Function Block Program Internal Alarm Properties - Advanced Tab
31.24 Function Block Program Internal Alarm

Properties - Advanced Tab
Use the Advanced tab to change the alarm properties of a function block program
internal alarm.
Table: Advanced Tab


before deployment.

alarm.
Flashing alert Select True to make the alert flash in the

Alarms pane and Alarm Views when an
alarm is triggered.

849
31.24 Function Block Program Internal Alarm Properties - Advanced Tab
Continued
Audible alert Select True to make the alert audible when

an alarm is triggered.
the alarm.
the alarm.

acknowledged.
Edit (Action requirements) Click to open the property pane of the


on page 1538.

page 875.


850
31.25 Create Alarm Wizard – Presentation Page
31.25 Create Alarm Wizard – Presentation

Page
Use the Presentation page to configure the presentation settings of the alarm.
Figure: Presentation page
Table: Presentation Page

Alarm message Displays the present state of the alarm. For


is reset.

851
31.25 Create Alarm Wizard – Presentation Page
Continued

reset.
Enter the category that the alarm belongs to.
Same priority Select to set all priorities to the same value.
Flashing alert Select to make the alarm row flash in the

Alarms pane and Alarm Views when the
alarm is triggered.
Audible alert Select to make the alert audible when the

alarm is triggered.

852
31.26 Create Alarm Wizard – User Action Page
31.26 Create Alarm Wizard – User Action

Page
Use the User Action page to force a user to actions that are connected to the
alarm.
Figure: User action page
Table: User Action Page


alarm.
“Acknowledgement” on page 738.
the alarm.

853
31.26 Create Alarm Wizard – User Action Page
Continued
the alarm.
When acknowledging an alarm Select what actions the user has to perform
when acknowledging an alarm.
Required user action Select what actions the user has to perform
when any of the listed events occur.

854
31.27 Create Alarm Wizard – Attachment Page
31.27 Create Alarm Wizard – Attachment

Page
Use the Attachment page to add attachments to the alarm.
Figure: Attachment page
Table: Attachment Page

Add attachment
Click to add an attachment to the alarm.
Remove attachment
Click to remove an attachment.
Navigate to
Click to open the attachment that is selected
in the attachment list.
Display on alarm Select to display the attachment when the

alarm is triggered.

855
31.28 Create Change of State Alarm Wizard – Alarm Trigger Page
31.28 Create Change of State Alarm Wizard –

Alarm Trigger Page
Use the Alarm Trigger page to configure the trigger settings of the change of
state alarm.
Figure: Change of state alarm trigger page
Table: Change of State Alarm Trigger Page

True Select to trigger the alarm when the

monitored variable is equal to true.
False Select to trigger the alarm when the

monitored variable is equal to false.

Disable alarm Displays the present state of the alarm. For

Alarm delay Enter the time, in seconds, the alarm has to

Reset delay Enter the time, in seconds, the alarm has to

is triggered.


856
31.29 Create Multistate Alarm Wizard – Alarm Trigger Page
31.29 Create Multistate Alarm Wizard – Alarm

Trigger Page
Use the Alarm Trigger page to configure the trigger settings of the multistate
alarm.
Figure: Multistate alarm trigger page
Table: Multistate Alarm Trigger Page

between Select a range. If the monitored variable is

within this range, the alarm is triggered.
equal to Select a value. If the monitored variable is

equal to this value, the alarm is triggered.
Add row Add another alarm condition that triggers the

alarm.



is triggered.


857
31.29 Create Multistate Alarm Wizard – Alarm Trigger Page
Continued

Remove
Remove alarm condition.
Set unit
Enter the unit of the alarm.

858
31.30 Create Matching Text String Alarm Wizard – Alarm Trigger Page
31.30 Create Matching Text String Alarm

Wizard – Alarm Trigger Page
Use the Alarm Trigger page to configure the trigger settings of the matching text
string alarm.
Figure: Matching text string alarm trigger page
Table: Matching Text String Alarm Trigger Page

equal to Type a text string. When the monitored

variable matches this text string the alarm is
triggered.
Add row Add another alarm condition that triggers the

alarm.



is triggered.


859
31.30 Create Matching Text String Alarm Wizard – Alarm Trigger Page
Continued

Remove
Remove alarm condition.

860
31.31 Create Out of Range Alarm Wizard – Alarm Trigger Page
31.31 Create Out of Range Alarm Wizard –

Alarm Trigger Page
Use the Alarm Trigger page to configure the trigger settings of the out of range
alarm.
Figure: Out of range alarm trigger page
Table: Out of Range Alarm Trigger Page

Upper limit Enter the highest value the monitored

triggered.
Lower limit Enter the lowest value the monitored variable

triggered.

alarm is reset.



is triggered.

861
31.31 Create Out of Range Alarm Wizard – Alarm Trigger Page
Continued


Set unit

862
31.32 Create Out of Reference Range Alarm Wizard – Alarm Trigger Page
31.32 Create Out of Reference Range Alarm

Wizard – Alarm Trigger Page
Use the Alarm Trigger page to configure the trigger settings of the out of
reference range alarm.
Figure: Out of reference range alarm trigger page
Table: Out of Reference Range Alarm Trigger Page

Upper deviation limit Enter the upper limit the monitored variable
is allowed to deviate from the reference
variable before the alarm is triggered.
Lower deviation limit Enter the lower limit the monitored variable is
allowed to deviate from the reference
variable before the alarm is triggered.

alarm is reset.


Reference variable Enter the reference variable that is compared

with the monitored variable.

863
31.32 Create Out of Reference Range Alarm Wizard – Alarm Trigger Page
Continued

is triggered.


Set unit

864
31.33 Create Sum Alarm Wizard – Alarm Trigger Page
31.33 Create Sum Alarm Wizard – Alarm

Trigger Page
Use the Alarm Trigger page to configure the trigger settings of the sum alarm.
Figure: Sum alarm trigger page
Table: Sum Alarm Trigger Page

Add condition
Select the alarm filter conditions for the
alarms you want to include.
“Alarm Filter Conditions” on page 632.
You can use wildcards when setting up filter
conditions. For more information, see
page 954.
Remove condition
Remove the alarm filter conditions for the
alarms you want exclude.
Add row
Click to add an additional row with the same
condition.
Remove row
Click to remove a condition row.

865
31.33 Create Sum Alarm Wizard – Alarm Trigger Page
Continued


is triggered.



866
31.34 Create Enumeration Alarm Wizard – Alarm Trigger Page
31.34 Create Enumeration Alarm Wizard –

Alarm Trigger Page
Use the Alarm Trigger page to configure the trigger settings of the enumeration
alarm.
Figure: Enumeration alarm trigger page
Table: Enumeration Alarm Trigger Page

Trigger alarm when variable is Select the enumeration values that trigger
the alarm.
Monitored variable Enter the variable together with the

enumeration to monitor.


is triggered.



867
31.35 Create Variable Status Alarm Wizard – Alarm Trigger Page
31.35 Create Variable Status Alarm Wizard –

Alarm Trigger Page
Use the Alarm Trigger page to configure the trigger settings of the variable status
alarm.
Figure: Variale status alarm trigger page
Table: Variable Status Alarm Trigger Page

Forced Select to trigger the alarm when the

monitored variable status is forced. For more
information, see the Force and Release
Buttons topic on WebHelp.
Overridden Select to trigger the alarm when the

monitored variable status is overridden. For
more information, see the Output Override
Status topic on WebHelp.




868
31.35 Create Variable Status Alarm Wizard – Alarm Trigger Page
Continued

is triggered.


869
31.36 Create Attachment Wizard – Configure Attachment Page
31.36 Create Attachment Wizard – Configure

Attachment Page
Use the Configure Attachment page to set up the attachment you want to
attach to the alarm.
Figure: Configure Attachment page
Table: Configure Attachment Page

Object reference Enter the path to the item you want to attach
to the alarm.
Display on alarm Select True to automatically open and

display the attachment when the alarm is
triggered.

870
31.37 Alarm Trigger Properties - Basic Tab
31.37 Alarm Trigger Properties - Basic Tab

Use the Alarm Trigger Properties view or dialog box to configure and view the
general and object-reference properties. For more information, see section 52.28
“General Properties – Basic Tab” on page 1545.
Figure: AlarmTrigger Properties

871
31.38 Alarm Trigger Properties – Range Tab
31.38 Alarm Trigger Properties – Range Tab

Use the Range tab to configure the range that triggers the alarm.
Figure: Range tab
Table: Range Tab

First value Enter the lowest integer value of the range

that triggers the alarm.
Last value Enter the highest integer value of the range

that triggers the alarm.

872
31.39 Alarm Trigger Properties – Value tab

Use the Value tab to configure the integer that triggers the alarm.
Figure: Value tab
Table: Value Tab

Value Enter the integer value that triggers the

alarm.

873

Use the Value tab to type the text string that triggers the Matching text string
alarm.
Figure: Value tab
Table: Value Tab

Value Type the text string that triggers the alarm.

874
31.41 Attachment Properties
31.41 Attachment Properties

Use the Attachment properties to edit attachments and configure whether or not
the attachments are displayed when the alarm is triggered.
Figure: Attachment properties
Table: Attachment Properties

Display on alarm Select True to automatically open and

display the attachment when the alarm is
triggered.
Object reference Enter the path to the item you want to attach
to the alarm.

875
31.42 Alarm Control Panel Properties
31.42 Alarm Control Panel Properties

Use the Alarm Control Panel Properties to view the referenced lead object.
Figure: Alarm Control Panel properties
Table: Alarm Control Panel Properties

Lead object Displays the referenced lead object from

which all configuration data is copied. For
more information, see section 17.2 “Lead
and Shadow Relationship” on page 330.

876
31.43 User Action Properties
31.43 User Action Properties

Use the User Action properties dialog box to configure the mandatory or required
user actions items.
Figure: User action properties
Table: User Action Properties

User action Displays the user action item you are

configuring.
Comment Select True to require the users to write a

comment when they perform this kind of
user action.
Action note Select True to require the users to add an

action note to this kind of user action.
Cause note Select True to require the users to report

the circumstances of this kind of user action.

877
31.44 Alarm Styles View
31.44 Alarm Styles View

Use the Alarm Styles view to open the style properties of the different Alarm
states.
Figure: Alarm Styles view
Table: Alarm Styles View

Acknowledged Style Click to select the style object that

configures the appearance of an
acknowledged alarm in the Alarms pane and
Alarm View. For more information, see
section 31.46 “Acknowledged Style
Alarm Style Click to select the style object that

configures the appearance of a triggered
alarm in the Alarms pane and Alarm View.
“Alarm Style Properties” on page 881.
Disabled Style Click to select the style object that

configures the appearance of a disabled
alarm in the Alarms pane and Alarm View.
“Disabled Style Properties” on page 882.
Fault Style Click to select the style object that

configures the appearance of an alarm with
fault state in the Alarms pane and Alarm
View. For more information, see section
31.49 “Fault Style Properties” on page 883.
Reset Style Click to select the style object that

configures the appearance of a reset alarm
in the Alarms pane and Alarm View. For
more information, see section 31.50 “Reset
Style Properties” on page 884.

878
31.45 Alarm Styles Properties
31.45 Alarm Styles Properties

Use the Alarm Styles Properties view or dialog box to configure and view the
“General Properties – Basic Tab” on page 1545.General and References Properties
Figure: Alarm Styles Properties

879
31.46 Acknowledged Style Properties
31.46 Acknowledged Style Properties

Use the Acknowledged Style properties to edit and view the colors and fonts of
alarms in Alarms pane and Alarm Views that are in acknowledged state.
Figure: Acknowledged Style properties
Table: Acknowledged Style Properties

Font Enter the font to use for acknowledged

alarms in the Alarms pane and Alarm Views.
Background color Enter the background color of the row for

acknowledged alarms in the Alarms pane
and Alarm Views.
Font color Enter the font color to use for acknowledged


880
31.47 Alarm Style Properties
31.47 Alarm Style Properties

Use the Alarm Style properties to edit and view the colors and fonts of alarms in
Alarms pane and Alarm Views that are in Alarm state.
Figure: Alarm Style properties
Table: Alarm Style Properties

Font Enter the font to use for triggered alarms in

the Alarms pane and Alarm Views.

triggered alarms in the Alarms pane and
Alarm Views.
Font color Enter the font color to use for triggered


881
31.48 Disabled Style Properties
31.48 Disabled Style Properties

Use the Disabled Style properties to edit and view the colors and fonts of alarms
in the Alarm pane and Alarm Views that are in Disabled state.
Figure: Disabled Style properties
Table: Disabled Style Properties

Font Enter the font to use for disabled alarms in


disabled alarms in the Alarms pane and
Alarm Views.
Font color Enter the font color for disabled alarms in the
Alarms pane and Alarm Views.

882
31.49 Fault Style Properties
31.49 Fault Style Properties

Use the Fault Style properties to edit and view the colors and fonts of alarms in
the Alarms pane and Alarm Views that are in Fault state.
Figure: Fault Style properties
Table: Fault Style Properties

Font Enter the font to use for faulty alarms in the


faulty alarms in the Alarms pane and Alarm
Views.
Font color Enter the font color for faulty alarms in the

883
31.50 Reset Style Properties
31.50 Reset Style Properties

Use the Reset Style properties to edit and view the colors and fonts of alarms in
the Alarms pane and Alarm Views that are in Reset state.
Figure: Reset Style properties
Table: Reset Style Properties

Font Enter the font to use for reset alarms in the

Background color Enter the background color to use for reset

Font color Enter the font color to use for reset alarms in

884
31.51 Alarm Control Panel – Categories View
31.51 Alarm Control Panel – Categories View

Use the Categories view to create, edit, and remove categories that can be
connected to an alarm.
Figure: Categories view
Table: Categories View

Button Description
Add category
Click to open the Add category dialog box
where you define the name and description
for a new category. For more information,
see section 31.52 “Add Category Dialog
Box” on page 886.
Edit category
Click to open the Edit category dialog box
where you define the name and description
of an existing category. For more
information, see section 31.53 “Edit
Category Dialog Box” on page 887.
Remove category
Click to remove a category.
Group box
topic on WebHelp.

885
31.52 Add Category Dialog Box
31.52 Add Category Dialog Box

Use the Add Category dialog box to add a category.
Figure: Add Category dialog box
Table: Add Category Dialog Box

Name Type the name of the category.
Description Type a description of the category.

886
31.53 Edit Category Dialog Box
31.53 Edit Category Dialog Box

Use the Edit Category dialog box to edit the name or description of a category.
Figure: Edit Category dialog box
Table: Edit Category Dialog Box

Name Type the name of the category.
Description Type a description of the category.

887
31.54 Category Properties
31.54 Category Properties

Use the Category Properties view or dialog box to configure and view the
Figure: Category properties

888
31.55 Categories Properties
31.55 Categories Properties

Use the Categories Properties view or dialog box to add, edit and remove
categories and to view and configure the general properties of categories. For more
Figure: Categories properties
Table: Categories Properties

Name Diplays the category name. For more

information, see the Categories topic on
WebHelp.
Add Click to open the Category wizard, where

you add a category.
Edit Click to edit the properties of the selected

category. For more information, see section
31.54 “Category Properties” on page 888.
Remove Click to remove the selected category.

889
31.56 Alarm Control Panel – Cause Notes View
31.56 Alarm Control Panel – Cause Notes

View
Use the Cause Notes view to create, edit, and remove cause notes.
Figure: Cause Notes view
Table: Cause Notes View

Button Description
Add cause note

Click to open the Add cause note dialog
box where you define the name and
description for a new cause note. For more
information, see section 31.57 “Add Cause
Note Dialog Box” on page 891.
Edit cause note

Click to open the Edit cause note dialog
description of an existing cause note. For
more information, see section 31.58 “Edit
Cause Note Dialog Box” on page 892.
Click to edit a cause note.
Remove cause note

Click to remove a cause note.
Group box
topic on WebHelp.
Collapse all
Click to collapse the groups in the list to hide
underlying items.
Expand all
Click to expand the groups in the list to
display underlaying items.

890
31.57 Add Cause Note Dialog Box
31.57 Add Cause Note Dialog Box

Use the Add Cause Note dialog box to add a cause note.
Figure: Add Cause Note dialog box
Table: Add Cause Note Dialog Box

Name Type the name of the cause note.
Group name Enter the cause note group the cause note
belongs to.
Description Type a description of the cause note.

891
31.58 Edit Cause Note Dialog Box
31.58 Edit Cause Note Dialog Box

Use the Edit Cause Note dialog box to edit a cause note.
Figure: Edit Cause Note dialog box
Table: Edit Cause Note Dialog Box

Name Type the name of the cause note.
Group name Enter the group the cause note belongs to.
Description Type a description of the cause note.

892
31.59 Cause Notes Properties

Use the Cause Notes Properties view or dialog box to add, edit, and remove
cause note groups and to configure and view the general and object reference
properties. For more information, see section 52.28 “General Properties – Basic
Figure: Cause Notes properties
Table: Cause Notes Properties

Name Displays the name of the cause note group.

“Cause Notes” on page 780.
Add Click to open the Cause Note Group wizard,

where you add a cause note group.
Edit Click to open the properties dialog box for

the selected cause note group, where you
edit the properties of the cause note group.
“Cause Note Group Properties” on page
895.

893
Continued
Remove Click to remove the selected cause note

group.

894
31.60 Cause Note Group Properties
31.60 Cause Note Group Properties

Use the Cause Note Group Properties view or dialog box to view or edit the
properties of the Cause Note Group.
Figure: Cause Note Group properties
Table: Cause Note Group Properties

Name Displays the name of the cause notes in the

cause note group. For more information, see
section 30.2 “Cause Notes” on page 780.
Add Click to open the Cause Note wizard

the selected cause note. For more
information, see section 31.61 “Cause Note
Remove Click to remove the selected cause note.

895
31.61 Cause Note Properties
31.61 Cause Note Properties

Use the Cause Note Properties view or dialog box to type the display name of the
cause note and to configure and view the general and object references properties.
For more information, see section 52.28 “General Properties – Basic Tab” on page
1545.
Figure: Cause Note properties
Table: Cause Note Properties

Properties Type the display name of the cause note.

“Cause Notes” on page 780.

896
31.62 Alarm Control Panel – Action Notes View
31.62 Alarm Control Panel – Action Notes

View
Use the Action Notes view to create, edit, and remove action notes.
Figure: Action Notes view
Table: Action Notes View

Button Description
Add action note

Click to open the Add action note dialog
description for a new action note. For more
information, see section 31.63 “Add Action
Note Dialog Box” on page 898.
Edit action note

Click to open the Edit action note dialog
description of an existing action note. For
more information, see section 31.64 “Edit
Action Note Dialog Box” on page 899.
Remove action note

Click to remove an action note.
Group box
topic on WebHelp.
Collapse all
Click to collapse the groups in the list to hide
underlying items.
Expand all
Click to expand the groups in the list to
display underlaying items.

897
31.63 Add Action Note Dialog Box
31.63 Add Action Note Dialog Box

Use the Add Action Note dialog box to add an action note.
Figure: Add Action Note dialog box
Table: Add Action Note Dialog Box

Name Type the name of the action note.
Group name Enter the action note group the action note
belongs to.
Description Type a description of the action note.

898
31.64 Edit Action Note Dialog Box
31.64 Edit Action Note Dialog Box

Use the Edit Action Note dialog box to add an action note.
Figure: Edit Action Note dialog box
Table: Edit Action Note Dialog Box

Name Type the name of the action note.
Group name Enter the action note group the action note
belongs to.
Description Type a description of the action note.

899
31.65 Action Notes Properties

Use the Action Notes Properties view or dialog box to add, edit, and remove
action note groups and to configure and view the general and object-reference
Figure: Action Notes properties
Table: Action Notes Properties

Name Displays the name of the action note group.

“Action Notes” on page 786.
Add Click to open the Action Note Group wizard,

where you add an action note group.

the action note group, where you edit the
properties of the action note group. For
more information, see section 31.66 “Action
Note Group Properties” on page 902.

900
Continued
Remove Click to remove the selected action note

group.

901
31.66 Action Note Group Properties
31.66 Action Note Group Properties

Use the Action Note Group Properties view or dialog box to view or edit the
properties of the Action Note Group.
Figure: Action Note Group properties
Table: Action Note Group Properties

Name Displays the name of the action notes in the

action note group. For more information, see
section 30.6 “Action Notes” on page 786.
Add Click to open the Action Note wizard.

the selected action note. For more
information, see section 31.67 “Action Note
Remove Click to remove the selected action note.

902
31.67 Action Note Properties
31.67 Action Note Properties

Use the Action Note Properties view or dialog box to type the display name of the
action note and to configure and view the general and object reference properties.
1545.
Figure: Action Note properties
Table: Action Note Properties

Action note Type the display name of the action note.

“Action Notes” on page 786.

903
31.68 Alarm Control Panel – Checklists View
31.68 Alarm Control Panel – Checklists View

Use the Checklists view to creat, edit, and remove checklists.
Figure: Checklists view
Table: Checklist View

Button Description
Add checklist
Click to open the Add checklist dialog box
where you define the checklist name,
description, and add or edit checklist steps.
“Add Action Note Dialog Box” on page 898.
Edit checklist
Click to open the Edit checklist dialog box
where you edit the checklist name,
description, and add or edit checklist steps.
“Edit Checklist Dialog Box” on page 907.
Remove checklist
Click to remove a checklist.
Group box
topic on WebHelp.

904
31.69 Add Checklist Dialog Box

Use the Add Checklist dialog box to add, edit, or order the items of a checklist.
Figure: Checklist dialog box
Table: Checklist Dialog Box

Button Description
Name Type the name of the checklist.
Description Type a description of the checklist.
Add step
Click to open the Add checklist step
dialog box where you add a step to your
checklist. For more information, see section
31.71 “Add Checklist Step Dialog Box” on
page 909.
Edit step
Click to open the Edit checklist step
dialog box where you edit a checklist step.
“Edit Checklist Step Dialog Box” on page
910.
Remove step
Click to remove the selected step from the
checklist.

905
Continued
Button Description
Move step up
Click to move the selected step upwards in
the list.
Move step down

Click to move the selected step downwards
in the list.

906
31.70 Edit Checklist Dialog Box

Use the Edit Checklist dialog box to add, edit, or order the steps of a checklist.
Figure: Edit Checklist dialog box
Table: Edit Checklist Dialog Box

Button Description
Name Type the name of the checklist.
Description Type a description of the checklist.
Add step
Click to open the Add checklist step
dialog box where you add a step to your
31.71 “Add Checklist Step Dialog Box” on
page 909.
Edit step
Click to open the Edit checklist step
dialog box where you edit a checklist step.
“Edit Checklist Step Dialog Box” on page
910.
Remove step
Click to remove the selected step from the
checklist.

907
Continued
Button Description
Move step up
Click to move the selected step upwards in
the list.
Move step down

Click to move the selected step downwards
in the list.

908
31.71 Add Checklist Step Dialog Box
31.71 Add Checklist Step Dialog Box

Use the Add Checklist Step dialog box to add a new step to a checklist.
Figure: Add Checklist Step dialog box
Table: Add Checklist Step

Name Type the name of the checklist step.

909
31.72 Edit Checklist Step Dialog Box
31.72 Edit Checklist Step Dialog Box

Use the Edit Checklist Step dialog box to edit a checklist step.
Figure: Edit Checklist Step dialog box
Table: Edit Checklist Step

Name Type the name of the checklist step.

910
31.73 Checklists Properties
31.73 Checklists Properties

Use the Checklists Properties view or dialog box to add, edit, and remove
checklists.
Figure: Checklists properties
Table: Checklists Properties

Name Dipsplays the name of the added checklists.

“Checklists” on page 792.
Add Click to open the Checklist wizard, where

you add new checklists.
Edit Click to open the properties dialog box,

where you edit the properties of the selected
31.74 “Checklist Properties” on page 912.
Remove Click to remove the selected checklist.

911
31.74 Checklist Properties
31.74 Checklist Properties

Use the Checklist Properties view or dialog box to add, edit, and remove checklist
steps and to view and configure the general and references properties of the
checklist. For more information, see section 52.28 “General Properties – Basic Tab”
on page 1545.
Figure: Checklist properties
Table: Checklist Properties

Name Displays the name of the checklist steps that

have been added to the checklist. For more
Actions” on page 746.
Add Click to start the Checklist Step wizard.
Edit Click to edit the properties of the checklist

step. For more information, see section
31.75 “Checklist Step Properties” on page
913.
Remove Click to remove the selected checklist step.

912
31.75 Checklist Step Properties
31.75 Checklist Step Properties

Use the Checklist Step Properties view or dialog to edit the displayed instruction
and the step position of the checklist step and to view and configure the general
and references properties of the checklist step. For more information, see section
52.28 “General Properties – Basic Tab” on page 1545.
Figure: Checklist Step properites
Table: Checklist Step Properties

Checklist step Displays the checklist step instruction. For

Actions” on page 746.
Position Enter the position of the step on the

checklist.

913
31.76 Alarm – Basic Settings View
31.76 Alarm – Basic Settings View

Use the Basic Settings view to view the alarm name, alarm type, or edit the
comment to change the description of the alarm.
Figure: Basic Settings view
Table: Basic Settings View

Alarm type Displays the type of the alarm object.
Name Displays the name of the alarm object.
Description Type a description that describes the alarm

object.

914
31.77 Select Conditions Dialog Box – Alarm Filter Properties
31.77 Select Conditions Dialog Box – Alarm

Filter Properties
Use the Select Conditions dialog box to make it easier for you to find a specific
type of alarms.
Figure: Alarm filter condition properties
Table: Alarm Filter Conditions

Select the alarm filter conditions for the

alarms you want to include.
Remove the alarm filter conditions for the

alarms you want exclude.

condition.

915
31.78 Create Email Notification Wizard – Email Notification Page
31.78 Create Email Notification Wizard –

Email Notification Page
Use the Email Notification page to set up the conditions for the email notification.
Figure: Email Notification page
Table: Email Notification page

Status Select Disabled to deactivate the email

notification function.
Notify on transition to Select the alarm condition that has to be met

before the email notification is sent.
Email address Type the email address to the user or group

of users to whom the email notification is to
be sent.
Subject Type the subject text or the substitution

code for the subject text the email
notification is to have when sent.
Text Type the text content or the substitution

code for the text content the email is to have
when sent.
[Conditions list] Use the conditions list to add or remove

conditions for when the email notification is
to be sent and to make condition settings.

916
31.78 Create Email Notification Wizard – Email Notification Page
Continued
Add condition
Click to add a condition that has to be met
for the email to be sent.
Remove condition
Click to remove a condition that has to be
met for the email notification to be sent.
Add row
Click to add a row to the condition.
Remove row
Click to remove the row from the condition.

917
31.79 Email Notification View

Use the Email Notification view to view and edit the settings of an email
notification.
Figure: Email notification view
Table: Email Notification View

Name Type the name of the object to create.
Description Type a description that explains what the

object is used for.


before the email notification is sent.

be sent.

918
Continued


when sent.

conditions for when the email notification is
to be sent and to make condition settings.
Add condition
for the email to be sent.
Remove condition
met for the email notification to be sent.
Add row
Remove row

919
31.80 Email Notification Properties
31.80 Email Notification Properties

Use the Email Notification properties to configure the sender address and the
content of the notification mail.
Figure: Email Notification properties
Table: Email Notification Properties


be sent.


when sent.


920
31.81 Create Write to File Notification Wizard – Write to File Notification Page
31.81 Create Write to File Notification

Wizard – Write to File Notification Page
Use the Write to File Notification page to set up the conditions for the write to file
notification.
Figure: Write to file notification page
Table: Write to File Notification page

Status Select Disabled to deactivate the write to

file notification function, that is, no
information is written to the file.

before the notification is written to the file.
File name Type the name of the file in which the

notification is to be written. If the file does not
exist, a new file with this name is created.
Text Type the text content of the text file that is to

be sent when the conditions are met.

conditions for when the notification is to be
written to the file and to configure the
conditions.

921
31.81 Create Write to File Notification Wizard – Write to File Notification Page
Continued
Add condition
for the notification to be written to the file.
Remove condition
met for the notification to be written to the
file.
Add row
Remove row

922
31.82 Write to File Notification View

Use the Write to File Notification view to view and edit the settings of a write to file
notification.
Figure: Write to file notification view
Table: Write to File Notification View


object is used for.


before the notification is written to the file.


923
Continued


conditions for when the notification is to be
written to the file and to configure the
conditions.
Add condition
for the notification to be written to the file.
Remove condition
met for the notification to be written to the
file.
Add row
Remove row

924
31.83 Write to File Notification Properties
31.83 Write to File Notification Properties

Use the Write to File Notification properties to configure the message and file
name.
Figure: Write to file notification properties
Table: Write to File Notification Properties





925
31.84 Create Assignment Wizard – Assignment Page
31.84 Create Assignment Wizard –

Assignment Page
Use the Assignment page to set the assignment conditions that have to be met for
the alarm to be assigned.
Figure: Assignment page
Table: Assignment Page

Status Select Disabled to deactivate the

assignment function.
Assigned to Enter the user or user group that is to

receive the assignment request.
Active value Enter the value, generated by the connected

schedule or other multistate variable, that is
to activate this assignment object. The
number has to be larger than 0.
Schedule Select Disabled to deactivate the


conditions for when the alarm is to be
assigned and to make condition settings.

926
31.84 Create Assignment Wizard – Assignment Page
Continued
Add condition
Click to add conditions for when the alarm is
to be assigned.
Remove condition
Click to remove conditions for when the
alarm is to be assigned.
Add row
Remove row

927
31.85 Assignment View

Use the Assignment view to edit automatic alarm assignments.
Figure: Assignment view
Table: Assignment View


object is used for.


Schedule Enter the schedule or other multistate

variable that contains the value that is to be
used to activate the assignment.
(Conditions list) Use the conditions list to add or remove

conditions for when the alarm is to be
assigned and to make condition settings.
Add condition
Click to add conditions for when the alarm is
to be assigned.
Remove condition
Click to remove conditions for when the
alarm is to be assigned.

928
Continued
Add row
Remove row

929
31.86 Assignment Properties
31.86 Assignment Properties

Use the Assignment properties to configure which user or user group to send the
assignment request.
Figure: Assignment properties
Table: Assignment Properties



Schedule Enter the schedule or other multistate

variable that contains the value that is to be
used to activate the assignment.
Status Select Disabled to deactivate the


930
31.87 Alarm Properties

Use the Alarm properties to configure and view the general and object references
Figure: Alarm properties

931
31.88 Object Specific Event View Toolbar
31.88 Object Specific Event View Toolbar

Use the Object Specific Event View toolbar to manage how to display events.
Table: Object Specific Event View Toolbar

Object Description
Group box
topic on WebHelp.
Show Events Select the time span or the number of events

to display.
Refresh
Click to refresh the event list with the latest
events.


932
31.89 Progress View
31.89 Progress View

The Progress view displays information about time-consuming operations
between WorkStation and the Building Operation server.
Figure: The Progress view
Table: Progress View

Operation Displays the name of the operation that is

being performed.
Name Displays the name of the object that the

operation is performed on.
Progress Displays the progress of the operation so

you can determine when the operation is
complete.
Status Displays the status of the operation.
Click to get details for the operation.
Close Click to close the Progress view dialog

box.

933
31.90 Alarm Handling Properties
31.90 Alarm Handling Properties

Use the Alarm Handling Properties view or dialog box to configure and view the
Figure: Alarm Handling Properties

934

Use the Alarm properties to configure and view the general and object references
Figure: Alarm properties

935
32 Events
introduction to this topic
Topics
How Events Work
Events Pane and Event View Customization
Styling a Certain Event in the Events Pane or Event View
Event Filter Conditions
Applying an Event Filter
Creating a Filtered Event View
Filter Condition Wildcards
32 Events
32.1 How Events Work
32.1 How Events Work

All system events, as well as information and circumstances, are recorded in the
Event log. These event records can be viewed in the Events pane or in an Event
View.
Events can tell you when someone logged on or off the system, when a setpoint
was changed, if a notificaton was written to a file, if an e-mail notification was sent
or not and when an object was created. For example, Events can tell you when a
trend log or an alarm was created, and by whom. The event log also records when
servers were online or offline and when the software was upgraded. The event log is
useful for tracking down all information in your system.
You can create and use more than one Event View. Each Event View and the
Events pane can be customized with an event filter to only show the information you
are interested in.
You can view all events that have been generated from one object in the system
using the View command in the Actions menu.
In the Events view, you can also open a detailed view to inspect all properties for a
selected event.
Figure: Events view in WorkStation (above) and WebStation
32.1.1 Archive Overview

Archiving is the process of preserving historical data, which is comprised of
selected events and extended trend logs. For example, some facilities are required
to maintain archives to comply with government regulations. Another example is in
secure facilities where they must maintain records of who logged in or who
changed setpoints. Archiving is not a backup function because archive data cannot
be imported back into the system.
For more information, see section 49.1 “Archiving Overview” on page 1411.

939
32 Events
32.2 Events Pane and Event View Customization
32.2 Events Pane and Event View

Customization
You can style certain events to bring out those that are more of interest than other
events listed in the Events pane and Event Views. To style a specific event, you first
have to create a condition that is associated with the events you want to style. An
event can be styled with a unique background color, font, and font color.
For example, you can style all events where an alarm is acknowledged. To separate
this event from others you configure, change the background color to dark green
and the font color to white. All other events have the default style which is a white
background and black font color.
Figure: Events View with all acknowledge events styled

If an event fulfills the condition criteria in more than one of the configured event
criteria, it is the event style with highest priority in the Events View Style dialog box
that is applied to the event.

940
32 Events
32.3 Styling a Certain Event in the Events Pane or Event View
32.3 Styling a Certain Event in the Events

Pane or Event View
You style the appearance of an event in the Events pane or Event View to easily
detect the event when it occurs.
For more information, see section 32.2 “Events Pane and Event View
To style a certain event in the Events pane or Event View

1. Click somewhere in the Events pane or Event View to make sure the pane or
dialog box is in focus.
2. On the Actions menu, click Edit the style of associated events.
3. In the Event Styles dialog box, click Add.
4. In the Condition box, click the Browse button.
5. In the Select Conditions dialog box, click the Add condition button
and select an event category.
6. Enter the settings of the event category associated with the event you want to
style.
Note
• You can add several event categories to specify the event in
detail.

941
32 Events
8. Click OK.
9. In the Event Styles dialog box, in the Background color box, click the
Browse button.
10. Select the color for the background of the event row in the Events pane or
Event View.
11. Click OK.

12. In the Font color box, click the Browse button.
13. Select the color for the font of the event in the Events pane or Event View.
14. Click OK.
15. In the Font box, click the Browse button.
16. In the Font dialog box, select the font, font style and size that you want to
display the certain event text in.
17. Click OK.
18. In the Event Styles dialog box, click OK.

942
32 Events
You can add several event styles to different associated events.

943
32 Events
32.4 Event Filter Conditions

Event filter conditions are used to set up the conditions for the events you want to
be displayed in the Events pane or an Event View. You can use wildcards when
setting up filter conditions. For more information, see section 32.7 “Filter Condition
Wildcards ” on page 954.
Table: Event Filter Conditions

Acknowledge time Enter the property to filter events by the time

and date an alarm was acknowledged.
Alarm state Select the property to filter events by the

alarm state.
Alarm text Type the property to filter events by the

alarm message that was added to the alarm.
Assigned state Select the property to filter events by the

assigned state the alarm had. The possible
values are Unassigned, Assigned and
Accepted.
Assigned to domain Type the property to filter events by the

domain of the user or group that an alarm
was assigned to. Wildcards can be used.
Assigned to ID Type the property to filter events by the ID of

the user or group that an alarm was
Assigned to name Type the property to filter events by the

name of the user or group that an alarm was
BACnet alarm type Select the property to filter events by the

BACnet alarm that monitored a variable
within a BACnet network.
Basic evaluation state Select the property to filter events by the

basic evaluation state of an alarm. The value
True indicates that an alarm was triggered.
Category Type the property to filter events by the

category name. Wildcards can be used. For

944
32 Events
Continued
Command Type the property to filter events by the

executed command. Wildcards can be
Comment Type the property to filter events by the

comment that was added to an alarm.
Control source Type the property to filter events by the

initials of the controlling I/NET operator.
Control state Select the property to filter events by the 4

bit I/NET state descriptor.
Count Enter the property to filter events by the

number of times an alarm has toggled
Description Type the property to filter events by their

description. Wildcards can be used. For
Device name Type the property to filter events by the

name of the I/NET device that generated the
event. Wildcards can be used. For more
Disabled cause Select the property to filter events by the

cause for why the alarm was disabled. An
alarm can be disabled by user, shunt
variable and/or system (it’s disabled by
system if the alarm was incorrectly
configured).
Domain name Select the property to filter events by the

domain a user belonged to.
Evalutation state Select the property to filter events by the

evaluation state an alarm had. For example,
Upper limit alarm is displayed if the
monitored value reached the upper alarm
limit.
EWS ID Type the property to filter events by the id of

the event on the external system. Wildcards
page 954.

945
32 Events
Continued
EWS source ID Type the property to filter events by the id of

the external object that generated the event.
EWS source name Type the property to filter events by the

name of the external object that generated
the event. Wildcards can be used. For more
First name Type the property to filter events by the first

954.
Forced value Type the property to filter events by forced

values. Wildcards can be used. For more
Group Type the property to filter events by the

name of the cause note or action note group
the user edited. Wildcards can be used. For
Hidden Select the property to filter events by the

visible status an object had. False is
displayed when an object was shown.
Individual Enter the property to filter events by the

individual number of the individual whose
INET address Type the property to filter events by the

system address of the point, or station
address of the host or controller that
generated the event. Wildcards can be used.
INET event type Select the property to filter events by the

I/NET event type.
Last name Type the property to filter events by the last

954.

946
32 Events
Continued
Link name Type the property to filter events by the

name assigned to the link of the device from
which the event originated. Wildcards can be
Message text Type the property to filter events by the text

of an I/NET actio or dispatch message, if
there is one.
Monitored variable Type the property to filter events by path to

the monitored variable. Wildcards can be
Note Type the property to filter events by their

note. Wildcards can be used. For more
Previous alarm state Select the property to filter events by the

previous alarm state.
Priority Enter the property to filter events by the

priority an alarm had.
Source Type the property to filter events by the path

of the source object. Wildcards can be used.
Source server Type the property to filter events by the

server path of the source object. Wildcards
page 954.
State Type the property to filter events by (up to) 4

text characters that represent the text state
of a discrete point or the unit description of
an analog point. Wildcards can be used. For
Station name Type the property to filter events by the

name assigned to the controller from which
the event originated. Wildcards can be used.
System alarm ID Select the property to filter events by the

alarm ID generated by the system.
System event ID Select the property to filter events by the

event ID generated by the system.

947
32 Events
Continued
Tenant Enter the property to filter events by the

tenant number of the individual whose
Timestamp Enter the property to filter events by the time

and date when the event was generated.
Triggered time Enter the property to filter events by the time

and date an alarm went from normal state to
alarm state.
Type Select the property to filter events by event

type.
Unique alarm ID Type the property to filter events by the

unique alarm ID of an alarm. Wildcards can
954.
Unique user ID Type the property to filter events by the ID of

a user. Wildcards can be used. For more
User action item Type the property to filter events of which

the user has edited checklist, cause note
group, or action note group items. Wildcards
page 954.
User name Type the property to filter events by the

name of the user that generated the event.
Value after Type the property to filter events by the value

of an object after it was changed. Wildcards
page 954.
Value at change Type the property to filter events by the value

the monitored variable had when the alarm
was triggered. Wildcards can be used. For
Value before Type the property to filter events by the value

of an object before it was changed.

948
32 Events
Continued
Zone Select the property to filter events by I/NET

security zone number associated with a
security event (0-63).

949
32 Events
32.5 Applying an Event Filter

You use an event filter to make the Events pane or Event View only display events
that are of interest.
To apply an event filter

1. In WorkStation, in the System Tree pane, select the Events pane or Event
View you want to filter.
2. On the Actions menu, click Edit Event Filter.
3. In the Select Conditions dialog box, click the Add condition button
and select an event category.
4. Enter the settings of the event category that generate the writing action.
Note
• You can add multiple event types.
6. Click OK.

950
32 Events
The event filter has been created and is now applied to the Events pane or Event
View.

951
32 Events
32.6 Creating a Filtered Event View

You create a new filtered Event View to monitor and handle events. By adding an
event filter you only display events that you are interested in.
For more information, see section 32.2 “Events Pane and Event View
To create a filtered Event View

Operation server where you want to create the event.
2. On the File menu, point to New, and then click View.
3. In the object type list, click Event View.
4. In the Name box, type a name for the Event View.

5. In the Description box, type a description for the Event View.
6. Click Create.
7. In the System Tree pane, select the Event View that you want to add an
event filter to.
8. On the Actions menu, click Edit Event Filter.

952
32 Events
9. In the Select Conditions dialog box, click the Add Condition button
and select a condition.
10. Enter the settings of the condition.
Tip
You can add several event view conditions to specify when to write
the event view.
12. Click OK.

953
32 Events

A wildcard is one or more characters used to simplify the process of setting up filter
conditons. You use wildcards to subsitute characters or combinations of characters
in object properties, such as names or descriptions. For example, instead of setting
up five filter conditions for values with names beginning with a, b, c, d, or e, you can
set up one single filter condition for values with a name beginning with any of the
charachters in the range [a-e].
Table: Wildcard Characters

Character Description
* Use to match any combination of

characters, including no character
? Use to match any one character exactly
[ Use to begin a SET, that is, a number of

characters or a range
] Use to end a SET
[] Use to match any one character specified

within the SET, that is, enclosed by the
brackets
! Use to exclude the characters or range(s) of

a SET
- Use in a range within a SET: 0-9, a-z, A-Z
\ Use to ignore the wildcard character and

search for it as any other character
Any other character has to match exactly.

You can specify any number of characters or a range within brackets. In this case,
the filter includes one character specified within the brackets and any number of
characters specified outside the brackets.
Examples:
*at - Matches "at" and all objects ending with "at"
?t - Matches all two-character objects ending with "t"
[CB]at - Matches "Cat" and "Bat", that is, objects beginning with any one character
specified within the SET and ending with "at"
[A-C]at - Matches "Aat", "Bat", and "Cat"
[CB][au]t - Matches "Cat", "Cut", "Bat", and "But"
[!a-b0-1q]at - Matches all three-character objects ending with 'at' except "aat",
"bat", "0at", "1at" and "qat"
\\ - Matches "\"
b\\t - Matches ”b\t”

954
32 Events
Table: Wildcard Availability for Different Features

Feature * ? [b] [a-c] [\]] [!a-c]
Alarm View Yes Yes Not Not Not Not

Filter available available available available
Conditions
Event View Yes Yes Yes Yes Not Not

Filter available available
Conditions
Sum Alarm Yes Yes Yes Yes Yes Yes

Filter
Conditions
Notification Yes Yes Yes Yes Yes Yes

s Filter
Condition
Assignmen Yes Yes Yes Yes Yes Yes

ts Filter
Conditions

955
33 Events User Interface
introduction to this topic
Topics
Object Specific Event View
Event Styles Dialog Box
Event View Properties
Add/Remove Columns Dialog Box (Events)
Select Conditions Dialog Box – Events Filter Properties
EventLog Properties - Basic Tab
33.1 Object Specific Event View
33.1 Object Specific Event View

Use the Object Specific Events view to view all events that are related to a
specific object.
Figure: Object Specific Events view
Table: Object Specific Events View

Number Description
Use the Object Specific Events View toolbar

to administer which events to display. For
more information, see section 31.88 “Object
Specific Event View Toolbar” on page 932.
Use the Object Specific Events View

columns to sort, hide, or show information
about the events. For more information, see
the Add/Remove Columns Dialog Box topic
on WebHelp.

959
33.2 Event Styles Dialog Box
33.2 Event Styles Dialog Box

Use the Event Styles dialog box to edit the fonts and colors for different events in
the Events pane and Event View.
Figure: Event Style dialog box
Table: Event Style Dialog Box

Add Click to add and configure a new event to

style.
Delete Click to delete an event style.
Up Click to increase the priority of an event.
Down Click to decrease the priority of an event.
Condition Enter the condition or conditions of the event

to style.

events in the Events pane and Event View
that fulfill the configured conditions.
Font color Enter the font color to use for events in the
Events pane and Event View that fulfill
configured conditions.
Font Enter the font to use for events in the Events

pane and Event View that fulfill configured
conditions.

960
33.3 Event View Properties
33.3 Event View Properties

Use the Event View properties for viewing and editing the properties of the Events
pane and Event View.
Figure: Event View properties
Table: Event View Properties

Number of records shown Enter the number of rows you want to list in
the Events pane or Event view. You can
enter any number between 1 and 5999.
Important
• By default, the latest 1000 event records are displayed in the Event View.
• Regardless of the number of event records in the database, you can display a
maximum of 5999 event records at a time in the Event View.
• You can use the filter to display a different set of event records, maximum
5999 records at a time.

961
33.4 Add/Remove Columns Dialog Box (Events)

(Events)
Use the Add/Remove columns dialog box to add or remove columns from the
Events pane.
Table: Add/Remove Columns

Acknowledge time Select to display the time and date when the
alarm was acknowledged. For more
“Acknowledgement” on page 738.
Alarm state Select to display the alarm state. For more

on page 623.
Alarm text Select to display the alarm message that

was added to the alarm. For more
Messages” on page 728.
Assigned state Select to display the assigned state the

alarm had. For more information, see the
Alarm Assignment topic on WebHelp.
Assigned to domain Select to display the domain of the user or

group that an alarm was assigned to. For

962
Continued
Assigned to ID Select to display the ID of the user or group

that an alarm was assigned to.
Assigned to name Select to display the name of the user or

group that an alarm was assigned to. For
Functions” on page 624.
BACnet alarm type Select to display the BACnet alarm that

monitored a variable within a BACnet
network.
Basic evaluation state Select to display the basic evaluation state of

an alarm. The value True indicates that an
alarm was triggered.
Category Select to display the alarm category name.
Command Select to display the executed command.
Comment Select to display the comment that was

added to an alarm.
Control Source Select to display the initials of the controlling

I/NET operator.
Control State Select to display the 4 bit I/NET state

descriptor.
Count Select to display the number of times an

alarm has toggled between the alarm and
reset state. For more information, see the
Count topic on WebHelp.
Description Select to display the event description. For

“General Properties – Basic Tab” on page
1545.
Device Name Select to display the name of the I/NET

device that generated the event.
Disabled cause Select to display the cause for why the alarm
was disabled. An alarm can be disabled by
user, shunt variable and/or system (it’s
disabled by system if the alarm was
incorrectly configured).
Domain name Select to display the domain a user

belonged to. For more information, see
section 21.1 “Domains” on page 435.
Evaluation State Select to display the evaluation state an

alarm had. For example, Upper limit alarm is
displayed if the monitored value reached the
upper alarm limit.

963
Continued
EWS ID Select to display the EcoStruxure Web

Service identification of the event on the
external system.
EWS source ID Select to display the EcoStruxure Web

Service identification of the external object
that generated the event.
EWS source name Select to display the events ty the name of

the external object that generated the event.
First Name Select to display the first name of the

I/NET door point.
Forced value Select to display the forced values.
Group Select to display the name of the cause note

or action note group the user edited.
Hidden Select to display the visible status an object

had. False is displayed when an object was
shown.
Individual Select to display the individual number of the

I/NET door point.
INET Address Select to display the system address of the

point, or station address of the host or
controller that generated the event.
INET Event Type Select to display the I/NET event type.
Last Name Select to display the last name of the

I/NET door point.
LinkName Select to display the name assigned to the

link of the device from which the event
originated.
Message Text Select to display the text of an I/NET action

or dispatch message, if there is one.
Monitored variable Select to display the path of the monitored

variable.
Note Select to display event notes.
Previous alarm state Select to display the previous alarm state.
Priority Select to display the priority an alarm had.
Sequence number Select to display the event sequence


964
Continued
Source Select to display the path of the source

object.
Source server Select to display the server path of the

source object.
State Select to display the events in (up to) 4 text

characters that represent the text state of a
discrete point or the unit description of an
analog point.
StationName Select to display the name assigned to the

device from which the event originated.
System alarm ID Select to display the alarm ID generated by

the system.
System event ID Select to display the event ID generated by

the system.
Tenant Select to display the tenant number of the

I/NET door point.
Text Select to display the text messages in the E-

mail in a E-mail notification. For more
Timestamp Select to display the time and date when the

event was generated.
Triggered time Select to filter events by the time and date an

alarm went from normal state to alarm state.
Type Select to display the event type. For more

information, see section 52.28 “General
Properties – Basic Tab” on page 1545.
Unique alarm ID Select to display the ID of the alarm that

Unique user ID Select to display the ID of the user that

User action item Select to display events of which the user

has edited checklist, cause note group, or
action note group items.
User name Select to display the name of the user that

generated the event.. For more information,
see section 32.2 “Events Pane and Event
View Customization” on page 940.
Value after Select to display the value of an object after

it was changed.

965
Continued
Value at change Select to display the value the monitored

variable had when the alarm was triggered.
Value before Select to display the value of an object

before it was changed.
Zone Select to display the I/NET security zone

number associated with a security event (0-
63).

966
33.5 Select Conditions Dialog Box – Events Filter Properties
33.5 Select Conditions Dialog Box – Events

Filter Properties
Use the Select Conditions dialog box to make it easier to find a specific type of
event.
Figure: Event filter conditions
Table: Event Filter Properties

Add condition
Click to customize the conditions to sort out
the events that are of interest.
“Event Filter Conditions” on page 944.
Remove condition
Click to remove an added condition.

condition.

967
33.6 EventLog Properties - Basic Tab
33.6 EventLog Properties - Basic Tab

Use the EventLog Properties view or dialog box to view the general properties.
1545.
Figure: EventLog Properties

968
34 Trend Log Introduction
Topics
Trend Overview
Clearing a Trend Log
Editing or Commenting a Trend Log Record
Displaying the History of a Trend Log Record
Trend Units
Enabling a Trend Log
Disabling a Trend Log
Editing the Activation Method in a Trend Log
34.1 Trend Overview
34.1 Trend Overview

The function of a trend log is to log the variable that it is connected to and store the
records.
To be able to store larger amount of records, you connect an extended trend log.
The records of the trend log and the extended trend log can be presented
numerically in a trend log list or graphically in a trend chart. The records can also be
processed by a calculation method before they are presented.

971
34.1 Trend Overview

972
34.1 Trend Overview
Figure: Trend overview.
Note
A trend log that monitors an enumeration records the enumeration value and not
the enumeration definition.
For more information, see section 49.13 “Event and Alarm Enumerations” on
page 1434.
For more information, see section 49.16 “Trend Log Enumerations” on page
1454.
34.1.1 Trend Log Types

You use a trend log to collect data and then store the records. A record contains a
log value or an event as well as its time stamp and an optional comment. A trend
log can log an analog variable, a digital variable, or an integer variable.
For more information, see section 35.1 “Trend Log Types” on page 985.
34.1.2 Trend Log Functions

All trend logs store records by using the circular storing principle; you can also
connect trends logs to external trend logs with larger storing capacity. For some
trend logs you can set up conditions that have to be fulfilled before the trend log
starts recording.
For more information, see section 36.1 “Trend Log Functions” on page 1061.
34.1.3 Trend Units

You can define the unit of a trend log when the trend log is created or on a
previously created trend log where no unit has been set. After defining a unit for a
trend log, you cannot change it.
For more information, see section 34.5 “Trend Units” on page 978.
34.1.4 Trend Log List

The trend log list numerically displays the records of a trend log or an extended
trend log. The records of the trend log can be processed by a calculation method
before they are presented in the trend log list.
For more information, see section 38.1 “Trend Log Lists” on page 1135.
34.1.5 Trend Charts

A trend chart displays the records of a trend log or an extended trend log as a
series.

973
34.1 Trend Overview
For more information, see section 37.1 “Trend Charts” on page 1083.
34.1.6 Move or Copy Trend Logs or Extended Trend

Logs
When moving or copying a trend log or extended trend log to another server, only
the configuration of the trend log is transferred. If you copy the trend log to another
server, all recorded values are preserved in the original trend log while the copy on
the other server does not contain any recorded values. If you move the trend log to
another server, the configuration of the trend log is preserved but the record values
are lost.
Caution
Recorded values are lost when you move or copy a trend log to another server.
34.1.7 Mass Create


974
34.2 Clearing a Trend Log
34.2 Clearing a Trend Log

You clear a trend log to remove all recorded values. This procedure does not clear
meter settings in the meter trend log.
For more information, see section 34.1 “Trend Overview” on page 971.
Caution
• Ensure that the recorded values are backed up or not needed. Clearing a
trend log permanently erases all records and events.
To clear a trend log

the trend log is located.
2. Select the trend log you want to clear
3. On the Actions menu, point to Activation, and then click Clear trend log.
4. In the Clear log dialog box, click Yes to confirm that you want to clear the
trend log.
The trend log is now cleared.

975
34.3 Editing or Commenting a Trend Log Record
34.3 Editing or Commenting a Trend Log

Record
You edit or comment a trend log record through the trend log list, for example, to
correct a corrupt value or comment a specific record.
Note
• When editing an extended trend log record, the changes do not affect
corresponding record in the connected trend log.
To edit a trend log record

1. In WorkStation, in the System Tree pane, select the trend log list you want to
edit.
2. Select the record you want to edit, and then click the Edit/comment trend
log record button .

3. In the Value box, type the new value.
4. In the Comment box, type a comment.

5. Click Save.
6. On the main toolbar, click the Refresh button .

The record is now edited, when the list is refreshed the new record with comment is
displayed. All edits are stored and you can display a records history.

976
34.4 Displaying the History of a Trend Log Record
34.4 Displaying the History of a Trend Log

Record
You show the history of a trend log record, such as the original value as well as
edits, through the trend log list.
To display the history of a trend log record

show.
2. In the Trend log list, right-click a record, and then click Show history.
3. Click Close.
The dialog box displays all old values and which user that edited the record.

977
34.5 Trend Units
34.5 Trend Units

You can define the unit of a trend log when the trend log is created or on a
previously created trend log where no unit has been set. After defining a unit for a
trend log, you cannot change it.
Do not change the unit of a surveyed variable to a unit outside the trend log unit
category. The trend log stops logging because of the conversion problem and data
is lost. A system alarm is triggered and the trend log record is given the status: A log
value was missed.
Extended trend logs inherit the unit from the connected trend log. Trend charts and
trend log lists display the values according to the unit that is defined in your
operating system settings.
For example, a variable that represents a temperature in Kelvin is surveyed by an
interval trend log. The trend log is configured to store the values in degrees
Fahrenheit. A trend log list and trend chart are connected to the trend log. If you
display the trend chart or trend log list on an operating system that uses the SI
metric system, the values in the trend log list and trend chart are converted and
displayed in degrees Celsius.

978
34.5 Trend Units
Figure: In this setup the variable has the temperature unit Kelvin, recorded trend log
values are stored in Fahrenheit, and are displayed in Celsius.

979
34.6 Enabling a Trend Log
34.6 Enabling a Trend Log

You enable trend log to start recording values.
For more information, see section 36.3 “Activation Methods” on page 1063.
To enable a trend log

1. In WorkStation, System Tree pane, select the folder or server where the
trend log is located.
2. Select the trend log you want to enable.
3. On the Actions menu, point to Activation, and then click Enable trend
log.
The trend log is now enabled and starts recording when its start condition is fulfilled.

980
34.7 Disabling a Trend Log
34.7 Disabling a Trend Log

You disable a trend log to stop recording values.
To disable a trend log

2. Select the trend log you want to disable
3. On the Actions menu, point to Activation, and then click Disable trend
log.
The trend log is now disabled.

981
34.8 Editing the Activation Method in a Trend Log
34.8 Editing the Activation Method in a

Trend Log
You edit the activation method property to define the criteria that executes the trend
log to start recording.
To edit the activation method in a trend log

1. In WorkStation, in the System tree pane, select the folder or server where
2. Select the trend log you want to configure.
4. In the Activation method box, select the new activation method.
5. Click OK.

982
35 Trend Log Types
Topics
Trend Log Types
Interval Trend Logs
Interval Trend Log Delta
Creating an Interval Trend Log
Configuring an Interval Trend Log
Editing the Interval of an Interval Trend Log
Editing the Delta in an Interval Trend Log
Meter Trend Logs
Creating a Meter Trend Log and Associated Objects
Creating a Meter Trend Log
Managing Replacement of a Meter
Configuring a Meter Trend Log
Displaying Meter Change History
Change of Value Trend Logs
Creating a Change of Value Trend Log
Configuring a Change of Value Trend Log
Variable Triggered Trend Logs
Creating a Variable Triggered Trend Log
Configuring a Variable Triggered Trend Log
Manual Trend Logs
Creating a Manual Trend Log
Configuring a Manual Trend Log
Adding a Trend Log Record to a Manual Trend Log
Implicit Trend Logs
35 Trend Log Types
35.1 Trend Log Types

You use a trend log to collect data and then store the records. A record contains a
log value or an event as well as its time stamp and an optional comment. A trend
log can log an analog variable, a digital variable, or an integer variable.
For performance reasons and to make the trend log less sensitive to if a server goes
off line, it is recommended that you place trend logs as closely to the logged
variable as possible. Preferably on the server where the logged variable is located.
For example, if a sensor is connected to an Automation Server, the trend log that
records the temperature should be placed on that Automation Server.
You can use extended trend logs to structure the log data and to store it where
there is greater storage capacity.
When you create a trend log, the wizard helps you create and set up an extended
trend log, a trend log list, and a trend chart as well as the chosen trend log type. For
more information, see section 34.1 “Trend Overview” on page 971.

985
35 Trend Log Types
Figure: Trend wizard flow chart

986
35 Trend Log Types
35.1.1 Interval Trend Logs

The interval trend log collects data at a specific time interval. Each logged value is
stored as a record in the trend log. Use this trend log when the logging interval is
less than 1 hour.
For more information, see section 35.2 “Interval Trend Logs ” on page 989.
35.1.2 Meter Trend Logs

The meter trend log is a variable triggered trend log with extra functionality to
seamlessly handle consumption calculations independent of meter rollover or meter
exchange.
For more information, see section 35.8 “Meter Trend Logs” on page 1006.
35.1.3 Change of Value Trend Logs

The change of value trend log records the variable each time the difference
between the current value and the last log value exceeds the delta. Use the change
of value trend log to, for example, recording a variable that has an unequal
oscillation.
For more information, see section 35.14 “Change of Value Trend Logs” on page
1035.
35.1.4 Variable Triggered Trend Logs

The variable triggered trend log records the variable according to the changes of an
associated trigger variable. Use this type of trend log when the log interval is
scheduled to log monthly or yearly, or when another device is used to trigger the
log.
For more information, see section 35.17 “Variable Triggered Trend Logs” on page
1044.
35.1.5 Manual Trend Logs

The manual trend log records data that you manually enter. The manual trend log
does not log a variable. Use this type of trend log when values from offline devices
have to be manually registered to the trend log. For example, if you want to create a
trend log that monitors an electricity meter that cannot be connected to Building
Operation.
For more information, see section 35.20 “Manual Trend Logs” on page 1051.

987
35 Trend Log Types
35.1.6 Implicit Trend Logs

The implicit log is a change of value trend log which monitors the IO variable and
records a new value if the variable exceeds the delta. Each log value is stored as a
record in the trend log. The delta is automatically defined by Building Operation
depending on the measured unit of the device that is connected to the IO port.
For more information, see section 35.24 “Implicit Trend Logs ” on page 1058.

988
35 Trend Log Types
35.2 Interval Trend Logs

The interval trend log collects data at a specific time interval. Each logged value is
stored as a record in the trend log. Use this trend log when the logging interval is
less than 1 hour.
You create interval trend logs using WorkStation or WebStation. In WorkStation,
you configure the properties of the interval trend log to meet the specific needs of
your site.
For example, in the figure below, the interval trend log records a variable every
minute. The records are printed in a trend chart. The interval trend log does not
record the values between the intervals.

989
35 Trend Log Types
Figure: Interval trend log schematic.

990
35 Trend Log Types
The interval trend log, which is not a variable triggered trend log, has the function to
start log records according to a given start condition. For more information, see
section 36.3 “Activation Methods” on page 1063.
35.2.1 Interval Trend Log Delta

An interval trend log with delta can reduce the storage of similar records, and may
not fill up the storage capacity as quickly as as an interval trend log with no delta.
An interval trend log with delta checks the monitored value at each interval and
records the new value if it differs from the previously recorded value by more than
the delta. Delta is the difference between the current variable value and the last log
value. To log a variable according to the time interval, use a delta of zero.
minute but only if the variable exceeds or falls below the delta of 3. The records are
printed in a trend chart. Notice that the interval trend log with delta does not record
the values between the intervals, or on intervals where the variable is within the
delta.
Note
• To log a variable only according to the time interval, set Delta to zero.

991
35 Trend Log Types
Figure: Interval trend log with delta schematic.

992
35 Trend Log Types
If an interval trend log has a delta and a calculation method that uses periods, make
sure the period contains the required amount of records to generate a correct
calculation. If the value does not differ from the previously logged value by more
than the delta within the period, then none or too few values are recorded for the
calculation.
Note
• Adapt the period so it contains the required amount of records to generate a
correct calculation.
• If a calculation method is connected to an interval trend log with delta, make
sure that the period and delta are adapted for the calculation.

993
35 Trend Log Types
35.3 Interval Trend Log Delta

not fill up the storage capacity as quickly as as an interval trend log with no delta.
An interval trend log with delta checks the monitored value at each interval and
records the new value if it differs from the previously recorded value by more than
the delta. Delta is the difference between the current variable value and the last log
value. To log a variable according to the time interval, use a delta of zero.
minute but only if the variable exceeds or falls below the delta of 3. The records are
printed in a trend chart. Notice that the interval trend log with delta does not record
the values between the intervals, or on intervals where the variable is within the
delta.

994
35 Trend Log Types
Figure: Interval trend log delta schematic

995
35 Trend Log Types
not fill up the storage capacity as fast as an interval trend log with no delta.
If an interval trend log has a delta and a calculation method that uses periods, make
sure the period contains the required amount of records to generate a correct
calculation. If the value does not differ from the previously logged value by more
than the delta within the period, then none or too few values are recorded for the
calculation. If you want to calculate the required number of log records for a trend
log, you multiply the number of log records in one day with the number of days you
want to record. For example, the interval of the trend log is set to 1 hour, which
gives 24 recorded values per day. A trend log configured to record at least one
month records 31 days. The number of log records = 24 X 31 = 744.
Note

996
35 Trend Log Types
35.4 Creating an Interval Trend Log

You create an interval trend log to record a value of a variable at specified and
regularly occurring increments of time.
To create an interval trend log

you want to create the trend log.
2. On the File menu, point to New and then click Trend.
3. In the object type list, select Interval Trend Log.
4. In the Name box, type a name for the trend log.


997
35 Trend Log Types
5. In the Description box, type a description for the trend log.
6. Click Next.
7. In the Logged variable box, enter the variable that you want to log.
8. In the Delta box, enter the minimum value change that triggers a new record.
9. In the Unit box, click the browse button .


998
35 Trend Log Types
10. Select a unit for the trend log values.

12. Click Select.
13. In the Interval box, type the log frequency.

999
35 Trend Log Types
14. In the Log size box, type the log size time to be stored before old values are
overwritten.
15. In the Clear when enabled box, select True to clear the trend log every
time the trend log is enabled.

1000
35 Trend Log Types
16. In the Activation method box, select the condition to start the trend log:
• Select Always active to start recording values immediately after the
trend log is created.
• Select Variable controlled and then enter a variable in the Activation
variable box to start recording values when the start variable is true.
• Select Start at activation time and then enter the time in the
Activation time box to specify an exact time for the recording to begin.
17. Click Next.


1001
35 Trend Log Types
18. In the Extended Trend Log box, click the browse button to create an
extended trend log and connect it to the trend log.
19. In the Trend Log List box, click the browse button to create a trend log
list and connect it to the trend log.
20. In the Trend Chart box, click the browse button to either create a new
trend chart or connect the interval trend log to an existing trend chart.
21. Click Create.

1002
35 Trend Log Types
35.5 Configuring an Interval Trend Log
35.5 Configuring an Interval Trend Log

You configure the properties of an interval trend log to meet the unique needs of
your site.
1044.
To configure an interval trend Log

1. In WorkStation, in the System Tree pane, select the interval trend log you
want to configure.
3. Edit the properties:
Status Displays the status of the trend log.
Enabled Displays True if the trend log is enabled.
Activation time Enter the absolute start time when Time

mode is set to Absolute. This time is the
leftmost point of the x-axis.
Activation method Select the method for starting the trend

log. For more information, see section
36.3 “Activation Methods” on page 1063.
Clear when enabled Select True to clear the trend log when it
is enabled.
Activation variable Enter the variable that is to start the trend

log.
Logged variable Enter the variable that you want to log.
Interval Type how often to log the variable, the

interval defines the time between two log
records.
Log size Select the log size to store before old

records are overwritten.
Delta Select the minimum value change that

triggers a new record.
4. Click OK.

1003
35 Trend Log Types
35.6 Editing the Interval of an Interval Trend Log
35.6 Editing the Interval of an Interval Trend

Log
You edit the interval property of a trend log to increase or decrease the frequency of
records.
For more information, see section 35.4 “Creating an Interval Trend Log ” on page
997.
To edit the interval of an interval trend log

4. In the Interval box, type the new value.
5. Click OK.

1004
35 Trend Log Types
35.7 Editing the Delta in an Interval Trend Log
35.7 Editing the Delta in an Interval Trend

Log
You edit the delta property of a trend log to increase or decrease the number of
recorded values.
To edit the delta in an interval trend log

4. In the Delta box, edit the value.
5. Click OK.

1005
35 Trend Log Types
35.8 Meter Trend Logs

The meter trend log is a variable triggered trend log with extra functionality to
seamlessly handle consumption calculations independent of meter rollover or meter
exchange.
1044.
You create and configure meter trend logs using WorkStation.
For example, in the figure below, the meter trend log records a meter the 1st of
every month. In the middle of February the meter rolls over to 00000. A chart with
meter consumption calculation prints the consumption every month.

1006
35 Trend Log Types
Figure: Meter trend log

1007
35 Trend Log Types
When physically replacing an old meter with a new one, you have to configure the
meter trend log by adding the settings of the old meter and new meter in the
Manage replacement of meter dialog box in WorkStation. These settings are
the foundation to handle a meter rollover or calculating consumption though meter
replacement. For more information, see section 39.15 “Manage Replacement of
Meter Dialog Box” on page 1180.
Figure: Manage replacement of meter dialog box where you enter the values of the new
and old meter.
Note
• In order for a meter rollover to be managed correctly in the meter trend log
and to ensure logging starts at the correct energy reading value, you enter
previous meter and new meter information in the Manage replacement of
meter dialog box. For more information, see section 35.11 “Managing
Replacement of a Meter ” on page 1031.

1008
35 Trend Log Types
35.9 Creating a Meter Trend Log and Associated Objects
35.9 Creating a Meter Trend Log and

Associated Objects
You use the meter trend log to record the value of a meter and handle consumption
calculations independent of meter rollover and meter exchange.
To create a meter trend log and associated objects

3. In the object type list, select Meter Trend Log.


1009
35 Trend Log Types
6. Click Next.
8. In the Trigger variable box, enter the variable that triggers the log.


1010
35 Trend Log Types

12. Click Select.
13. In the Trigger when box, select when to record the value of the logged
variable:
• Select Change to true to record the value of the logged variable when
the trigger variable changes to true.
• Select Change to false to record the value of the logged variable when
the trigger variable changes to false.
• Select All changes to record the value of the logged variable anytime
the trigger variable changes state.
14. In the Log size box, enter the number of records to be recorded before old
ones are overwritten.

1011
35 Trend Log Types
16. Click Next.

17. In the Start time box, enter the time when the meter is installed.
18. In the Start value box, enter the value of the meter when it was installed.
19. In the Meter constant box, enter the constant of the meter.
20. In the Min value box, enter the first value of the meter when it rolls over.

1012
35 Trend Log Types
21. In the Max value box, enter the last value of the meter before it rolls over.
22. Click Next.

1013
35 Trend Log Types
24. Click Create.
25. In the Name box, type a name for the extended trend log.
26. In the Location box, enter the path where to store the extended trend log.

1014
35 Trend Log Types
27. In the Description box, type a description for the extended trend log.
28. Click Next.

29. In the Monitored trend log box, make sure that the meter log is entered.

1015
35 Trend Log Types
30. In the Smart log box, select if you want to use smart log:
• Select True to enable Building Operation software to automatically
optimize the transfer rate of records from the monitored trend log to the
extended trend log.
• Select False to manually specify the percentage threshold at which the
trend log transfers its records to the extended trend log, and then select
the percentage in the Threshold box.
31. In the Maximum transfer interval box, select the maximum length of time
that can pass between transfers.
32. In the Log records box, enter the number of records to be stored before old
33. In the Include in reports box, select True to make the extended trend log
available to WebReports, for example, to include the extended trend log in a
trend log comparison report.
34. In the Transfer trigger variable box, enter a trigger variable to force a
transfer of all records from the trend log to the extended trend log, for
example, to generate a complete report. For more information, see section
36.4 “Extended Trend Logs” on page 1067.

1016
35 Trend Log Types
35. Click Create.
37. Click Create.

1017
35 Trend Log Types
38. In the Name box, type a name for the trend log list.
39. In the Location box, enter the path where to store the trend log list.
40. In the Description box, type a description for the trend log list.
41. Click Next.


1018
35 Trend Log Types
42. In the Display trend log box, confirm that the meter log is automatically
entered.
43. In the Log space (records) box, enter the maximum number of records to
display in the trend log.

1019
35 Trend Log Types
44. Click Create.
45. In the Trend Chart box, click the browse button to create a new trend
chart and connect it to the existing trend log.
46. Click Create.

1020
35 Trend Log Types
47. In the Name box, type a name for the trend chart.
48. In the Location box, enter the path where to store the trend chart.
49. In the Description box, type a description for the trend chart.
50. Click Next.


1021
35 Trend Log Types
51. In the Time mode box, select the time mode for the trend chart:
• Select Absolute (start and end time) and then enter a start time in the
Start time box and an end time in the End time box to manually specify
the x-axis start point and end point. For more information, see section
37.8 “Trend Chart Axes” on page 1103.
• Select Relative (to current time) and then type the time span in the
Time span box to automatically adapt the x-axis of the chart to display
the current time as the rightmost value. For more information, see section
37.8 “Trend Chart Axes” on page 1103.

1022
35 Trend Log Types
52. In the Auto scale left Y-axis box, select True to automatically adapt the y-
axis scale to the trend log series.
53. Click Add to display additional trend data in the trend chart.
54. In the object type list, select Trend Log Series or Real Time Trend
Series.
55. In the Name box, type a name for the series.


1023
35 Trend Log Types
56. In the Description box, type a description for the series.
57. Click Next.

58. In the Display variable box, enter the variable you want to display in the
trend chart.
59. In the Weight box, enter the line weight of the series.

1024
35 Trend Log Types
60. In the Show markers box, select True to display a marker for each
recorded value.
61. Click Create.

1025
35 Trend Log Types
62. Click Create.
63. Click Create.

The meter trend log is now connected to an extended trend log, a trend log list, and
a trend chart.

1026
35 Trend Log Types
35.10 Creating a Meter Trend Log

You use the meter trend log to record the value of a meter and seamlessly handle
consumption calculations independent of meter rollover and meter exchange.
To create a meter trend log

2. On the File menu, point to New, and then click Trend.
3. Select Meter Trend Log.

6. Click Next.

1027
35 Trend Log Types


1028
35 Trend Log Types

12. Click Select.
13. In the Trigger when box, select when to record the value of the logged
variable.
• Select Change to true to record the value of the logged variable when
• Select Change to false to record the value of the logged variable when
the trigger variable changes to false.
• Select All changes to record the the value of the logged variable
anytime the trigger variable changes state.
14. In the Log records box, select the number of records to be recorded before
old ones are overwritten.
16. Click Next.
17. In the Start time box, enter the time when the meter is installed.
18. In the Start value box, enter the value of the meter when it was installed.
19. In the Meter constant box, enter the constant of the meter.
20. In the Min value box, enter the first value of the meter when it rolls over.
21. In the Max value box, enter the last value of the meter before it rolls over.
22. Click Next.

1029
35 Trend Log Types
23. In the Extended Trend Log box, click the Browse button to create an
24. In the Trend Log List box, click the Browse button to create a trend
log list and connect it to the trend log.
25. In the Trend Chart box, click the Browse button to either create a
new trend chart or connect the trend log to an existing trend chart.
26. Click Create.
The meter trend log is created in the selected folder.
Note
• When a meter trend log is created, you need to add the current meter value.

1030
35 Trend Log Types
35.11 Managing Replacement of a Meter

You have to manage the meter settings each time a meter is replaced.
To manage replacement of a meter

1. In WorkStation, in the System Tree pane, select the meter trend log you
want to manage.
2. On the Actions menu, click Manage Meter.
3. In the End time box, enter the end time of the old meter. Preferably the time
when the meter is replaced.
4. In the End value box, type the value of the old meter when it was replaced.
5. In the Start time box, enter the time when the new meter is installed.
6. In the Start value box, type the current value of the new meter when it was
installed.
7. In the Meter constant box, type the constant of the new meter. For
example, if the meter counts in kilo (103) type 1000.
8. In the Min value box, type the first value of the new meter when it rolls over.

1031
35 Trend Log Types
9. In the Max value box, type the last value of the new meter before it rolls over.
10. Click OK.

1032
35 Trend Log Types
35.12 Configuring a Meter Trend Log
35.12 Configuring a Meter Trend Log

You configure the properties of a meter trend log to meet the unique needs of your
site.
To configure a meter trend log

1. In WorkStation, in the System Tree pane, select the meter trend log you
want to configure.
is enabled.

Trigger variable Enter the variable that triggers the trend

Trigger when Select when you want the variable

recorded: when trigger variable changes
to true, changes to false, or all changes.
“Variable Triggered Trend Logs” on page
1044.

4. Click OK.

1033
35 Trend Log Types
35.13 Displaying Meter Change History
35.13 Displaying Meter Change History

You view, through a trend log list, all meter change events that are registered by the
meter trend log.
Note
• The meter change history is only applicable for the meter trend log.
To display meter change history

1. In WorkStation, in the System Tree pane, select the trend log list that is
connected to a meter trend log.
2. On the Trend Log List toolbar, click the Show list of meter change
events button .
3. Click OK, to close the dialog box.

It is important that all meter changes are registered in the Manage replacement
of meter dialog box.

1034
35 Trend Log Types
35.14 Change of Value Trend Logs

The change of value trend log records the variable each time the difference
between the current value and the last log value exceeds the delta. Use the change
of value trend log to, for example, recording a variable that has an unequal
oscillation.
Note
• The change of value trend log is limited to 10 records per second.
• Do not set the delta too small since this can quickly fill up the trend log.
For example, in the figure below, the change of value trend log records a variable
every time the variable exceeds or falls below the delta of 3. The records are printed
in a trend chart. Notice that the change of value trend log records the values
without any time perspective between the records.

1035
35 Trend Log Types
Figure: Change of value trend log schematic.

1036
35 Trend Log Types
The change of value trend log, which is not a variable triggered trend log, has the
function to start log records according to a given start condition. For more
information, see section 36.3 “Activation Methods” on page 1063.

1037
35 Trend Log Types
35.15 Creating a Change of Value Trend Log

You create a change of value trend log to record the changes of a variable.
1035.
To create a change of value trend log

3. In the object type list, select Change of Value Trend Log.


1038
35 Trend Log Types
6. Click Next.
7. In the Logged variable box, enter the variable you want to log.
8. In the Delta box, enter the minimum value change that triggers a new record.


1039
35 Trend Log Types

12. Click Select.
13. In the Log size box, enter the number of records to be stored before old
values are overwritten.

1040
35 Trend Log Types
15. In the Activation method box, select the condition to start the trend log:
• Select Always active to start recording values immediately after the
trend log is created.
• Select Variable controlled and then enter a variable in the Activation
variable box to start recording values when the start variable goes on.
• Select Activation at start time and then enter the time in the
Activation time box to specify an exact time for the recording to begin.
16. Click Next.


1041
35 Trend Log Types
19. In the Trend Chart box, click the browse button to either create a new
trend chart or connect the trend log to an existing trend chart.
20. Click Create.

1042
35 Trend Log Types
35.16 Configuring a Change of Value Trend Log
35.16 Configuring a Change of Value Trend

Log
You configure the properties of a change of value trend log to meet the unique
needs of your site.
1035.
To configure a change of value trend log

1. In WorkStation, in the System Tree pane, select the change of value trend
log you want to configure.

Activation method Select the method for starting the trend

log. For more information, see section
36.3 “Activation Methods” on page 1063.
is enabled.

log.


4. Click OK.

1043
35 Trend Log Types
35.17 Variable Triggered Trend Logs

The variable triggered trend log records the variable according to the changes of an
associated trigger variable. Use this type of trend log when the log interval is
scheduled to log monthly or yearly, or when another device is used to trigger the
log.
For example, in the figure below, the variable triggered trend log records a variable
every time the associated trigger variable, for example, a switch, changes to true.
The records are printed in a trend chart. Notice that the variable triggered trend log
records the variable without any perspective to time or delta.

1044
35 Trend Log Types
Figure: Variable triggered trend log schematic

1045
35 Trend Log Types
You can configure the trend log to collect data when the trigger value changes to
True, changes to False, or All changes.
Figure: Trigger variable changes to true
Figure: Trigger variable changes to false
Figure: Trigger variable all changes

1046
35 Trend Log Types
35.18 Creating a Variable Triggered Trend Log
35.18 Creating a Variable Triggered Trend

Log
You create a variable triggered trend log to record the variable according to the
changes of an associated trigger variable.
To create a variable triggered trend log

3. Select Variable Triggered Trend Log.

6. Click Next.

1047
35 Trend Log Types
7. In the Logged variable box, enter the variable you want to log.
9. In the Unit box, click Browse button .


1048
35 Trend Log Types

12. Click Select.
13. In the Trigger when box, select Change to true to log the variable when
14. In the Log records box, select the number of records to be stored before old
16. Click Next.
19. In the Trend Chart box, click the Browse button to either create a
new trend chart or connect the trend log to an existing trend chart.
20. Click Create.
The variable triggered trend log is created in the selected folder.

1049
35 Trend Log Types
35.19 Configuring a Variable Triggered Trend Log
35.19 Configuring a Variable Triggered Trend

Log
You configure the properties of a variable triggered trend log to meet the unique
needs of your site.
1044.
To configure a variable triggered trend log

1. In WorkStation, in the System Tree pane, select the variable triggered trend
log you want to configure.
is enabled.

Trigger variable Enter the variable that triggers the trend

Trigger when Select when you want the variable

recorded: when trigger variable changes
to true, changes to false, or all changes.
“Variable Triggered Trend Logs” on page
1044.

4. Click OK.

1050
35 Trend Log Types
35.20 Manual Trend Logs

The manual trend log records data that you manually enter. The manual trend log
does not log a variable. Use this type of trend log when values from offline devices
have to be manually registered to the trend log. For example, if you want to create a
trend log that monitors an electricity meter that cannot be connected to Building
Operation.

1051
35 Trend Log Types
Figure: Manual trend log schematic.

1052
35 Trend Log Types
35.21 Creating a Manual Trend Log

You create a manual trend log that records data that you manually enter.
To create a manual trend log

3. Select Manual Trend Log.

6. Click Next.

1053
35 Trend Log Types
7. In the Unit box, click browse button .

10. Click Select.

1054
35 Trend Log Types
11. Click Next.
14. In the Trend Chart box, click the Browse button to either create a new
trend chart or connect the trend log to an existing trend chart.
15. Click Create.
The manual trend log is created in the selected folder. You have to manually add
the records to the manual trend log.

1055
35 Trend Log Types
35.22 Configuring a Manual Trend Log
35.22 Configuring a Manual Trend Log

You configure the properties of a manual trend log to meet the unique needs of your
site.
To configure a manual trend log

1. In WorkStation, in the System Tree pane, select the manual trend log you
want to configure.
Unit Enter the unit the trend log stores the

records in.
4. Click OK.

1056
35 Trend Log Types
35.23 Adding a Trend Log Record to a Manual Trend Log
35.23 Adding a Trend Log Record to a Manual

Trend Log
You have to manually add records to a manual trend log.
Note
• The Add trend log record dialog box is only applicable to manual trend
logs.
To add a trend log record to a manual trend log

2. Select the manual trend log you want add a value to.
3. On the Actions menu, point to Modification, and then click Add log
record.
4. In the Time stamp box, type the time of the new value.
5. In the Data type box, select Number if the value is an integer or decimal.
6. In the Value box, type the value.
7. In the Comment box, type a comment.
8. Click Add record.
9. Click Close.
The record is now added to the trend log.

1057
35 Trend Log Types
35.24 Implicit Trend Logs
35.24 Implicit Trend Logs

The implicit log is a change of value trend log which monitors the IO variable and
records a new value if the variable exceeds the delta. Each log value is stored as a
record in the trend log. The delta is automatically defined by Building Operation
depending on the measured unit of the device that is connected to the IO port.
Note
• The implicit log is not manually created as with the other trend logs in
WorkStation.
The implicit trend log exists on all IO points. When a device is connected to an IO
port, the implicit trend log is automatically configured and starts recording values.
Table: The Implicit Trend Log Delta for Different Units

Unit Delta
Temp 0.2 ºC (0.2 ºF)
Voltage 0.2 V
Current 0.3 mA
Resistance 200 Ω
The implicit trend log stores approximately 500 records before old records are
overwritten.

1058
36 Trend Log Functions
Topics
Trend Log Functions
Log Record Storage
Activation Methods
Extended Trend Logs
Creating an Extended Trend Log
Configuring an Extended Trend Log
Editing the Threshold Property of an Extended Trend Log
Editing the Maximum Transfer Interval Property of an
Extended Trend Log
Editing the Number of Log Records for a Trend Log
Editing an Extended Trend Log to be Included in Reports
Manually Transferring Records to the Extended Trend Log
36.1 Trend Log Functions
36.1 Trend Log Functions

All trend logs store records by using the circular storing principle; you can also
connect trends logs to external trend logs with larger storing capacity. For some
trend logs you can set up conditions that have to be fulfilled before the trend log
starts recording.
36.1.1 Log Record Storage

All trend logs use circular storing. How many records a trend log can store before
overwriting old ones depends on the trend log configuration.
For more information, see section 36.2 “Log Record Storage” on page 1062.
36.1.2 Activation Methods

The interval trend log and change of value trend log start recording values when the
configured activation method is fulfilled. On all trend logs, you can manually stop
recording values by disabling the trend log. To resume the recording, you enable
the trend log.
36.1.3 Extended Trend Logs

You use an extended trend log to transfer records from a trend log. An extended
trend log can be connected to a trend log or connected in a series to another
extended trend log. Only one extended trend log can be connected to a trend log.
For more information, see section 36.4 “Extended Trend Logs” on page 1067.

1061
36.2 Log Record Storage
36.2 Log Record Storage

All trend logs use circular storing. How many records a trend log can store before
overwriting old ones depends on the trend log configuration.
For example, a trend log is configured to store 10 records. The logging starts and
the first record x1 is stored. After 10 records the trend log is full. The next record
x11 overwrites the oldest record which in our case is x1. The next logging x12
overwrites the oldest record x2, and so on.
Figure: Circular storing, schematic

1062
36.3 Activation Methods

The interval trend log and change of value trend log start recording values when the
configured activation method is fulfilled. On all trend logs, you can manually stop
recording values by disabling the trend log. To resume the recording, you enable
the trend log.
36.3.1 Always active

Use always active to have the trend log start recording values 10 seconds after the
log is created or enabled.
Figure: Activation method, Always active
36.3.2 Variable Controlled

Use variable controlled start to have the trend log start recording values when a
connected variable goes on. This variable can be a scheduled variable or a variable
from a switch.
You can have the trend log continue recording when the start variable goes off.

1063
Figure: Activation method,, Variable controlled that does not follow the start variable.
Or you can choose to have the trend log stop recording when the start variable,
such as a fan, goes off. For example, you can use this feature to log the effective
time a fan is on.

1064
Figure: Activation method, Variable controlled that follows the start variable.
36.3.3 Start at activation time

Use start at activation time to have the trend log start recording values at a specified
time.

1065
Figure: Activation method, Start at activation time

1066
36.4 Extended Trend Logs

You use an extended trend log to store records from a trend log. An extended trend
log can be connected to a trend log or connected in a series to another extended
trend log. Only one extended trend log can be connected to a trend log or another
extended trend log.
You create and configure extended trend logs from WorkStation.
Important
• The extended trend log cannot log a variable.
• Do not connect more than one extended trend log to a trend log or another
extended trend log. If a trend log is connected to two or more extended trend
logs, critical conflicts can occur.
Figure: Do not connect more than one extended trend log to a trend log or extended trend
log.

1067
The extended trend log is often saved on a higher server level with more storage
capacity than the server of an ordinary trend log. This extra storage capacity
enables the server to store more records before it overwrites old ones. The
extended trend log can be viewed in a trend log list or a trend chart.
You can configure the extended trend log to transfer data several ways: Smart log,
percentage, time interval, or force transfer.
Table: Extended Trend Log Transfer Criteria

Function Explanation
Smart log Automatically updates the transfer rate with

respect to the frequency of records, network
speed, and the capacity of the server that
runs the trend log and the extended trend
log.
Threshold Transfers records every time a specific

percentage threshold of records on the trend
log is reached.
Maximum transfer interval Transfers records at a specific time interval

even though the threshold or Smart log
condition is not reached.
Transfer trigger variable Transfers records when triggered by a

variable that changes state from false to
true, for example, a digital schedule. The
transfer takes place regardless of the
transfer threshold. This function can be used
to ensure that the extended trend log
contains all records, for example, to
generate a complete report at the end of
every month.
Force transfer Executed by the user to manually force a

transfer even though transfer threshold is not
reached.

1068
Figure: Extended trend log that transfers records from a trend log each time the trend log
exceeds a record volume of 20% or every hour.

1069
When you edit a record in the extended trend log, the changes do not affect the
connected trend log. If you edit a record in the trend log, the changes are
transferred to the extended trend log next time a transfer occurs. You can edit both
the trend log and the corresponding record in the extended trend log, but the edit is
written twice in the extended trend log record under certain circumstances:
• the record in the extended trend log is manually updated
• the corresponding edit is transferred from the trend log to the extended trend
log
The trend log list or trend chart displays the last written value of an edited record.
Example 1: You edit a record in a trend log that is connected to an extended trend
log. The extended trend log is updated with the edited record. After the transfer,
you update the corresponding record in the extended trend log. The trend log list
and trend chart connected to the extended trend log display the last value of the
record, which in this case is the extended trend log edit.
Example 2: You edit a record in a trend log that is connected to an extended trend
log. Before the extended trend log is updated with the edited record, you edit the
corresponding record in the extended trend log. After a while the trend log transfers
its edited record to the extended trend log. The trend log list and trend chart
connected to the extended trend log display the edited trend log record value and
not the edited extended trend log record value. In this case, the trend log list and
trend chart display the last value that was written to the extended trend log, not the
last edited value.
You can view all edits, automatically transferred or manually added, in the record
history.
Important
If you import, export, copy, or paste an extended trend log connected to a trend
log, the reference to the connected trend log is lost.
36.4.1 Archive Overview


1070
36.5 Creating an Extended Trend Log

You create an extended trend log to store log records for a longer period of time
and free up memory in the Automation Server. Extended trend logs are also
required for generating reports using Building Operation WebReports.
To create an extended trend log

you want to create the extended trend log.
3. In the object type list, select Extended Trend Log.
4. In the Name box, type a name for the extended trend log.

1071
5. In the Description box, type a description for the extended log.
6. Click Next.
7. In the Monitored trend log box, enter the trend log that you want to transfer
records from.

1072
8. In the Smart log box, select if you want to use smart log:
• Select True to enable Building Operation software to automatically
optimize the transfer rate of records from the monitored trend log to the
extended trend log.
• Select False to manually specify the percentage threshold at which the
trend log transfers its records to the extended trend log, and then select
the percentage in the Threshold box.
9. In the Maximum transfer interval box, select the maximum length of time
that can pass between transfers.
10. In the Log records box, enter the number of records to be stored before old
11. In the Include in reports box, select True to make the extended trend log
available to WebReports.
12. In the Transfer trigger variable box, enter a trigger variable to force a
transfer of all records from the trend log to the extended trend log. For more
information, see section 36.4 “Extended Trend Logs” on page 1067.
13. Click Create.

The extended trend log is created and transfers and stores records from a trend
log.

1073
36.6 Configuring an Extended Trend Log
36.6 Configuring an Extended Trend Log

You configure the properties of an extended trend log to meet the unique needs of
your site.
To configure an extended trend log

1. In WorkStation, in the System Tree pane, select the extended trend log you
want to configure.
3. Edit the basic properties:
Monitored trend log Enter the trend log that you want to
transfer records from.

records in.
Smart log Select True to optimize the transfer of

the monitored trend log to the extended
trend log.
Threshold Select the percentage threshold at which

the trend log transfers its records to the
extended trend log.
Maximum transfer interval Select the maximum length of time that

can pass between transfers from the
monitored trend log to the extended trend
log.
Log records Select the number of records to store

before old records are overwritten.
Include in reports Select True to include the extended

trend log data in reports.
Transfer trigger variable Enter a trigger variable to force a transfer

of all records from the trend log to the
extended trend log, for example, to
generate a complete report. For more
information, see section 36.4 “Extended
Trend Logs” on page 1067.
4. Click OK.

1074
36.7 Editing the Threshold Property of an Extended Trend Log
36.7 Editing the Threshold Property of an

Extended Trend Log
You edit the threshold property to increase or decrease the percentage threshold of
records in the connected trend log.
To edit the treshold property of an extended trend log

2. Select the extended trend log you want to configure.
4. In the Treshold box, select the new value.
5. Click OK.

1075
36.8 Editing the Maximum Transfer Interval Property of an Extended Trend Log
36.8 Editing the Maximum Transfer Interval

Property of an Extended Trend Log
You edit the maximum transfer interval property to establish the time interval
between two transfers.
To edit the maximum transfer interval property of an extended

trend log
4. In the Maximum transfer interval box, select the new value.
5. Click OK.

1076
36.9 Editing the Number of Log Records for a Trend Log
36.9 Editing the Number of Log Records for

a Trend Log
You increase or decrease the number of records to be stored in the trend log before
For more information, see section 36.2 “Log Record Storage” on page 1062.
To edit the number of log records for a trend log

4. In the Log records box, enter the new value.
5. Click OK.

1077
36.10 Editing an Extended Trend Log to be Included in Reports
36.10 Editing an Extended Trend Log to be

Included in Reports
You edit extended trend logs to be included in reports if you want trend log data to
appear in the reports.
For more information, see the Concept Title topic on WebHelp.
To edit an extended trend log to be included in reports

4. In the Include in Reports? box, select True.
The extended trend log is set up to be included in reports.

1078
36.11 Manually Transferring Records to the Extended Trend Log
36.11 Manually Transferring Records to the

Extended Trend Log
You force a transfer of records from a trend log to its connected extended trend log
even though the set transfer threshold is not reached.
To manually transfer records to the extended trend log

the extended trend log is located.
2. Select the extended trend log that you want to transfer records to.
3. On the Actions menu, point to Activation, and then click Force transfer.
The monitored trend log is now transferred to the extended trend log.

1079
37 Trend Charts
Topics
Trend Charts
Configuring a Trend Chart
Showing Trend Chart Grid Lines
Adding a Trend Log Series to a Trend Chart
Adding a Real-Time Trend Series to a Trend Chart
Editing the Trend Chart Settings
Activating Trend Chart Live Update
Trend Chart Axes
Scroll the Trend Chart X-Axis to the Current Time
Configuring the X-Axis with a Relative Time Span
Configuring the X-Axis with an Absolute Time Span
Manually Configuring the Y-Axis Scale
Automatically Configuring the Y-Axis Scale
Assigning a Series to a Y-Axis
Real-Time Plotting
Creating a Real-Time Plot Trend Chart
Creating a Trend Chart that Monitors a Variable in Real-
Time
Trend Chart Series
Creating a Trend Chart that Monitors a Trend Log Series
Attaching a Calculation Method to a Trend Chart Series
Time Zone Modes in a Trend Chart
Configuring the Trend Chart Time Zone
Temporary Trend Charts
Opening a Trend Log in a Temporary Trend Chart
Saving a Temporary Trend Chart
37 Trend Charts
37.1 Trend Charts
37.1 Trend Charts

A trend chart displays the records of a trend log or an extended trend log as a
series.
A trend chart series that presents a trend log is automatically updated with the
latest records, provided that Live update is activated. A trend chart series that
presents records from a field controller trend log needs to be refreshed manually.
There is no upper limitation of how many trend logs a trend chart can present.
However, the performance decreases as the number of displayed trend logs
increase. The records of the trend log can be processed by a calculation method
before they are presented in the trend chart.

1083
37 Trend Charts
37.1 Trend Charts
Figure: Trend chart, schematic

When a trend chart presents records live from an extended trend log, the latest
records of the connected trend log are frequently transferred to the extended trend
log. This decreases the delay that can occur when the extended trend log has to
wait for the transfer threshold to be reached before new records from the trend log
are transferred. With this method, the trend chart presents the latest records.

1084
37 Trend Charts
37.1 Trend Charts
Figure: An extended trend log, that presents in an opened live trend chart, frequently
transfers the latest records from the trend log to the extended trend log.

1085
37 Trend Charts
37.1 Trend Charts
If two extended trend logs are connected between the trend log and the trend
chart, the transfer that occurs when a trend chart presents records live only
transfers the records from the nearest extended trend log. The transfer threshold
rate between the trend log and the first connected trend log remains unaffected.

1086
37 Trend Charts
37.1 Trend Charts

1087
37 Trend Charts
37.1 Trend Charts
Figure: Latest trend log record that does not present the same short latency in a live trend
chart when two extended trend logs are connected in a series between the trend log and
trend chart.
When waiting for a new record, the trend chart draws a dotted line from the last
recorded value and forward. When a new value is recorded, the dotted line
between the last and the new record is replaced by a solid series of lines.
Figure: If no value is recorded, the trend chart draws a dotted line.

1088
37 Trend Charts
37.1 Trend Charts
37.1.1 Trend Chart Series

A series can be presented as a line, discrete line, digital, or bars. Series can be
presented in different colors and with different line weights.
For more information, see section 37.18 “Trend Chart Series” on page 1117.
37.1.2 Trend Chart Axes in WorkStation

The x-axis of the trend chart represents time. The time span of the axis can be set
with a fixed start and end time or with an end time relative to the present time. The
axis can be quick-scaled to show the last hour, last day, last month, or last year.
For more information, see section 37.8 “Trend Chart Axes” on page 1103.
37.1.3 Trend Chart Axes in WebStation

For more information, see the Trend Chart Axes in WebStation topic on WebHelp.
37.1.4 Real-Time Plotting

The real-time plot is a variable displayed directly in the trend chart. The real-time
plot is an instant reflection of the variable, so the history of the real-time plot is lost
when the trend chart is closed. However, the history is not lost for I/O points that
have implicit logs where approximately 500 records of history are displayed.
For more information, see section 37.15 “Real-Time Plotting” on page 1111.
37.1.5 Time Zone Modes in a Trend Chart

In a trend chart, you can present the records of a trend log in different time zones:
local time or a predefined time zone.
For more information, see section 37.21 “Time Zone Modes in a Trend Chart” on
page 1125.
37.1.6 Calculation Methods

Use a calculation method to process the records of the trend log before presenting
them in a trend log list or a trend chart. The original records in the trend log are not
affected by the calculation method. The calculation method is applied to the trend
log records grouped by a specific time interval.
For more information, see section 38.7 “Calculation Methods” on page 1148.

1089
37 Trend Charts
37.1 Trend Charts
37.1.7 Temporary Trend Charts

To display a trend log without creating a new trend log list or trend chart, the trend
log can be displayed in a temporary list or chart.
For more information, see section 37.23 “Temporary Trend Charts” on page 1129.

1090
37 Trend Charts
37.2 Configuring a Trend Chart

You configure the properties of a trend chart to meet the unique needs of your site.
To configure a trend chart

1. In WorkStation, in the System Tree pane, select the trend chart you want to
configure.
3. Click the Basic tab.

1091
37 Trend Charts

Time mode Select the time mode of the x-axis.
Start time Enter the absolute start time when Time

Time span Type the relative time span of the x-axis.
Time zone Select the time zone of the trend log list.
The mode is the perspective in which the
trend log is displayed.
Show nearest information for all Select True to show information on every
series series along a diagonal line.
Auto scale left y-axis Select True to activate auto scale and
have the left y-axis adapt itself to the
displayed series.
Left y-axis minimum Enter the minimum value of the left y-axis.
Left y-axis maximum Enter the maximum value of the left y-

axis.
Auto scale right y-axis Select True to activate auto scale and
have the right y-axis adapt itself to the
displayed series.
Right y-axis minimum Enter the minimum value of the right y-

axis.
Right y-axis maximum Enter the maximum value of the right y-

axis.
Show grid lines for X-axis Select True to show grid lines for the x-
axis.
Show grid lines for left Y-axis Select True to show gridlines for the left
y-axis originating from the y-axis scale.
Show grid lines for right Y-axis Select True to show gridlines for the right
y-axis originating from the y-axis scale.
Add Click to add a series to the trend chart.

“Create Object Wizard – Naming the
Object Page” on page 1538.
Edit Click to edit a selected series. For more

information, see section 39.25 “Trend
Chart Series Properties” on page 1198.
Remove Click to remove a selected series.
5. Click the Series tab.


1092
37 Trend Charts
6. Edit the series properties:

7. Click OK.

1093
37 Trend Charts
37.3 Showing Trend Chart Grid Lines

You show the trend chart grid lines on the x-axis and the y-axis to make the chart
easier to read.
For more information, see section 39.22 “Trend Chart Settings Dialog Box – Axes
To show trend chart grid lines

configure.
2. On the Trend Chart toolbar, click the Open trend chart settings button
.
3. Below the Time zone box, select Show grid lines to show grid lines
originating from the x-axis scale.
4. Select Show left grid lines or Show right grid lines to show grid lines
originating from the y-axis scale.
5. Click OK.
Grid lines are now shown in the trend chart. Repeat the procedure to hide the grid
lines.

1094
37 Trend Charts

1095
37 Trend Charts
37.4 Adding a Trend Log Series to a Trend Chart
37.4 Adding a Trend Log Series to a Trend

Chart
You add a trend log series to a trend chart to compare trend data from different
logs or variables.
To add a trend log series to a trend chart

add a trend log series to.
2. In the System Tree pane, select the trend log you want to add.
3. Drag the trend log from the System Tree pane to the trend chart diagram.
4. Click Save.

1096
37 Trend Charts
37.5 Adding a Real-Time Trend Series to a Trend Chart
37.5 Adding a Real-Time Trend Series to a

Trend Chart
You add a real-time trend series to a trend chart to compare trend data from
different logs or variables.
To add a real-time trend series to a trend chart

add a trend series to.
3. Under Series Configuration Settings, click Add.

1097
37 Trend Charts
4. In the object type list, select Real Time Trend Series.

7. Click Next.

1098
37 Trend Charts
8. In the Display variable box, enter the path to the variable you want to
display in the trend chart.
9. In the Weight box, enter the line weight of the series.

recorded value.

1099
37 Trend Charts
11. Click Create.
12. Click OK.

1100
37 Trend Charts
37.6 Editing the Trend Chart Settings
37.6 Editing the Trend Chart Settings

You configure the scale of the trend chart axes, the presentation of series, and the
calculation method to make it easier to interpret the series, representing the trend
log records, in the trend chart.
To edit the trend chart settings

1. In WorkStation, in the System Tree pane, select the trend chart.
2. On the Trend Chart toolbar, click Open trend chart settings button .
3. Edit the trend chart settings.
4. Click OK.

1101
37 Trend Charts
37.7 Activating Trend Chart Live Update
37.7 Activating Trend Chart Live Update

You activate the live update of a trend chart to automatically update the trend chart
with the latest records.
To activate trend chart live update

1. In WorkStation, in the System Tree pane, select the trend chart on which
you want to activate live update.
2. Select Live update.

1102
37 Trend Charts
37.8 Trend Chart Axes

Figure: Absolute time span and relative time span, schematic

The y-axis refers to the measurement unit that the variable represents. The scale of
the y-axis can be set manually or by auto scale. You can configure the trend chart
to present series on one y-axis or two y-axes, one to the left and one to the right.
Use two y-axes to present series with different ranges in the same trend chart.
Figure: One y-axis and two y-axes, schematic

To make reading easier, grid lines can be shown in the trend chart. Grid lines can
be shown in both the x- and y-direction, independent of each other.

1103
37 Trend Charts
Figure: Grid lines, schematic

1104
37 Trend Charts
37.9 Scroll the Trend Chart X-Axis to the Current Time
37.9 Scroll the Trend Chart X-Axis to the

Current Time
You scroll the x-axis rightmost point for fast navigation to the current time. This is
useful when live update is disabled.
To scoll the trend chart x-axis to current time

show.
2. On the Trend Chart navigation bar, click the Scroll to current client time
button .
The trend chart displays the trend chart with the client’s current time as the
rightmost x-axis point.

1105
37 Trend Charts
37.10 Configuring the X-Axis with a Relative Time Span
37.10 Configuring the X-Axis with a Relative

Time Span
You set the trend chart time span of the x-axis relative to the series current end
point time to automatically adapt the trend chart to display the current time and the
latest records within the specific time span.
To configure the x-axis with a relative time span

configure.
3. In the Time mode box, select Relative (to current time).
4. In the Time span box, type the length of the x-axis to display before the
current time.
5. Click OK.
The x-axis is now configured with a relative time span.

1106
37 Trend Charts
37.11 Configuring the X-Axis with an Absolute Time Span
37.11 Configuring the X-Axis with an Absolute

Time Span
You configure the time span of a trend chart x-axis to display the records that are
recorded within a specific period of time.
To configure the x-axis with an absolute time span

configure.
.
3. In the Time mode box, select Absolute (start and end time).
4. In the Start time boxes, type the x-axis leftmost date and time.
5. In the End time boxes, type the x-axis rightmost date and time.
6. Click OK.
The x-axis is now configured with an absolute time span.

1107
37 Trend Charts
37.12 Manually Configuring the Y-Axis Scale
37.12 Manually Configuring the Y-Axis Scale

You manually configure the trend chart y-axis to have a fixed scale. The trend chart
has two y-axes, one to the left and one to the right. You can use this procedure to
scale both axes.
To manually configure the y-axis scale

configure.
.
3. Clear Auto scale left y-axis and Auto scale right y-axis.
4. In the Left y-axis minimum and Right y-axis minimum boxes, type the
minimum value of the y-axis.
5. In the Left y-axis maximum and Right y-axis maximum boxes, type the
maximum value of the y-axis.
6. Click OK.
The y-axis is now set with a fixed scale.

1108
37 Trend Charts
37.13 Automatically Configuring the Y-Axis Scale
37.13 Automatically Configuring the Y-Axis

Scale
You configure the trend chart to automatically scale the y-axis. The trend chart has
two y-axes, one to the left and one to the right. You can use this procedure to scale
both axes.
To automatically configure the y-axis scale

configure.
.
3. Select Auto Scale left y-axis and Auto Scale right y-axis.
4. Click OK.
The y-axis scale is now set automatically and updated with the presented series.

1109
37 Trend Charts
37.14 Assigning a Series to a Y-Axis
37.14 Assigning a Series to a Y-Axis

You assign a trend chart series to a y-axis to make the chart easier to read. When
using two axes, you can set different y-axis scales for the series.
To assign a series to a y-axis

configure.
.
3. Click the Series tab.
4. In the Data series box, select the series you want to assign to either the left
or the right axis.
5. In the Assigned to y-axis box, select an axis.
6. Click OK.
The series is now assigned to the left or right y-axis.

1110
37 Trend Charts
37.15 Real-Time Plotting
37.15 Real-Time Plotting

The real-time plot is a variable displayed directly in the trend chart. The real-time
plot is an instant reflection of the variable, so the history of the real-time plot is lost
when the trend chart is closed. However, the history is not lost for I/O points that
have implicit logs where approximately 500 records of history are displayed.
Figure: Real-time plot, schematic

A real-time plot trend chart updates and draws a solid series each time it registers
that the variable has a new value. If the variable remains on the same value, the
series is drawn as a dotted line.
When you save a real-time plot trend chart, a trend chart object is created that you
can reach from the System Tree pane.
Note
• A real-time plot can only be displayed in a trend chart and not in a trend log
list.

1111
37 Trend Charts
37.16 Creating a Real-Time Plot Trend Chart
37.16 Creating a Real-Time Plot Trend Chart

You create a real-time plot trend chart to display a variable in real time.
To create a real-time plot trend chart

1. In WorkStation, in the System Tree pane, select the variable you want to
display in a real-time plot trend chart.
2. On the Actions menu, point to View, and then click New Trend chart.

4. Browse to where you want to save the real-time plot trend chart.
5. Click Save.
By saving the real-time plot trend chart, a trend chart object is created in the
System Tree pane.

1112
37 Trend Charts
37.17 Creating a Trend Chart that Monitors a Variable in Real-Time
37.17 Creating a Trend Chart that Monitors a

Variable in Real-Time
You create a trend chart that monitories a variable in real-time, for example, to
access and check the current status of the variable.
To create a trend chart that monitors a variable in real-time

Operation server where you want to create the trend chart.
3. Select Trend Chart.

6. Click Next.

1113
37 Trend Charts
7. In the Time mode box, select Absolute to manually specify the x-axis start
and end point.
8. In the Start time box, type the absolute start time (the leftmost point of the x
axis).
9. In the End time box, type the absolute end time (the rightmost point of the x
axis).
10. In the Auto scale left y-axis box, select True so the y-axis adapts itself to
displayed series.
11. Click Add.

1114
37 Trend Charts
12. Select Real Time Trend Series.

15. Click Next.
16. In the Display variable box, enter the variable you want to display in the
trend chart.
17. In the Weight box, select the weight of the series.


1115
37 Trend Charts
recorded.
19. Click Create.
20. In the Configure real-time trend series dialog box, click Create.
The real-time trend series trend chart is created in the selected folder.

1116
37 Trend Charts
37.18 Trend Chart Series

A series can be presented as a line, discrete line, digital, or bars. Series can be
presented in different colors and with different line weights.
Figure: Types of series presentation, schematic

To make reading easier, records can be presented with markers. Markers can only
be shown for lines and discrete lines, not for digital or bars.

1117
37 Trend Charts
Figure: Presentation with markers, schematic

1118
37 Trend Charts
37.19 Creating a Trend Chart that Monitors a Trend Log Series
37.19 Creating a Trend Chart that Monitors a

Trend Log Series
You create a trend chart that monitors trend log series. When creating a trend chart
from the trend log wizard’s last step, connect objects to the trend log step. The
procedure starts when naming the trend chart.
To Create a trend chart that monitors a trend log series

you want to create the trend chart.
3. In the object type list, select Trend Chart.

5. In the Description box, type a description for the trend chart.
6. Click Next.

1119
37 Trend Charts
7. In the Time mode box, select Absolute to manually specify the x-axis start
and end point.
8. In the Start time box, type the absolute start time of the x-axis.
9. In the Time span box, type the relative time span of the x-axis in seconds.
10. In the Auto scale left y-axis box, select True so the y-axis adapts itself to
the displayed series.
11. Click Add.

1120
37 Trend Charts
12. In the object type list, select Trend Log Series.

15. Click Next.
16. In the Display trend log box, enter the trend log you want to display in the
trend chart.
17. In the Weight box, select the weight of the series.


1121
37 Trend Charts
recorded value.
19. In the Show events box, select True to display event symbols.
20. Click Create.
21. In the Configure Trend Chart dialog box, click Create.
The trend log series trend chart is created in the selected folder.

1122
37 Trend Charts
37.20 Attaching a Calculation Method to a Trend Chart Series
37.20 Attaching a Calculation Method to a

Trend Chart Series
You attach a calculation method to a trend chart series to process the recorded
values and present the result.
To attach a calculation method to a trend chart series

attach a calculation method to.
3. Click the Calculations tab.
4. In the Data series box, select the series you want to add a calculation
method to.
5. In the Calculation method box, select a calculation method.

6. Select Delta over period if the calculation method is a delta calculation with
periods.

1123
37 Trend Charts
37.20 Attaching a Calculation Method to a Trend Chart Series
7. In the Period box, select the time span for which the calculation method is to
be executed.
Note
• If Custom is selected in the Period box, enter a custom time
span for which the calculation method is to be executed in the
Custom period box and the time when you want the custom
period to start in the Custom period alignment boxes.
• To calculate the required number of records for a trend log,
multiply the number of records in one day with the number of
days you want the trend log to record. For example, the interval
of the trend log is set to 1 hour, then this gives 24 recorded
values per day. The trend log should record at least one month
of recorded values equal to 31 days. For example, the number of
records = 24 x 31 = 744.
8. In the Custom period box, enter a custom time span for which the
calculation method is to be executed.
9. In the Custom period alignment boxes, enter the time when you want the
custom period to start.
10. Click OK.
A calculation method is now attached to the series.

1124
37 Trend Charts
37.21 Time Zone Modes in a Trend Chart

In a trend chart, you can present the records of a trend log in different time zones:
local time or a predefined time zone.
Before you set the time zone for a trend chart, you should consider these settings:
• Computer clock settings
• Regional settings
A computer clock displays time that has been set manually or by synchronizing to a
time server. The computer clock time shows local time. Regional time displays the
time of the selected location. Asynchronous computer clock time and regional time
are not uncommon and can cause, for example, unexpected time discrepancies
between time stamps on received values and the computer clock time.
37.21.1 Local Time

A trend chart presented in Local time displays trend logs with time stamps adjusted
for the client computer time zone.
The client computer does not consider the local time of the server where the
variable is logged. The same variable logged on servers in different time zones is
displayed with matching time stamps for corresponding values.

1125
37 Trend Charts
Figure: Local time zone, schematic
37.21.2 Predefined Time Zone

A trend chart presented in a predefined time zone displays trend logs in the time of
the selected time zone regardless of where the server is located.
The same variable logged on servers in different time zones are displayed with
adjusted time stamps for corresponding values. Use predefined time zone when
you need to compare trend logs on servers located in different time zones.

1126
37 Trend Charts
Figure: Predefined time zone, schematic

1127
37 Trend Charts
37.22 Configuring the Trend Chart Time Zone
37.22 Configuring the Trend Chart Time Zone

You display the time of the records in local time, server time, or in the time of a
predefined time zone. By changing the time zone settings you make it easier to
interpret the time stamp.
For more information, see section 37.21 “Time Zone Modes in a Trend Chart” on
page 1125.
To configure the trend chart time zone mode

configure.
.
3. In the Time zone box, select a time zone to display the trend chart time
stamps in:
• Select Local time to display the time stamps in real time from the
perspective of the client.
• Select a predfined time zone to display the time stamps in real time from
the perspective of the selected time zone.
4. Click OK.
The x-axis is now set according to the selected time zone.

1128
37 Trend Charts
37.23 Temporary Trend Charts
37.23 Temporary Trend Charts

Figure: Trend log displayed in a temporary trend log list and temporary trend chart
Note
You have to manullay refresh the trend log list.

1129
37 Trend Charts
37.24 Opening a Trend Log in a Temporary Trend Chart
37.24 Opening a Trend Log in a Temporary

Trend Chart
You open a trend log in a temporary trend chart to graphically view the recorded
values. When you close the temporary trend chart, the chart is not saved.
For more information, see section 38.9 “Temporary Trend Log Lists” on page 1155.
To open a trend log in a temporary trend chart

2. Select the trend log you want to open as a temporary trend chart.
3. On the Actions menu, point to View, point to Trend charts, and then click
New Trend chart.
The trend chart is displayed in the work area under a generic name.

1130
37 Trend Charts
37.25 Saving a Temporary Trend Chart
37.25 Saving a Temporary Trend Chart

You save temporary trend charts and trend log lists to make them available for
future use.
To save a temporary trend chart

1. In WorkStation, in the temporary trend chart you want to save, click the
Save button to create a trend chart.

2. Browse to the location where you want to save the trend chart.
4. Click Save.

1131
38 Trend Log Lists
Topics
Trend Log Lists
Creating a Trend Log List
Configuring a Trend Log List
Time Zone Modes in a Trend Log List
Displaying the Trend Log List Time Stamps with Fractions
Configuring the Trend Log List Time Zone
Calculation Methods
Attaching a Calculation Method to a Trend Log List
Temporary Trend Log Lists
Saving a Temporary Trend Log List
38 Trend Log Lists
38.1 Trend Log Lists

The trend log list numerically displays the records of a trend log or an extended
trend log. The records of the trend log can be processed by a calculation method
before they are presented in the trend log list.
The trend log list can only display one trend log at a time and must be manually
refreshed to display recently recorded values.

1135
38 Trend Log Lists
Figure: Trend log list, schematic

1136
38 Trend Log Lists
38.1.1 Time Zone Modes in a Trend Log List

In a trend log list, you can present the records of a trend log in different time zones:
local time zone, server time zone, and UTC time zone.
For more information, see section 38.4 “Time Zone Modes in a Trend Log List” on
page 1142.
38.1.2 Calculation Methods

38.1.3 Temporary Trend Log Lists

For more information, see section 38.9 “Temporary Trend Log Lists” on page 1155.

1137
38 Trend Log Lists
38.2 Creating a Trend Log List

You create a trend log list to display records from a trend log.
Tip
• If you are creating a trend log list from a trend log wizard, the procedure starts
when you name the trend log list.
To create a trend log list

you want to create the trend log list.
3. In the object list, select Trend Log List.
4. In the Name box, type a name for the trend log list.

1138
38 Trend Log Lists
5. In the Description box, type a description for the trend log list.
6. Click Next.
7. In the Display trend log box, enter the trend log you want to display in the
trend log list.

1139
38 Trend Log Lists
8. In the Log space (records) box, enter the maximum number of rows to
display in the trend log.
9. Click Create.

1140
38 Trend Log Lists
38.3 Configuring a Trend Log List
38.3 Configuring a Trend Log List

You configure the properties of a trend log list to meet the unique needs of your
site.
To configure a trend log list

configure.
Display trend log Enter the trend log to display in the trend
log list.
Log space (records) Select the maximum number of records

to display in the trend log list.
Show events Select True to display events in the trend

log list. This function does not hide events
in the list that contain a value or
comment. For example, when a record is
added, edited, or commented.
Time zone Select which time perspective to display

in the trend log. For more information, see
section 38.4 “Time Zone Modes in a
Trend Log List” on page 1142.
Calculation method Select a calculation method.
Delta over period Select True to apply a period to the delta

calculation method.
Period Select the time span for which the

Custom period Enter a custom time span for which the

Custom period alignment Enter the time when you want the custom
period to start.
4. Click OK.

1141
38 Trend Log Lists
38.4 Time Zone Modes in a Trend Log List

In a trend log list, you can present the records of a trend log in different time zones:
local time zone, server time zone, and UTC time zone.
38.4.1 Local Time Zone

Use local time zone to display the trend logs in real time from the perspective of the
client.
For example, a trend log in Moscow is monitored on a client in Tbilisi. The trend log
is recording at 8:00-13:00 local server time. 13:00 Moscow time is 14:00 Tbilisi
time, so the Tiblisi trend log displays 9:00-14:00 in the client trend log list.
Figure: Trend log list displayed on a client with local time zone.
38.4.2 Server Time Zone

Use server time zone to display in real time from the perspective of the server.
is recording at 8:00-13:00 local server time and this is how it is displayed in the
client trend log list.

1142
38 Trend Log Lists
Figure: Trend log list displayed on a client with server time zone.
38.4.3 UTC Time Zone

Use UTC time zone to display the trend logs in the perspective of UTC.
is recording at 8:00-13:00 local server time. 8:00 Moscow time is 5:00 UTC time,
so the Tiblisi displays 5:00-10:00 in the trend log list.

1143
38 Trend Log Lists
Figure: Trend log list displayed on a client with UTC time zone.

1144
38 Trend Log Lists
38.5 Displaying the Trend Log List Time Stamps with Fractions
38.5 Displaying the Trend Log List Time

Stamps with Fractions
You display the trend log list time stamps with fractions, to show the exact time
stamp when the value was recorded.
To display time stamps with fractions

display its time stamps in fractions.
2. On the Trend Log List toolbar, click the Show time stamps with fractions
button .
The time stamps in the trend log list are now shown with hundredths. Repeat the
procedure to hide the fractions.

1145
38 Trend Log Lists
38.6 Configuring the Trend Log List Time Zone
38.6 Configuring the Trend Log List Time

Zone
You change the time zone to display time stamps in the trend log in UTC or in the
perspective of the client or server. By changing the time zone settings you make it
easier to interpret the time stamp.
For more information, see section 38.4 “Time Zone Modes in a Trend Log List” on
page 1142.
To configure the trend log list time zone

configure.
2. On the Trend log list toolbar, click the Open trend log list settings button
.

1146
38 Trend Log Lists
38.6 Configuring the Trend Log List Time Zone
3. In the Time zone box, select a time zone to display the trend log list time
stamps in:
• Select Local to display the time stamps in real time from the perspective
of the client.
• Select Server to display the time stamps in real time from the
perspective of the server.
• Select UTC to display the time stamps in the real time in the perspective
of UTC.
4. Click OK.
The records in the trend log are now displayed in the selected time zone mode.

1147
38 Trend Log Lists
38.7 Calculation Methods

The following calculation methods are available:
• Maximum
• Minimum
• Average
• Summary
• Delta
• Delta over period
• Meter consumption
Note
38.7.1 Maximum
The maximum value of each period is presented.
Figure: Maximum calculation method, schematic

1148
38 Trend Log Lists
Important
If the log point is offline or no value is produced during the interval, no value is
displayed.
38.7.2 Minimum
The minimum value of each period is presented.
Figure: Minimum calculation method, schematic
Important
displayed.
38.7.3 Average
The average of the values in each period is calculated and presented.

1149
38 Trend Log Lists
Figure: Average calculation method, schematic
Important
displayed.
38.7.4 Summary
The sum of the values in each period is calculated and presented.

1150
38 Trend Log Lists
Figure: Summary calculation method, schematic
38.7.5 Delta
The change to the previous value is calculated and presented.
Figure: Delta calculation method, schematic

1151
38 Trend Log Lists
38.7.6 Delta over Period

The change over a period is calculated and presented. The value at the period limit
is often interpolated, based upon the last value in the old period and the first value in
the new period.
Figure: Delta over period calculation method, schematic
38.7.7 Meter Consumption

Meter consumption is a delta over period calculation with meter functionality. For
more information, see section 35.8 “Meter Trend Logs” on page 1006.

1152
38 Trend Log Lists
38.8 Attaching a Calculation Method to a Trend Log List
38.8 Attaching a Calculation Method to a

Trend Log List
You attach a calculation method to a trend log list to process the recorded values
and present the result.
To attach a calculation method to a trend log list

attach a calculation method to.
2. On the Trend Log List toolbar, click the Open trend log list settings
button .
3. In the Calculation method box, select a calculation.
4. In the Delta over period box, select True if the calculation method is a delta
calculation with periods.

1153
38 Trend Log Lists
38.8 Attaching a Calculation Method to a Trend Log List
5. In the Period box, select the time span for which the calculation method is to
be executed.
Note
• If Custom is selected in the Period box, enter a custom time
span for which the calculation method is to be executed in the
Custom period box and the time when you want the custom
period to start in the Custom period alignment boxes.
• To calculate the required number of records for a trend log,
multiply the number of records in one day with the number of
days you want the trend log to record. For example, the interval
of the trend log is set to 1 hour, then this gives 24 recorded
values per day. The trend log should record at least one month
of recorded values equal to 31 days. For example, the number of
records = 24 x 31 = 744.
6. In the Custom period box, enter a custom time span for which the
7. In the Custom period alignment boxes, enter the time when you want the
custom period to start.
8. Click OK.
A calculation method is now attached to the trend log list.

1154
38 Trend Log Lists
38.9 Temporary Trend Log Lists
38.9 Temporary Trend Log Lists

Figure: Trend log displayed in a temporary trend log list and temporary trend chart
Note
You have to manullay refresh the trend log list.

1155
38 Trend Log Lists
38.10 Saving a Temporary Trend Log List
38.10 Saving a Temporary Trend Log List

You save temporary trend charts and trend log lists to make them available for
future use.
To save a temporary trend log list

1. In WorkStation, in the temporary trend chart you want to save, click the
Save button to create a trend chart.

2. Browse to the location where you want to save the trend chart.
4. Click Save.

1156
39 Trends User interface
Topics
Trend Log System Tree Icons
Actions Menu – Activation Submenu
Actions Menu – View Submenu
Actions Menu - View Submenu - Trend Charts Submenu
Actions Menu - View Submenu - Trend Log Lists Submenu
Actions Menu – Modification Submenu
Interval Trend Log Properties
Meter Trend Log Properties
Change of Value Trend Log Properties
Variable Triggered Trend Log Properties
Manual Trend Log Properties
Extended Trend Log Properties
Trend Chart Properties
Trend Log List Properties
Manage Replacement of Meter Dialog Box
Meter Change History Dialog Box
Trend Chart View
Trend Chart Toolbar
Trend Chart Event Icons
Trend Chart Navigation Bar
Series Tab Shortcut Menu
Trend Chart Settings Dialog Box – Axes Tab
Trend Chart Settings Dialog Box – Series Tab
Trend Chart Settings Dialog Box – Calculation Tab
Trend Chart Series Properties
Real Time Trend Series Properties
Trend Log List View
Add/Remove Columns Dialog Box (Trends)
Trend Log List Toolbar
Trend Log List Event Icons
Trend Log List – Log Info View
Trend Log List Shortcut Menu
Add Trend Log Record Dialog Box
Edit/Comment Trend Log Record Dialog Box
Create Trend Log Wizard – Configure Interval Trend Log
Page
Create Trend Log Wizard – Configure Meter Trend Log Page
Create Trend Log Wizard – Configure Change of Value Trend
Log Page
Create Trend Log Wizard – Configure Variable Triggered Trend
Log
Create Trend Log Wizard – Configure Manual Log Page
Create Trend Log Wizard – Configure Extended Trend Log Page
Create Trend Log Wizard – Configure Trend Chart Page
Create Trend Log Wizard – Configure Real-Time Trend Series
Page
Create Trend Log Wizard – Configure Trend Log Series Page
Create Trend Log Wizard – Configure Trend Log List Page
Create Trend Log Wizard – Connect Objects to the Trend Log
Page
Trend Log Wizard – Initial Meter Settings Page
39.1 Trend Log System Tree Icons
39.1 Trend Log System Tree Icons

This section describes the icons in WorkStation that relate to trend logs.
Table: Trend Log Icons in WorkStation

Icon Description
Trend log
Indicates the object is a trend log. For more
information, see the Trend Logs topic on
WebHelp.
Trend chart
Indicates the object is a trend chart. For
more information, see section 37.1 “Trend
Charts” on page 1083.
Trend log list

Indicates the object is a trend log list. For
Log Lists” on page 1135.

1159
39.2 Actions Menu – Activation Submenu

Use the Activation submenu to enable, disable, or clear a trend log.
Figure: The trend log Actions menu, Activation submenu
Table: Activation Submenu

Command Description
Enable trend log Click to enable the trend log. The trend log
starts when the start condition is fulfilled.
Disable trend log Click to disable the trend log and stop all
recording activity.
Clear trend log Click to clear all the records from the trend
log.
Force transfer Click to manually forces the transfer of

records to the extended trend log.

1160
39.3 Actions Menu – View Submenu

Use the View submenu to display object related events, temporary trend charts or
trend log lists.
Figure: Actions menu - View submenu
Table: Actions Menu – View Submenu

Command Description
Events Click to open an Events pane that displays

the events related to a specific object. For
Specific Event View” on page 959.
Trends Click to view related trend objects. For more

information, see section 52.55 “Related
Trends Properties Dialog” on page 1575.
Report Click to open a report.
Trend charts Use the Trend charts submenu to open or

create a trend chart. For more information,
see section 39.4 “Actions Menu - View
Submenu - Trend Charts Submenu” on
page 1162.
Trend log lists Use the Trend log lists submenu to open or
create a trend log list. For more information,
Submenu - Trend Log Lists Submenu” on
page 1163.
Watch pane Use the Watch pane submenu to select the

property of the variable you want to monitor.
“Actions Menu - View Submenu - Watch
Submenu” on page 1523.

1161
39.4 Actions Menu - View Submenu - Trend Charts Submenu
39.4 Actions Menu - View Submenu - Trend

Charts Submenu
Use the Trend charts submenu to open a trend chart or to create a trend chart.
Figure: Trend Charts submenu
Table: Trend Charts Submenu

Command Description
[Chart name] Click to open one of the charts in the menu.

“Trend Chart View” on page 1184.
New Trend chart Click to create a new trend chart. For more
information, see section 37.1 “Trend Charts”
on page 1083.

1162
39.5 Actions Menu - View Submenu - Trend Log Lists Submenu
39.5 Actions Menu - View Submenu - Trend

Log Lists Submenu
Use the Trend log lists submenu to open a trend log list or to create a new trend
log list.
Figure: Trend Log Lists submenu
Table: Trend Log Lists Submenu

Command Description
(Name of log list] Click to open one of the trend log lists on the
menu. For more information, see section
38.1 “Trend Log Lists” on page 1135.
New Trend log list Click to create a new trend log list. For more
information, see the Trend Logs topic on
WebHelp.

1163
39.6 Actions Menu – Modification Submenu

Use the Modification submenu to add a value to a manual trend log.
Figure: The trend log Actions menu, Modification submenu
Table: Modification Submenu

Command Description
Add log record Click to open the Add log record dialog
box where you add values and comments to
a manual trend log. For more information,
see section 35.23 “Adding a Trend Log
Record to a Manual Trend Log” on page
1057.

1164
39.7 Interval Trend Log Properties

Use the Interval Trend Log properties to configure the interval trend log.
Figure: Interval trend log properties
Table: Table Interval Trend Log Properties Pane


Activation method Select the method for starting the trend log.
“Activation Methods” on page 1063.
Clear when enabled Select True to clear the trend log when it is
enabled.

log.

1165
Continued

records.



1166
39.8 Meter Trend Log Properties

Use the Meter Trend Log properties to configure the meter trend log.
Figure: Meter trend log properties
Table: Meter Trend Log Properties

enabled.

Trigger variable Enter the variable that triggers the trend log
to start recording.

1167
Continued
Trigger when Select when you want the variable recorded:

when trigger variable changes to true,
changes to false, or all changes. For more
information, see section 35.17 “Variable
Triggered Trend Logs” on page 1044.


1168
39.9 Change of Value Trend Log Properties

Use the Change of Value Trend Log properties to configure the change of value
trend log.
Figure: Change of value trend log properties
Table: Change of Value Trend Log Properties


enabled.

1169
Continued

log.



1170
39.10 Variable Triggered Trend Log Properties
39.10 Variable Triggered Trend Log

Properties
Use the Variable Triggered Trend Log properties to configure the variable
triggered trend log.
Figure: Variable triggered trend log properties
Table: Variable Triggered Trend Log Properties

enabled.

to start recording.

1171
39.10 Variable Triggered Trend Log Properties
Continued



1172
39.11 Manual Trend Log Properties
39.11 Manual Trend Log Properties

Use the Manual Trend Log properties to configure the manual trend log.
Figure: Manual trend log properties
Table: Manual Trend Log Properties


records in.

1173
39.12 Extended Trend Log Properties

Use the Extended Trend Log properties to configure the extended trend log.
Figure: Extended trend log properties
Table: Extended Trend Log Properties

Monitored trend log Enter the trend log that you want to transfer
records from.

records in.
Smart log Select True to optimize the transfer of the

log.
Threshold Select the percentage threshold at which the

trend log transfers its records to the
extended trend log.
Maximum transfer interval Select the maximum length of time that can
pass between transfers from the monitored
trend log to the extended trend log.

1174
Continued
Log records Select the number of records to store before

old records are overwritten.
Include in reports Select True to include the extended trend

log data in reports.
Transfer trigger variable Enter a trigger variable to force a transfer of

all records from the trend log to the
extended trend log, for example, to generate
a complete report. For more information, see
section 36.4 “Extended Trend Logs” on
page 1067.

1175
39.13 Trend Chart Properties

Use the Trend Chart Properties dialog box to configure the general properties of
the trend chart.
Figure: Trends chart properties
Table: Trend Chart Properties Table


Time span Type the relative time span of the x-axis.

1176
Continued
Time zone Select the time zone of the trend log list. The
mode is the perspective in which the trend
log is displayed.
Show nearest information for all Select True to show information on every
series series along a diagonal line.
Auto scale left y-axis Select True to activate auto scale and have
the left y-axis adapt itself to the displayed
series.
Left y-axis minimum Enter the minimum value of the left y-axis.
Left y-axis maximum Enter the maximum value of the left y-axis.
Auto scale right y-axis Select True to activate auto scale and have
the right y-axis adapt itself to the displayed
series.
Right y-axis minimum Enter the minimum value of the right y-axis.
Right y-axis maximum Enter the maximum value of the right y-axis.
Show grid lines for X-axis Select True to show grid lines for the x-axis.
Show grid lines for left Y-axis Select True to show gridlines for the left y-
axis originating from the y-axis scale.
Show grid lines for right Y-axis Select True to show gridlines for the right y-
axis originating from the y-axis scale.
Add Click to add a series to the trend chart. For

on page 1538.

information, see section 39.25 “Trend Chart
Series Properties” on page 1198.

1177
39.14 Trend Log List Properties

Use the Trend Log List properties to configure the trend log list.
Figure: Trend log list properties
Table: Trend Log List Properties

Display trend log Enter the trend log to display in the trend log
list.
Log space (records) Select the maximum number of records to

display in the trend log list.
Show events Select True to display events in the trend

log list. This function does not hide events in
the list that contain a value or comment. For
example, when a record is added, edited, or
commented.
Time zone Select which time perspective to display in

the trend log. For more information, see
section 38.4 “Time Zone Modes in a Trend
Log List” on page 1142.

1178
Continued
Calculation method Select a calculation method.

calculation method.


period to start.

1179
39.15 Manage Replacement of Meter Dialog Box
39.15 Manage Replacement of Meter Dialog

Box
Use the Manage replacement of meter dialog box to configure the meter
setting when a new meter is installed or replaced.
Note
• The Manage replacement of meter dialog box only applies to meter
trend log.
Figure: Manage replacement of meter dialog box
Table: Manage Replacement of Meter Dialog Box

End time Type the end time of the old meter,

preferably the time when the meter is
replaced.
End value Type the value the old meter has when it is
replaced.
Unit Displays the unit of the meter trend log.
Start time Type the time when the new meter is

installed.
Start value Type the current value of the new meter

when it was installed.
Meter constant Type the constant of the new meter. If the

meter counts in kilo (103) type 1000.
Min value Type the first value of the new meter after
roll-over.

1180
39.15 Manage Replacement of Meter Dialog Box
Continued
Max value Type the last value of the new meter before
roll-over.

1181
39.16 Meter Change History Dialog Box

Use the Meter change history dialog box to display all meter changes together
with the replaced meters settings.
Note
• The Meter change history dialog box only applies to meter trend log.
Figure: Meter change history dialog box
Table: Meter Change History Dialog Box

End time Displays the time when the old meter was
replaced.
End value Displays the value the old meter had when it
was replaced.
Unit Displays the unit of the old meter.
Start time Displays the time when the new meter was
installed.
Start value Displays the value of the new meter when it

was installed.
Meter constant Displays the constant of the new meter. If

the meter counts in kilo (103), the constant is
1000.
Min value Displays the first value of the new meter after
roll-over.

1182
Continued
Max value Displays the last value of the new meter

before roll-over.

1183
39.17 Trend Chart View

Use the Trend Chart view to graphically display trend log records and events.
Figure: Trend chart view
Table: Trend Chart View

Number Description
Use the trend chart toolbar to adjust the

visible trend chart area. For more
Toolbar” on page 1186.
Use the Series tab shortcut menu to

manage the appearance of a trend log
series. For more information, see section
39.21 “Series Tab Shortcut Menu” on page
1191.
Use the trend log event icons to get

information about a specific record. For
Chart Event Icons” on page 1188.

1184
Continued
Number Description
Use the navigation bar to horizontally adjust

the visible trend chart area. For more
Navigation Bar” on page 1190.

1185
39.18 Trend Chart Toolbar

Use the Trend Chart toolbar to manage the trend chart and its series.
Table: Trend Chart Toolbar

Button Description
Reset zoom
Click to reset the trend chart to its original
size in the database.
Pointer
Click to point to log records in the trend
chart or to scroll vertically with the mouse
wheel.
Scroll trend chart vertical

Click to activate vertical scroll. Drag the chart
area upwards or downwards to scroll the y-
axis vertically.
Zoom in
Click to increase the scale of the trend chart
or drag to magnify an area in the trend chart.
Zoom out
Click to decrease the scale of the trend
chart.
Show one hour

Click to set the scale of the x-axis to one
hour.
Show one day

day.
Show one week

week.
Show one month

month.
Show one year

year.
Show nearest information on every

series
Click to show values of every trend chart
series at a specific time.

1186
Continued
Button Description
Open trend chart settings

Opens the Trend chart settings dialog
box for the trend chart where you can
configure the trend chart series, axes, and
calculations.
“Trend Chart Settings Dialog Box – Axes
For more information, see the Trend Chart
Settings Dialog Box – Axis Tab topic on
WebHelp.
Save current settings

Click to save the settings you have done in
the trend chart in WebStation.

1187
39.19 Trend Chart Event Icons

Use the Trend Chart event icons to get information on different trend log events.
Table: Trend chart event icons

Icon Description
Log was started

Indicates that the trend log started recording
values.
Log was stopped

Indicates that the trend log stopped
recording values.
The log is not configured

Indicates that the trend log is not correctly
configured or preferences are missing, so
the trend log cannot start recording values.
A log value was missed

Indicates that one or more records were
missed due to interrupted communication,
hardware failure, or software failure.
The log configuration was updated

Indicates that the settings of the trend log
were updated. The change is described in
the ToolTip of the event.
Record was added

Indicates that a record was manually added.
The new value is described in the event
ToolTip.
Record was edited

Indicates that a record was manually edited.
The change is described in the ToolTip of the
event.
Record was added and commented

Indicates that a record was manually added
and commented. The new value and
comment are described in the ToolTip of the
event.
Record was edited and commented

Indicates that a record was manually edited
and commented. The changes are
described in the ToolTip of the event.

1188
Continued
Icon Description
Record was commented

Indicates that a record was commented. The
comment is shown in the ToolTip of the
event.
Log was cleared

Indicates that a trend log was cleared.
Meter was changed

Indicates that the meter was changed or that
the settings were configured. This icon only
applies to the meter trend log.
Values exist outside the viewable area

Indicates that values exist before the values
displayed in the trend chart area.
Values exist outside the viewable area

Indicates that values exist after the values
displayed in the trend chart area.
Null value was logged

Indicates that a Null value was logged.
System clock changed

Indicates the system date and time of the
server where the trend log is located has
been changed. For more information, see
section 17.1 “Time and Time Zone” on page
329.
Override
Indicates that the recorded value is
overridden by the hardware and is not the
measured value. For more information, see
the Output Override Status topic on
WebHelp.
Forced
Indicates that the recorded value is forced by
the software and is not the measured value.
For more information, see the Forced I/O
Values topic on WebHelp.
Log database restored

Indicates that the log database has been
restored and that, when the log restarts,
there can be a time gap in the log series.
Log reset by extended log

Indicates that the log has been cleared by
the extended trend log due to a log
database restore.

1189
39.20 Trend Chart Navigation Bar
39.20 Trend Chart Navigation Bar

Use the Trend Chart navigation bar to horizontally scroll the trend chart.
Table: Trend Chart Navigation Bar

Log start
Click to scroll back to the first value of the
trend chart in WorkStation.
Fast backward
Click to scroll fast backward.
Backward
Click to scroll back.
Live update Select to have the trend chart automatically

adjust itself according to the latest trend log
record in WorkStation.
Auto scroll
Click to have the trend chart automatically
adjust itself according to the latest trend log
record in WebStation.
Forward
Click to scroll forward.
Fast forward
Click to scroll fast forward.
Current time
Click to scroll forward to the latest value of
the trend chart in WorkStation.

1190
39.21 Series Tab Shortcut Menu

Use the Series tab to open the series shortcut menu, where you can change the
presentation of series, show or hide events, markers, and series, bring to front and
remove series, as well as open the trend chart settings dialog box.
The series tabs are located at the bottom leftmost if there are series attached to the
left y-axis, and at the bottom rightmost if there are series attached to the right y-
axis.
Figure: Series tab with the series shortcut menu
Table: Series Tab with the Shortcut Menu

Line Select to display the series as a line.
Discrete line Select to display the series as a discrete line.
Digital Select to display the series as a digital line.
Bars Select to display the series as bars.
Events Select to present the series with event

symbols.
Visible Select to hide or display the series in the

trend chart.
Markers Select to display a marker for each record.

Markers can only be shown for lines and
discrete lines, not for digital and bars.
Bring to front Click to display the series in front of the

others.
Remove series Click to remove series from the trend chart.

1191
Continued
Open trend chart settings Click to open the property dialog box for the
trend chart and its series.

1192
39.22 Trend Chart Settings Dialog Box – Axes Tab
39.22 Trend Chart Settings Dialog Box – Axes

Tab
Use the Axes tab to configure the properties of the chart axes.
Figure: Axes tab
Table: Axes Tab


End time Enter the absolute end time when Time

mode is set to Absolute (start time and
end time). This time is the rightmost point
of the x-axis.
Time span Type the relative time span of the x-axis

when Time mode is set to Relative (to
current time). The rightmost point of the x-
axis is the current time.
Time zone Select time zone for the trend chart. The
time zone is the displayed time perspective
of the trend log.
Show grid lines Select to show horizontal grid lines.

1193
39.22 Trend Chart Settings Dialog Box – Axes Tab
Continued
Auto scale left y-axis Select to activate auto scale. The scale of
the left y-axis adapts itself to the displayed
series.
Left y-axis minimum Type the minimum value of the left y-axis.
Left y-axis maximum Type the maximum value of the left y-axis.
Show left grid lines Select to show grid lines on the left y-axis.
Auto scale right y-axis Select to activate auto scale. The scale of
the right y-axis adapts itself to the displayed
series.
Right y-axis minimum Type the minimum value of the right y-axis.
Right y-axis maximum Type the maximum value of the right y-axis.
Show right grid lines Select to show grid lines on the right y-axis.

1194
39.23 Trend Chart Settings Dialog Box – Series Tab
39.23 Trend Chart Settings Dialog Box –

Series Tab
Use the Series tab to configure the properties of the series in the trend chart.
Figure: Trend chart settings - series tab
Table: Series Tab

Display variable/trend log Displays the referenced variable or trend log.

To change the reference, browse to a
different variable or trend log.
Data series Displays all series in the trend chart. Select a

series to display its presentation properties.
Series presentation Select the presentation type of the series.
Assigned to y-axis Select Left to attach the series to the left y-

axis.
Weight Type the weight of the line. The value is a

value without correlation to any unit of
measure.
Show markers Select to display a marker for each record.

Markers can only be shown for lines and
discrete lines, not for digital and bars.
Show events Select to present the series with event

symbols.

1195
39.23 Trend Chart Settings Dialog Box – Series Tab
Continued
Color Enter the color of the series.

1196
39.24 Trend Chart Settings Dialog Box – Calculation Tab
39.24 Trend Chart Settings Dialog Box –

Calculation Tab
Use the Calculation tab to attach a calculation method to a series.
Figure: Calculations tab
Table: Calculations Tab

Data series Displays all series in the trend chart. Select a

series to display its presentation properties.
Calculation method Select calculation method to calculate the

recorded values before displaying the series
in the trend chart.
Delta over period Select to apply a period to the delta

calculation method.

Custom period When Custom period is selected, enter a

custom time span for which the calculation
method is to be executed.
Custom period alignment When Custom period is selected, enter the

time when you want the custom period to
start.

1197
39.25 Trend Chart Series Properties

Use the Trend Chart Series Properties dialog box to configure the properties of
the trend chart series.
Figure: Trend chart series properties
Table: Trend Chart Series Properties

Display trend log Displays the path the trend log series is
connected to.
Y-axis Select Left to attach the series to the left y-

axis.
Series presentation Select the presentation of the series: line,

discrete line, binary, or bars.
Color Enter the color of the series.
Weight Enter the weight of the line. The line-weight

value is a value without correlation to any
unit of measure.

1198
Continued
Show markers Select True to show a marker for each

record. The marker can only be shown for
lines and discrete lines, not for digital and
bars.
Show events Select True to show event symbols in the

trend chart.
Calculation method Select the calculation method to calculate

the recorded values before displaying the
series in the trend chart.

calculation method.


calculation method is to be executed
period to start.

1199
39.26 Real Time Trend Series Properties
39.26 Real Time Trend Series Properties

Use the Basic tab to configure and view real time trend properties. For more
Figure: Real Time Series Properties - Basic tab

1200
39.27 Trend Log List View

Use the Trend Log List view to view, edit, or export the records of a trend log.
Figure: Trend log list view
Table: Trend Log List View

Number Description
Use the trend log list toolbar to manage or

export trend log records. For more
information, see section 39.29 “Trend Log
List Toolbar” on page 1204.
Use the log info to get detailed information

about the trend log list. For more
List – Log Info View” on page 1208.
Use the trend log list columns to sort the

trend log records. For more information, see
the Add/Remove Columns Dialog Box topic
on WebHelp.
Use the trend log list shortcut menu to edit,

add, or show the history of trend log
records. For more information, see section
39.32 “Trend Log List Shortcut Menu” on
page 1209.

1201
Continued
Number Description
Use the trend log event icons to get

information about a specific record. For
Log List Event Icons” on page 1206.

1202
39.28 Add/Remove Columns Dialog Box (Trends)

(Trends)
trend log list.
Table: Add/Remove Columns Dialog Box

Component Descriptin
Comment Select to display the comment added by a

user or system. For more information, see
section 30.1 “Comments” on page 779.
Events Select to display any events that occurred.
Sample status Select to display the condition when the

sample was recorded.
Sequence number Select to display the event sequence

Time stamp Select to display the time and date when the
User Select to display the user name that

Value Select to display the value.

1203
39.29 Trend Log List Toolbar

Use the trend log list toolbar to manage the trend log list and records.
Figure: Trend log list with toolbar
Table: Trend Log List Toolbar

Button Description
Show/Hide group box

Click to open or close the column grouping
and sorting tool.
Events
Click to show or hide events in the trend log
list. This function does not hide events in the
list that contain a value or comment, such as
Record was added, Record was
edited, and Record was commented.
“Trend Log List Event Icons” on page 1206.
Show time stamps with fractions

Click to show the time stamps with
hundredths.
Show decimal values

Click to display the values as decimals.
Show values as bitstrings

Click to display the values as bitstrings.
Show values as booleans

Click to display the values as booleans.
Add trend log record

Click to open the Add trend log record
dialog box where you can add one or more
values to the trend log. Refresh the trend log
list to see the added values. For more
information, see section 39.33 “Add Trend
Log Record Dialog Box” on page 1210.

1204
Continued
Button Description
Edit/comment trend log record

Click to open the Edit/comment trend
log record dialog box, where you can edit
or comment a recorded value. For more
“Edit/Comment Trend Log Record Dialog
Box” on page 1211.
Clear trend log

Click to clear all the records from the trend
log.
Export to .XML
Click to open the Export dialog box.
Export to .CSV
Click to open the Export dialog box.
Show list of meter change events

Click to open the Meter change history
dialog box, where the history of meter
changes is shown. For more information, see
section 39.16 “Meter Change History Dialog
Box” on page 1182.
Open trend log list settings

Click to open the Settings dialog box for
the trend log list, where you can configure
the trend log settings. For more information,
see section 39.14 “Trend Log List

1205
39.30 Trend Log List Event Icons

Use the trend log list event icons to get information on different trend log events.
Table: Trend Log List Event Icons

Icon Description
Log was started

Indicates that the trend log started recording
values.
Log was stopped

Indicates that the trend log stopped
recording values.
The log is not configured

Indicates that the trend log is not correctly
configured or preferences are missing, so
the trend log cannot start recording values.
A log value was missed

Indicates that one or more records were
missed due to interrupted communication,
hardware failure, or software failure.
The log configuration was updated

Indicates that the settings of the trend log
were updated. The change is described in
the comment column of the table.
Record was added

Indicates that a record was manually added.
Record was edited

Indicates that a record was manually edited.
Record was added and commented

Indicates that a record was manually added
and commented. The new value and
comment are described in the ToolTip of the
event.
Record was edited and commented

Indicates that a record was manually edited
and commented. The changes are
described in the ToolTip of the event.
Record was commented

Indicates that a log record was commented.
The comment is displayed in the ToolTip of
the event and in the comment column of the
table.

1206
Continued
Icon Description
Log was cleared

Indicates that a trend log was cleared.
Meter was changed

Indicates that the meter was changed or that
the settings were configured.
This event symbol only applies to the meter
trend log.
System clock changed

Indicates that the system date or time,
where the trend log is located, has been
changed. For more information, see section
17.1 “Time and Time Zone” on page 329.
Override
Indicates that the recorded value is
overridden by the hardware and is not the
measured value. For more information, see
the Output Override Status topic on
WebHelp.
Forced
Indicates that the recorded value is forced by
the software and is not the measured value.
For more information, see the Forced I/O
Values topic on WebHelp.
Log database restored

Indicates that the log database has been
restored and that, when the log restarts,
there can be a time gap in the log series.
Log reset by extended log

Indicates that the commands from the
extended trend log have been cleared from
the trend log.

1207
39.31 Trend Log List – Log Info View
39.31 Trend Log List – Log Info View

When expanded, the Log Info view displays a summary of the data recorded in the
trend log list.
Note
• The log info does not include records that are not displayed in the trend log
list. The log info data changes with the trend log when the trend log list is
refreshed or reopened.
Figure: Log info view
Table: Log Info View

Log name The name of the log that is connected to the

trend log list.
Log unit The unit of the recorded values.
Calculation method The calculation method connected to the

trend log list, if any.
Start time The time of the first record in the trend log
list.
Highest value The highest value in the trend log list.
Average The average value of the trend log list.
Displayed trend log The trend log that is connected to the trend
log list.
Stop time The time of the last record in the trend log
list.
Lowest value The lowest value in the trend log list.
Number of records The number of records to be stored before


1208
39.32 Trend Log List Shortcut Menu
39.32 Trend Log List Shortcut Menu

Right-click a row in a trend log list to open the trend log list shortcut menu, where
you can edit a record, show the history of a record, or copy the trend log list data.
Figure: The trend log list shortcut menu
Table: Trend Log List Shortcut Menu

Edit record Click to open the Edit/Comment trend

log record value dialog box where you
can edit values or add comments. For more
Show history Click to open the Edit/Comment trend

log value dialog box where you can edit
values or add comments. For more
Copy Click to copy the list data to the clipboard.

1209
39.33 Add Trend Log Record Dialog Box
39.33 Add Trend Log Record Dialog Box

Use the Add trend log record dialog box to add a trend log record to a manual
trend log.
Note
• The Add trend log record dialog box is only applicable to manual trend
logs.
Figure: Add trend log record dialog box
Table: Add Trend Log Record Dialog Box

Time stamp Enter the time and date of the new record.
Value Type the value of the new record.
Comment Type a comment for the record.

1210
39.34 Edit/Comment Trend Log Record Dialog Box
39.34 Edit/Comment Trend Log Record Dialog

Box
Use the Edit/comment trend log record dialog box to change a trend log value
in the trend log.
Figure: Edit/comment trend log record dialog box
Table: Edit/Comment Trend Log Record Dialog Box

Time stamp Displays the time the value was recorded.
Value Type the new value of the record.
Comment Type a comment for the value.

1211
39.35 Create Trend Log Wizard – Configure Interval Trend Log Page
39.35 Create Trend Log Wizard – Configure

Interval Trend Log Page
Use the Configure Interval Trend Log page to configure the settings of the
interval trend log.
Figure: Configure interval trend log page
Table: Configure Interval Trend Log Page


Unit Enter the unit of the records in the trend log

list. For more information, see section 34.5
“Trend Units” on page 978.

records.

enabled.
Start condition Select the method of starting the trend log.


1212
39.36 Create Trend Log Wizard – Configure Meter Trend Log Page

Meter Trend Log Page
Use the Configure Meter Trend Log page to configure the settings of the meter
trend log.
Figure: Configure meter trend log page
Table: Configure Meter Trend Log Page

to start recording.



enabled.

1213
39.37 Create Trend Log Wizard – Configure Change of Value Trend Log Page

Change of Value Trend Log Page
Use the Configure Change of Value Trend Log page to configure the settings
of a change of value trend log.
Figure: Configure change of value trend log page
Table: Configure Change of Value Trend Log Page




enabled.
Activation time Type the start time of the trend log.

log.

1214
39.38 Create Trend Log Wizard – Configure Variable Triggered Trend Log

Variable Triggered Trend Log
Use the Configure Variable Triggered Trend Log page to configure the
settings of a variable triggered trend log.
Figure: Configure variable triggered trend log page
Table: Configure Variable Triggered Trend Log Page

to start recording.



enabled.

1215
39.39 Create Trend Log Wizard – Configure Manual Log Page

Manual Log Page
Use the Configure Manual Log page to configure the settings of a manual log.
Figure: Configure manual log page
Table: Configure Manual Log Page



1216
39.40 Create Trend Log Wizard – Configure Extended Trend Log Page

Extended Trend Log Page
Use the Configure Extended Trend Log page to configure the settings of the
extended trend log.
Figure: Configure extended trend log page
Table: Configure Extended Trend Log Page

Monitored trend log Enter the trend log that you want to transfer
records from.
Smart log Select True to optimize the transfer of the

log.
Maximum transfer interval Select the maximum length of time that can
pass between transfers from the monitored
trend log to the extended trend log.
Log records Select the number of records to store before

Include in reports? Select True to include the extended trend

log data in reports.
Transfer trigger variable Enter a trigger variable to force a transfer of

all records from the trend log to the
extended trend log, for example, to generate
a complete report. For more information, see
section 36.4 “Extended Trend Logs” on
page 1067.

1217
39.41 Create Trend Log Wizard – Configure Trend Chart Page

Trend Chart Page
Use the Configure Trend Chart page to configure the settings of the trend chart.
Figure: Configure trend chart page
Table: Configure Trend Chart Page


Stop time Enter the absolute stop time when Time

rightmost point of the x-axis.
Time span When time mode is set to Relative the

leftmost x-axis value is equal current time
minus Time span. Where the rightmost x-
axis value is current time.
Auto scale left y-axis Select to activate auto scale. The scale of
the left y-axis adapts itself to the displayed
series.
Series Displays all series in the trend chart.

1218
39.41 Create Trend Log Wizard – Configure Trend Chart Page
Continued
Add Click to add a series to the trend chart. For

on page 1538.

Series Properties” on page 1198.

1219
39.42 Create Trend Log Wizard – Configure Real-Time Trend Series Page

Real-Time Trend Series Page
Use the Configure real-time trend series page to add a series to the trend
chart that presents a variable in real-time.
Figure: Configure real-time trend series page
Table: Configure Real-Time Trend Series Page

Display variable Enter the variable you want to present as a


measure.

bars.

1220
39.43 Create Trend Log Wizard – Configure Trend Log Series Page

Trend Log Series Page
Use the Configure Trend Log Series page to add a series to the trend chart that
presents a trend log.
Figure: Configure trend log series page
Table: Configure Trend Log Series Page

Display trend log Enter the trend log you want to present as a

measure.

bars.
Show events Select True to show event symbols in the

trend chart.

1221
39.44 Create Trend Log Wizard – Configure Trend Log List Page

Trend Log List Page
Use the Configure Trend Log List page to create a trend log list that presents
the records from a trend log.
Figure: Configure trend log list page
Table: Configure Trend Log List Page

Display trend log Enter the trend log you want to present in
the trend log list.
Log space (records) Select the maximum number of records to

display in the trend log list.

1222
39.45 Create Trend Log Wizard – Connect Objects to the Trend Log Page
39.45 Create Trend Log Wizard – Connect

Objects to the Trend Log Page
Use the Connect Objects to the Trend Log page to connect the trend log to an
extended trend log, trend log list, or trend chart.
Figure: Connect objects to the trend log page
Table: Connect Objects to the Trend Log Page

Extended Trend Log Click the browse button to start the wizard
to create an extended trend log and connect
it to the trend log.
Trend Log List Click the browse button to start the wizard
to create a trend log list and connect it to the
trend log.
Trend Chart Click the browse button to start the wizard

to connect the trend log to a new trend or a
existing trend chart.

1223
39.46 Trend Log Wizard – Initial Meter Settings Page
39.46 Trend Log Wizard – Initial Meter

Settings Page
Use the Initial Meter Settings page to set the initial values for the meter trend log.
Figure: Initial meter settings page
Table: Initital Meter Settings page

Start time Displays the time when the new meter was
installed.
Start value Displays the value of the new meter when it

was installed.
Meter constant Displays the constant of the new meter. If

1000.
Min value Displays the first value of the new meter after
roll-over.
Max value Displays the last value of the new meter

before roll-over.

1224
40 Mass Create Alarms and
Trends
Topics
Mass Create
Mass Create Unit Management
Object or Property Variable Type
Suffix and Prefix
Mass Create Path Options
Mass Creating Alarms
Mass Creating Alarms Using the Search Method
Mass Creating Trend Logs
Mass Creating Trend Logs Using the Search Method
Mass Creating Extended Trend Logs
Mass Creating Extended Trend Logs Using the Search
Method
Mass Create Object Wizard – Name Page
40 Mass Create Alarms and Trends
40.1 Mass Create
40.1 Mass Create

The main principle in Building Operation is that what you can do from one object or
property, you can mass create from a number of selected objects or properties on a
one to one basis. For example, you have seven objects that you want to monitor
with seven interval trend logs. By selecting the objects and starting the ordinary
New Object wizard, you configure a generic interval trend log template. When
finishing the wizard Building Operation automatically creates seven identical interval
trend logs that monitor individual objects.
Figure: Mass creating identical trend logs from different variables.
40.1.1 Object or Property Variable Type

In Building Operation, you can create alarms or trend logs that are suitable for the
variable type you have selected.
For more information, see section 40.3 “Object or Property Variable Type” on page
1230.

1227
40.1 Mass Create
40.1.2 Suffix and Prefix

When you mass create objects you can specify a prefix and suffix that are added to
the created object name. The prefix is added before the name and the suffix is
added after.
For more information, see section 40.4 “Suffix and Prefix” on page 1232.
40.1.3 Mass Create Unit Management

You can only mass create alarms with identical units or no unit. When you mass
create trend logs, each trend log gets the same unit as the logged variable.
For more information, see section 40.2 “Mass Create Unit Management ” on page
1229.
40.1.4 Mass Create from Properties with the Search

Method
Mass creating can be performed by either selecting objects in the object list or
selecting the objects or properties in a search result list. Using the search result list
is very convenient if you want to monitor a number of properties located in different
devices or folders. For example, you want to create enumeration alarms that
monitor the reliability property on several I/O points. The I/O points are located on
several Automation servers. By performing a search for the reliability property you
can select the points that you want to monitor in the search result list.
40.1.5 Mass Create Path Options

You have two options when deciding where to create new alarms, trend logs, and
extended trend logs:
• Absolute path
• Relative path
The default folder for alarms, trend logs, and extended trend logs is the root folder
of the System Tree pane.
When you use an absolute path, you can specify the folder in which you want to
create all the alarms, trend logs, and extended trend. When you use a relative path,
you can specify where the new alarms and trend logs are created in relation to the
connected variable.

1228
40.2 Mass Create Unit Management
40.2 Mass Create Unit Management

You can only mass create alarms with identical units or no unit. When you mass
create trend logs, each trend log gets the same unit as the logged variable.
Figure: Objects and properties with no unit are given the unit that is defined for the other
objects.

1229
40.3 Object or Property Variable Type

In Building Operation, you can create alarms or trend logs that are suitable for the
variable type you have selected.
If you select objects or properties with different variable types, you can only mass
create alarms or trend logs that have these variable types in common. For example,
you want to create identical alarms for three analog variables and one multistate
variable. When starting the New Object wizard, Building Operation restricts you to
create out of range alarms, out of reference alarms, or variable status alarms. This
because of the multistate alarm is not suitable to analog variables.
Table: Suitable Alarms and Trend Logs for a Specific Variable Type
Type Alarm Trend Log
Analog variable • Out of range alarm • Interval trend log

• Out of reference range • Meter trend log
alarm
• Change of value trend
• Variable status alarm log
• Variable triggered trend
log
Multistate variable • Multistate alarm • Interval trend log

• Out of range alarm • Meter trend log
• Out of reference range • Change of value trend
alarm log
• Variable status alarm • Variable triggered trend
log
Digital variable • Change of state alarm • Interval trend log

• Out of range alarm • Meter trend log
• Out of reference range • Change of value trend
alarm log
• Variable status alarm • Variable triggered trend
log
Enumeration variable • Enumeration alarm • Interval trend log

• Multistate alarm • Meter trend log
• Out of range alarm • Change of value trend
log
• Out of reference range
alarm • Variable triggered trend
log
• Variable status alarm
String variable • Matching text string A trend log can only monitor
alarm values, not text strings.
• Variable status alarm

1230
Note
A trend log that monitors an enumeration records the enumeration value and not
the enumeration definition.
For more information, see section 49.13 “Event and Alarm Enumerations” on
page 1434.
For more information, see section 49.16 “Trend Log Enumerations” on page
1454.

1231
40.4 Suffix and Prefix
40.4 Suffix and Prefix

When you mass create objects you can specify a prefix and suffix that are added to
the created object name. The prefix is added before the name and the suffix is
added after.
For example, you have six offices in Building B. Every office has a temperature
sensor that you want to log with an interval trend log. The sensors are named Office
x, where x is the room number. When mass creating the interval trend logs you add
the prefix Building B, and the suffix Interval Trend Log. Building Operation creates
the interval trend logs and names them Building B - Office x - Interval Trend log,
where x is the office number.
Figure: Mass created trend logs with prefix and suffix.

1232
40.5 Mass Create Path Options
40.5 Mass Create Path Options

You have two options when deciding where to create new alarms, trend logs, and
extended trend logs:
• Absolute path
• Relative path
The default folder for alarms, trend logs, and extended trend logs is the root folder
of the System Tree pane.
When you use an absolute path, you can specify the folder in which you want to
create all the alarms, trend logs, and extended trend. When you use a relative path,
you can specify where the new alarms and trend logs are created in relation to the
connected variable.
The relative path is created by browsing to a destination folder for one of the alarms
or trend logs. The relative path between the connected variable of that alarm or
trend log and the alarm or trend log itself is then applied to the destination of all
other alarms or trend logs. If you select an invalid relative path, for example, by
selecting a destination folder for one alarm or trend log on a level that does not exist
for all the selected variables, it is not possible to create any alarms or trend logs.

1233
40.6 Mass Creating Alarms

You mass create alarms to create identical alarms for different objects, instead of
creating the alarms one by one.
To mass create alarms

1. In Workstation, in the List View, select the objects that you want to create
alarms for.
3. In the object type list, select the alarm type you want to create.
4. In the Prefix box, type a label that is added in front of the name of the alarms.

1234
5. In the Suffix box, type a label that is added after the name of the alarms.
6. In the Description box, type a description for the alarms.
7. Select Use relative path if you want to use relative path addressing, that
is, if you want to create the different alarms in positions that all relate to their
respective objects with the same pattern of relative path addressing.
8. In the Location box, enter the location where you want to create the alarms.
If you use relative path, this location applies to the first object in the list, and its
path will work as a pattern for the relative path that is applied to all the
remaining objects.
Note
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create will be disabled.
9. If you use relative path, verify that the additional two lines show the resulting
relative path pattern that you intend, and the way this pattern applies to an
example object in the list.
10. Click Next.

See the alarm procedures for detailed information on how to create and set up your
specific alarm type:
• For more information, see section 28.5 “Creating a Multistate Alarm” on page
656.
• For more information, see section 28.9 “Creating a Variable Status Alarm” on
page 671.
• For more information, see section 28.17 “Creating an Enumeration Alarm” on
page 703.
• For more information, see section 28.7 “Creating a Matching Text String Alarm”
on page 664.
• For more information, see section 28.11 “Creating an Out of Range Alarm” on
page 678.
• For more information, see section 28.13 “Creating an Out of Reference Range
Alarm” on page 687.
• For more information, see section 28.3 “Creating a Change of State Alarm ” on
page 648.

1235
40.7 Mass Creating Alarms Using the Search Method
40.7 Mass Creating Alarms Using the Search

Method
You use the search tool to find objects or properties that have the name or other
property in common. You then mass create identical alarms for these objects
instead of creating the alarms one by one for each object or property.
To mass create alarms using the search method

1. In WorkStation, in the Search box, type the name or the property that the
objects have in common.

3. In the Search view, select the objects or properties you want to create alarms
for.

1236
5. In the object type list, select the alarm type you want to create.
6. In the Prefix box, type a label that is added in front of the name of the alarms.
7. In the Suffix box, type a label that is added after the name of the alarms.
8. In the Description box, type a description for the alarms.
9. Select Use relative path if you want to use relative path addressing, that
is, if you want to create the different alarms in positions that all relate to their
10. In the Location box, enter the location where you want to create the alarms.
If you use relative path, this location applies to the first object in the list, and its
path will work as a pattern for the relative path that is applied to all the
remaining objects.
Note
for any of the objects in the list, Next and Create will be disabled.

1237
11. If you use relative path, verify that the additional two lines show the resulting
relative path pattern that you intend, and the way this pattern applies to an
example object in the list.
12. Click Next.

See the alarm procedures for detailed information on how to create and set up your
specific alarm type:
• For more information, see section 28.5 “Creating a Multistate Alarm” on page
656.
• For more information, see section 28.9 “Creating a Variable Status Alarm” on
page 671.
• For more information, see section 28.17 “Creating an Enumeration Alarm” on
page 703.
• For more information, see section 28.7 “Creating a Matching Text String Alarm”
on page 664.
• For more information, see section 28.11 “Creating an Out of Range Alarm” on
page 678.
• For more information, see section 28.13 “Creating an Out of Reference Range
Alarm” on page 687.
• For more information, see section 28.3 “Creating a Change of State Alarm ” on
page 648.

1238
40.8 Mass Creating Trend Logs

You use the mass create feature to create identical trend logs for different objects,
instead of creating the trend logs one by one.
To mass create trend logs

1. In Workstation, in the List View, select the objects that you want to create
trend logs for.

3. In the object type list, select the trend log you want to create.
4. In the Prefix box, type a label that is added in front of the name of the trend
logs.

1239
5. In the Suffix box, type a label that is added after the name of the trend logs.
6. In the Description box, type a description for the trend logs.
7. Select Use relative path if you want to use relative path addressing, that is,
if you want to create the different trend logs in positions that all relate to their
respective objects with the same pattern of relative addressing.
8. In the Location box, enter the location where you want to create the trend
logs. If you use relative path, this location applies to the first object in the list,
and its path works as a pattern for the relative path that is applied to all the
remaining objects.
Note
for any of the objects in the list, Next and Create are disabled.
9. Click Next.
See the trend log procedures for detailed information on how to create and set up
your specific trend log type:
• For more information, see section 35.4 “Creating an Interval Trend Log ” on
page 997.
• For more information, see section 35.15 “Creating a Change of Value Trend
Log ” on page 1038.
• For more information, see section 35.10 “Creating a Meter Trend Log ” on
page 1027.
• For more information, see section 35.18 “Creating a Variable Triggered Trend
Log” on page 1047.

1240
40.9 Mass Creating Trend Logs Using the Search Method
40.9 Mass Creating Trend Logs Using the

Search Method
You use the search tool to find objects or properties that have the name or other
property in common. You then mass create identical trend logs for these objects
instead of creating the trend logs one by one for each object or property.
To mass create trend logs using the search method

objects have in common.

3. In the Search view, select the objects or properties you want to create trend
logs for.


1241
5. In the object type list, select the trend log you want to create.
6. In the Prefix box, type a label that is added in front of the name of the trend
logs.
7. In the Suffix box, type a label that is added after the name of the trend logs.
8. In the Description box, type a description for the trend logs.
remaining objects.
Note
11. Click Next.

See the trend log procedures for detailed information on how to create and set up
your specific trend log type:
• For more information, see section 35.4 “Creating an Interval Trend Log ” on
page 997.
• For more information, see section 35.15 “Creating a Change of Value Trend
Log ” on page 1038.
• For more information, see section 35.10 “Creating a Meter Trend Log ” on
page 1027.

1242
• For more information, see section 35.18 “Creating a Variable Triggered Trend
Log” on page 1047.

1243
40.10 Mass Creating Extended Trend Logs

You use the mass create feature to create identical extended trend logs from trend
logs, instead of creating the extended trend logs one by one.
To mass create extended trend logs

1. In Workstation, in the List View, select the trend logs that you want to create
extended trend logs for.
2. On the File menu, point to New and then click Extended Trend Log.
3. In the Prefix box, type a label that is added in front of the name of the
extended trend logs.
4. In the Suffix box, type a label that is added after the name of the extended
trend logs.

1244
5. In the Description box, type a description for the extended trend logs.
remaining objects.
8. Click Next.
• For more information, see section 36.5 “Creating an Extended Trend Log” on
page 1071.

1245
40.11 Mass Creating Extended Trend Logs Using the Search Method

Using the Search Method
You use the search tool to find trend logs that have the name or other property in
common. You then mass create identical extended trend logs for these trend logs
instead of creating the extended trend logs one by one for each trend log.
To mass create extended trend logs using the search method

trend logs have in common.

3. In the Search view, select the trend logs you want to create extended trend
logs for.
4. On the File menu, point to New and then click Extended Trend Log.

1246
40.11 Mass Creating Extended Trend Logs Using the Search Method
5. In the Prefix box, type a label that is added in front of the name of the
extended trend logs.
6. In the Suffix box, type a label that is added after the name of the extended
trend logs.
7. In the Description box, type a description for the extended trend logs.
respective objects with the same pattern of relative addressing.
remaining objects.
Note
10. Click Next.

• For more information, see section 36.5 “Creating an Extended Trend Log” on
page 1071.

1247
40.12 Mass Create Object Wizard – Name Page
40.12 Mass Create Object Wizard – Name

Page
Use the Choosing the type and naming the object page to name the mass-created
objects.
Figure: Naming the object page
Table: Naming the Object Page

Object type list Select the type of object you want to mass
create. For more information, see section
48.1 “Object Types” on page 1393.
Prefix Type a label that is added in front of the

object name. For more information, see
section 40.4 “Suffix and Prefix” on page
1232.
Suffix Type a label that is added after the object

name. For more information, see section
40.4 “Suffix and Prefix” on page 1232.

object is used for.
Use library item to corresponding property
Use relative path Select Use relative path to use relative path
addressing, that is, if you want to create the
different alarms or trends in positions that all
relate to their respective objects with the
same pattern of relative path addressing.

1248
40.12 Mass Create Object Wizard – Name Page
Continued
Location Enter the path to the location in the System

Tree where you want to create the object. By
default, the path to the selected folder or
object in the System Tree is displayed.

1249
41 Schedules Introduction
Topics
Schedules Overview
Schedule Bindings
Configuring a Schedule as a Shadow
41.1 Schedules Overview

A schedule is a sequence of events that determines when essential events occur in
a building automation system: doors locking or unlocking, temperature raised or
lowered, or equipment turned on or off.
For example, the lighting in an office building needs to be automated to conserve
energy during non-business hours. To regulate the lights from Monday through
Friday, you create a weekly schedule that turns the lights on at 07:00 and switches
them off at 20:00. If there are any non-routine events, such as holidays, you can use
exception events to override the schedule and turn the lights off. For more
information, see section 44.5 “Exception Events in WorkStation” on page 1298.
41.1.1 Schedule Editor Overview

You use the Schedule Editor to create and manage schedule events for digital,
multistate, and analog schedules. The schedule events that you create can be
weekly events or exception events. A weekly event recurs on a weekly basis. An
exception event defines either a one-time change or a recurring change that
overrides the standard weekly events. In the Schedule Editor, you can view the
schedule events in Basic view or Advanced view.
For more information, see section 42.1 “Schedule Editor Overview” on page 1259.
41.1.2 Priorities
Priority is a number that corresponds to a preassigned level of importance. When
used in schedules, priority numbers range from one to sixteen. One is the most
important or highest priority and sixteen is the lowest priority.
For more information, see section 42.5 “Priorities” on page 1264.
41.1.3 Schedule Types

You can create three types of schedules: Digital, Multistate, or Analog. You create a
digital schedule if the schedule needs to control a device with two output states,
such as On or Off. You create a multistate schedule if the schedule needs to control
a device that has output states based on multiple states, such as low, medium, or
high. You create an analog schedule if the schedule controls a device that gauges
the output in real numbers.
For more information, see section 43.1 “Schedule Types ” on page 1279.
41.1.4 Schedule Events

A schedule can have two types of events: weekly events and exception
events. Weekly events occur every week at specified times. Exception events occur
when the schedule deviates from the weekly schedule, such as during
holidays. Exception events override the weekly events when there is an overlap.
For more information, see section 44.1 “Schedule Events” on page 1293.

1253
41.1.5 Calendars in WorkStation

A calendar is a list of dates. The calendar provides the schedule with the dates
when the exception events shall occur. To save time, you can reference a single
calendar rather than entering several exception events in a schedule.
For more information, see section 45.2 “Calendars in WorkStation” on page 1324.
41.1.6 Schedule and Calendar Synchronization

on page 1344.
41.1.7 Schedule Bindings

simplest form, a binding consists of a source and a destination. The destination
reads the value from the source.
For more information, see section 41.2 “Schedule Bindings” on page 1255.

1254
41.2 Schedule Bindings
41.2 Schedule Bindings

simplest form, a binding consists of a source and a destination. The destination
reads the value from the source.
Figure: Binding diagram

In Building Operation, you typically bind source values to destination properties in
objects such as programs, alarms, trend logs, and graphics. These objects
frequently need to use values that exist somewhere else in the system.
41.2.1 Binding Examples

Bindings are used in schedules the same way that bindings are used throughout
the system. You bind a schedule to a point in order to control the value with the
schedule. The following examples demonstrate the different uses of schedules and
bindings.
Analog Schedule
You bind an analog schedule to an analog output, such as a thermostat setpoint.
When the schedule dictates a change in temperature, the system sends the output
information to the setpoint for the thermostat to act on. For more information, see
section 43.10 “Binding an Analog Value to an Analog Schedule” on page 1289.
Digital Schedule
You bind a digital schedule to a digital output, such as a light switch. The system
will switch the light on or off depending on the value set in the schedule. For more
information, see section 43.4 “Binding a Digital Value to a Digital Schedule” on page
1282.
Multistate Schedule
You bind a multistate schedule to a multistate output, such as an air handler. When
the schedule dictates a change in air flow, the system will send the output
information to the air handler depending on the value of the state set in the
schedule. For more information, see section 43.7 “Binding a Multistate Value to a
Multistate Schedule” on page 1286.

1255
41.3 Configuring a Schedule as a Shadow
41.3 Configuring a Schedule as a Shadow

You configure a schedule as a shadow to synchronize it with a schedule that
already contains all weekly events and exception events.
on page 1344.
To configure a schedule as a shadow

1. In WorkStation, in the System Tree pane, select the schedule you want to
configure as a shadow.
3. In the Lead object box, enter the schedule that you want to synchronize the
shadow schedule with.
4. Click OK.

1256
42 Schedule Editor
Topics
Schedule Editor Overview
Basic View of the Schedule Editor
Advanced View of the Schedule Editor
Time Zones
Priorities
Editing an Event Priority
Configuring a Time Value Pair for a Schedule
Setting the Time Increments in the Server Time Bar
Modifying a Time Value Bar in the Graphic View
Modifying a Schedule Using the Text View
Modifying a Schedule Using the Graphic View
Schedule Colors in WorkStation
42 Schedule Editor
42.1 Schedule Editor Overview
42.1 Schedule Editor Overview

You use the Schedule Editor to create and manage schedule events for digital,
multistate, and analog schedules. The schedule events that you create can be
weekly events or exception events. A weekly event recurs on a weekly basis. An
exception event defines either a one-time change or a recurring change that
overrides the standard weekly events. In the Schedule Editor, you can view the
schedule events in Basic view or Advanced view.
42.1.1 Basic View of the Schedule Editor

The Basic view of the Schedule Editor serves as a workspace to plan and design a
schedule. You use this editor to create, manage, and display weekly scheduled
events and exception events.
For more information, see section 42.2 “Basic View of the Schedule Editor” on page
1260.
42.1.2 Advanced View of the Schedule Editor

The Advanced view of the Schedule Editor has the features of the Basic view with
some additional capabilities. All the tasks that you can perform in the Basic view,
you can also perform in the Advanced view.
For more information, see section 42.3 “Advanced View of the Schedule Editor ” on
page 1261.
42.1.3 Schedule Colors

A schedule has a color code so you can identify weekly events and exception
events at a glance. This color code can assist you when you are modifying your
schedule or trying to troubleshoot any problems.
For more information, see section 42.12 “Schedule Colors in WorkStation” on page
1274.

1259
42 Schedule Editor
42.2 Basic View of the Schedule Editor
42.2 Basic View of the Schedule Editor

The Basic view of the Schedule Editor serves as a workspace to plan and design a
schedule. You use this editor to create, manage, and display weekly scheduled
events and exception events.
You can also display the client time zone and the server time zone in the Basic view.
This is convenient if your server is located in a time zone that is different from the
time zone where you are configuring the schedule. For more information, see
section 42.4 “Time Zones” on page 1263.
The following figure displays the schedule of the lights within the building. The
weekly events are in green and the exception event in blue. The values of the events
are also displayed. Monday, October 21 is an exception event so it does not follow
the same scheduled events as the rest of the week. The lights are off all day. For the
rest of the week, the lights turn on at 07:00 and turn off at 18:00.
Figure: Basic view of the Schedule Editor

1260
42 Schedule Editor
42.3 Advanced View of the Schedule Editor

The Advanced view of the Schedule Editor has the features of the Basic view with
some additional capabilities. All the tasks that you can perform in the Basic view,
you can also perform in the Advanced view.
Unlike the Basic view, the Advanced view lists the exception and weekly events in
an event tree. In addition, there is a Combined option that displays all the weekly
and exception events for a selected date.
Two toggles provide additional options:
• Mode: Switches between an editor or preview mode.
• View: Switches between a graphical or text view.
Figure: Advanced view of the Schedule Editor
42.3.1 Mode
The Mode toggle provides the following capabilities:
• Editor mode where you can view or edit a weekly event or an exception event.
• Preview mode where you can preview (but not edit) all the weekly schedules
and exceptions for a selected date. However, only the effective weekly and
exception events display for that date. Typically, you see one weekly and one
exception event.
42.3.2 View
The View toggle provides the following capabilities:
• Graphic View where you can view or edit a weekly event or an exception
event. For more information, see section 42.11 “Modifying a Schedule Using
the Graphic View” on page 1273.

1261
42 Schedule Editor
• Text View where you can define specific more time sequences or to break
down a time value into hundredths of a second. For more information, see
section 42.10 “Modifying a Schedule Using the Text View” on page 1271.
Figure: Text View
42.3.3 Combined
You can view all of the events for a selected date using both the Combined option
and Preview mode. Events can include exception and weekly events, and the
Default value. You can toggle the combined events between the Graphic View or
Text View.
Figure: Combined Events in Graphic View

For more information, see section 46.4 “Advanced Schedule Editor Toolbar ” on
page 1350.

1262
42 Schedule Editor
42.4 Time Zones
42.4 Time Zones

When you create a schedule, the time zone of the server that contains the schedule
determines the execution of the events. If the schedule is copied to a server in a
different time zone, the specified dates and times relate to the new time zone.
For example, a schedule with an event defined to start at 08:00 Eastern Standard
Time in a device located in Boston is copied to a device in London. The event would
start at 08:00 Greenwich Mean Time.
When working within a schedule, you can display two different time zones. Building
Operation also displays the time differential for the second time zone. For example,
if you are working in Eastern Standard Time, the Greenwich Mean Time shows a +5
time differential.

1263
42 Schedule Editor
42.5 Priorities
42.5 Priorities
42.5.1 Exception Events

An exception event occurs instead of the scheduled weekly events for a single date,
date range, calculated date, or calendar reference.
Exception events always take precedence over weekly events. When two exception
events overlap, priorities can determine which event takes precedence over the
other. Generally, priorities resolve the following conflicts:
• Two events with different priorities occur on the same day and time. In this
case, the higher priority takes control of the schedule.
For example, a schedule that is set at priority 14 controls a fan in an office area
at low speed during normal business hours. A Special Meeting event
scheduled at 11:00 is set at priority 12 for medium speed. Therefore, the
schedule adjusts the fan from low to medium for the meeting and ignores the
priority 14 event until the priority 12 event ends.
• Two events with the same priority level occur on the same day and time. In this
case, the position in the Event tree determines which priority takes control of
the schedule. The position depends on when exception event was created.
In the following example, two exception events are set at Priority 12. Winter
Break was created first followed by Scout Meeting. Therefore, Winter Break
takes precedence over Scout meeting because that event was created first.
In the Advanced Schedule Editor, an event tree lists the exception events in
separate folders according to priority level. For example, an exception event set at
priority 10 is contained in a Priority 10 folder. If no priority is specified, Building
Operation places the event in the default folder, Priority 16. No event folders display
in the event tree if all exception events use the default priority. For more information,
see section 42.3 “Advanced View of the Schedule Editor ” on page 1261.
By default, all exception events are set at priority 16, but you can change priority
level. For more information, see section 42.6 “Editing an Event Priority” on page
1266.

1264
42 Schedule Editor
42.5 Priorities
Schedule Colors
For more information, see section 42.12 “Schedule Colors in WorkStation” on page
1274.

1265
42 Schedule Editor
42.6 Editing an Event Priority

You edit an event priority to change the exception event to a higher or lower priority.
To edit an event priority

1. In WorkStation, in the System Tree pane, right click the schedule you want
to edit and click Open.
2. In the Work area, click the Basic view of the Schedule editor.
3. In the Event grid, select the exception event you want to edit.
4. On the Basic toolbar, click the Edit schedule event button .


1266
42 Schedule Editor
5. In the Priority box, enter the priority level for the event.
6. Click OK.

1267
42 Schedule Editor
42.7 Configuring a Time Value Pair for a Schedule
42.7 Configuring a Time Value Pair for a

Schedule
You configure a time value pair to modify weekly or exception events in a Building
Operation schedule or BACnet schedule.
page 1261.
To configure a time value pair for a schedule

1. In WorkStation, in the System Tree pane, select the schedule that you want
to modify.
2. Click the Advanced tab of the editor.
3. Expand the Exceptions or Weekly folder.
4. Right click on the time period that you want to modify and click Properties.
5. Modify the properties.

Value Select the value associated with the event.
Start Time Select the hour, minutes, and seconds for the start time.
No End Time Select to have the event last all day.
End Time Select the hour, minutes, and seconds for the end time.
6. Click OK.

1268
42 Schedule Editor
42.8 Setting the Time Increments in the Server Time Bar
42.8 Setting the Time Increments in the

Server Time Bar
You set the time increments in the Server Time bar to adjust the time value bars in
the Graphic View.
page 1261.
To set the time increments in the Server Time bar

edit.
2. In the Work area, click the Advanced tab.
3. Click the Edit Schedule button .
4. Click the Graphic View button .

5. Right click on the Server Time bar, point to Snap To and select a time
segment.

You can modify a time value bar using the selected time increment. For more
information, see section 42.9 “Modifying a Time Value Bar in the Graphic View” on
page 1270.

1269
42 Schedule Editor
42.9 Modifying a Time Value Bar in the Graphic View
42.9 Modifying a Time Value Bar in the

Graphic View
You modify a time value bar in the Graphic View to shorten or lengthen a time span.
The ToolTip displays the server time intervals, such as 15 minutes.
page 1261.
To modify a time value bar in the Graphic View

edit.
2. In the Work area, click the Advanced tab.
3. Click on a time value pair and drag the bar by the handles at either end to
shorten or lengthen the time span.

1270
42 Schedule Editor
42.10 Modifying a Schedule Using the Text View
42.10 Modifying a Schedule Using the Text

View
Use the Text View of the Advanced Schedule editor to edit specific time sequences
and break down a time value into hundredths of a second.
page 1261.
To modify a schedule using the Text View

1. Select a schedule in the System Tree pane.
2. Click the Advanced tab of the Schedule Editor.
3. In the Schedule Event Tree, complete one of the following tasks:

• To modify an exception, expand the Exceptions folder and Priority x
folder. Then, select an exception.
• To modify a day, expand the Weekly folder and select a day.
4. Click the Text View button .

5. Right-click on the time period that you want to modify and click Properties.

1271
42 Schedule Editor
42.10 Modifying a Schedule Using the Text View
6. Edit the properties.

Hour Enter the hour when you want the Object property reference
set to Value. Use the time format that matches your Windows
regional settings.
Select Any hour if you want the Object property reference
set to Value at all times.
Minute Enter a number to set the time for Value to be written to the
property reference.
Second Enter a number to set the time for Value to be written to the
property reference.
Hundredths Enter a number to set the time for Value to be written to the
property reference.
Value Enter a value to write to the property reference at the scheduled

time, such as True.
7. Click OK.

1272
42 Schedule Editor
42.11 Modifying a Schedule Using the Graphic View
42.11 Modifying a Schedule Using the Graphic

View
Use the Graphic View of the Advanced Schedule editor to edit the properties of an
exception or weekly event.
page 1261.
To modify a schedule using the Graphic View

1. Select a schedule in the System Tree pane.
2. Click the Advanced tab of the Schedule Editor.
3. In the Schedule Event Tree, choose one of the following tasks:

• To modify an exception, expand the Exceptions folder and Priority x
folder. Then, select an exception.
• To modify a day, expand the Weekly folder and select a day.
4. Click the Graphic View button .

5. Right-click on the time period that you want to modify and click Properties.
7. Click OK.

1273
42 Schedule Editor
42.12 Schedule Colors in WorkStation

42.12.1 Basic Schedule View

In the Event grid, weekly events and exception events display in distinct colors to
clearly identify them. Similar events that are next to each other are highlighted in
different shades of the same color so you can easily see the start and stop time. For
example, a meeting scheduled from 7:00 to 11:00 is dark green while the weekday
event from 11:00 to 15:15 is in light green. In the Calendar view, you can view the
weekly events and exception events across several months and the selected day in
black.
Figure: Basic Schedule Editor colors
Table: Basic Schedule Editor Colors

Color Description
Cream Event grid: default value
Green Event grid: weekly events
Blue Event grid: exception events
Light blue Calendar view: exception events
Black Calendar view: selected day
Priority Level Conflicts

The Event grid also highlights a conflict in dark blue if there are two exception
events that overlap on the same day and have different values, but are set at the
same priority level.

1274
42 Schedule Editor
Figure: Priority level conflict

42.12.2 Advanced Schedule View

In the Event gride, weekly and exception events are both green in the Advanced
Schedule. Events that are next to each other in the schedule are presented in
different intensities of green so you can easily see the start and stop time of these
events. In the Calendar view, you can view the weekly events and exception events
across several months and the selected day in dark blue.
Figure: Advanced Schedule Editor colors

1275
42 Schedule Editor
Table: Advanced Schedule Editor Colors

Color Description
Cream Event grid: default value
Green Event grid: weekly events
Blue Event grid: exception events
Light blue Calendar view: exception events
Dark blue Calendar view: selected day

1276
43 Schedule Types
Topics
Schedule Types
Digital Schedules
Creating a Digital Schedule
Binding a Digital Value to a Digital Schedule
Multistate Schedules
Creating a Multistate Schedule
Binding a Multistate Value to a Multistate Schedule
Analog Schedules
Creating an Analog Schedule
Binding an Analog Value to an Analog Schedule
43 Schedule Types
43.1 Schedule Types
43.1 Schedule Types

You can create three types of schedules: Digital, Multistate, or Analog. You create a
digital schedule if the schedule needs to control a device with two output states,
such as On or Off. You create a multistate schedule if the schedule needs to control
a device that has output states based on multiple states, such as low, medium, or
high. You create an analog schedule if the schedule controls a device that gauges
the output in real numbers.
You create schedules using WorkStation.
43.1.1 Analog Schedules

An analog schedule controls a device that gauges the output in real numbers. The
real numbers include positive or negative numbers, fractions, and decimal values.
For more information, see section 43.8 “Analog Schedules” on page 1287.
43.1.2 Digital Schedules

A digital schedule controls a device that has an on output state and an off output
state.
For more information, see section 43.2 “Digital Schedules” on page 1280.
43.1.3 Multistate Schedules

A multistate schedule controls a device that has output states based on integers or
positive whole numbers including zero.
For more information, see section 43.5 “Multistate Schedules” on page 1284.

1279
43 Schedule Types
43.2 Digital Schedules
43.2 Digital Schedules

A digital schedule controls a device that has an on output state and an off output
state.
For example, you can create a digital weekly schedule that is bound to a digital
output, such as a light switch. To turn on the lights Monday through Friday from
08:00 to 17:00, you can set the value to On when the schedule is active and Off
when the schedule is inactive.
Figure: Digital Schedule

1280
43 Schedule Types
43.3 Creating a Digital Schedule
43.3 Creating a Digital Schedule

You create a digital schedule to control the state of a digital value.
For more information, see section 43.2 “Digital Schedules” on page 1280.
To create a digital schedule

1. In WorkStation, in the System Tree pane, select the server or the folder
where you want to create the schedule.
2. On the File menu, point to New and then click Schedule.
3. In the object type list, select Digital Schedule.
4. In the Name box, type a name for the schedule.

5. In the Description box, type a description for the schedule.
6. Click Create.
Now you can add events to the digital schedule and bind it to a digital value.

1281
43 Schedule Types
43.4 Binding a Digital Value to a Digital Schedule
43.4 Binding a Digital Value to a Digital

Schedule
You bind a digital value to a digital schedule so the variable status follows the
scheduled times.
To bind a digital value to a digital schedule

1. In WorkStation, in the System Tree pane, select the variable or value that
contains the digital value.
2. On the Actions menu, click Edit bindings.
3. In the Browser pane, select the folder that contains the digital schedule.
4. Select the digital schedule that you want to bind to the digital value.

1282
43 Schedule Types
43.4 Binding a Digital Value to a Digital Schedule
5. Drag the digital schedule to the Binding column for the digital value.

1283
43 Schedule Types
43.5 Multistate Schedules
43.5 Multistate Schedules

A multistate schedule controls a device that has output states based on integers or
positive whole numbers including zero.
For example, you can create a multistate weekly schedule that is bound to a
multistate value to control an air handler unit in an office building. To regulate the air
circulation Monday through Friday from 08:00 to 17:00, you can set the value to 2
(occupied) when the schedule is active and 1 (unoccupied) when the schedule is
inactive.
Figure: Multistate Schedule

1284
43 Schedule Types
43.6 Creating a Multistate Schedule
43.6 Creating a Multistate Schedule

You create a multistate schedule to control the state of a multistate value.
For more information, see section 43.5 “Multistate Schedules” on page 1284.
To create a multistate schedule

1. In WorkStation, in the System Tree pane, select the server or the folder
where you want to create the schedule.
3. In the object type list, select Multistate Schedule.

6. Click Create.
Now you can add events to the multistate schedule and bind it to a multistate value.

1285
43 Schedule Types
43.7 Binding a Multistate Value to a Multistate Schedule
43.7 Binding a Multistate Value to a

Multistate Schedule
You bind a multistate value to a multistate schedule so the variable status follows
the scheduled times.
To bind a multistate value to a multistate schedule

1. In WorkStation, in the System Tree pane, select the program or folder that
contains the multistate value.
2. On the Actions menu, click Edit Bindings.
3. In the Browser pane, select the folder that contains the multistate schedule.
4. Select the multistate schedule that you want to bind to the multistate value.
5. Drag the multistate schedule to the Binding column for the multistate value.
6. On the main toolbar, click the Save button .

1286
43 Schedule Types
43.8 Analog Schedules
43.8 Analog Schedules

An analog schedule controls a device that gauges the output in real numbers. The
real numbers include positive or negative numbers, fractions, and decimal values.
For example, you can create an analog schedule to regulate a thermostat setpoint
in an office area. To control the temperature from 08:00 to 17:00, you can set the
value to 22 °C (70 °F) when the schedule is active and 16 °C (62 °F) when the
schedule is inactive.
Figure: Analog Schedule

1287
43 Schedule Types
43.9 Creating an Analog Schedule
43.9 Creating an Analog Schedule

You create an analog schedule to control the state of an analog value.
For more information, see section 43.8 “Analog Schedules” on page 1287.
To create an analog schedule

1. In WorkStation, in the System Tree pane, select the server or the folder.
3. In the object type list, select Analog Schedule.

6. Click Create.
Now you can add events to the analog schedule and bind the schedule to an
analog value.

1288
43 Schedule Types
43.10 Binding an Analog Value to an Analog Schedule
43.10 Binding an Analog Value to an Analog

Schedule
You bind an analog value to an analog schedule so the variable status follows the
scheduled times.
To bind an analog value to an analog schedule

1. In WorkStation, in the System Tree pane, select the program or folder that
contains the analog value.
2. On the Actions menu, click Edit bindings.
3. In the Browser pane, select the folder that contains the analog schedule.
4. Select the analog schedule that you want to bind to the analog value.
5. Drag the analog schedule to the Binding column for the analog value.
6. On the main toolbar, click the Save button .

1289
44 Schedule Events
Topics
Schedule Events
Displaying Client Time and Server Time in a Schedule
Deleting a Date List Entry from a Calendar
Weekly Events in WorkStation
Exception Events in WorkStation
Editing a Date Exception Event
Editing a Date Range Exception Event
Editing a Calculated Exception Event
Adding a Date Range Exception Event
Adding a Calculated Exception Event
Adding a Weekly Event
Adding a Calendar Exception Event
Adding a Date Exception Event
44 Schedule Events
44.1 Schedule Events

A schedule can have two types of events: weekly events and exception
events. Weekly events occur every week at specified times. Exception events occur
when the schedule deviates from the weekly schedule, such as during
holidays. Exception events override the weekly events when there is an overlap.
For each schedule, you can set a default value. The default value goes into effect
after the exception events and weekly events are complete or relinquish control. For
example, the weekly event for a fan ends at 17:00. The fan ran at a value of 3 (high)
throughout the event. There are no scheduled events after the weekly event.
Because you have assigned 0 as the default value, the fan adjusts to the default
value and turns to 0 (off). The value remains at 0 until the next scheduled event.
Events occur in the following order of precedence:
• Exception events
• Weekly events
• Default value
44.1.1 Weekly Events in WorkStation

A weekly event occurs every week for an extended period of time on a regular
basis. You can schedule more than one weekly event for each day of the week.
For more information, see section 44.4 “Weekly Events in WorkStation” on page
1297.
44.1.2 Weekly Events in WebStation

For more information, see the Weekly Events in WebStation topic on WebHelp.
44.1.3 Exception Events in WorkStation

For more information, see section 44.5 “Exception Events in WorkStation” on page
1298.
44.1.4 Exception Events in WebStation

For more information, see the Exception Events in WebStation topic on WebHelp.

1293
44 Schedule Events
44.1.5 Priorities
44.1.6 Time Zones

When you create a schedule, the time zone of the server that contains the schedule
determines the execution of the events. If the schedule is copied to a server in a
different time zone, the specified dates and times relate to the new time zone.
For more information, see section 42.4 “Time Zones” on page 1263.

1294
44 Schedule Events
44.2 Displaying Client Time and Server Time in a Schedule
44.2 Displaying Client Time and Server Time

in a Schedule
You display the client time and the server time of a schedule to compare the client
time with the server time. Schedule times are set according to the server time.
To display client time and server time in a schedule

1. In WorkStation, in the System Tree pane, select the schedule.
2. In the Work area, click the Basic view.
3. Right-click the Server Time bar.
4. Click Show client time zone.

5. Click Show client time zone again to display the server time zone only.

1295
44 Schedule Events
44.3 Deleting a Date List Entry from a Calendar
44.3 Deleting a Date List Entry from a

Calendar
You delete a date list entry from a calendar to remove the entry from a schedule.
To delete a date list entry from a calendar

1. In WorkStation, in the System Tree pane, select the calendar.
2. In the work area, click the Calendar Editor view.
3. In the Date List, select an entry.
4. On the Calendar Editor toolbar, click the Delete button .

Repeat the procedure to delete additional date list entries.

1296
44 Schedule Events
44.4 Weekly Events in WorkStation
44.4 Weekly Events in WorkStation

Figure: Weekly events in a Building Operation schedule

If there are any non-routine events, such as holidays, you can use exception events
to override the schedule. For more information, see section 44.5 “Exception Events
in WorkStation” on page 1298.

1297
44 Schedule Events
44.5 Exception Events in WorkStation

For example, you create an exception event in March for an intense aerobics class
in the gym to open an air vent to 100 % from 06:30 to 17:00 every Wednesday in
March. This exception event takes precedence over the regularly scheduled weekly
Wednesday events.
When scheduling exception events, you can use four exception types to provide
flexibility and control in your schedule.
44.5.1 Date Exception Events

A single date exception event can occur on a single day, or you can use the options
for the event to occur on more than one day. The options such as Any year and
Any day provide flexibility. To schedule a single date event to take place every year
on October 31, you select the following single date options:
• Year: Any year
• Month: October
• Day of month: 31
• Day of week: Any day
44.5.2 Date Range Exception Events

A date range exception event is an event that lasts over a period of time. In addition
to a specific day of month, you can select Odd, Even, or Any month, and Any
day or Last day, to provide the flexibility to a date range. For example, to schedule
an exception event to occur annually from the last day of March to the last day of
April, select the following options for the start and end dates:
Start Date
• Start year: Any year
• Start month: March
• Day of month: Last day
End Date
• Year: Any year
• Month: April
• Day of month: Last day

1298
44 Schedule Events
44.5.3 Calculated Exception Events

A calculated date is an exception event that recurs. Other than a specific month and
week, you can select Any month and Any week or Last week, to provide
flexibility to a calculated date. For example, to schedule the Monday of the first
week of every month for an exception event, select the following options:
• Month: Any month
• Week of month: First week
• Day of week: Monday
44.5.4 Calendar Exception Events

A calendar reference allows you to apply an exception event for all dates specified
in the calendar. For example, to schedule exception events for all holidays on a
calendar, you select the calendar you want to reference and the schedule will follow
the holidays created in the calendar.

1299
44 Schedule Events
44.6 Editing a Date Exception Event

You edit a date exception event to change the information about an exception
event.
To edit a date exception event

edit.
3. In the Event grid, select the date exception event you want to edit.

1300
44 Schedule Events

1301
44 Schedule Events

Event type Click Exception to display the exception types.
Exception type Select Single date for the exception type to apply to the
schedule.
All Day Select All Day for an all day event.
Add Entry Click to add a line to the Times and values box.
Delete Entry Click to delete an entry from the Times and values box.
Name Type a name for the exception event.
Priority Select a priority number between 1 (highest priority) and 16

(lowest priority).
Year Select a year. You can use Any year as a valid entry.
Month Select a month for the exception event or Odd month, Even
month, Any month.
Day of month Select a value for the day of the month. You can use Any Day
and Last Day as valid entries.
Day of week Select a day of the week. Setting the value to Any Day ensures
consistency with the rest of the date specification, this is the
recommended setting.
6. Click Ok.

1302
44 Schedule Events
44.7 Editing a Date Range Exception Event

You edit a date range exception event to change the information about an
exception event.
To edit a date range exception event

edit.
3. In the Event grid, select the date range exception event you want to edit.

1303
44 Schedule Events

1304
44 Schedule Events

Exception type Select Date range for the exception to apply to the schedule.
Name Type a name for the event.

(lowest priority).
month, Any month.
Day of month Select a value for the day of the month. You can use Any Day
and Last Day as valid entries.
6. Click Ok.

1305
44 Schedule Events
44.8 Editing a Calculated Exception Event

You edit a calculated exception event to change the information about an exception
event.
To edit a calculated exception event

edit.
3. In the Event grid, select the calculated exception event you want to edit.

1306
44 Schedule Events

1307
44 Schedule Events

Exception type Select Calculated for an exception type to apply the schedule.

(lowest priority).
month, Any month.
Week of month Select a week of the month for the exception event or First
week, Second week, Third week, Fourth week, Last
week, Any week.
6. Click Ok.

1308
44 Schedule Events
44.9 Adding a Date Range Exception Event

You create a date range exception to schedule a date range event that takes
precedence over a scheduled weekly event.
To add a date range exception event

add the date range exception event to.
2. Click the Basic view.
3. On the Basic toolbar, click the New schedule event button .


1309
44 Schedule Events
4. Under Event type, click Exception.
5. Under Exception type, click Date range.

6. Select All Day to have the event last all day.
7. In the Value box, enter a value.
8. In the Name box, type a name for the exception.
9. In the Priority box, select a priority.
10. In the Year box, select a year for the start date and the end date.
11. In the Month box, select a month for the start date and end date.

1310
44 Schedule Events
12. In the Day of month box, select a day of the month for the start date and
end date.
13. In the Day of week box, select a day of the week for the start date and end
date.
14. Click OK.

1311
44 Schedule Events
44.10 Adding a Calculated Exception Event

You create a calculated exception to schedule a recurring event that takes
precedence over a scheduled weekly event.
To add a calculated exception event

add the calculated exception event to.
3. On the Basic toolbar, click the New schedule event button .


1312
44 Schedule Events
4. Under Event type, click Exception.
5. Under Exception type, click Calculated.

6. Select All Day to have the event last all day.
7. In the Name box, type a name for the exception.
8. In the Priority box, enter a priority.
9. In the Month box, select a month.
10. In the Week of month box, select a week of the month.
11. In the Day of week box, select a day of the week.
12. Click OK.

1313
44 Schedule Events
44.11 Adding a Weekly Event
44.11 Adding a Weekly Event

You add weekly events to a schedule to determine when the event is to regularly
occur. Weekly events always occur regularly unless overridden by an exception
event.
For more information, see section 44.4 “Weekly Events in WorkStation” on page
1297.
To add a weekly event

add the weekly event to.
3. On the Basic Schedule Editor toolbar, click the View weekly schedule
events button .
4. In the grid, click the start time. Drag the cursor vertically to select the end time
and then horizontally to select all days for which the event should be valid.

1314
44 Schedule Events
44.12 Adding a Calendar Exception Event

You add a calendar to the schedule to make an exception event for all dates
specified in the calendar.
To add a calendar exception event

add the calendar to.
3. On the Basic Schedule Editor toolbar, click the New schedule event
button .

1315
44 Schedule Events
4. Click Exception.
5. Click Calendar.
6. Select All Day if the exception event is to be on or off all day.
7. In the Start Time column, type a start time for the exception event.
8. In the End Time column, type an end time for the exception event.
9. In the Value column, select a value for the exception event.
10. In the Name box, type a name for the exception event.
11. In the Priority box, select a priority for the exception event to make it override
conflicting events with lower priorities.

1316
44 Schedule Events
12. In the Calendar box, enter the calendar that you want to add.
13. Click OK.

Note
• You cannot specify different times and values for each of the different dates.
All dates specified in the calendar must have the same times and values
assigned to them.

1317
44 Schedule Events
44.13 Adding a Date Exception Event

You add a single date exception event to make an exception for a specific day in
the schedule, such as 10 December, 2013.
For more information, see section 44.5 “Exception Events in WorkStation” on page
1298.
To add a date exception event

add the single date exception event to.
3. On the Basic Schedule Editor toolbar, click the New schedule event
button .

1318
44 Schedule Events
4. Click Exception.
5. In the Exception type box, click Single date.

6. Select All Day if the exception event is to be on or off all day.
7. In the Start Time column, type a start time for the exception event.
8. In the End Time column, type an end time for the exception event.
9. In the Value column, select a value for the exception event.
10. In the Name box, type a name for the exception event.
11. In the Priority box, select a priority for the exception event to make it override
conflicting events with lower priorities.

1319
44 Schedule Events
12. In the Year box, select the year for the single date.
13. In the Month box, select the month for the single date.
14. In the Day of month, select a day of month for the single date.
15. In the Day of week box, select a weekday for the single date.
16. Click OK.


1320
45 Calendars
Topics
Calendar Editor Overview
Calendars in WorkStation
Calendar Events
Creating a Calendar
Adding a Date Calendar Event
Adding a Date Range Calendar Event
Adding a Calculated Date Calendar Event
Configuring a Calendar as a Shadow
Storing Expired Calendar Events
Editing a Date Calendar Event
Editing a Date Range Calendar Event
Editing a Calculated Date Calendar Event
Schedule and Calendar Synchronization
45 Calendars
45.1 Calendar Editor Overview
45.1 Calendar Editor Overview

The Calendar Editor is the editor you use to create a date list of exception events.
The date list can include a single date, a date range, or a recurring date. You use
the calendar when creating a schedule that uses a Calendar Reference Exception.
You can apply one calendar to many schedules.
The following figure displays the calendar with all of the exception events in blue.
The exception events are also in a list view.
Figure: Calendar Editor Overview

1323
45 Calendars
45.2 Calendars in WorkStation

A calendar is a list of dates. The calendar provides the schedule with the dates
when the exception events shall occur. To save time, you can reference a single
calendar rather than entering several exception events in a schedule.
Figure: Exception events in a calendar

Many schedules can make a reference to the calendar. You can define the group of
dates once rather than over and over again in multiple schedules, a potentially
tedious task if your building control system contains many schedules.
45.2.1 Calendar Editor Overview

You use the Calendar Editor to create a calendar that contains a date list of
exception events. The exception events can be a single date, a date range, or a
recurring date. By using a calendar, you specify all the exception events only one
time, rather than in each schedule. The calendar is then referenced to each of the
schedules and all exception dates are automatically designated in the schedules.
For more information, see section 45.1 “Calendar Editor Overview” on page 1323.
45.2.2 Calendar Events

The dates specified in a calendar are shown in the date list. You can specify dates
in a calendar by three different methods:
• Date: a specific date

1324
45 Calendars
• Date range: a fixed period with a set start and stop date
• Calculated date: a fixed period that repeats
For more information, see section 45.3 “Calendar Events” on page 1326.

1325
45 Calendars
45.3 Calendar Events

The dates specified in a calendar are shown in the date list. You can specify dates
in a calendar by three different methods:
• Date: a specific date
• Date range: a fixed period with a set start and stop date
• Calculated date: a fixed period that repeats
45.3.1 Date Calendar Events

A single date within a calendar is an entry that occurs once or every year on the
same date.
The following single date entry choices schedule an event on a single date, January
1, 2009:
• Year - 2009
• Month - January
• Day of month - 1
• Day of week - Any day
The following single date entry choices schedule an event on a single date every
year, January 1:
• Year - Any Year
• Month - January
• Day of month - 1
• Day of week - Any day
The following choices produce an error message:
• A day, month, and year combination that does not coincide
An example is Friday, March 5, 2009. This date actually falls on a Thursday.
• Any years past 2105
• An explicit day that is out of range
An example is September 31 or February 29 in a non-leap year.
45.3.2 Date Range Calendar Events

You can include a date range in the date list. A date range is a series of days to
include in a calendar. An example of a date range is January 1, 2009 to January 31,
2009, which adds the entire month of January to the calendar as an event. You can
use this date range for a device, such as a thermostat, to behave differently for the
whole month of January.

1326
45 Calendars
45.3.3 Calculated Calendar Events

You can include a calculated date on a date list. A calculated date has no set start
and stop date. For example, you use a calculated date to schedule the first week of
the even months on a Friday.

1327
45 Calendars
45.4 Creating a Calendar

You create a calendar to specify exception dates, date ranges, or calculated dates.
Then you only reference the calendar to the each of the schedules. This way you
specify all the exception dates only one time.
To create a calendar
you want to create the calendar.
3. In the object type list, select Calendar.
4. In the Name box, type a name for the calendar.


1328
45 Calendars
5. In the Description box, type a description for the calendar.
6. Click Create.
Now you can add dates, date ranges, or calculated dates to the calendar.

1329
45 Calendars
45.5 Adding a Date Calendar Event

You add a date to a calendar to specify an exception date for a specific day, such
as 7 May, 2013.
To add a date calendar event

1. In WorkStation, in the System Tree pane, select the calendar you want to
add the exception to.
2. Click the Calendar Editor tab.
3. On the Calendar Editor toolbar, click the Add Date button .

4. In the Entry name box, type the name that you want to display on the date
list.
5. In the Year box, select the year for the date.

6. In the Month box, select the month for the date.
7. In the Day of month box, select the day for the date.

1330
45 Calendars
8. In the Day of week box, select the weekday for the date.
9. Click OK.

1331
45 Calendars
45.6 Adding a Date Range Calendar Event

You add a date range to a calendar to specify two or more consecutive days with a
specific start and end date, such as 19 March to 23 March, 2013.
To add a date range calendar event

add the exception to.
3. On the Calendar Editor toolbar, click the Add Date Range button .
list.
5. In the Start year box, select the year for the start date.
6. In the Start month box, select the month for the start date.
7. In the Day of month box, select the day for the start date.
8. In the Day of week box, select the weekday for the start date.
9. In the Year box, select the year for the end date.
10. In the Month box, select the month for the end date.
11. In the Day of month box, select the day for the end date.

1332
45 Calendars
12. In the Day of week box, select the weekday for the end date.
13. Click OK.


1333
45 Calendars
45.7 Adding a Calculated Date Calendar Event
45.7 Adding a Calculated Date Calendar

Event
You add a calculated date to specify a recurring event, such as Friday of the first
week of even months. Calculated dates are also used for events or holidays that do
not always fall on the same date each year.
To add a calculated date calendar event

1. In WorkStation, in the System Tree pane, select the calendar that you want
to add the exception dates to.
3. On the Calendar Editor toolbar, click the Add Calculated button .

list.
5. In the Month box, select a month for the calculated date.

6. In the Week of month box, select the week of month for the calculated date.

1334
45 Calendars
45.7 Adding a Calculated Date Calendar Event
7. In the Day of week box, select a weekday for the calculated date.
8. Click OK.

1335
45 Calendars
45.8 Configuring a Calendar as a Shadow
45.8 Configuring a Calendar as a Shadow

You configure a calendar as a shadow to synchronize it with a calendar that already
contains all exception dates, date ranges, or calculated dates, such as a holiday
calendar.
Note
• Schedules cannot refer to a calendar located on another Enterprise Server or
Automation Server. You need to create shadow calendars in all servers that
contain schedules that are to refer to the calendar.
on page 1344.
To configure a calendar as a shadow

configure as a shadow.
3. In the Lead object box, enter the calendar that you want to synchronize the
shadow calendar with.
4. Click OK.

1336
45 Calendars
45.9 Storing Expired Calendar Events
45.9 Storing Expired Calendar Events

You store expired events to keep an expired calendar event for future reference.
To store expired calendar events

1. In WorkStation, in the System Tree pane, select the calendar with the events
that you want to store.
2. In the File menu, click Properties.
3. In the Remove past events box, select False to store events after they
expire.

1337
45 Calendars
45.10 Editing a Date Calendar Event

You edit a date calendar to change the information about a calendar event.
To edit a date calendar event

edit.
3. In the date list, right-click the date calendar event you want to edit and click
Properties.

1338
45 Calendars
Entry name Type an entry name for the calendar entry.
month, Any month.
Day of month Select a value for the day of the month. You can use Any
Day and Last Day as valid entries.
Day of week Select a day of the week. Setting the value to Any Day
ensures consistency with the rest of the date specification,
this is the recommended setting.
5. Click OK.

1339
45 Calendars
45.11 Editing a Date Range Calendar Event

You edit a date range calendar to change the information about a calendar event.
To edit a date range calendar event

edit.
2. In Calendar Editor, select the date range calendar.
3. Right-click the date range calendar.


1340
45 Calendars
Start year Select a year. You can use Any year as a valid entry.
Start month Select a month for the exception event or Odd month, Even
month, Any month.
Day of month Select a value for the day of the month. You can use Any
Day and Last Day as valid entries.
month, Any month.
5. Click OK.

1341
45 Calendars
45.12 Editing a Calculated Date Calendar Event
45.12 Editing a Calculated Date Calendar

Event
You edit a calculated date calendar to change the information about a calendar
event.
To edit a calculated date calendar event

edit.
2. In Calendar Editor, select the calculated date calendar.
3. Right-click the calculated date calendar.


1342
45 Calendars
45.12 Editing a Calculated Date Calendar Event
month, Any month.
Week of month Select a week of the month for the exception event or First
week, Second week, Third week, Fourth week, Last
week, Any week.
5. Click OK.

1343
45 Calendars
45.13 Schedule and Calendar Synchronization
45.13 Schedule and Calendar Synchronization

For example, the building might require the same heating and lighting events on all
floors. Schedule A controls the events on the first floor, Schedule B on the second
floor, and Schedule C on the third floor. Using lead and shadow schedules, you can
configure one lead schedule, Schedule A, and reference it throughout the building
from Schedules B and C, the shadow schedules. When you create the shadow
schedule, you need to create the same schedule type as the lead schedule. For
example, if you want to create a shadow schedule and the lead schedule type is an
analog schedule, you need to create an analog shadow schedule.
Figure: Lead and shadow schedules

You use a lead schedule somewhat like a template. To change a property within the
shadow schedules, you make the change within the lead schedule. The changes
are then reflected in all of the shadow schedules. Only certain properties of the lead
schedule, however, are copied into the shadow schedule depending on the
property type. Some properties in a lead schedule, such as name and description,
are unique to the lead schedule and are not duplicated in the shadow schedule.
Other properties that are not specific to the lead schedule, such as effective period,
are always duplicated in the shadow schedule. These principles apply to lead
calendars and shadow calendars as well.
Building Operation supports lead and shadow schedules where exception events,
weekly events, and other configuration properties are duplicated in the shadow
schedules.
Building Operation also supports lead and shadow calendars where the date list is
duplicated in the shadow calendars.

1344
46 Schedules User Interface
Topics
Schedule Editor – Basic View
Basic Schedule Editor Toolbar
Advanced Schedule Editor – Graphic View
Advanced Schedule Editor Toolbar
Edit Effective Period Dialog Box
Edit Exception Dialog Box
Edit Time Value Period Dialog Box
Snap To Menu
Show Client Time Zone
Schedule Properties – Basic Tab
Schedule Event Properties Dialog Box – Weekly View
Schedule Event Properties Dialog Box – Single Date
Exception View
Schedule Event Properties Dialog Box – Date Range
Exception View
Schedule Event Properties Dialog Box – Calculated
Exception View
Schedule Event Properties Dialog Box – Calendar
Reference View
Calendar Editor View
Calendar Editor Toolbar
Calendar Properties – Basic Tab
Edit Calendar Entry Dialog Box – Add Date
Edit Calendar Entry Dialog Box – Date Range
Edit Calendar Entry Dialog Box – Calculated Date
46.1 Schedule Editor – Basic View
46.1 Schedule Editor – Basic View

Use the Basic view to create weekly and exception events for a schedule.
Figure: Basic Schedule Editor
Table: Basic Schedule Editor

Number Description
Calendar view
Displays the calendar with exception events in blue.
Schedule Events toggle

Displays either the combined (Weekly and Exception) events view or Weekly
events view.
Basic View toolbar

Displays the toolbar to manage schedules.
Event grid
Displays weekly and exception events in Graphic view.

1347
46.2 Basic Schedule Editor Toolbar
46.2 Basic Schedule Editor Toolbar

Use the Basic Schedule Editor toolbar to manage schedules.
Table: Basic Schedule Editor Toolbar

Button Description
New schedule event

Click to create a new schedule event.
Edit schedule events

Click to edit a selected event.
Delete
Click to delete events in the schedule.
View all schedule events

Click to display weekly and exception events for the selected week.
View weekly schedule events

Click to display weekly events.

1348
46.3 Advanced Schedule Editor – Graphic View
46.3 Advanced Schedule Editor – Graphic

View
Use the Graphic view to graphically display the scheduled events.
Figure: Advanced Schedule Editor – Graphic View
Table: Advanced Schedule Editor – Graphic View

Number Description
Advanced view toolbar

Click the buttons to manage schedules. For more information, see section
46.4 “Advanced Schedule Editor Toolbar ” on page 1350.
Schedule event tree

Displays weekly and exception events.
Client and server time bar

Displays the client time and the server time.
Time value periods

Displays the beginning and end times and the values associated with the
scheduled events.
Calendar overview
Displays in blue the dates that contain exception events.

1349
46.4 Advanced Schedule Editor Toolbar
46.4 Advanced Schedule Editor Toolbar

Use the Advanced Schedule Editor toolbar to manage schedules.
Table: Advanced Schedule Editor Toolbar

Icon Description
Edit Schedule
Click to enter edit mode.
Preview Events
Click to display all the configured events for a selected day.
Add Special Event

Click to insert exception events into a schedule.
Delete
Graphic View
Click to configure events in graphic mode.
Text View
Click to configure events in the textual mode.

1350
46.5 Edit Effective Period Dialog Box
46.5 Edit Effective Period Dialog Box

Use the Edit Effective Period dialog box to select the start and end dates of the
effective period, or to leave the default values so the schedule is always within the
effective period.
Figure: Edit Effective Period dialog box
Table: Edit Effective Period Dialog Box

Start year Select the year that the effective period begins.
Start month Select the month that the effective period begins.
Day of month Select a value for the day of the month. You can use Any Day and Last
Day as valid entries.
Month Select a month for the exception event or Odd month, Even month,
Any month.

1351
46.6 Edit Exception Dialog Box
46.6 Edit Exception Dialog Box

Use the Edit Exception dialog box to add or edit an exception event in the
Advanced Schedule Editor.
Figure: Edit Exception dialog box
Table: Edit Exception Dialog Box

Exception name Type a name for the exception event.
Exception Select a priority for the exception event. Valid values are from 1-16, 1
priority being the highest priority.
Period type Select a time category to associate with the schedule event.
Period object Enter the event associated with the period type.

1352
46.7 Edit Time Value Period Dialog Box
46.7 Edit Time Value Period Dialog Box

Use the Edit Time Value Period dialog box to modify weekly or exception events
in the Advanced Schedule Editor.
Figure: Edit Time Value Period dialog box
Table: Edit Time Value Period Dialog Box


1353
46.8 Snap To Menu
46.8 Snap To Menu

Use the Snap To menu to select the time increments to display in the Advanced
Schedule Editor when dragging a time value bar from the start to end time. The
default time increment is 15 minutes.
Figure: Snap To menu

1354
46.9 Show Client Time Zone
46.9 Show Client Time Zone

Use Show client time zone to toggle between displaying the client time zone in
addition to the server time zone in the Advanced Schedule Editor.
Figure: Show Client Time Zone

1355
46.10 Schedule Properties – Basic Tab

Use the Basic tab to display general and status information about the schedule. On
this tab, you can reference a lead schedule so you can reuse the events configured
in the lead schedule in several shadow schedules.
Figure: Basic tab
Table: Basic Tab

Previous transition time Displays the date and time the value most
recently changed.
Time since previous transition (min) 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.
Next transition time Displays the date and time the value will
change.

1356
Continued
Time to next transition (min) 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 (min) 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.
Lead object Select a lead schedule to reference.

1357
46.11 Schedule Event Properties Dialog Box – Weekly View
46.11 Schedule Event Properties Dialog Box –

Weekly View
Use the Weekly View in the Schedule Event Properties dialog box in the
Basic Schedule Editor to create a new weekly event for an existing schedule.
Figure: Schedule Event Properties dialog box - weekly view
Table: Schedule Event Properties Dialog Box – Weekly View

Event type Click Weekly to select a weekly event type.
Days of week Select the days of the week that apply to this
schedule.
All day Select All Day for an all day event.
Add Entry Click to add a line to the Times and values

box.

1358
46.11 Schedule Event Properties Dialog Box – Weekly View
Continued
Delete Entry Click to delete an entry from the Times and

values box.

1359

Single Date Exception View
Use the Single Date Exception view in the Schedule Event Properties
dialog box to schedule a single date exception.
Figure: Schedule Event Properties dialog box - Single date exception view
Table: Schedule Event Properties Dialog Box – Single Date Exception View
Event type Click Exception to display the exception

types.

1360
Continued
Exception type Select Single date for the exception type to

apply to the schedule.

box.

values box.
Name Type a name for the exception event.
Priority Select a priority number between 1 (highest

priority) and 16 (lowest priority).
Year Select a year. You can use Any year as a

valid entry.
Month Select a month for the exception event or

Odd month, Even month, Any month.
Day of month Select a value for the day of the month. You
can use Any Day and Last Day as valid
entries.
Day of week Select a day of the week. Setting the value to

Any Day ensures consistency with the rest
of the date specification, this is the

1361

Date Range Exception View
Use the Date Range Exception view in the Schedule Event Properties
dialog box to schedule a date range exception.
Figure: Schedule Event Properties dialog box - Date range exception view
Table: Schedule Event Properties Dialog Box – Date Range Exception View

types.

1362
Continued
Exception type Select Date range as an exception type to


box.

values box.

Year Select a year. You can use Any year as a

valid entry.

Day of month Select a value for the day of the month. You
can use Any Day and Last Day as valid
entries.


1363
46.14 Schedule Event Properties Dialog Box – Calculated Exception View

Calculated Exception View
Use the Calculated Exception view in the Schedule Event Properties dialog
box to schedule recurring exceptions.
Figure: Schedule Event Properties dialog box - Calculated exception view
Table: Schedule Event Properties Dialog Box – Calculated Exception View


types.

1364
46.14 Schedule Event Properties Dialog Box – Calculated Exception View
Continued
Exception type Select Calculated for an exception type to


Year Displays Any Year which is the default for

the calculated exception view.

Week of month Select a week of the month for the exception

event or First week, Second week,
Third week, Fourth week, Last week,
Any week.


1365

Calendar Reference View
Use the Calendar Reference view in the Schedule Event Properties dialog
box to reference a calendar to apply to your schedule.
Figure: Schedule Event Properties dialog box - Calendar reference view
Table: Schedule Event Properties Dialog Box – Calendar Reference View


types.

1366
Continued
Exception type Select Calendar to initiate a calendar

reference.

Calendar Select a calendar to reference.

1367
46.16 Calendar Editor View
46.16 Calendar Editor View

Use the Calendar Editor view to manage the calendar events for the calendar.
Figure: Calendar Editor view
Table: Calendar Editor View

Number Description
Click to expand the list of calendar events that are included in the calendar.
Use the Calendar Editor toolbar to add and delete calendar events. For more
information, see section 46.17 “Calendar Editor Toolbar” on page 1369.
Select the year you want the calendar to display.
Click to scroll the calendar one month at the time.
Displays the calendar for the selected twelve-month period with the dates for
the calendar events shown in blue. For more information, see section 45.1
“Calendar Editor Overview” on page 1323.

1368
46.17 Calendar Editor Toolbar
46.17 Calendar Editor Toolbar

Use the Calendar Editor toolbar to manage calendars.
Table: Calendar Editor Toolbar

Button Description
Add Date
Click to add an event that occurs on a single day. For more information, see
section 46.19 “Edit Calendar Entry Dialog Box – Add Date” on page 1371.
Add Date Range

Click to add an event that contains a date range. For more information, see
section 46.20 “Edit Calendar Entry Dialog Box – Date Range ” on page
1372.
Add Calculated Date

Click to add an event that recurs on a regular basis. For more information,
see section 46.21 “Edit Calendar Entry Dialog Box – Calculated Date ” on
page 1373.
Delete

1369
46.18 Calendar Properties – Basic Tab
46.18 Calendar Properties – Basic Tab

Use the Basic tab to display general and status information about the calendar. On
this tab, you can reference a lead calendar so you can reuse the events configured
in the lead calendar in several shadow calendars.
Figure: Basic tab
Table: Basic Tab

Value Displays True when the current date

matches the date specified in the calendar
entry in the Date List.
Remove past events Select True if you want to delete calendar

entries that no longer impact a calendar.
Lead object Select a lead calendar if you are creating a

shadow calendar.

1370
46.19 Edit Calendar Entry Dialog Box – Add Date
46.19 Edit Calendar Entry Dialog Box – Add

Date
Use the Edit Calendar Entry dialog box to configure a calendar entry for a single
date exception event.
Figure: Edit Calendar Entry dialog box - add date
Table: Edit Calendar Entry Dialog Box – Add Date

Year Select a Year for the date calendar entry. You can also use Any Year
as a valid entry.
Any month.
Day of month Select a value for the day of the month. You can use Any Day and
Last Day as valid entries.

1371
46.20 Edit Calendar Entry Dialog Box – Date Range
46.20 Edit Calendar Entry Dialog Box – Date

Range
Use the Edit Calendar Entry dialog box to configure a date range calendar entry
for an exception event.
Figure: Edit Calendar Entry dialog box - date range
Table: Edit Calendar Entry Dialog Box – Date Range

Start year Select a year. You can use Any year as a valid entry.
Start month Select a month for the exception event or Odd month, Even month,
Any month.
Day of month Select a value for the day of the month. You can use Any Day and
Last Day as valid entries.
Any month.

1372
46.21 Edit Calendar Entry Dialog Box – Calculated Date
46.21 Edit Calendar Entry Dialog Box –

Calculated Date
Use the Edit Calendar Entry dialog box to create a calendar entry for a recurring
exception event.
Figure: Edit Calendar Entry dialog box - calculated date
Table: Edit Calendar Entry Dialog Box – Calculated Date

Any month.
Week of month Select a week of the month for the exception event or First week,
Second week, Third week, Fourth week, Last week, Any
week.

1373
47 WorkStation
Topics
WorkStation
System Tree Pane
List View
Control Panel
Opening Control Panel
Quick Filter
Hyperlinks
Creating a Hyperlink
Utilities
47 WorkStation
47.1 WorkStation
47.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
10.6 “Licenses” on page 205.
Figure: WorkStation and Building Operation Server
47.1.1 Flexible Workspace

In WorkStation, you can optimize the workspace for every user. For example in a
big building complex, the janitor of Building A might only see Building A and the
associated alarms and trend logs, not the whole complex.
On the other hand, the administrators workspace lets them supervise all buildings in
the complex, their alarms and trend logs on the site.

1377
47 WorkStation
47.1 WorkStation
Figure: Different workspaces in WorkStation
47.1.2 User rights

The user rights in WorkStation are used to control what every user might do in the
system. Some users can view a trend log but not change the presentation. Others
users can change everything in a trend log, including values, and even create a new
trend log.

1378
47 WorkStation
47.2 System Tree Pane

The System Tree pane displays the tree structure of the system, depending upon
user rights or configuration. In System Tree pane you can view and create, delete,
copy, rename, and move objects. The System Tree can be collapsed and/or
filtered.
Figure: System Tree pane in WorkStation
Filtering in the System Tree Pane

You can choose to show or hide the presentation objects using the filter in the
System Tree pane.
The following objects are categorized as presentation objects:
• Folders
• Graphics
• Panels
• Trend Log Lists
• Trend Charts
• Schedules
• Calendars
• Alarm viewers
• Event viewers
• Saved Searches
• Servers
• Remote Servers
• Networks
• Field Devices
• Reports

1379
47 WorkStation
All other objects are non-presentation objects.

1380
47 WorkStation
47.3 List View
47.3 List View

You can use the List View to navigate the system. You can also rename, copy,
and paste objects in the List View. Using the Quick filter, you can easily filter objects
in the list.
The List View is displayed in the work area in WorkStation.
Figure: The List View of a folder

The List View reflects the content and properties of the selected object. Therefore,
the List View looks different and contains different tabs depending on the object.
Figure: The List View of a server object

You can group and sort the objects in the List View using the Group and sort
function. You can add or remove columns in the List View.

1381
47 WorkStation
47.4 Control Panel
47.4 Control Panel

The Control Panel gives you easy access to some of the common functions in
Building Operation.
To get back to the Control Panel when you have entered any of the functions, click
the Back button on the navigation toolbar.
Figure: Control Panel

1382
47 WorkStation
47.5 Opening Control Panel
47.5 Opening Control Panel

You use Control Panel to get easy access to some of the most used functions in
Building Operation.
For more information, see section 47.4 “Control Panel” on page 1382.
To open Control Panel


1383
47 WorkStation
47.6 Quick Filter
47.6 Quick Filter

You use Quick filter to filter out the objects by its name from the list by typing in the
Quick filter box. For example, if you want to find all objects that are named
“temperature”, just type “temp” in the Quick filter box and only objects named
temperature are displayed in the list.
Figure: Filtering on characters in all visible columns

The Quick filter filters on everything that is visible in the columns in the List View. For
example, if you filter on “2” you do not get any hits. But if you add the columns Note
1 and value you get hits on the temperature, which is 21, the setpoint which is 20,
and the Note that the program controlling the fan is a model 22.

1384
47 WorkStation
47.6 Quick Filter
Figure: Quick filter filters on all visible columns in the view

Quick filter is used in the following components in WorkStation:
• List View
• Alarms pane
• Alarm views
• Events pane
• Event views
• Alarm or Event details view
• Watch pane
• Add/Remove columns dialog box
• Create object wizard

1385
47 WorkStation
47.6 Quick Filter
Figure: The Quick filter is used in, for example, the List View (upper right), in the Watch
pane (bottom left), and in the Add/Remove dialog box (center right).

1386
47 WorkStation
47.7 Hyperlinks
47.7 Hyperlinks
Building Operation supports hyperlinks. Hyperlinks can be added and displayed in
WorkStation. Hyperlinks can also be added in, for example, a graphic that is
displayed in WorkStation. In WorkStation, you can navigate on the web page in
same way as in a web browser.
Building Operation uses Microsoft Internet Explorer to present web pages. Plug-ins,
for example Flash and Java, have to be installed to be able to correctly display
pages that use these plug-ins.
Figure: Building Operation supports hyperlinks

1387
47 WorkStation
47.8 Creating a Hyperlink

You create a hyperlink in WorkStation to get easy access to important information
on the Internet.
For more information, see section 47.7 “Hyperlinks” on page 1387.
To create a hyperlink
1. In WorkStation, in the System Tree pane, select the server or folder where
you want to create the hyperlink.
2. On the File menu, point to New and then click Hyperlink.
3. In the Name box, type a name for the hyperlink.
4. In the Description box, type a description for the hyperlink.

5. Click Next.

1388
47 WorkStation
6. In the URL box, type the URL for the hyperlink.
7. Click Create.

1389
47 WorkStation
47.9 Utilities
47.9 Utilities
Building Operation is equipped with two types of utilities, Signal Generators and
Simple Math Operators. The utilities are used for testing, for example, trend logs
and alarms.
47.9.1 Signal Generator

Signal Generator is used to create a sinus, square or saw tooth curve. Signal
generator can also be used to generate a setpoint, an alarm or an event.
47.9.2 Simple Math Operators

Simple Math Operator is used to add, subtract, multiply and divide a one value from
another.

1390
48 Building Operation Objects
Topics
Object Types
Object Names
Object Properties
Opening an Object in a New Window
Object Tab Display
Showing the Same Tab While Navigating Between Objects
Showing Non-Presentation Objects in the System Tree Pane
Multi-edit
Editing Multiple Objects
Move, Copy, Paste, Rename, and Delete
Deleting an Object
Renaming a Folder or Object
Creating a Folder
Copying a Folder or Object
Viewing Related Trends
48.1 Object Types
48.1 Object Types

The Building Operation database is based on objects. Some objects are created
when the database in installed, others are created by the engineer. Depending on
the object type and your permission, you can configure objects in a many different
way.
Objects that are relevant for the user are presented in the System Tree pane and in
the List View. To ease recognition of objects, every object type is represented by an
icon.

1393
48.2 Object Names
48.2 Object Names

All objects in the Building Operation database has to have a name. Building
Operation is case-sensitive and differentiates between upper and lowercase
characters. Two objects cannot be named in the same way in the same folder even
if the objects are of different types. For example, you cannot create an alarm
named Building A and a graphic named Building A in the same folder. However, if
you name the graphic Building a, with a lowercase a, you can create it in the same
folder as the alarm object Building A.
The following characters are not allowed in object names in Building Operation.
• /
• "
• ?
• *
• ~
• White space is not allowed in the beginning or the end of an objects name.
• . (period) is not allowed in the beginning of an objects name.
There is no limitation of how many characters an object name can have. However,
some field devices retain their character limitations when they are added to Building
Operation database.

1394
48.3 Object Properties

Every object in Building Operation has a lot of different properties. There are three
ways to access the properties of a selected object in WorkStation:
• Properties tab
• Properties Dialog box
• Properties grid
All three methods displays the same properties.
Figure: The Properties tab for a trend log.

Properties can be of two different types: read only and read/write. Read only
properties are dimmed and cannot be changed. Read/write properties can be
changed by the operator.

1395
The properties are sorted under different tabs in the properties tab/dialog/grid. The
number of tabs depends on the object. Some object have a lot of properties and
tabs, others have only one tab with only a few properties.
Figure: A server object with three properties tabs (left) and a value with only the basic
properties tab.
A common tab for all objects is the Basic properties tab that contains general
properties as type, name and description.

1396
48.4 Opening an Object in a New Window
48.4 Opening an Object in a New Window

You open an object in a new window to be able to display two or more objects at
the same time.
For more information, see the Window Menu topic on WebHelp.
To open an object in a new window

1. In WorkStation, in the System Tree pane, right-click the object you want to
open in the new window, and then click Open in new window.

1397
48.5 Object Tab Display
48.5 Object Tab Display

You can make WorkStation open the same tab each time you navigate between
objects.
For example, you want to check all alarm messages in your alarms. The default
behavior in WorkStation is that the Basic Settings tab is displayed whenever you
click on an alarm object. You can have the system display the Presentation tab of
the Alarm object every time you click on an Alarm object.

1398
48.6 Showing the Same Tab While Navigating Between Objects
48.6 Showing the Same Tab While

Navigating Between Objects
You have the system open the same tab whenever you open a new object to make
it easier to view the same properties of the objects.
For more information, see section 48.6 “Showing the Same Tab While Navigating
Between Objects” on page 1399.
To show the same tab while navigating between objects

1. In WorkStation, on the Tools menu, click Options.
2. Select Show same tab while navigating between objects.
3. Click OK.

1399
48.7 Showing Non-Presentation Objects in the System Tree Pane
48.7 Showing Non-Presentation Objects in

the System Tree Pane
You use the Show non-presentation object filter if you want to display non-
presentation objects in the System Tree pane. Typical non-presentation objects are
Plain English programs and Function Block programs, values, and alarms.
For more information, see section 47.2 “System Tree Pane” on page 1379.
To show non-presentation objects in the System Tree pane

1. In the System Tree pane, click the Filter button.
2. Select Show non-presentation objects.

1400
48.8 Multi-edit
48.8 Multi-edit
Use Multi-edit when you want to change a lot of property values at the same time.
For example, you want to change all setpoints from 22 to 20. You select all the
objects in the List View, open the Properties grid, and then change the value in the
Value box. After you click Save, the changes take effect.
Figure: Multi–editing
The objects do not need to be of the same type to be edited. However, the
properties you want to edit have to be of the same type.

1401
48.9 Editing Multiple Objects
48.9 Editing Multiple Objects

You can edit more than one object at the same time to save time.
For more information, see section 48.8 “Multi-edit” on page 1401.
To edit multiple objects

1. In WorkStation, in the List View, select the objects you want to edit.
2. On the List View toolbar, click Show/Hide Property Grid.
3. In the Property Grid, edit the property you want to change for all selected
objects.

1402
48.10 Move, Copy, Paste, Rename, and Delete
48.10 Move, Copy, Paste, Rename, and Delete

You can move, copy, paste, rename, and delete objects from the Building
Operation database at any time. To help you identify the object references that are
affected when you delete an object, Building Operation displays a dialog box with
information about references.
Move
Move does not affect the references. When you move an object, that object still
references the same objects it referenced before you moved it. Objects referring to
a moved object still refer to the same object after the move. Object cannot be
moved between servers however.
Paste
Paste removes all external references that are relative but keeps absolute and
locked references.
Paste Special
Paste Special does the same thing as Paste but with the added benefit of keeping
all of the external references.
Rename
Objects that are referring to each other do not lose their references if you change
the name of an object. Building Operation automatically updates any references
after you have renamed an object.
Delete
When deleting an object, you can select to keep the reference in other objects to
the object you want to delete. You can then add a new object with the same name
on the same location and all references are valid. This can be used if you, for
example want to replace an analog value with a digital value or a multistate value.
Offline
If some of the objects are offline during a rename or delete, the system cannot
update the references. In this case, the system informs you of the references that
cannot be updated. You can still complete the procedure, but you have to keep
track of the reference that are not updated. You can repair the references when the
offline object is online again.
Note
When changing the name of a folder or server, you also have to reconfigure users
and user groups path permissions to this server or folder. For more information,
see section 22.4 “Path Permissions” on page 464.

1403
48.11 Deleting an Object
48.11 Deleting an Object

You delete unused objects from the database to get rid of unused objects or
objects you do not want.
For more information, see section 48.10 “Move, Copy, Paste, Rename, and Delete”
on page 1403.
To delete an object
1. In WorkStation, in the System Tree pane, select the object you want to
delete.
2. On the Edit menu, click Delete.
3. Select if you want to keep references in other object(s) to the object you
selected to delete.
4. Click Show references to see the affected references.

1404
48.12 Renaming a Folder or Object
48.12 Renaming a Folder or Object

You rename a folder or object to make the name more suitable to your needs.
Note
When changing the name of a folder or server, you also have to reconfigure users
and user groups path permissions to this server or folder. For more information,
see section 22.4 “Path Permissions” on page 464.
Note
You cannot change the name of a domain that is shared between servers.
For more information, see section 48.10 “Move, Copy, Paste, Rename, and Delete”
on page 1403.
To rename a folder or object

1. In WorkStation, in the System Tree pane, select the folder or object you
want to rename.
2. On the Edit menu, click Rename.
3. In the Rename object dialog box, type the new name.
4. Click OK.

1405
48.13 Creating a Folder
48.13 Creating a Folder

You create folders to organize your Building Operation database.
For more information, see the Xenta LonWorks Groups topic on WebHelp.
To create a folder
1. In WorkStation, in the System Tree pane, select the folder, server, or
network where you want to create the folder.
2. On the File menu, point to New and then click Folder.
3. In the Name box, type a name for the folder.
4. In the Description box, type a description for the folder.

5. Click Create.

1406
48.14 Copying a Folder or Object
48.14 Copying a Folder or Object

You copy a folder or object when you quickly want to create a new folder or object.
To copy a folder or object

1. In WorkStation, in the System Tree pane, select the folder or object you
want to copy.
2. On the Edit menu, click Copy.
3. In the System Tree pane, select the folder where you want to paste the
copied folder or object.
4. On the Edit menu, click Paste.

1407
48.15 Viewing Related Trends
48.15 Viewing Related Trends

You can view the trend objects related to a selected object.
To view related trends

1. In WorkStation, in the System Tree pane, select the object for which you
want to view
related alarms and trends.
2. On the Action menu, point to View and then click Trends.
3. In the Trends dialog, select the object you want to view.
4. Click Open.
The selected object opens in the workarea in WorkStation.

1408
49 Archive
Topics
Archiving Overview
Archiving Server Compatibility
Enabling the Archiving Function and Defining the Archive
Folder
Archive Directory Does Not Exist
Archiving Formats and Storage
Manual and Scheduled Archiving
Manually Creating an Archive
Creating a Scheduled Archive
Removing Extended Trend Logs from the Archive
Removing Events from the Archive
Archive Folders, Files, and Names
Archive Log Contents
Event and Alarm Enumerations
System Alarm ID Enumerations
System Event ID Enumerations
Trend Log Enumerations
System Alarms For Archiving
49 Archive
49.1 Archiving Overview

Archiving is a function of an Enterprise Server. Therefore, you cannot archive data
on a standalone Automation Server. However, you can archive trend logs and
extended trend logs created on an Automation Server that are monitored by
extended trend logs created on an Enterprise Server.
Figure: Archiving overview
Important
The Enterprise Server Windows service runs under the System account of the
local machine where the Enterprise Server is installed. If you plan to save the
archive files to a network drive, make sure that the System account is given write
access to this drive to ensure that the archive process can validate the path and
then save the files to that location.
49.1.1 Archive Log Files

The system archives historical data into two types of log files:
• Event logs: All the selected alarm, user activity, and system events are archived
into one file.

1411
49 Archive
• Extended trend logs: The system archives data collected from selected
extended trend logs created on the Enterprise Server.
49.1.2 Archiving Formats and Storage

You generate an archive by selecting either a CSV or XML format. You can store the
archive in the default location or define a different location.
For more information, see section 49.5 “Archiving Formats and Storage” on page
1417.
49.1.3 Archive Folders, Files, and Names

The archving process creates uniquely named folders to identify the type of archive
(manual or scheduled) and the date on which the archive was performed. Each
folder includes the log files that were archived on that date.
For more information, see section 49.11 “Archive Folders, Files, and Names” on
page 1427.
49.1.4 Archiving Server Compatibility

You can configure archiving on an Enterprise Server.
For more information, see section 49.2 “Archiving Server Compatibility” on page
1414.
49.1.5 System Alarms for Archiving

There are several default system alarms for archiving.
For more information, see section 49.17 “System Alarms For Archiving” on page
1456.

1412
49 Archive
49.1.6 Manual and Scheduled Archiving

You can archive data as needed using manual methods or at predefined intervals
using a schedule.
For more information, see section 49.6 “Manual and Scheduled Archiving” on page
1418.

1413
49 Archive
49.2 Archiving Server Compatibility
49.2 Archiving Server Compatibility

You can configure archiving on an Enterprise Server.
The following table lists the servers that support archiving capabilities.
Table: Archiving and Server Compatibility Matrix

Server Runtime Description
Archiving?
Enterprise Yes You can configure and manage archiving on an

Server Enterprise Server.
Automation No You cannot configure or initiate archiving on this type

Server of server. The system only archives data from trend
logs or extended trend logs on Automation Servers
that are monitored by extended trend logs on the
Enterprise Server.

1414
49 Archive
49.3 Enabling the Archiving Function and Defining the Archive Folder
49.3 Enabling the Archiving Function and

Defining the Archive Folder
Prior to generating an archive, you activate the archiving function and define a path
to a directory on the Enterprise Server where you want to store the archives.
To enable the archiving function and define the archive folder

1. In WorkStation, on the Tools menu, click Control Panel, and then click
Archiving.
2. Select Enabled.
3. In the Path box, type the path to the directory where you plan to store the
archive files.
4. Click Validate to confirm that the path is valid on the system.
A check mark displays if the system successfully validates the path.

You designate a different archive directory by typing a new location in the Path box
and then validating the path again.

1415
49 Archive
49.4 Archive Directory Does Not Exist
49.4 Archive Directory Does Not Exist

When you attempt to create an archive to a location that has not been created, has
been deleted, or was moved, the "Archive directory does not exist!" message is
displayed.
49.4.1 Solution
Ensure that the path to the archive folder is valid.

1416
49 Archive
49.5 Archiving Formats and Storage
49.5 Archiving Formats and Storage

You generate an archive by selecting either a CSV or XML format. You can store the
archive in the default location or define a different location.
Table: Comparison of Archiving Formats

Method Description
CSV Comma Separated Values is a standard text file that stores spreadsheet or
database information in a simple table format. Each record is on a separate
line and each field within that record is separated by a delimiter, such as a
comma.
XML Extensible Markup Language is a markup language that defines a set of

rules for formatting documents. Primarily, XML is used to structure,
transport, and store data rather than to display data.
49.5.1 Archive Storage and Validation

By default, the system stores archive files in the Archives folder located in Program
Data/Schneider Electric StruxureWare/Building Operation <version>/Enterprise
Server/db. You can define a different path to store the archives on your file system,
such as a network drive or external memory device. To ensure that the new location
is valid, you can prompt the system to validate the path. For more information, see
section 49.3 “Enabling the Archiving Function and Defining the Archive Folder” on
page 1415.

1417
49 Archive
49.6 Manual and Scheduled Archiving
49.6 Manual and Scheduled Archiving

You can archive data as needed using manual methods or at predefined intervals
using a schedule.
Table: Comparison of Archiving Methods

Method Benefits
Manual Performed on an as-needed basis, for example, prior to upgrading a

server. When a Manual Archive is created, the temporary archive data is
not deleted.
Scheduled Automatically generated by the system at regularly scheduled intervals.

When a Scheduled Archive completes, the temporary archive data is
deleted.
Scheduled archiving is an automated way of preserving historical data. For

convenience, the system provides a default digital schedule, which is bound to the
Archive Manager. You can modify, but not delete, this Archive schedule. For more
information, see section 49.1 “Archiving Overview” on page 1411.

1418
49 Archive
49.7 Manually Creating an Archive

You create an archive manually to preserve the historical data on an Enterprise
Server on an as-needed basis, such as before a system upgrade.
1418.
To manually create an archive

Archiving.
2. Under Archive Settings, click Enabled.
3. Select the events that you want to include in the archive:

• Alarm Events. Select to include high priority or off-normal events
(providing the alarms are pre-configured and active on the system.)
• User Events. Select to include user-initiated events, such as value
overrides or configuration changes.
• System Events. Select to include device-initiated events, such as time
stamps.
4. Click the Add extended trend logs button to add extended trend logs
to the archive.

1419
49 Archive
5. In the Include column, select the extended trend logs and click OK.
6. In the Output Type box, select the format you want to use for the archive:
• CSV. This output generates data separated by a delimiter.
• XML. This output generates data using a standard internet protocol.
7. In the Path box, type the path to an existing folder or server where you want
to store the archive files.

1420
49 Archive

10. Click Archive Now.
The archive is saved to the specified path.

1421
49 Archive
49.8 Creating a Scheduled Archive

You configure the Archive settings and schedule on the Enterprise Server to
automate the archiving process.
1418.
To create a scheduled archive

1. In WorkStation, on the Tools menu, click Control Panel and then click
Archiving.
2. Under Archive Settings, click Enabled.
3. Select the events that you want to include in the archive:

• Alarm Events: Select to include high priority or off-normal events
(providing the alarms are pre-configured and active on the system).
• User Events: Select to include user-initiated events, such as value
overrides or configuration changes.
• System Events: Select to include device-initiated events, such as time
stamps.
4. Click the Add extended trend logs button to add extended trend logs
to the archive.

1422
49 Archive
5. In the Include column, select the extended trend logs and click OK.
6. Under Archive Schedule, click Schedule to create recurring exception and

calendar events.
7. In the Output Type box, select the format you want to use for the archive:
• CSV: This output generates data separated by a delimiter.
• XML: This output generates data using a standard internet protocol.
8. In the Path box, type the path to an existing folder or server where you want
to store the archive files.

1423
49 Archive
10. When finished, click the Save button .

1424
49 Archive
49.9 Removing Extended Trend Logs from the Archive
49.9 Removing Extended Trend Logs from

the Archive
You remove extended trend logs that you do not want to include in the archive.
To remove extended trend logs from the archive

Archiving.
2. Select the extended trend logs that you want to remove from the archive and
click the Remove extended trend logs button .

1425
49 Archive
49.10 Removing Events from the Archive
49.10 Removing Events from the Archive

You remove events that you do not want to include in the archive, such as User
Events.
To remove events from the archive

Archiving.
2. Clear the events that you want to remove from the archive.

1426
49 Archive
49.11 Archive Folders, Files, and Names

As part of the archive process, the system creates uniquely named archive files and
folders that identify the type of archive (manual or scheduled) and the date on which
the archive was performed.
Figure: Archives folder on Enterprise Server

By default, these folders are located in the Archives directory where the Enterprise
Server is installed. However, you can change the directory to another valid location.
49.11.1 Archive Folder Names

During the archive process, the system creates a new folder in the path specified in
the Archive Settings Manager. The system generates and then places the CSV or
XML files within this folder. To prevent accidental overwriting, the system uses the
Method_date.file extension format, which makes the folder name unique. For
example, if you manually generate an archive on April 11, 2012, the system creates
a folder named Manual_Archive20120411 (yyyymmdd). If you generate an archive
the following day, the system creates a new folder with the new date.
49.11.2 Archive System Resource Files

When archiving is enabled, the system creates resource files that collect the data
from the selected extended trend logs prior to archiving. The system names the files
using random hexadecimal characters, such as a2d9e877, and then places them in
the path specified in the Archive Settings Manager. These files should not be
deleted.

1427
49 Archive
49.11.3 File Names for Extended Trend Log Archives

The system names extended trend log archive files using the
Method_(Address)_date.file extension format. If you generate a manual archive in
CSV format for extended trend logs on on July 8, 2012, the system names the file,
Manual_Archive_(Server_1_<Extended_Trend_Log name>)_2012-07-01_2012-07-
08.csv.
49.11.4 File Names for Events Log Archives

The system names the event log archives using the Method_(EventLog)_date.file
extension format. If you manually generate an archive on April 11, 2012 for the
Alarm, User, and System events, the system names the archive file
Manual_Archive_(Server_1_System_Events_EventLog_EventRecords)_2012-04-
02_2012-04-11.csv.
49.11.5 Unique Archive File Names

If you generate more than one archive file on the same date, the system appends a
number to the end of each similarly named archive to ensure that the files are not
overwritten. For example, if you manually generate an archive named
Manual_(Server_1_System_Events_EventLog_EventRecords)_2012-04-02_2012-
04-11.csv and immediately generate another identical archive, the system names
the second archive,
Manual_(Server_1_System_Events_EventLog_EventRecords)_2012-04-02_2012-
04-11_1.csv. Using the appended number (_1), the system creates a unique name
for the second archive with the same method on the same date.
49.11.6 Archive Log Contents

You use a structured database editor to view archive information in rows and
columns, which may contain text strings, paths, identities, or enumeration values.
For more information, see section 49.12 “ Archive Log Contents” on page 1429.

1428
49 Archive
49.12 Archive Log Contents

You use a structured database editor to view archive information in rows and
columns, which may contain text strings, paths, identities, or enumeration values.
Figure: Archive data displayed in a spreadsheet editor
Note
The time stamps for each record in the archive file reflect the UTC rather than
local machine time.
49.12.1 Columns and Descriptions

The following table provides an overview of an archive file. The number and type of
columns that display varies with the log that is viewed. For example, trend logs have
a different set of column headers than event logs due to the data content.
Table: Archive Files – Column and Descriptions

Column Description
AcknowledgeTime Displays the time and date when the alarm was
acknowledged.
AlarmState Displays the present alarm state.
AlarmText Displays the alarm message that was added to the alarm.
AssignedState Displays the assigned state the alarm had.
AssignedToDomain Displays the domain to which the user or group was

assigned.
AssignedToName Displays the name of the user or group to which an alarm

was assigned.
AssignedToUniqueUserId Displays the unique ID of the user or group to which an

alarm was assigned.
BACnetEventType Displays the BACnet event that occurred within a BACnet

network.

1429
49 Archive
Continued
Column Description
BasicEvaluationState Displays the basic evaluation state of an alarm.
Category Displays the name of a category.
Command Displays the executed command.
Comment Displays the comment that was added to an alarm.
ControlDescr Displays the descriptive information about the I/NET

operator.
ControlSource Displays the initials of the controlling I/NET operator.
Count Displays the number of times the alarm has toggled

CWSId Displays the ID of the EcoStruxure Web Service (EWS)

object.
CWSSourceId Displays the ID of the EWS source object.
CWSSourceName Displays the name and path of the EWS source object.
Description Displays a brief summary of the major features or

characteristics.
DeviceName Displays the name of an I/NET device that generated the

event.
DisabledCause Displays the reason why the alarm was disabled, such as a
shunt variable.
DomainName Displays the domain to which a user belongs.
EditTime Displays the time when the
EndTime Displays the time when the
EndValue Displays the
EvaluationState Displays the present evaluation state of the alarm, such as

Upper limit alarm.
Event Displays an event that occurred within the network.
EventGUID Displays the unique identity of the event.
FirstName Displays the first name of the individual whose key/card

was used at the I/NET door point.
ForcedValue Displays the forced value events.
GroupName Displays the name of the cause note or action note group
the user edited.
Hidden Displays the visible status of an object, such as False.

1430
49 Archive
Continued
Column Description
InetAddr Displays the system address of the point, or station

address of the host or controller that generated the event.
IndivNdx Displays the number of the individual whose key/card was

used at the I/NET door point.
InetEventTypeId Displays the IDs of the I/NET event types generated by the
system.
ItemName Displays the name of the check list, cause note, or action
note group the user edited.
LastName Displays the last name of the individual whose key/card

was used at the I/NET door point.
LinkName Displays the name assigned to the link of the device from
which the event originated.
LogType Displays the
MaxValue Displays the
MessageText Displays the text of an I/NET action or dispatch message.

(Optional)
MeterConstant Displays the
MinValue Displays the
MonitoredValue Displays the path of the monitored variable.
MonitoredValueType Displays the type of monitored value that triggers an alarm,

such as Forced.
MonitoredVariable Displays the path of the monitored variable.
Note Displays the text entered into the Note 1 property.
OriginalSeqNo Displays the RefSeqNo collected from a trend log. This

number is only written on an extended trend log containing
records that were changed on the connected trend log.
OriginatedGUID Displays the unique identity of the source.
PreviousAlarmState Displays the previous alarm state.
Priority Displays the current priority of the alarm.
RefSeqNo Displays the unique sequence number of a record that has

been edited.
SEQNO Displays the sequence number of the record.
ServerOffline Displays the online/offline status of a server.
Source Displays the name and path of the source object.

1431
49 Archive
Continued
Column Description
SourceServer Displays the name and path of the source object.
StationName Displays the name assigned to the controller from which

the event originated.
StartTime Displays the
StartValue Displays the
Status Displays the
SystemAlarmId Displays the alarm ID generated by the system.
SystemEventId Displays the event ID generated by the system.
TenantNdx Displays the tenant number of the individual whose

TextField Displays the information entered into the Text property.
TimeStamp Displays the date and time when the record was
generated.
TriggeredTimestamp Displays the time and date an alarm went from normal
state to alarm state.
TYPE Displays the object type that defines the properties of the
object.
UniqueAlarmId Displays the unique alarm ID of an alarm.
UniqueUserId Displays the unique identity number of a user.
Unit Displays the selected unit of a value, such as °F

(Fahrenheit).
User Displays the user who generated the event.
UserName Displays the name of the user who generated the event.
Value Displays the
ValueAfter Displays the value of an object after it was changed.
ValueBefore Displays the value of an object before it was changed.
Zone Displays the I/NET security zone number associated with a

security event.
49.12.2 Event and Alarm Enumerations

An enumeration is a range of values representing a specific command or event.
For more information, see section 49.13 “Event and Alarm Enumerations” on page
1434.

1432
49 Archive
49.12.3 Trend Log Enumerations

Trend log properties use two enumeration values: Events and Status.
For more information, see section 49.16 “Trend Log Enumerations” on page 1454.

1433
49 Archive
49.13 Event and Alarm Enumerations

The following tables list the enumeration values for the supported alarm and event
properties.
49.13.1 Alarm State

The table lists the enumeration values for Alarm State.
Table: Alarm State

Enumeration Enumeration definition
value
0 Normal
1 Alarm
2 Acknowledged
3 Reset
4 Disabled
5 Fault
49.13.2 Assigned State

The table lists the enumeration values for Alarm State.
Table: Assigned State

value
0 Unassigned
1 Assigned
2 Accepted
49.13.3 BACnet Alarm Type

The table lists the enumeration values for BACnet Alarm Type.

1434
49 Archive
Table: BACnet Alarm Type

Value
0 Change of bitstring
1 Change of state
2 Change of value
3 Command failure
4 Floating limit
5 Out of range
6 Complex event type
8 Change of life safety
9 Extended
10 Buffer ready
11 Unsigned range
49.13.4 Basic Evaluation State

The table lists the enumeration values for Basic Evaluation State.
Table: Basic Evaluation State

value
0 False
1 True
49.13.5 Disabled Cause

The table lists the enumeration values for Disabled Cause.
Table: Disabled Cause

value
1 Shunt variable
2 User
4 System

1435
49 Archive
49.13.6 Evaluation State

The table lists the enumeration values for Evaluation State.
Table: Evaluation State

value
0 Normal
1 Off-normal alarm
2 Upper limit alarm
3 Lower limit alarm
4 Life safety alarm
5 Faulty alarm
49.13.7 Hidden
The table lists the enumeration values for Hidden.
Table: Hidden
value
0 False
1 True
49.13.8 Previous Alarm State

The table lists the enumeration values for Previous Alarm State.
Table: Previous Alarm State

value
0 Normal
1 Alarm
2 Acknowledged
3 Reset
4 Disabled
5 Fault

1436
49 Archive
49.13.9 System Alarm ID

The table lists the enumeration values for System Alarm ID. For more information,
see section 49.14 “System Alarm ID Enumerations” on page 1438.
49.13.10 System Event ID

The table lists the enumeration values for System Event ID. For more information,
see section 49.15 “System Event ID Enumerations” on page 1447.

1437
49 Archive
49.14 System Alarm ID Enumerations

The table lists the enumeration values for System Alarm ID. For more information,
see section 49.13 “Event and Alarm Enumerations” on page 1434.
Table: System Alarm ID

value
0 Server restarted
1 IO module offline
2 Server offline
4 E-mail service failed to connect to SMTP server
5 E-mail service failed to login to SMTP server
6 System cold start
7 System warm start
8 System factory reset
9 Device offline
a Signal alarm
b Cannot verify lead object status
c Duplicate of local network
d Duplicate network identifier
e Duplicate device identifier
f Invalid device identifier
10 Duplicate device address
11 Duplicate device name
12 Defective protocol implementation
13 BACnet did not start
14 Failed to create object
15 Failed to initialize references
16 Database update failed
17 A log sample was missed
18 A log data transfer was missed

1438
49 Archive
Continued
value
19 File I/O error
1a Server configuration error
1b Network offline
1c IP connection offline
1d Signal event
1e New application program
1f Parser failed
20 Unit is locked
21 Unit is unlocked
22 Logging started
23 Logging stopped
24 Log stopped because it is full
25 Log full
26 Not enough RAM memory for log
27 Too many log definitions
28 Error in log definition
29 Not enough flash memory for log
2a Log variable error
2b No valid Blueprint File
2c Unhandled buffer ready notification
2d Alarm signal trigger buffer full
2e Bad lead object reference
2f Bad lead object type
30 Shadow update failed
31 Unable to access lead object
32 Incorrect lead object back-reference
33 Unable to access shadow object
34 Server not restarted Backup in process

1439
49 Archive
Continued
value
25 Server not restarted Restore in process
36 Server not restarted Other
37 Failure retrieving backup set from remote server
38 Failure restoring server database
39 Failure backing up server database
3a E-mail service fail to send message
3b E-mail service configuration error
3c Port offline
3d Wrong alarm unit
3e BACnet server failure
3f Sigma system schedule executed
40 Subnet offline
41 Invalid device address
64 Invalid archive path
65 Archive path must be set to enable archiving
66 Archive directory does not exist! Retrying in 5 minutes!
67 Archive directory does not exist!
68 Can not enable archiving
69 Invalid archiving format
6a Archiving is not enabled
6b IO error when generating archive
6c IO error when writing to archive temporary
6d IO error, cannot write to archive directory!
6e IO error, cannot write to archive directory! Retrying in 5 minutes!
6f IO error, not enough space left in the archive directory!
70 IO error, not enough space left in the archive directory! Retrying in 5

minutes!
100 Communication failed

1440
49 Archive
Continued
value
101 Communication failed Configuration error
102 Communication failed Unexpected Server fullpath
103 Communication failed Unexpected Server type
104 Communication failed Authentication error
105 Communication failed Authorization error
106 Communication failed Domain is not available
107 Communication failed Hostname is invalid
108 Communication failed Version Mismatch
200 Task 1 CPU limit reached, disabling real time priority
201 Task 2 CPU limit reached, disabling real time priority
211 Email service no sender email address
212 Email service no recipient email address
213 Email service no sender and recipient email address
214 Task period extended
215 No file name set
216 Module type mismatch
217 Serial port in use
1f40 NETWORK 8000 message
1f41 NW8 Unrecognized command
1f42 NW8 Command failure
1f43 NW8 Leaves network event
1f44 NW8 Joins network event
1f45 NW8 ASD message
1f46 NW8 Leaves/joins network
1f4a NW8 Database initialized
1f4b NW8 ROM failure
1f4c NW8 RAM failure
1f4d NW8 Freeze error

1441
49 Archive
Continued
value
1f4e NW8 Database modified
1f4f NW8 Device warm reset
1f50 NW8 Device cold reset
1f51 NW8 AS1 diagnostic
1f52 NW8 AT1 diagnostic
1f54 NW8 UI diagnostic
1f55 NW8 UI1 diagnostic
1f5a NW8 UI6 diagnostic
1f5b NW8 UI7 diagnostic
1f5c NW8 UI8 diagnostic
1f5e NW8 Relay failure
1f5f NW8 Relay failure 01
1f60 NW8 Relay failure 02
1f6a NW8 Relay failure 12

1442
49 Archive
Continued
value
1f6b NW8 Relay failure 13
1f6c NW8 Relay failure 14
1f6d NW8 Relay failure 15
1f6e NW8 Relay failure 16

1443
49 Archive
Continued
value
1f90 NW8 Setpoint out of range
1f91 NW8 Duct temperature out of range
1f92 NW8 Zone temperature out of range
1f93 NW8 Device reset
1f94 NW8 Configuration error
1f95 NW8 Damper range error
1f96 NW8 Pressure error
1f97 NW8 EEprom memory error
1f98 NW8 Application modified
1f99 NW8 Missing changeover input
1f9a NW8 EEprom checksum error
1f9b NW8 Sensor input failure
1f9c NW8 System fault 32
1f9d NW8 No U-Link communication
1f9e NW8 Application error 1
1f9f NW8 Application error 2
1fa0 NW8 Application error 4
1fa4 NW8 Press sensor
1fa5 NW8 Duct temperature

1444
49 Archive
Continued
value
1fa6 NW8 Minimum flow potentiometer
1fa7 NW8 Maximum flow potentiometer
1fa8 NW8 Hot water potentiometer
1fa9 NW8 Induction auxilary potentiometer
1faa NW8 Space setpoint
1fab NW8 Space temperature
1faf NW8 Sensor failure GCS 01
1fc3 NW8 Sensor failure GCS 02
1fd7 NW8 Sensor failure GCS 03
1feb NW8 Sensor failure GCS 04
1fff NW8 Sensor failure GCS 05
2013 NW8 Sensor failure GCS 06
203b NW8 Sensor failure GCS 08
204f NW8 Sensor failure GCS 09
20b3 NW8 Sensor failure GCS 24
20c7 NW8 Sensor failure GCS 25
20db NW8 Sensor failure GCS 26
20ef NW8 Sensor failure GCS 27
2150 NW8 Sensor failure end

1445
49 Archive
Continued
value
2151 NW8 Leaves LCM network event
2152 NW8 Joins LCM network event
2153 NW8 Leaves/joins LCM network
2197 NETWORK 8000 message end
2198 CWS Method Error
2199 CWS Value Poll failed
219a CWS Alarm Poll failed
219b CWS Browse failed
219c CWS GetObject failed
219d CWS GetHistory failed
219e See gap after 0x200

1446
49 Archive
49.15 System Event ID Enumerations

The table lists the enumeration values for System Event ID. For more information,
see section 49.13 “Event and Alarm Enumerations” on page 1434.
Table: System Event ID

value
0 Server initialized
1 Server shutdown
2 User logged on
3 User logged off
4 Log on failed - account disabled
5 Log on failed - authentication
6 Log on failed - domain not found
7 Log on failed - domain controller unavailable
8 Log on failed - domain controller unavailable
9 Log on failed - no permissions
a Password changed
b Property changed
c Command executed
d IO module offline
e IO module online
f Object created
10 Object deleted
11 Objects imported
12 Objects deployed
13 Object moved
14 Object renamed
15 File notification sent
16 Email sent successfully
17 Object changed

1447
49 Archive
Continued
value
18 Log on failed - user not associated with a group
19 Server database backed up
1a Server database restored
1b Signal event
1c Forced value
1d New forced value
1e Unforce value
1f Log on failed - version mismatch
1f40 NETWORK 8000 message
1f41 NW8 Unrecognized command
1f42 NW8 Command failure
1f43 NW8 Leaves network event
1f44 NW8 Joins network event
1f45 NW8 ASD message
1f46 NW8 Leaves/joins network
1f4a NW8 Database initialized
1f4b NW8 ROM failure
1f4c NW8 RAM failure
1f4d NW8 Freeze error
1f4e NW8 Database modified
1f4f NW8 Device warm reset
1f50 NW8 Device cold reset
1f51 NW8 AS1 diagnostic
1f54 NW8 UI diagnostic

1448
49 Archive
Continued
value
1f5a NW8 UI6 diagnostic
1f5b NW8 UI7 diagnostic
1f5c NW8 UI8 diagnostic
1f5e NW8 Relay failure

1449
49 Archive
Continued
value
1f90 NW8 Setpoint out of range

1450
49 Archive
Continued
value
1f91 NW8 Duct temperature out of range
1f92 NW8 Zone temperature out of range
1f93 NW8 Device reset
1f94 NW8 Configuration error
1f95 NW8 Damper range error
1f96 NW8 Pressure error
1f97 NW8 EEprom memory error
1f98 NW8 Application modified
1f99 NW8 Missing changeover input
1f9a NW8 EEprom checksum error
1f9b NW8 Sensor input failure
1f9c NW8 System fault 32
1f9d NW8 No U-Link communication
1f9e NW8 Application error 1
1f9f NW8 Application error 2
1fa4 NW8 Press sensor
1fa5 NW8 Duct temperature
1fa6 NW8 Minimum flow potentiometer
1fa7 NW8 Maximum flow potentiometer
1fa8 NW8 Hot water potentiometer
1fa9 NW8 Induction auxilary potentiometer
1fab NW8 Space temperature
1faf NW8 Sensor failure GCS 01
1fc3 NW8 Sensor failure GCS 02
1fd7 NW8 Sensor failure GCS 03
1feb NW8 Sensor failure GCS 04

1451
49 Archive
Continued
value
1fff NW8 Sensor failure GCS 05
20b3 NW8 Sensor failure GCS 24
20c7 NW8 Sensor failure GCS 25
20db NW8 Sensor failure GCS 26
20ef NW8 Sensor failure GCS 27
2150 NW8 Sensor failure end
2151 NW8 Leaves LCM network event
2152 NW8 Joins LCM network event
2153 NW8 Leaves/joins LCM network
2197 NETWORK 8000 message end
2198 Trying to send email
219a Failed to send email
219b Deploy started
219c Deploy succeeded
219d Deploy failed
219e Learn started

1452
49 Archive
Continued
value
219f Learn succeeded
21a0 Learn failed
21a1 Server deployed
21a2 Deploy command queued
21a3 Learn command queued
21a4 Rebuild change-tracking data command queued
21a5 Rebuild change-tracking data started
2329 Modbus Incompatible to the group
232a Modbus User poll interval selected
232b Modbus Calculated poll interval selected
232c Modbus Group factorized
232d Modbus Group re-factorized
232e Modbus Illegal function code
232f Modbus Illegal data address
2330 Modbus Illegal data value

1453
49 Archive
49.16 Trend Log Enumerations

Trend log properties use two enumeration values: Events and Status.
Table: Event
value
0 Undefined
1 Log started
2 Log stopped
3 Data cleared
4 Log sample missed
5 Config updated
6 Missed upload
7 Time padding
8 Log unconfigured
9 System clock changed
10 Log status
11 Log interrupted
12 Null value
13 Log database restored
14 Log reset by extended log
Table: Status
value
0 None
1 Offline
2 Forced
4 Invalid
8 Override
16 In alarm

1454
49 Archive
Continued
value
32 Fault
64 Out of service

1455
49 Archive
49.17 System Alarms For Archiving
49.17 System Alarms For Archiving

There are several default system alarms for archiving.
Table: Archiving System Alarms

System Alarm The system generates an alarm if
Archive Path Must Be Set To Enable The destination path for the archive file is not
Archiving defined.
Archiving Directory Does Not Exist The directory path is not valid.
Archiving Directory Does Not Exist, Retrying The directory path is not valid. The system
in 5 Minutes will restart the archive process in 5 minutes.
Cannot Enable Archiving The Archiving function is not enabled.
Invalid Archiving Format The archiving format is not supported.
Archiving Is Not Enabled Archiving is disabled when a manual archive

is initiated.
To Error, When Generating Archive There is a detected error during the archive
generation.
To Error, When Writing To Archive There is a detected error when the archive is
Temporary saved to a predefined directory.
To Error, Cannot Write To Archive Directory There is a detected error when the archive is
saved to a predefined directory.
To Error, Cannot Write To Archive Directory, There is a detected error when the archive is
Retry in 5 Minutes saved to a predefined directory. The system
will restart the archive process in 5 minutes.
To Error, Not Enough Space Left In The The destination directory does not have
Archive Directory enough storage space for the archive.
To Error, Not Enough Space Left In The The destination directory does not have
Archive Directory, Retrying in 5 Minutes enough storage space for the archive. The
system will restart the archive process in 5
minutes.

1456
50 Archive User Interface
Topics
Archive Settings Manager Dialog Box
Add Extended Trend Logs Dialog Box
Archiving Settings Properties – Basic Tab
Archiving Settings Properties – Content Tab
Archive Icons in the System Tree
Event Archive File
Trend Log Archive File
50.1 Archive Settings Manager Dialog Box

Use the Archive Settings Manager to archive events and extended and trend
logs on the Enterprise Server.
Figure: Archive Settings Manager dialog box
Table: Archive Settings Manager Dialog Box

Number Description
Enabled Select to activate the archiving function on the Enterprise Server. For more
information, see section 49.3 “Enabling the Archiving Function and Defining the
Archive Folder” on page 1415.
Disable Select to disable the archiving function on the Enterprise Server.

d
Archive Click to archive the selected historical data immediately. For more information,
Now see section 49.7 “Manually Creating an Archive” on page 1419.
Alarm Select to include Alarm events in the archive.

Events
User Select to include User events in the archive.

Events
System Select to include System events in the archive.

Events

1459
Continued
Number Description
Add Click the plus sign to add an extended trend log to the list.
extende
d trend
log icon
Remove Click the remove sign to delete an extended trend log to the list.
extende
d trend
log icon
Extende Select the logs that you want to include in the archive.
d Trend
Log
Archive Click Schedule to configure a schedule for archiving. For more information, see
Schedul section 49.6 “Manual and Scheduled Archiving” on page 1418.
e
Output Select an output type for the archive. For more information, see section 49.5
Type “Archiving Formats and Storage” on page 1417.
Path Type the path to the location where you want store the archive files. For more
information, see section 49.3 “Enabling the Archiving Function and Defining the
Archive Folder” on page 1415.
Validate
Click to validate that the path is valid. A green checkmark displays if the
system successfully validates the path.

1460
50.2 Add Extended Trend Logs Dialog Box
50.2 Add Extended Trend Logs Dialog Box

Use the Add Extended Trend Logs dialog box to include logs in an archive. The
system only lists the logs on the Enterprise Server that are not included the archive.
Figure: Add Extended Trend Logs dialog box
Table: Add Extended Trend Logs Dialog Box

Click to include all the listed extended trend logs in the archive operation.
Click to exclude all the extended trend logs selected for the archive
operation.
Include Select the extended trend logs that you want to include in the archive.
For more information, see the Including Extended Trend Logs in an
Archive topic on WebHelp.
Extended Displays the name and the location of the extended trend log on the
Trend Log Enterprise Server.

1461
50.3 Archiving Settings Properties – Basic Tab
50.3 Archiving Settings Properties – Basic

Tab
Use the Basic tab to enable the archiving function, set delay, and select the format
of the archive file.
Figure: Archive Settings Basic properties tab
Table: Archive Settings Basic Tab

Enabled Select True to activate the archiving

function.
Path Type the path to the location where you

want to create your archive.
IsValidPath Select True to indicate the objects have

passed the validation.
Output format Select the output format of the archive. For

“Archiving Formats and Storage” on page
1417.

1462
50.4 Archiving Settings Properties – Content Tab
50.4 Archiving Settings Properties – Content

Tab
Use the Content tab to add events and trend logs to the archive.
Figure: Archive Settings Content tab
Table: Archive Settings Basic Properties Tab

Alarm Select True to include Alarm events in the

archive.
User Select True to include User events in the

archive.
System Select True to include System events in the

archive.
Logs Displays the logs you have selected to be

archived.
Add Click to add a new trend log to the archive.
Edit Click to change the trend log to be archived.

1463
50.5 Archive Icons in the System Tree
50.5 Archive Icons in the System Tree

Use the Archive icons to view information related to the archiving function.
Table: Archive Icons

Icon Description
Indicates Archive Settings.
Indicates the Archive schedule. For more information, see section 46.1
“Schedule Editor – Basic View” on page 1347.

1464
50.6 Event Archive File

Use the Event Archive to view all events that have passed during the running time
of the server.
Figure: Event archive file
Table: Event Archive File

Column Description
TYPE Displays the object type that defines the

properties of the object.
Displays the date and time when the event
was generated.
SEQNO Displays the event sequence number.
TimeStamp Displays the date and time when the event

was generated.
Description Displays the description of the object.
EventGUID Displays the unique identity of the event.
OriginatedGUID Display the unique identity of the source.
Source Displays the path of the source object.
SourceServer Displays the path where the object is

located.
Note Displays the text added to the object in the

Note 1 property.
SystemEventId Displays the event identity generated by the

system. For more information, see section
49.13 “Event and Alarm Enumerations” on
page 1434.
DomainName Displays the domain the user belongs to.
UserName Display the name of the user that generated

the event.
UniqueUserId Displays the identity of the user that

ValueBefore Displays the value of an object before it was

changed.

1465
Continued
Column Description
ValueAfter Displays the value of an object after it was

changed.
AssignedState Displays alarms that have been assigned to

and accepted by any user or group. For
more information, see section 49.13 “Event
and Alarm Enumerations” on page 1434.
MonitoredVariable Displays the path of the monitored variable
PreviousAlarmState Displays the previous alarm state. For more

information, see section 49.13 “Event and
Alarm Enumerations” on page 1434.
AlarmState Displays the present state of the alarm. For

TriggeredTimestamp Displays the time and date of the last state

transfer from normal state to alarm state.
EvaluationState Displays the present evaluation state of the

alarm. For more information, see section
49.13 “Event and Alarm Enumerations” on
page 1434.
MonitoredValue Displays the value of the monitored variable.
Priority Displays the current priority level of the alarm

state.
Count Displays the number of times the alarm has

toggled between the alarm and reset state.
AcknowledgeTime Displays the time and date when the alarm

was acknowledged.
BasicEvaluationState Displays the alarm state. False represents

the alarm is in normal state. For more
Hidden Displays False if the object is shown. For

Category Displays the category name of the alarm.
DisabledCause Displays the cause of the disabled alarm. For

ServerOffline Displays the online status of the server. For

UniqueAlarmId Displays the unique identity of the alarm.

1466
Continued
Column Description
AlarmText Displays the alarm messages that are added

to the alarm.
Command Displays the executed command that

AssignedToDomain Displays the domain the user or group that

AssignedToName Displays the name of the user or group that

AssignedToUniqueUserId Displays the ID of the user or group that the

alarm is assigned to.
GroupName Displays the name of the cause note or

action note that has been edited.
ItemName Displays the checklist, cause note group, or

action note group items that have been
edited.
BACnetEventType Displays the BACnet event. For more

SystemAlarmId Displays the alarm ID generated by the

system when an alarm is triggered. For more
Comment Displays the comment that has been added

to an alarm.

1467
50.7 Trend Log Archive File

Use the Trend Log Archive to view the history of a trend log.
Figure: Trend log archive file
Table: Trend Log Archive File

Column Description
TYPE Displays the object type that defines the

SEQNO Displays the event sequence number.
TimeStamp Displays the date and time when a record or

RefSeqNo Displays the unique sequence number of a

record that has been edited.
OriginalSeqNo Displays the RefSeqNo collected from a

trend log. This number is only written on an
extended trend log that has records that
have been changed on the connected trend
log.
User Displays the user that generated the event.
Comment Displays the comment that was added to a

record when it was edited.
Event Displays if something is missing or

something unexpected happens. For more
Enumerations” on page 1454.
EndTime Displays the time when the old meter was

replaced.
EndValue Displays the value the old meter had when it

was replaced.
StartTime Displays the time when the new meter was

installed.

1468
Continued
Column Description
StartValue Displays the value of the new meter when it

was installed.
MeterConstant Displays the constant of the new meter. If

1000.
MinValue Displays the first value of the new meter after

roll-over.
MaxValue Displays the last value of the new meter

before roll-over.
Value Displays the value of a record.
EditTime Displays the time of the record that is added

manually to a manual trend log.
LogType The type of the trend log that has been

edited.
Description Displays the trend log property that has been

configured.
Status Displays the status of the trend log. For more

Enumerations” on page 1454.

1469
51 Search
Topics
Search Overview
Simple Search
Performing a Search Using Simple Search
Saving a Search
Advanced Search
Properties Conditions Search
Search for Objects Using Advanced Search
Setpoint Search Example
Non-Validated Programs Search Example
51 Search
51.1 Search Overview
51.1 Search Overview

Use Search in WorkStation to find and view objects in the database.
There are two different ways to search in WorkStation, Simple search and Advance
search. An Advanced search can be done on, for example on conditions or objects
types. An Advanced search can be saved for further use.
Search is case insensitive, which means that Search does not differ between upper
case and lower case. A search on "Fan" results with hits on both "fan" and "Fan".
51.1.1 Simple Search

Use Simple search to search all objects names and properties names. The search
results are displayed in a list.
For more information, see section 51.2 “Simple Search” on page 1474.
51.1.2 Advanced Search

Use the advanced search to filter and refine a search so you don’t get too many
irrelevant results.
For more information, see section 51.5 “Advanced Search” on page 1478.
51.1.3 Saved Search

Frequently used searches including the settings can be saved and reused.
A Saved search is displayed in the System Tree pane and the List View. To perform
the search, open the Saved search from the System Tree pane or List View. The
search results are displayed in the work area (with collapsed Search criteria area).
A Saved search can be changed, renamed, and deleted.
Note
• When you save a search, only the setting for the search is saved. The search
result is never saved.

1473
51 Search
51.2 Simple Search
51.2 Simple Search

Use Simple search to search all objects names and properties names. The search
results are displayed in a list.
Simple search searches for all object and property names. If you want to search for
a text string that are values of properties, for example text Note 1, Note 2, and
Description you have to use Advanced search and select the condition “Note1”,
“Note 2”, and “Description”.
Figure: Simple search toolbar and search result list
51.2.1 Wildcard Search

You can use wildcards in both Simple search and Advanced search. Use wildcards
to substitute characters or combinations of characters in a search.
Search supports three wildcards:
• Asterisk (*) represents any combination of characters including white space. *
must be used if the text string you search for contains white space. For
example, if you want to search for object names as "temperature setpoint" or
"setpoint office" make sure that you use "*" in the end or in the beginning of the
word "setpoint".
• Question mark (?) represents any single character.
• Square brackets “[]” search for all characters that stands inside the brackets.
For example, if you want to find all objects and properties containing the word
“Temperature”, you start the search with an asterisk so that the search includes all
hits on objects like “Outside Air Temperature” where the asterisk represents the
words before "Temperature", in this case, “Outside Air”. You also have to end the
search text with an asterisk to include objects like “Temperature Alarm” where the
asterisk represents the word after "Temperature", in this case “Alarm”.
If you search on [a,b]*, you find all objects that begins with an a or a b.
You can also search on objects that start with numbers using square brackets. For
example, a search on [0-9]* finds all objects that starts with a number. A search on
[1,2,3]* finds all objects that starts with 1, 2, or 3.

1474
51 Search
51.2 Simple Search
Note
The Search box can never be empty. To perform a search, you have to enter
something in the Search box. If you want to search for all objects in a folder, enter
an asterisk (*).
51.2.2 Search Result List

The search result list can be sorted and grouped in a number of ways. You can also
add and remove columns from the list. Using the Property grid, you can also open
the properties for all objects in the list. For more information, see section 47.3 “List

1475
51 Search
51.3 Performing a Search Using Simple Search
51.3 Performing a Search Using Simple

Search
You use Simple search to search for an object by its name.
For more information, see the Search View topic on WebHelp.
To perform a search using simple search

1. In WorkStation, in the Search box, enter the text you want to search for.

The search result is presented in the Search view list.

1476
51 Search
51.4 Saving a Search
51.4 Saving a Search

You save a search so you can reuse it later.
To save a search
1. In WorkStation, on the Search toolbar, click the Save search criteria
button .
2. Enter the location where you want to save the search.
3. In the Name box, type a name.
4. Click Save.

1477
51 Search
51.5 Advanced Search

Use the advanced search to filter and refine a search so you don’t get too many
irrelevant results.
For more information, see section 51.5 “Advanced Search” on page 1478.
Applying a filter means that you set up rules that specify what kind of objects are
relevant to the search. These rules can be based on object types and object
properties.
51.5.1 Wildcard Search

You can use wildcards in both Simple search and Advanced search. Use wildcards
to substitute characters or combinations of characters in a search.
Search supports three wildcards:
• Asterisk (*) represents any combination of characters including white space. *
must be used if the text string you search for contains white space. For
example, if you want to search for object names as "temperature setpoint" or
"setpoint office" make sure that you use "*" in the end or in the beginning of the
word "setpoint".
• Question mark (?) represents any single character.
• Square brackets “[]” search for all characters that stands inside the brackets.
For example, if you want to find all objects and properties containing the word
“Temperature”, you start the search with an asterisk so that the search includes all
hits on objects like “Outside Air Temperature” where the asterisk represents the
words before "Temperature", in this case, “Outside Air”. You also have to end the
search text with an asterisk to include objects like “Temperature Alarm” where the
asterisk represents the word after "Temperature", in this case “Alarm”.
If you search on [a,b]*, you find all objects that begins with an a or a b.
You can also search on objects that start with numbers using square brackets. For
example, a search on [0-9]* finds all objects that starts with a number. A search on
[1,2,3]* finds all objects that starts with 1, 2, or 3.
Note
The Search box can never be empty. To perform a search, you have to enter
something in the Search box. If you want to search for all objects in a folder, enter
an asterisk (*).
51.5.2 Object Types Search

You can select the object types that you want to include in the search. If you do not
select a type, all types are included. For example, if you want to search on all
graphics containing bindings named "temperature" you include only graphics in the
search. A search without the object type graphics selected results in a list with all
objects, such as values, graphics, and alarms named "temperature".

1478
51 Search
51.5.3 Properties Conditions Search

You can set conditions on object properties that you want to include in the search.
For more information, see section 51.6 “Properties Conditions Search” on page
1480.
51.5.4 Setpoint Search Example

You want to search for all setpoints , that are over 22, in all offices. You know that
all setpoint are marked “setpoint” in some way, such as “office setpoint”, “setpoint
office”, and “temperature setpoint”. When the search is done, you want to save the
search so that you can use it again without making all settings for objects and
conditions.
For more information, see section 51.8 “Setpoint Search Example” on page 1484.
51.5.5 Non-Validated Programs Search Example

You want to find the programs that are not validated in your system. So you search
for all programs that have validation set to None or Failed.
For more information, see section 51.9 “Non-Validated Programs Search Example”
on page 1487.
51.5.6 Search Result List

The search result list can be sorted and grouped in a number of ways. You can also
add and remove columns from the list. Using the Property grid, you can also open
the properties for all objects in the list. For more information, see section 47.3 “List

1479
51 Search
51.6 Properties Conditions Search
51.6.1 You can set conditions on object properties that you want to include in the search.
Figure: The Select Conditions dialog box when no object type is selected in the Include
types dialog box.
If you choose to include one or more object types in the search, you can select a
condition from the common properties for these object types. If no object type is
included in the search, you can select conditions from the general properties for all
object types.
If you include only one object in the search you can choose between all the
properties for that objects. For example, if you choose Alarm you can select from all
alarm properties in the Selection dialog box.
For example, to search for disabled alarms, you select alarm object type and then
select alarm state in the property list.
Figure: The properties available in the Select Conditions dialog box when alarm is
selected in the Include types dialog box.

1480
51 Search
The condition formats looks different depending on property type.
Combining condition groups

You can combine condition groups to better suit your search. The different
conditions groups can be combined in any way using "and" and "or".
For example, we want to find all analog values that contain "Setpoint" or
"setpoint" in their object names or descriptions. The objects we want to find have a
values over 20 or have been modified after 2013-02-25 00:00:00.
A search on these criteria looks like this:
Figure: You can combine different search criteria in conditions groups to further refine your
search.
Note
Strings in the Select Conditions dialog box are case sensitive, that is they differ
between upper and lower case. A description condition for the text string
"temperature" is not the same as "Temperature".

1481
51 Search
51.7 Search for Objects Using Advanced Search
51.7 Search for Objects Using Advanced

Search
You use this procedure to find objects in the database.
To search for objects using advanced search

1. In WorkStation, on the Building Operation Toolbar menu, click the Search
button .
2. In the text box, type your search.
3. In the In folder box, select the folder where you want to start the search.
4. Select Include properties to include properties in the search.
5. Select Include subservers to include subservers in the search.
6. Select Stop if more than 1000 results to stop the search at 1,000 results.
7. In the Include types box, click the browser button if you want to include a
specified object type in your search.

1482
51 Search
51.7 Search for Objects Using Advanced Search
8. Select the object types you want to include in the search.
9. Click the Add type button .

10. Click OK.
11. In the Select Conditions box, click the Add conditions if you want to add
conditions for the search.
12. Click OK.

Search results are displayed in the Search result area.

1483
51 Search
51.8 Setpoint Search Example

You want to search for all setpoints , that are over 22, in all offices. You know that
all setpoint are marked “setpoint” in some way, such as “office setpoint”, “setpoint
office”, and “temperature setpoint”. When the search is done, you want to save the
search so that you can use it again without making all settings for objects and
conditions.
In the search field enter *setpoint*, this includes all objects containing “setpoint”. If
you enter only the word setpoint, without the asterisks (*) you do not find objects
named “office setpoint” or “setpoint_office_1”.
You only want to search in University X, not in University Y, therefore you limit the
search to University X. To do this you browse to University X in the In folder box.
Figure: The Search View when you want to search for the word temperature in all objects
in Unviversity X.
To avoid all other hits, for example graphics with links that are named "setpoint" you
have to filter on the object type Point. This is done in the Select types dialog box
under Advanced settings.

1484
51 Search
Figure: The Select types dialog box when you filter on Point.
If you perform a search now you find all object types that are Points and namned
"setpoints" in any way. To filter out only the setpoints with a value of 22 or more we
have to set up a condition using the Select Conditions dialog box. We set the value
to be greater than or equal to 22.
Figure: The Select Conditions dialog box when value is set to be between 22 and 100.
When all search criteria is set we perform the search. The result is presented in the
Search result list.

1485
51 Search
Figure: Search result and search criteria

To be able to use the search once again without going through all the settings once
agin we save the search with the name "Setpoints over 22".
Figure: The saved search "Setpoints over 22" in the System Tree pane.

1486
51 Search
51.9 Non-Validated Programs Search Example
51.9 Non-Validated Programs Search

Example
You want to find the programs that are not validated in your system. So you search
for all programs that have validation set to None or Failed.
You only want to search in University X, so you right-click University X and then click
Search. You want to find all programs that are not validated regardless of their
names. The Search box cannot be empty and you want to find all programs
regardless of their names so you have to enter an asterisk (*).
Figure: The Search View when you have entered an asterisk (') that finds all objects in
University X.
To narrow you search so that only program, Script or Function Block is found, you
have to add Programs in the Select types dialog box.

1487
51 Search
Figure: The Select types dialog box when all objet types of the categories Plain English
and Function Block is selected.
Then you select the conditions for the search in the Select Conditions dialog box.
We only want to find non-validated programs. Therefore we choose Validation from
the Add condition list, and then we select None and Failed, and click OK.
Figure: The validation conditions None and Failed is selected in the Select Condition
dialog box.
Then we perform the search.

1488
51 Search
Figure: The search result for all program in University X that are not validated
successfully.
To be able to use the search again without going through all the settings once more
we save the search with the name "Non-Validated Program Search".

1489
52 WorkStation User Interface
Topics
Basic Functionality Icons in the System Tree Pane
File Menu
File Menu – New Submenu
Edit Menu
Actions Menu
Actions Menu – Activation Submenu
Actions Menu – Advanced Submenu
Actions Menu – Advanced Commands Submenu
Actions Menu – Modification Submenu
Actions Menu – View Submenu
Actions Menu - View Submenu - Watch Submenu
Actions Menu – Actions Submenu
Watch Select Property Dialog Box
Add/Remove Columns Dialog Box (Watch Pane)
Tools Menu
Options Dialog Box
Control Panel View
Progress View – Advanced
Progress View – Simple
Operation Details Dialog Box
Error Details – Progress View
Create Object Wizard – Naming the Object Page
List View Toolbar
System Tree Pane Toolbar
Confirm Delete Dialog Box
Delete Object Dialog Box
Rename Object Dialog Box
General Properties – Basic Tab
General Properties – References Tab
Retain Level
Configure Dialog Box - Configuration Tab
Configure Dialog Box – Operation Tab
Search Icons
Search View
Search View Toolbar
Search Toolbar
Add/Remove Columns Dialog Box (Search)
Select Folder Dialog Box
Select Types Dialog Box
Select Conditions Dialog Box
Add/Remove Columns Dialog Box (System Tree Pane)
Analog Value Properties
Digital Value Properties
Multistate Value Properties
String Value Properties
Signal Generator Dialog Box
Simple Math Operator Dialog Box
Create Hyperlink Wizard – Assign the URL Page
Select Object Dialog Box
Select Object and Properties Dialog Box
Progress View
System Object Properties
System Control Panel Properties
Commit Page
Related Trends Properties Dialog
52.1 Basic Functionality Icons in the System Tree Pane
52.1 Basic Functionality Icons in the System

Tree Pane
This section describes the icons in WorkStation that relate to the System Tree pane.
Icon Description
Folder
Indicates a folder.
Server
Indicates an Enterprise Server or an
Automation Server. For more information,
see the Server Overview topic on WebHelp.
System
Indicates the System folder in a server. For
more information, see the Server Overview
topic on WebHelp.
Tasks
Indicates a Task that is used to run a Script
program of a Function Block program. For
more information, see the Tasks topic on
WebHelp.
Archive settings
Archive setting icon as it is displayed in the
System Tree pane. For more information,
see section 49.1 “Archiving Overview” on
page 1411.
Search query
Indicates a saved search in the System Tree
and in the List View. For more information,
see section 51.1 “Search Overview” on page
1473.
System Control Panel

Indicates System Control Panel. For more
information, see section 47.4 “Control Panel”
on page 1382.

1495
52.2 File Menu
52.2 File Menu

Use the File menu to log off from the system, import and export information, print,
and create new objects.
Figure: The File menu
Command Description
New Click to open the New submenu where you

create new objects. For more information,
see section 52.3 “File Menu – New
Open Click to open an object.
Open in new window Click to open the selected object in a new

window in the work area.
Save Click to save changes.
Log Off Click to log off WorkStation. Your session

ends and you are sent to the Welcome
Window where you can log in to Building
Operation with the same or another user
26.7 “Building Operation WorkStation
Window” on page 566.
Change Password Click to open the Change Password

dialog box where you change your
password. For more information, see section
26.11 “Change Password Dialog Box” on
page 573.

1496
52.2 File Menu
Continued
Command Description
Export Click to open the Save As dialog box where

you export a solution to a file location on the
WorkStation file system.
The Export preview dialog box displays
when there are objects in the solution that
Building Operation cannot export from the
server. Use this dialog box to view multiple
objects that the system can and cannot
export from the server. For more information,
see the Export Preview Dialog Box topic on
WebHelp.
Import Click to open the Open dialog box where

you select a previously exported solution
that you want to import. After you select a
file, the Import dialog box displays.
The Import dialog box provides a summary
of information about the imported file and a
preview of the names and file structure of the
objects to be imported. For more
information, see the Import Dialog Box topic
on WebHelp.
LonWorks import Click to open the Import - LonWorks

submenu where you import resource files
(DRF kits) or device templates (XIF files).
Print Preview Click to preview a printout before printing.
Print Click to print the selected object.
Print Setup Click to adjust the print settings.
Properties Click to open the Properties dialog box

where you inspect or change properties for
the selected object. For more information,
see section 52.28 “General Properties –
Basic Tab” on page 1545.
Shortcut Properties Displays the Properties dialog box for the

currently selected shortcut.
Exit Click to quit WorkStation.

1497
52.3 File Menu – New Submenu

Use the New submenu to create new objects.
Figure: File menu - New submenu
Command Description
Alarm Click to open the Create Object wizard

where you create an alarm. For more
on page 1538.
An alarm monitors a variable and alerts you if
the monitored variable matches the
configured alarm conditions. For more
Assignment Click to open the Create Object wizard

where you create an assignment. For more
on page 1538.
A triggered alarm can be automatically
assigned to a specific user or user group
that seems to be most suited to correct the
problem. For more information, see section
29.28 “Automatic Assignment” on page 767.

1498
Continued
Command Description
Application Click to open the Create Object wizard

where you create an application folder for a
hosted BACnet device. For more
on page 1538.
b3 device Click to open the Create Object wizard

where you create a b3 device on the MSTP
network. For more information, see section
52.22 “Create Object Wizard – Naming the
b3 BACnet devices are a family of intelligent,
programmable, stand-alone devices that
provide Direct Digital Control of air handlers
and systems as well as individual terminal
units. For more information, see the b3
BACnet Device Overview topic on WebHelp.
BACnet device Click to open the Create Object wizard

where you create a BACnet device that is
hosted by the local server. For more
on page 1538.
BACnet loop Click to open the Create Object wizard

where you create a BACnet loop that
represents a feedback control loop. For
on page 1538.
You use a BACnet loop to create a feedback
system without manually creating or editing
Script code. For more information, see the
BACnet Objects topic on WebHelp.
BACnet network Click to open the Create Object wizard

where you create a BACnet network that is
not directly connected to the server. For
on page 1538.
You use a BACnet network when you want
to host a device that is on a network that is
not directly connected to the server. For
more information, see the BACnet Networks
topic on WebHelp.

1499
Continued
Command Description
BACnet notification Click to open the Create Object wizard

where you create a BACnet notification that
can be referenced by BACnet alarms and
objects configured for intrinsic alarming. For
on page 1538.
For more information, see the BACnet
Alarms topic on WebHelp.
BACnet program Click to open the Create Object wizard

where you create a BACnet program and
upload the properties of a BACnet program
from a BACnet device into Building
Operation. For more information, see section
BACnet trend log Click to open the Create Object wizard

where you create a BACnet trend log that
monitors and records the trends of a
monitored property. For more information,
see section 52.22 “Create Object Wizard –
A BACnet trend log is a property monitor for
a specific object. When certain conditions
are reached, a log is produced with the
property value and a date/time stamp. For
more information, see the BACnet Objects
topic on WebHelp.
BBMD Click to open the Create Object wizard

where you create a BBMD when you want
BACnet broadcast messages to be
communicated throughout an IP network.
You create BBMDs on Ethernet-based
devices, such as Automation Servers, when
you want BACnet broadcast messages to
be communicated throughout an IP network.
BBMD BDT entry Click to open the Create Object wizard

where you create a BDT Entry for a BBMD.
You create a BDT entry for to configure a
master table for a BBMD.
Device Click to open the Create Object wizard

where you create a device. For more
on page 1538.

1500
Continued
Command Description
Document Click to open the Create Object wizard

where you create a document. For more
on page 1538.
A document is a container in which you can
upload a file for use in Building Operation.
You can upload all types of files including
reports, forms, images, and video clips. For
“Documents Overview” on page 1597.
Extended trend log Click to open the Create Object wizard

where you create an extended trend log. For
on page 1538.
An extended trend log is used to upload and
store log records from a trend log in a device
where space is limited. For more information,
see section 36.4 “Extended Trend Logs” on
page 1067.
Folder Click to open the Create Object wizard

where you create a folder. For more
on page 1538.
Function Block Click to open the Create Object wizard

where you create a Function Block program.
For more information, see the Function Block
Editor Overview topic on WebHelp.
Graphic Click to open the Create Object wizard

where you create a graphic. For more
on page 1538.
The created graphic is empty and has to be
edited. For more information, see the
Graphics Editor Overview topic on WebHelp.
Hyperlink Click to open the Create Object wizard

where you create a hyperlink. For more
on page 1538.
Hyperlinks are used to acces web pages on
the Internet. For more information, see
section 47.7 “Hyperlinks” on page 1387.

1501
Continued
Command Description
Interface Click to open the Create Object wizard

where you create an interface. For more
on page 1538.
The created interface can be a BACnet
interface, LonWorks interface, MicroNet
network, or Modbus interface/network.
For more information, see the BACnet
Interface topic on WebHelp.
For more information, see the LonWorks
For more information, see the MicroNet
Network Protocols topic on WebHelp.
For more information, see the Modbus
For more information, see the Web Services
IP network Click to open the Create Object wizard

where you create an IP network. For more
on page 1538.
LonWorks Network Opens the Create Object wizard, where

you create a LonWorks network. For more
on page 1538.
MicroNet Click to open the Create Object wizard,

where you create any one of three MicroNet
network types. For more information, see
MicroNet is a moderate-to-large scale
Building Management System. For more
information, see the MicroNet Network
Protocols topic on WebHelp.
MicroNet ARCNET Network Click to open the Create Object wizard,

where you create a MicroNet ARCNET
network. For more information, see section
An ARCNET network contains ARCNET
variant MicroNet devices. For more
information, see the ARCNET Networks
topic on WebHelp.

1502
Continued
Command Description
MicroNet NCP Network Click to open the Create Object wizard,

where you create a MicroNet NCP network.
An NCP network is the Satchwell Native
Communications Protocol proprietary
network, containing NCP variant MicroNet
devices. For more information, see the NCP
Networks topic on WebHelp.
MicroNet SNP Network Click to open the Create Object wizard,

where you create a MicroNet SNP network.
An SNP network is the Satchwell SatchNet
Pro proprietary network, containing SNP
variant MicroNet devices. For more
information, see the SNP Networks topic on
WebHelp.
Modbus Device Click to open the Create Object wizard

where you create an external slave device on
a serial Modbus (master) network, or a new
serial device on a Modbus TCP gateway. For
on page 1538.
A Modbus device is any device that
conforms to the Modbus standard (for
example, a meter or a programmable logic
controller). For more information, see the
Modbus Devices topic on WebHelp.
Modbus Points Click to open the Create Object wizard

where you create a Modbus point within an
external device. For more information, see
A Modbus point is an analog, digital or
multistate input (or output) at a Modbus
device. For more information, see the Point
and Value Types topic on WebHelp.
Modbus TCP Device Click to open the Create Object wizard

where you create a Modbus TCP device. For
on page 1538.
A Modbus TCP device is any Modbus device
on a Modbus TCP network. For more
information, see the Modbus Devices topic
on WebHelp.

1503
Continued
Command Description
Modbus Register Group Click to open the Create Object wizard

where you create a Modbus register group
within a Modbus device. For more
on page 1538.
A Modbus register group is a container
where Modbus registers can be polled as a
group by a Modbus polling device. For more
information, see the Modbus Register
Groups topic on WebHelp.
Modbus Value Click to open the Create Object wizard

where you create a Modbus value in a
Modbus interface. For more information, see
A Modbus value is an analog, digital or
multistate input (or output) at a Modbus
interface. For more information, see the
Point and Value Types topic on WebHelp.
MSTP network Click to open the Create Object wizard

where you create an MS/TP Network for
BACnet devices or b3 devices. For more
on page 1538.
Building Operation supports BACnet IP
networks and MS/TP networks. For more
information, see the BACnet Networks topic
on WebHelp.
Network Variable Click to open the Create Object wizard

where you create a network variable. For
on page 1538.
Notification Click to open the Create Object wizard

where you create a notification. For more
on page 1538.
User notifications are used for notifying users
or user groups that a certain alarm event has
occurred in the system. Notifications are
delivered to the users as e-mails or written to
files outside Building Operation. For more

1504
Continued
Command Description
Panel Click to open the Create Object wizard

where you create a panel. For more
on page 1538.
A panel can consist of one or several panes
and one work area with viewable objects, for
example graphics, trend charts, reports, or
another panel. For more information, see
section 24.6 “Panel Components” on page
508.
Point Click to open the Create Object wizard

where you create a BACnet input or output
point. For more information, see section
You can create BACnet points in a server
and in a hosted BACnet device. For more
information, see the BACnet Objects topic
on WebHelp.
Program Click to open the Create Object wizard

where you create a program. For more
on page 1538.
For more information, see the Function Block
Editor Overview topic on WebHelp.
For more information, see the Script Editor
Workflow topic on WebHelp.
Report Click to open the Create Object wizard

where you create a report. For more
on page 1538.
Click to create a report. For more
information, see the WebReports Overview
topic on WebHelp.
Schedule Click to open the Create Object wizard

where you create a schedule. For more
on page 1538.
Schedules are used to determine when
essential events occur in a building
automation system. For more information,
see section 41.1 “Schedules Overview” on
page 1253.

1505
Continued
Command Description
Search Click to open the Create Object wizard

where you create a search. For more
on page 1538.
Search is used for searching for objects and
properties of objects in Building Operation.
“Search Overview” on page 1473.
Server Click to open the Create Object wizard

where you create a server. For more
on page 1538.
Shortcut Click to open the Create Object wizard

where you create a shortcut. For more
on page 1538.
A shortcut is a link to a server, folder, or
other object and is simply a pointer to an
object which acts as if it is that object. For
more information, see section 53.7 “Shortcut
Creation” on page 1585.
User Account Click to open the Create Object wizard

where you create a user account. For more
on page 1538.
A user account uniquely identifies a user to
the system. For more information, see
section 19.4 “User Accounts and User
Account Groups” on page 375.
Domain Click to open the Create Object wizard

where you create a domain. For more
on page 1538.
A domain contains of user accounts, user
account groups, software permissions,
workspaces and one or several Building
Operation servers. For more information, see
section 21.1 “Domains” on page 435.
Text report Opens the Create Object wizard, where

you create a text report. For more
information, see the Creating a Text Report
topic on WebHelp.

1506
Continued
Command Description
Trend Click to open the Create Object wizard

where you create trend logs, trend log lists,
or trend charts. For more information, see
The function of a trend log is to log the
variable that it is connected to and store the
34.1 “Trend Overview” on page 971.
Trend log Click to open the Create Object wizard

where you create a trend log. For more
on page 1538.
The function of a trend log is to log the
variable that it is connected to and store the
34.1 “Trend Overview” on page 971.
User account group Click to open the Create Object wizard

where you create a user account group. For
on page 1538.
A user account group can contain both user
accounts and other user account groups.
For more information, see section 19.4 “User
page 375.
Utility Click to open the Create Object wizard

where you create a utility. For more
on page 1538.
The utilities Signal Gererator and Simple
Math Operator are used for testing the
system. For more information, see section
47.9 “Utilities” on page 1390.
Value Click to open the Create Object wizard

where you create a value. For more
on page 1538.
View Click to open the Create Object wizard

where you create an Event view or Alarm
view. For more information, see section
Views are used to display information in a
easy way. For more information, see section
27.1 “Alarm Overview” on page 621.

1507
Continued
Command Description
Workspace Click to open the Create Object wizard

where you create a workspace. For more
on page 1538.
A workspace is a configured layout and
selection of components that display in
WorkStation. For more information, see
section 24.3 “Workspace Components and

1508
52.4 Edit Menu
52.4 Edit Menu

Use the Edit menu for standard editing of objects.
Figure: Edit menu
Table: Edit Menu

Command Description
Cancel Click to cancel the latest command.
Refresh Click to refresh the selected object or

workspace.
Select all Click to select all objects.
Deselect all Click to deselect all objects.
Cut Click to cut the selected objects. The objects

are placed on the clipboard.
Copy Click to copy the selected objects. The

objects are placed on the clipboard.
Paste Click to paste a copied or cut object.
Paste as shortcut Pastes a shortcut to a (copied) folder or

object into the selected folder or server root.
Paste special Paste with the all external references intact.

“Move, Copy, Paste, Rename, and Delete”
on page 1403.
Move Click to move an object to another location.

“Move, Copy, Paste, Rename, and Delete”
on page 1403.

1509
52.4 Edit Menu
Continued
Command Description
Delete Click to open the Confirm delete dialog

box where you delete the selected object.
“Confirm Delete Dialog Box” on page 1542.
Rename Click to rename the selected object.
Create shortcut Creates a new shortcut to a selected folder

or object into the same folder as the target.

1510
52.5 Actions Menu
52.5 Actions Menu

Use the Actions menu to carry out commands for objects selected in the System
Tree pane or a List View.
Figure: Action menu when a Function Block program is selected.
Table: Actions Menu

Command Description
Actions Use the Actions submenu to create manual

archives on an Enterprise Server. For more
information, see section 52.12 “Actions
Menu – Actions Submenu” on page 1524.
Activation Use the Activation submenu to enable,

disable, force transfer, or clear a trend log.
“Actions Menu – Activation Submenu” on
page 1518.
Advanced Use the Advanced submenu to repair

references or communication after a server
has been offline. For more information, see
section 52.7 “Actions Menu – Advanced
Advanced commands Use the Advanced commands submenu

to execute commands for a device. For
more information, see section 52.8 “Actions
Menu – Advanced Commands Submenu”
on page 1520.
Alarm Refresh Transfers all alarms buffered in the Xenta

device to the server. For more information,
see the Alarms for Xenta LonWorks Devices
topic on WebHelp.
b3 devices Use the b3 devices submenu to

automatically assign the node IDs and initiate
communication with devices on the MS/TP
network, or to update the firmware. For
more information, see the b3 BACnet Device
Properties – Advanced Tab topic on
WebHelp.
Backup Click to open the Backup Options dialog

box where you back up the selected server.
“Backup Options Dialog Box” on page 1683.

1511
52.5 Actions Menu
Continued
Command Description
Clear Status Clears the diagnostic data for the device or

local node. For more information, see the
LonWorks Device Properties – Diagnostics
Tab topic on WebHelp.
Cold start Restarts the device and clears the RAM

memory. For more information, see the
Xenta LonWorks Device Restart topic on
WebHelp.
Cold start device Cold starts a hosted BACnet device. For

more information, see the Device Cold Start
and Warm Start topic on WebHelp.
Commission Opens the Commission Device wizard,

where you download settings and
parameters to the device.
For more information, see the Neuron ID and
Commission Settings Page topic on
WebHelp.
For more information, see the Actions
Menu – Device Submenu topic on WebHelp.
Create Reports From WebReports Click to restore the Reports folder in the
System Tree. For more information, see the
Reports in WorkStation and the WebReports
Web Site topic on WebHelp.
Data Import Click to import the MicroNet import file. For

more information, see the Data Import topic
on WebHelp.
Decommission Deactivates the device in the network.
Device Use the Device submenu where you

manage your devices. For more information,
see the Actions Menu – Device Submenu
topic on WebHelp.
Device communication control Enables and disables BACnet device

communications and also disables the ability
of a device to initiate communications with
other network devices. For more information,
see the Device Communication topic on
WebHelp.
Discover Devices Identifies the devices and objects on a

particular BACnet network, or an entire
BACnet internetwork. For more information,
see the BACnet Device Discovery topic on
WebHelp.
Download Downloads the application from the Building

Operation server database to the device.
Download device configuration Downloads the parameters from the Building

Operation server database to the device.

1512
52.5 Actions Menu
Continued
Command Description
Edit Opens the object for editing in the

appropriate editor.
Edit Alarm Filter Click to open the Select conditions dialog

box, where you sort the information in an
Alarms pane. For more information, see
section 31.77 “Select Conditions Dialog
Box – Alarm Filter Properties” on page 915.
Edit Assignment Condition Click to open the Select conditions dialog

box, where you define when to send the
assignment. For more information, see
Edit bindings Click to open the Edit Bindings dialog box.

For more information, see the Bindings View
topic on WebHelp.
Edit Event Filter Click to open the Select conditions dialog

box, where you edit an event filter to an
object. For more information, see section
33.5 “Select Conditions Dialog Box – Events
Filter Properties” on page 967.
Edit in spreadsheet Click to open Edit in spreadsheet where

you can quickly build and reuse a database
of I/O modules on the I/O bus. For more
information, see the Copying from MS Excel
to Spreadsheet View topic on WebHelp.
Edit Notification Condition Click to open the Select conditions dialog

box, where you define when to send the
alarm notification. For more information, see
Edit Sum Alarm Condition Click to open the Select conditions dialog
box, where you configure the conditions that
determine which alarms the sum alarm
surveys. For more information, see section
31.77 “Select Conditions Dialog Box – Alarm
Filter Properties” on page 915.
Edit the style of associated events Click to open the Event styles dialog box
where you style the appearance of a specific
event in the Events pane. For more
information, see section 33.2 “Event Styles
Dialog Box” on page 960.
Host EWS Objects Click to host a remote EcoStruxure Web

Service object. For more information, see the
EcoStruxure Web Service Client topic on
WebHelp.

1513
52.5 Actions Menu
Continued
Command Description
IO wiring list Click to open the IO Wiring List dialog box

where you print an I/O wiring list for the I/O
bus that describes which I/O points are
associated with each I/O module. For more
information, see the Print I/O Wiring List
Dialog Box topic on WebHelp.
Launch VisiSat Click to start VisiSat. For more information,

see the VisiSat Programming topic on
WebHelp.
Learn BDT Table Click to open the Learn BDT Table dialog
box where you learn the BACnet Broadcast
Device Table from one BBMD to another
BBMD. For more information, see the
BACnet Learn BDT Table Dialog Box topic
on WebHelp.
Learn LCM Learns the blocks in the LCM. For more

information, see the Learn LCM Blocks topic
on WebHelp.
LCM sync date time Sends the server's date and time to each
LCM device on the LCM network. For more
information, see the NETWORK 8000 LCMs
topic on WebHelp.
Manage IO bus Click to open the I/O Module

Management Tool dialog box where you
assign and unassign logical I/O modules,
correct the position of a module type, or
correct a module mismatch. For more
information, see the I/O Module
Management Tool Dialog Box topic on
WebHelp.
Manage Meter Click to open the Manage Meter dialog

box where you manage the settings of a new
meter. For more information, see section
39.15 “Manage Replacement of Meter
Dialog Box” on page 1180.
MNL Use the MNL submenu to open WorkPlace

Tech Monitor, to monitor or perform a task
on an MNL LonWorks device. For more
information, see the Actions Menu – MNL
Submenu topic on WebHelp.
Modification Use the Modification submenu to modify a

trend log. For more information, see section
52.9 “Actions Menu – Modification
Print IO module labels Click to open the Print IO Module Labels

dialog box where you print the placard of the
I/O module. For more information, see the
Print I/O Module Labels Dialog Box topic on
WebHelp.

1514
52.5 Actions Menu
Continued
Command Description
Proxy Update Reads the configuration properties of the

block in the LCM. For more information, see
the NETWORK 8000 LCMs topic on
WebHelp.
Removed from Network Removes an offline device object for a

physical device that was previously removed
from the network.
Reset Resets the block in the LCM. For more

information, see the NETWORK 8000 LCMs
topic on WebHelp.
Reset IO module Resets the I/O module with its old

configuration. For more information, see the
I/O Module Configuration topic on WebHelp.
Restore Click to open the Restore Options dialog

box where you restore the selected server,
or upload the configurations properties of an
external BACnet device to a device proxy.
Revert to application value Click to use an NCI value from the device
application when downloading the device
configuration (NCI values) to an MNL
LonWorks device. For more information, see
the NCI Values topic on WebHelp.
Save To Save the selected backup to another

location in the Building Operation server
database. For more information, see section
62.13 “Backup Sets View” on page 1693.
Send ServicePin Sends service pin for the local node, so

other devices can identify the local node on
the network. For more information, see the
Discovering a Xenta Device topic on
WebHelp.
Send time sync now Triggers a time synchronization of all the

BACnet devices listed in the BACnet
Interface.
Teach Sends the selected BBMD configuration to

all other BBMDs in the system. For more
information, see the BBMD BDT Entry
Properties – Basic Tab topic on WebHelp.
Time sync Synchronizes the time between a hosted

device and the local server. For more
information, see the BACnet Interface – Time
Synchronization Recipients Tab topic on
WebHelp.

1515
52.5 Actions Menu
Continued
Command Description
Update IO module firmware Click to open the Update IO Module

Firmware dialog box where you upgrade
the firmware for I/O modules. For more
information, see the Update I/O Module
Firmware Dialog Box topic on WebHelp.
Upload Uploads the application from the device to

the Building Operation server database.
Upload device configuration Uploads the parameters from the device to

the Building Operation server database.
Update Object list Updates the list of BACnet device objects.
Warm start Restarts a device without clearing the RAM

Xenta LonWorks Device Restart topic on
WebHelp.
Warm start device Restarts a BACnet hosted device without

clearing all configuration data, run-time data,
and the values of objects. For more
information, see the Device Cold Start and
Warm Start topic on WebHelp.
View Use the View menu to open a report, trend

chart, trend log list, or add a value to the
Watch pane. For more information, see
section 52.10 “Actions Menu – View
View Action Notes Click to open an Events pane that displays

all events where an action note has been
see the Events Pane and Event View topic
on WebHelp.
View Cause Notes Click to open an Events pane that displays

all events where a cause note has been
see the Events Pane and Event View topic
on WebHelp.
View Checklists Click to open an Events pane that displays

all events where a check list has been added
to the alarm. For more information, see the
Events Pane and Event View topic on
WebHelp.
View Comments Click to open an Events pane that displays

all events where a comment has been added
to the alarm. For more information, see the
Events Pane and Event View topic on
WebHelp.

1516
52.5 Actions Menu
Continued
Command Description
View History Click to open an Events pane where all

history events of an alarm are displayed. For
more information, see the Events Pane and
Event View topic on WebHelp.
Wink Generates a response from the device, such

as flashing the power LED, so you can
identify the physical device. The device must
be connected, have its ID set, and support
the Wink function.

1517

Use the Activation submenu to enable, disable, or clear a trend log.
Figure: The trend log Actions menu, Activation submenu
Table: Activation Submenu

Command Description
Enable trend log Click to enable the trend log. The trend log
starts when the start condition is fulfilled.
Disable trend log Click to disable the trend log and stop all
recording activity.
Clear trend log Click to clear all the records from the trend
log.
Force transfer Click to manually forces the transfer of

records to the extended trend log.

1518
52.7 Actions Menu – Advanced Submenu
52.7 Actions Menu – Advanced Submenu

Use the Advanced submenu to repair communications or repair references.
Figure: The Actions menu - Advanced submenu
Command Description
Repair references Click to repair references when you have

moved, renamed, or deleted an object that
refers to another object that is offline. For
more information, see section 48.10 “Move,
Copy, Paste, Rename, and Delete” on page
1403.
Rebind
Detect Subnet/Node conflicts Select to detect address conflicts in the

network. The command finds and presents
the neuron IDs of any online devices that
share the same subnet/node address.
Repair server communication Click to repair server comminication after a

server has been offline. For more
information, see the Repairing Server
Communication topic on WebHelp.

1519
52.8 Actions Menu – Advanced Commands Submenu
52.8 Actions Menu – Advanced Commands

Submenu
Use the Advanced Commands submenu to execute functions on the selected
LonWorks device or Xenta device.
Figure: The Actions menu - Advanced Commands submenu
Table: Advanced Commands Submenu

Command Description
Wink Click to generate a response from the

device, such as flashing the power LED.
Clear Status Click to clear the diagnostic data for the

device or local node. For more information,
see the LonWorks Device Properties –
Diagnostics Tab topic on WebHelp.
Warm Start Click to restart the device without clearing

the RAM memory. For more information, see
the Xenta Device Restart Modes topic on
WebHelp.
Cold Start Click to restart the device and clear the RAM
Xenta Device Restart Modes topic on
WebHelp.
Alarm Refresh Click to transfer all alarms buffered in the

physical Xenta device to Building Operation.
For more information, see the Xenta Alarm
Handling topic on WebHelp.
Assign to xenta group Click to assign one or all Xenta devices to a

default structure of Xenta groups after a
solutions (application) import. For more
information, see the Assigning to Xenta
Group topic on WebHelp.

1520

Use the Modification submenu to add a value to a manual trend log.
Figure: The trend log Actions menu, Modification submenu
Table: Modification Submenu

Command Description
Add log record Click to open the Add log record dialog
box where you add values and comments to
a manual trend log. For more information,
see section 35.23 “Adding a Trend Log
Record to a Manual Trend Log” on page
1057.

1521

Use the View submenu to display object related events, temporary trend charts or
trend log lists.
Figure: Actions menu - View submenu
Table: Actions Menu – View Submenu

Command Description
Events Click to open an Events pane that displays

the events related to a specific object. For
Specific Event View” on page 959.
Trends Click to view related trend objects. For more

information, see section 52.55 “Related
Trends Properties Dialog” on page 1575.
Report Click to open a report.
Trend charts Use the Trend charts submenu to open or

create a trend chart. For more information,
Submenu - Trend Charts Submenu” on
page 1162.
Trend log lists Use the Trend log lists submenu to open or
create a trend log list. For more information,
Submenu - Trend Log Lists Submenu” on
page 1163.
Watch pane Use the Watch pane submenu to select the

property of the variable you want to monitor.
“Actions Menu - View Submenu - Watch

1522
52.11 Actions Menu - View Submenu - Watch Submenu
52.11 Actions Menu - View Submenu - Watch

Submenu
Use the Watch submenu to choose which property you want to monitor.
Figure: Watch submenu
Command Description
Use default properties Click to use the default property when you
monitor the variable.
Select Property Click to open a dialog box where you select

the property of the variable you want to
monitor.

1523
52.12 Actions Menu – Actions Submenu
52.12 Actions Menu – Actions Submenu

Use the Actions submenu to create manual archives on an Enterprise Server.
Figure: Actions Menu – Actions submenu
Table: Actions Menu – Actions Submenu

Command Description
Create archive(s) Creates a manual archive that is saved to a predefined path on the
now computer running WorkStation. For more information, see section
50.1 “Archive Settings Manager Dialog Box” on page 1459.

1524
52.13 Watch Select Property Dialog Box
52.13 Watch Select Property Dialog Box

Use the Watch Select Property dialog box to select the property of the variable you
want to monitor.
Figure: Select property dialog box


1525
52.14 Add/Remove Columns Dialog Box (Watch Pane)

(Watch Pane)
Watch pane.

1526
52.15 Tools Menu
52.15 Tools Menu

Use the Tools menu to open the Control Panel and the Options dialog box.
Figure: Tools menu
Table: Tools Menu

Command Description
Control Panel Click to open the Control Panel where you

get access to some of the most used
administration functions in Building
Operation, such as alarms, domains, user
accounts, backup and archiving, and
engineering. For more information, see
section 52.17 “Control Panel View” on page
1529.
Options Click to open the Options dialog box where

you manage some local user settings. For
“Options Dialog Box” on page 1528.

1527
52.16 Options Dialog Box
52.16 Options Dialog Box

Use the Options dialog box to manage some local user settings.
Figure: Options dialog box
Table: Options Dialog Box

Show same tab while navigating Click to open the same tab at all times when
between objects you navigate between objects. For more
information, see section 48.5 “Object Tab
Display” on page 1398.
Reset all user settings Click to reset your locally saved user setting.
For more information, see the
Personalization topic on WebHelp.

1528
52.17 Control Panel View

Use the Control Panel to access some of the most used functions in Building
Operation.
Figure: Control Panel
Table: Control Panel

Server Select the server you want to work with.
Action notes Click to open Action notes. For more

information, see section 30.6 “Action Notes”
on page 786.
Categories Cick to open Categories. For more

information, see section 29.10 “Categories”
on page 732.
Cause notes Click to open Cause notes. For more

information, see section 30.2 “Cause Notes”
on page 780.
Checklists Click to open Checklists. For more

information, see section 30.10 “Checklists”
on page 792.

1529
Continued
Domain Click to open Domain. For more information,

see section 21.1 “Domains” on page 435.
Alarm appearances Click to open Alarm appearances. For more

information, see section 31.44 “Alarm Styles
Account management Click to open Account management. For

page 375.
Network time and time zones Click to open Network time and time zones.
“Time and Time Zone” on page 329.
Communication Click to open Server Communication. For

more information, see the Server
Communication topic on WebHelp.
Device discovery Click to open the Device discovery. For more

information, see the Device Discovery topic
on WebHelp.
Reference Manager Click to open Reference Manager. For more

information, see the Reference Management
topic on WebHelp.
Binding Templates Click to open Binding Templates. For more

information, see the Binding Templates topic
on WebHelp.
WorkPlace Tech Editor Click to open WorkPlace Tech Editor. For

more information, see the WorkPlace Tech
Editor topic on WebHelp.
LNS Plug-in Registration Click to open LNS Plug-in Registration. For

more information, see the LNS Plug-ins topic
on WebHelp.
Backup Rules Click to open Backup Rules. For more

information, see section 57.1 “Backup and
Restore Overview” on page 1605.
Backup Sets Click to open Backup Sets. For more

information, see section 59.1 “Backup Sets”
on page 1629.
Backup and Restore Manager Click to open Backup and Restore Manager.
“Comparison of Backup and Restore
Methods ” on page 1607.
Archiving Click to open Archive Settings. For more

information, see section 49.1 “Archiving

1530
Continued
EWS Server Configuration Click to open the EcoStruxure Web Service

server configuration. For more information,
see the EcoStruxure Web Service Server
topic on WebHelp.

1531
52.18 Progress View – Advanced

The Advanced Progress View is displayed when you download and commission
objects in field devices in, for example, LonWorks and BACnet.
The Progress view displays information about time-consuming operations between
WorkStation and Building Operation server. You can also see detailed information
about what went wrong if the operation fails.
Figure: Advanced Progress view when an operation failed.
52.18.1 Detail View

The detailed information in the Progress view helps you to identify problems during
any operation.

1532
Figure: Detailed information is displayed in the Error dialog.

1533
52.19 Progress View – Simple

The Progress view displays information about time-consuming operations between
WorkStation and Building Operation server. You can also see detailed information
about what went wrong if the operation fails.
52.19.1 Simple Progress View

The Simple Progress View is displayed when you create, rename, copy or move, an
object. If the operation is successful and very fast you may probably not notice the
Progress view at all.
Figure: Simple Progress view when an operation failed.
52.19.2 Detail View

The detailed information in the Progress view helps you to identify problems during
any operation.

1534
Figure: Detailed information is displayed in the Error dialog.

1535
52.20 Operation Details Dialog Box
52.20 Operation Details Dialog Box

The Operating details dialog box displays more detailed information on what
went wrong during the operation.
Figure: Failing Progress - Progress Manager dialog box
Table: Failing Progress - Progress Manager dialog box

Path Displays the path to the object the operation

is performed on.
Type Displays the object type.
Operation details Dislays the time and text for the operation.
Error details Click to open the Error dialog box to get

more error details. For more information, see
section 52.21 “Error Details – Progress
Copy to clipboard Click to copy the information to the

clipboard.

1536
52.21 Error Details – Progress View
52.21 Error Details – Progress View

Use the Error dialog box to display more information about errors during the
operation.
Figure: Error dialog box.
Table: Error Details – Progress View

Previous Click to get to the previous error message.
Next Click to get to the next error message.
Copy to clipboard Click to copy the information to the

clipboard.
Close Click to close the dialog box.

1537
52.22 Create Object Wizard – Naming the Object Page
52.22 Create Object Wizard – Naming the

Object Page
Use the Naming the object page to set the basic properties for the object. For
objects with several types, you also select the object type.
Figure: Naming the object page
Table: Naming the Object Page

(Object type list) Select the type of object you want to create.
“Object Types” on page 1393.
Name Type the name of the object. For more

information, see section 48.2 “Object
Names” on page 1394.
Prefix Type a label that is added in front of the

object name. For more information, see
section 40.4 “Suffix and Prefix” on page
1232.
Suffix Type a label that is added after the object

name. For more information, see section
40.4 “Suffix and Prefix” on page 1232.
Location Enter the path to the location in the System

Tree where you want to create the object. By
default, the path to the selected folder or
object in the System Tree is displayed.

1538
52.22 Create Object Wizard – Naming the Object Page
Continued

object is used for.

1539
52.23 List View Toolbar
52.23 List View Toolbar

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.
Table: List View Toolbar

Button Description
Parent folder
Click to move up one folder.
Create Folder
Click to create a new folder.
Show/Hide Group Box

topic on WebHelp.
Show/Hide Property Grid

Click to display the Properties of a selected
48.3 “Object Properties” on page 1395.


1540
52.24 System Tree Pane Toolbar
52.24 System Tree Pane Toolbar

Use the System Tree pane toolbar to filter objects in the System Tree pane.
Table: System Tree Toolbar

Button Description
Filter
Click to show non-presentaion objects. For
more information, see section 47.2 “System
Tree Pane” on page 1379.
Collapse All
Click to collapse the tree structure.
Table: The System Tree pane filter menu

Command Description
Show non-presentation objects Select to show non-presentation objects.

1541
52.25 Confirm Delete Dialog Box
52.25 Confirm Delete Dialog Box

Use the Confirm Delete dialog box to view how the object you are deleting is
referred to, and from, other objects. When you delete objects you are informed on
how the object is referred to, and from, other objects. The affected references will
not be deleted.
Figure: Confirm Delete dialog box
Table: Confirm Delete dialog box

Keep references ... Select to keep references in other objects to

the object you want to delete.
Path Displays the path to the objects that is

affected by the object you want to delete.
Copy to clipboard Click to copy the information about the

affected references to the clipboard.
Yes Click to delete the object.
No Click to close the dialog box without deleting

the object.

1542
52.26 Delete Object Dialog Box
52.26 Delete Object Dialog Box

The Delete object dialog box is displayed when you try to delete an object you
are not allowed to delete.
Figure: Delete object dialog box
Table: Delete Object Dialog Box

Command Description
Apply to all selected objects Select to apply the same command to all
selected object(s).
Abort deletion Click Abort deletion to keep all objects.
Ignore Click Ignore to the delete the selected

objects and keep objects that you are not
allowed to delete.

1543
52.27 Rename Object Dialog Box
52.27 Rename Object Dialog Box

Use the Rename object dialog box to rename an object.
Figure: Rename object dialog box
Table: Rename Object Dialog Box

Object Name Type the new name of the object.

1544
52.28 General Properties – Basic Tab

Use the Basic tab to configure and view the basic properties.
Figure: General properties – basic tab
Table: General Properties

Name Displays the name of the object.

object is used for.
Type Displays the object type that defines the

Foreign address Displays the address to a non-Building

Operation device, for example a BACnet
device.
Modified Displays the date and time when the object

was last modified.
Note 1 Type text that you display in a graphic or use

when searching for the object.

1545
Continued
Note 2 Type text that you display in a graphic or use

when searching for the object.
Validation Select the validation status of the object to

keep track of which objects have passed or
failed the validation.

1546
52.29 General Properties – References Tab
52.29 General Properties – References Tab

Use the References tab to view and navigate to referred objects.
Figure: General properties – references tab
Table: General Properties – References Tab

References Displays the object's references to other

objects. Click on a reference to navigate to
the object the reference points to.

1547
52.30 Retain Level
52.30 Retain Level

In Building Operation, the Retain level setting for variables allows the user to
configure when the system should retain the value of the variable.
System Events No Cold start Warm start
and Activities
Cold start command Default value a Variable retains the Variable retains last
last value set by value set by a user or
either a user or an default if never set by
application. user.
Warm start Default value Variable retains the Variable retains the
command last value set by last value set by
either a user or an either a user or an
application. application or default
if never set by user.
Exporting & Default value Variable retains the Variable retains the
Importing last value set by last value set by a
either a user or an user or default if
application. never set by user.
Viewing Variable in Shows the last value Shows the last value Shows the last value
Building Operation set by either a user or set by either a user or set by either a user or
user interface an application an application. an application, but
not what is in the
configuration
database. b
Backup & Restore Default value Variable retains the Variable retains last
application. user.
Power loss and Default value Variable retains the Variable retains the
restore last value set by last value set by
either a user or an either a user or an
application. application or default
if never set by user.
Upgrade Default value Variable retains the Variable retains last

application. user.
a) 1. Initial value is the value that a variable will have when it is first created. It was determined by the
Building Operation developers at design time
b) 2. The last value set by a user is not visible in the UI if an application is also setting the variable. This
could cause unintended control problems when there is an import, cold start, upgrade, or restore. It
is recommended that Warm start retain level should not be used in cases where users and
application need to set a variable. An example might be a temperture set point that is visible in a
graphic for a user to change but also is driven automatically from a program. In this case, a Cold
start retain level should be used instead.

1548
52.31 Configure Dialog Box - Configuration Tab
52.31 Configure Dialog Box - Configuration

Tab
You can configure the unit for a value and force or change values.
Figure: Using the Configure dialog box and the Configuration tab you can change or set
units for values.
Type Displays the object type. Read-only
Unit Displays the Unit. Select to change the unit.

“Units” on page 318.
Init value Read-only.
Reference Read-only.
Forceable Select to make the value forcible. For more

information, see the Forced Values topic on
WebHelp.
Retain level Select how to handle values for warm start,

cold start, system events, and system
activities. For more information, see section
52.30 “Retain Level ” on page 1548.

1549
52.31 Configure Dialog Box - Configuration Tab
Using the Null checkbox, you can remove any value of a property. The Null
checkbox is available for all properties where the value can be removed. For
example, you can remove references from trend logs using the Null checkbox.
Values can be forced to a certain value. The true value from the system is displayed
in the Unforced value box.

1550
52.32 Configure Dialog Box – Operation Tab
52.32 Configure Dialog Box – Operation Tab

Use the Operation tab to force and release values and to check the unforced
value.
Figure: The Operation tab displaying both the forced and unforced value
Value Enter the value that you want to use to

override the value of the property. For more
information, see the Forced Values topic on
WebHelp.
Force value Click Force value to force a value. For

more information, see the Forced Values
topic on WebHelp.
Unforced Value Displays the actual value that the point

would have if the value had not been forced.
For more information, see the Forced Values
topic on WebHelp.

1551
52.33 Search Icons
52.33 Search Icons

This table describes the search icons.
Table: Search Icons

Icon Description
Search query
Indicates a saved search in the System Tree
pane and in the List View. For more
information, see section 51.1 “Search

1552
52.34 Search View
52.34 Search View

Use the Search view to do the search settings, view the search results, and save
searches.
Figure: Search
Table: Search View

Component Descriptions
Use the Search toolbar to clear, save, and

update search settings .
Type the text you want to search for in the

Search box.
The Search result list displays search results.
Click the magnifier to start a search.
In folder Enter the folder where you want to search.
Include properties Select to include properties in your search.
Include subserver Select to include subservers in your search.
Stop if more than 1000 results Select to stop the search when the results
exceed 1000.

1553
52.34 Search View
Continued
Component Descriptions
Include types Enter the object types that you want to

include in the search.
Conditions Use Include conditions to enter the

conditions that you want to apply on the
object type properties.

1554
52.35 Search View Toolbar
52.35 Search View Toolbar

Use the Search view toolbar to save a search, group search results or clear
search criteria.
Table: Search View Toolbar

Button Description
Save search criteria

Click to save the search for future use.
Show/Hide group box

topic on WebHelp.
Show/Hide property grid

Click to display the Properties of a selected
48.3 “Object Properties” on page 1395.
Clear search criteria

Click to clear all settings in the Search view.

1555
52.36 Search Toolbar
52.36 Search Toolbar

Use the Search basic toolbar to make a simple search on all objects.
Figure: Search basic toolbar

1556
52.37 Add/Remove Columns Dialog Box (Search)

(Search)
Use the Add/Remove Columns dialog box to add or remove columns to the
Search View.

1557
52.38 Select Folder Dialog Box
52.38 Select Folder Dialog Box

Use the Select Folder dialog box to select the folder where you want to search.
Figure: Select folder dialog box
Table: Select Folder Dialog Box

Path Displays the path to the selected folder.
System Tree Select the folder where you want to search.

1558
52.39 Select Types Dialog Box
52.39 Select Types Dialog Box

Use the Select types dialog box to select the object types you want to include in
the search.
Figure: Select types dialog box
Table: Select Types Dialog Box

Object type tree Select the object type to search for.
Add type
Click to add the selected object type to the
search.
Remove type
Click to remove the selected object from to
the search.
Selected object types Displays the object types that are included in
the search.
Find type Type the name of the object type you want
to include.

1559
52.40 Select Conditions Dialog Box
52.40 Select Conditions Dialog Box

Use the Select Conditions dialog box to enter property criteria for the object
types that are included in the search.
Figure: Select conditions dialog box with the common properties for all object types.
Table: Select Conditions Dialog Box

Button Description
Click to add a condition.
Click to remove a condition.

1560
52.41 Add/Remove Columns Dialog Box (System Tree Pane)

(System Tree Pane)
view of objects, such as folders, in the System Tree pane. Depending on the object
you have selected in the System Tree pane, you get a different set of column
options.
Figure: Ad/Remove Columns dialog box

1561
52.42 Analog Value Properties
52.42 Analog Value Properties

Use the Analog Value properties dialog box to view or configure an analog value.
Figure: Analog value
Table: Analog Value

Force value Click to force a value. For more information,

see the Forced Values topic on WebHelp.

1562
52.43 Digital Value Properties
52.43 Digital Value Properties

Use the Digital Value properties dialog box to view or configure a digital value.
Figure: Digital value
Table: Digital Value



1563
52.44 Multistate Value Properties
52.44 Multistate Value Properties

Use the Multistate Value properties dialog box to view or configure a multistate
value.
Figure: Multistate value
Table: Multistate Value



1564
52.45 String Value Properties
52.45 String Value Properties

Use the String Value properties dialog box to view or configure a string value.
Figure: String value
Table: String Value



1565
52.46 Signal Generator Dialog Box
52.46 Signal Generator Dialog Box

Use the Signal Generator dialog box to configure a sinus, square or saw tooth
signal used for tests.
Figure: Signal generator dialog box
Signal type Select the signal type, sinus, square, saw

tooth, setpoint, alarm, or event.
Cycle (s) Select the cycle in seconds.
Amplitude Select the amplitude.

1566
52.47 Simple Math Operator Dialog Box
52.47 Simple Math Operator Dialog Box

Use the Simple Math Operator dialog box to add, subtract, multiply, or divide
one value from another when you perform tests.
Figure: Simple math operator
Operator Select the operator, add, subtract, multiply,

or divide.
In1 Input value 1.
In2 Input value 2.

1567
52.48 Create Hyperlink Wizard – Assign the URL Page
52.48 Create Hyperlink Wizard – Assign the

URL Page
Use the Assign the URL page to type the URL.
Figure: Assign the URL page
Table: Assign the URL Page

URL Type the URL of the website.

1568
52.49 Select Object Dialog Box
52.49 Select Object Dialog Box

Use the Select Object dialog box to select objects.
Figure: Select object dialog box
Table: Select Object Dialog Box

Command Description
Lock path Select to lock the path and make it absolute.

For more information, see the Reference
Format topic on WebHelp.
Path Displays the path to the selected object.

1569
52.50 Select Object and Properties Dialog Box
52.50 Select Object and Properties Dialog Box

Use the Select Object and Properties dialog box to select an object and its
properties.
Figure: Select object and properties dialog box
Table: Select Object and Properties Dialog Box

Lock path Select to lock the path and make it absolute.

For more information, see the Reference
Format topic on WebHelp.
Path Displays the path to the selected object.

1570
52.51 Progress View
52.51 Progress View

The Progress view displays information about time-consuming operations
between WorkStation and the Building Operation server.
Figure: The Progress view
Table: Progress View

Operation Displays the name of the operation that is

being performed.
Name Displays the name of the object that the

operation is performed on.
Progress Displays the progress of the operation so

you can determine when the operation is
complete.
Status Displays the status of the operation.
Click to get details for the operation.
Close Click to close the Progress view dialog

box.

1571
52.52 System Object Properties
52.52 System Object Properties

Use the System Object Properties view or dialog box to configure and view the
Figure: System Object Properties

1572
52.53 System Control Panel Properties
52.53 System Control Panel Properties

Use the System Control Panel Properties view or dialog box to configure and
view the general and object-reference properties. For more information, see section
52.28 “General Properties – Basic Tab” on page 1545.
Figure: System Control Panel Properties

1573
52.54 Commit Page
52.54 Commit Page

The Commit Page displays the progress indication.
Figure: Commit page
Table: Commit Page

[Progress bar] Displays the progress indication.

1574
52.55 Related Trends Properties Dialog
52.55 Related Trends Properties Dialog

Use the Related Trends properties dialog to view trend objects that are referred
to by a selected object.
Figure: Related Trends
Table: Related Trends

[Quick filter] Enter a word or a character to filter on. For

[List of references] Lists the referred objects.
Path Displays the path to the trend object that is

selected in the list.

1575
53 Shortcuts
Topics
Shortcuts Overview
Shortcut Functionality
User Access to Shortcuts and Targets
Shortcut Presentation
Viewing Shortcuts
Viewing Shortcut Properties
Shortcut Creation
Creating a Shortcut
Configuring the Target of a Shortcut
Editing Shortcuts
53 Shortcuts
53.1 Shortcuts Overview
53.1 Shortcuts Overview

In Building Operation, you can create shortcuts to objects in the System Tree pane.
A shortcut is a link to a target server, folder, or other object and is simply a pointer
to an object which acts as if it is that object.
Note
• For the purposes of this discussion, examples of objects in the System Tree
pane are servers, folders, graphics or points.
As an example, you might want to view, in one place, the open or closed state of
the security doors in all of six different buildings on a site. However, the digital input
objects representing door status (open/closed) are distributed throughout the
System Tree pane on a building-by-building basis. To implement the required view,
you could create a folder in a convenient place in the System Tree pane, and within
the folder, create shortcuts to all the (door status) digital input objects in all six
buildings.
As another example, you could create a shortcut to an existing server or folder
complete with its internal objects.
You can create shortcuts in any server or folder in the System Tree pane (except for
the System folder). You can also create shortcuts to other objects (such as graphic
objects) and points (such as analog and digital values).

1579
53 Shortcuts
53.2 Shortcut Functionality
53.2 Shortcut Functionality

When you click on a shortcut to an object in the System Tree pane, the appropriate
view for the target object (such as a graphic or a properties dialog box) is displayed.
If you view the Properties of a selected shortcut, the properties shown are always
those of the target object. However, if you view the Shortcut Properties of a
selected shortcut, the properties shown are those of the shortcut.
When you select a shortcut, the address bar shows the address of the shortcut and
the icon of the shortcut becomes highlighted. Also, the name displayed on the
window tab is that of the shortcut.
You can reference a shortcut as if it were the target object. For example, if you drag
a shortcut to the Watch pane, the target object is added to the Watch pane as if it
had been dropped there instead. This functionality also applies to other situations
such as logging and alarms.
Shortcut object commands that create new objects referencing the target (such as
a new alarm or trend log) create the new objects at the parent folder of the shortcut
(not the parent folder of the target).
Shortcuts are followed whenever a selection action is performed, except in the
following circumstances:
• When the target value is Null
• When exporting objects (the shortcut is exported, not the target)
• When displaying the shortcut object properties using the Shortcut
Properties command in the context menu

1580
53 Shortcuts
53.3 User Access to Shortcuts and Targets
53.3 User Access to Shortcuts and Targets

The software permissions of a shortcut and its target object can be independently
configured to enable control of user group accessibility.
Whenever these software permissions are set such that the user can see the target
object by means of the shortcut, the user has the same read/write access to the
shortcut as is set up for the target object.
The shortcut inherits all the commands of the target object type (but not all of these
commands act upon the target object).
Inherited commands applied at the shortcut operate on either the shortcut itself, or
on the target object, as listed in the following table:
Table: Inherited Command Application

Command applied at shortcut Command operates on…
Delete Shortcut
Copy Shortcut
Move Shortcut
Rename Shortcut
Cut/Paste Shortcut
Shortcut properties Shortcut
Properties Target
Open Target
Add to Watch Target
Trend commands Target
Create Alarm Target

1581
53 Shortcuts
53.4 Shortcut Presentation
53.4 Shortcut Presentation

Shortcuts without targets and shortcuts to objects are non-presentation objects. By
default, non-presentation objects are not displayed in the System Tree, except
when selected by means of the System Tree filter. However, a shortcut with a
server or a folder as a target is a presentation object and is always displayed in the
System Tree. For more information, see section 53.5 “Viewing Shortcuts” on page
1583.
When a shortcut is created in a server or folder by means of the File-New
submenu or the New-Shortcut command of the Context menu, the shortcut has
no valid target. In this case, only the overlay icon (a small arrow in a square) is
displayed (because no target type is assigned).
Figure: Example of a shortcut without an assigned target

When a target is assigned, the overlay icon of the shortcut is added on top of the
icon of the target. For more information, see section 54.3 “Shortcut Properties –
Basic Tab” on page 1593.
The following figure is an example of a shortcut for an analog value in the System
Tree:
Figure: Example of a shortcut to an analog value

When you click a shortcut, the address of the shortcut is displayed in the address
bar and the name of the shortcut is displayed in the the tab of the shortcut window.

1582
53 Shortcuts
53.5 Viewing Shortcuts
53.5 Viewing Shortcuts

You view shortcuts to objects in the System Tree, but shortcuts to objects are non-
presentation objects and must first be selected for display (shortcuts to folders are
displayed in the System Tree by default).
For more information, see section 53.4 “Shortcut Presentation” on page 1582.
To view shortcuts to objects
1. In the System Tree pane, click the Filter icon to open the filter menu.
2. Select Show non-presentation objects.
You can now view the properties of the shortcut(s).

1583
53 Shortcuts
53.6 Viewing Shortcut Properties
53.6 Viewing Shortcut Properties

You view the properties of a shortcut in order to confirm or change the target of the
shortcut.
For more information, see section 53.10 “Editing Shortcuts” on page 1588.
To view the properties of a shortcut

1. In the System Tree pane, right-click the shortcut and then click Shortcut
Properties.
Note
• You cannot view the properties of a shortcut by selecting the Properties
command. You must select the Shortcut Properties command.

1584
53 Shortcuts
53.7 Shortcut Creation
53.7 Shortcut Creation

You can create a shortcut to a server, folder or object anywhere in the System Tree
pane.
If you attempt to create another shortcut with the same name as an existing
shortcut within the same server or folder, you will be prevented from entering the
duplicate name. If you attempt to drag-and-drop a shortcut to a destination where a
shortcut exists with the same name, you will be presented with a dialog box
explaining the other options available.
You can use more than one shortcut to refer to the same target object, but a
shortcut can only refer to one target object. The target object keeps track of all
shortcuts that refer to it (they behave as ordinary object references).
The following table shows the menu commands applicable to the creation of
shortcuts for some common System Tree pane objects.
Table: Menu Commands for Shortcut Creation

File- Context Context Context Edit Edit Other
New (right- (right- (right- menu menu
submen mouse) mouse) mouse)
u menu menu menu
Comma Shortcut New- Create Paste as Create Paste as Drag-

nd Shortcut shortcut shortcut shortcut shortcut and-drop
Server Yes Yes Yes* Yes Yes Yes Yes
Folder Yes Yes Yes Yes Yes Yes Yes
Point No No Yes Yes Yes Yes Yes
Graphic No No Yes Yes Yes Yes Yes
*Except for the highest level server where there is more than one server.
53.7.1 Shortcuts in Servers and Folders

You can create shortcuts in the root of a server or in an existing folder. A shortcut
can reference objects in other servers. The menu commands applicable to the
creation of shortcuts for servers and folders are shown in the table above.
If a shortcut object is created without specifying a target object, the (forward) target
object reference is removed.
53.7.2 Shortcuts to Objects and Points

You can create shortcuts to objects or points (for example, a graphic or an analog
value) within a server or folder. In these cases, the target object is automatically
displayed in the properties dialog box of the shortcut. The menu commands
applicable to the creation of shortcuts for some example objects and points are
shown in the table above.

1585
53 Shortcuts
53.8 Creating a Shortcut
53.8 Creating a Shortcut

You create a shortcut to an object or folder to provide a pointer that acts as if it is
that object or folder.
For more information, see section 53.7 “Shortcut Creation” on page 1585.
To create a shortcut
1. In WorkStation, in the System Tree pane, select the object you want to
create the shortcut for.
2. Right-click and drag the object to the server or folder where you want the
shortcut.
3. Click Create Shortcut.

1586
53 Shortcuts
53.9 Configuring the Target of a Shortcut
53.9 Configuring the Target of a Shortcut

Shortcuts created using the File-New submenu or the Context menu New
command are not automatically configured with a target, therefore you must
configure the target manually.
For more information, see section 53.10 “Editing Shortcuts” on page 1588.
To configure the target of a shortcut

1. In WorkStation, in the System Tree pane, right-click the shortcut object and
select Shortcut Properties.
Target Enter the path of the target object (either

directly, or by way of the browse button
4. In the Select Object dialog box, select a Path Type option (if required).
5. Click Select.
6. Click OK.

1587
53 Shortcuts
53.10 Editing Shortcuts
53.10 Editing Shortcuts

When you have created a shortcut in a folder or on a server using the File-New-
Shortcut submenu or the context menu New-Shortcut option, you must then
also assign a target to the shortcut. It is not necessary to assign a target to a
shortcut after using any other shortcut creation method.
When you delete a target object, the forward reference in all shortcuts referencing
that target object is removed. Also, the shortcut object icon changes to display the
shortcut overlay icon only (a small arrow in a square).
When you delete a shortcut object, the (backwards) reference held in the target
object is removed.
When you move a target object, the shortcuts referencing that target are updated
with the new target path in their (forward) target object reference. When you move a
shortcut object, the (backwards) reference held in the target object is updated with
the new path.
When you rename a target object, the shortcuts referencing that target are updated
with the new target path. If you rename a shortcut object, the (backwards)
reference held in the target object is updated with the new path.
When you duplicate a shortcut object, the (backwards) reference held in the
common target object is updated with the additional path to the new shortcut. For
more information, see section 53.9 “Configuring the Target of a Shortcut” on page
1587.

1588
54 Shortcuts User Interface
Topics
Shortcuts Icon
Create Shortcut Wizard – Shortcut Target Page
Shortcut Properties – Basic Tab
54.1 Shortcuts Icon
54.1 Shortcuts Icon

This section describes the icon in WorkStation that relates to shortcuts.
Table: Shortcuts Icon in Building Operation

Icon Description
Overlay Shortcut icon

Indicates a shortcut to an object in the
System Tree.

1591
54.2 Create Shortcut Wizard – Shortcut Target Page
54.2 Create Shortcut Wizard – Shortcut

Target Page
Use the Shortcut target page to enter the target of the shortcut.
Figure: Shortcut target page
Table: Shortcut Target Page

Command Description
Shortcut target Enter the target of the shortcut.

1592
54.3 Shortcut Properties – Basic Tab
54.3 Shortcut Properties – Basic Tab

Use the Basic tab to view shortcut properties or to change the path to the target
object in the System Tree pane.
Figure: Basic tab
Table: Basic Tab

Target Enter the path of the target server, folder or

object.

1593
55 Documents
Topics
Documents Overview
Creating a Document
55 Documents
55.1 Documents Overview
55.1 Documents Overview

A Document is a container in which you can upload (import) a file for use in Building
Operation. You can upload all types of files, including reports, forms, images, and
video clips.
When you open a Document, Building Operation starts the installed editor or viewer
associated with the file type. For example, you can open, edit, and save documents
associated with Microsoft Word. For more information, see the Opening a
Document topic on WebHelp.
Important
You can upload any file type, including .doc, .jpg, .pdf, or .txt, without size
restrictions. However, importing files larger than 17 MB to an Automation Server
can result in an Insufficient Memory error.
Document creation
You can quickly create a Document by dragging a file from Windows Explorer to
WorkStation. You can also create a Document by using the Wizard. For more
information, see section 55.2 “Creating a Document” on page 1598.
Document attachment to other objects

After a Document is created and saved, you can attach the Document to another
Building Operation object, such as an Alarm. For instance, you can create an Alarm
Acknowledgement checklist and attach the checklist to a particular alarm.
Operators can review and complete the checklist using a standard Windows viewer
or editor, such as Notepad. For more information, see section 28.21 “Configuring
Attachments of an Alarm” on page 719.
However, a Document is a separate entity so you cannot attach the Document
directly to another object. Instead, you make an attachment from a Building
Operation object to the Document.
Important
When you log off or are automatically logged off, any unsaved changes in the
document are not saved in the database. Make sure that you save changes in
open documents frequently.

1597
55 Documents
55.2 Creating a Document
55.2 Creating a Document

You create a document so that you can view, edit, and store files in WorkStation.
You can also attach documents to other Building Operation objects, such as
alarms.
For more information, see section 55.1 “Documents Overview” on page 1597.
To create a document
1. In Windows Explorer, select the file you want to import to WorkStation.
2. In WorkStation, drag the file to the server or folder where you want to create a
document.

1598
56 Documents User Interface
Topics
Document Properties – Basic Tab
New Document Wizard – Import Document Page
56.1 Document Properties – Basic Tab
56.1 Document Properties – Basic Tab

Use the Basic tab to view the current information on a particular document
including the source file associated with the document. You can also import a
different source file.
Figure: Basic tab
Table: Basic Tab

File Enter the file that you want to import to WorkStation.

1601
56.2 New Document Wizard – Import Document Page
56.2 New Document Wizard – Import

Document Page
Use the Import Document page to import a file to WorkStation. You can upload
all types of files including: reports, diagrams, note files, trend diagrams, voice
messages, images, and video clips.
Figure: Import document dialog box
Table: Import Document Dialog Box

File Enter the file that you want to import to WorkStation.

1602
57 Backup and Restore
Topics
Backup and Restore Overview
Comparison of Backup and Restore Methods
Local Backup and Restore of Building Operation Servers
Remote Backup and Restore of Automation Servers
57.1 Backup and Restore Overview

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.
57.1.1 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.
Building Operation provides two backup options:
• Configuration only: Useful for new installations, Building Operation backs up
the configuration database, which preserves a snapshot of the configuration
data for a particular date and time.
• All data: Useful for existing systems, Building Operation backs up the
configuration data and historical data, which preserves a snapshot of the
configuration data for a particular date and includes a copy of the trend logs
and event logs.
For more information, see section 58.1 “Backup” on page 1613.
57.1.2 Restore
Restore is the process of restoring data to an original or former state. Using
Restore, you can revert to a previous snapshot of the server data despite any
configuration changes made since the last backup. In Building Operation, Restore
is a manual process designed to avoid the accidental overwriting of current server
data.
For more information, see section 61.1 “Restore” on page 1667.
57.1.3 BACnet Backup and Restore

BACnet Backup uses a binary file format to back up an entire device. Specifically,
BACnet Backups comprise the entire contents of the selected device, such as
associated objects, properties, bindings, historical data, and related proprietary
configuration data.
For more information, see the BACnet Backup and Restore topic on WebHelp.

1605
57.1.4 Archiving Overview

57.1.5 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.
For more information, see section 57.2 “Comparison of Backup and Restore
Methods ” on page 1607.

1606
57.2 Comparison of Backup and Restore Methods
57.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.
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 Use this method to back up Enterprise Servers and

Operation configuration Automation Servers that can include data from b3,
Backup data and LonWorks, Network 8000, I/NET, MicroNet, and Modbus
historical data devices.
The b3 devices are automatically backed up whenever a
Building Operation server is backed up. Therefore, b3
devices do not need backing up using the BACnet
Backup method.
BACnet Backs up Use this method to backup primarily:

Backup configuration
data • External devices
• Routers
BACnet Backup and Restore can also backup and
restore b3 devices that are connected to either a b3CX
controller or external router. However, BACnet backup
and restore cannot backup b3 devices when the devices
are connected to an Automation Server that functions as
a router. For more information, see the BACnet Backup
and Restore topic on WebHelp.
Building Restores a Use this method to restore Enterprise Servers and

Operation Building Automation Servers that can include data from b3,
Restore Operation LonWorks, Network 8000, I/NET, MicroNet, and Modbus
server using devices.
configuration
data and
historical data
contained in a
backup set
BACnet Restores a Use this method to backup primarily:

Restore device using
configuration • External devices
data contained • Routers
in a backup
set (no
historical data)
Tip
To restore archived data, use the Archiving feature rather than Restore method.
See For more information, see section 49.1 “Archiving Overview” on page 1411.

1607
57.3 Local Backup and Restore of Building Operation Servers
57.3 Local Backup and Restore of Building

Operation Servers
In WorkStation, you can log on to a Building Operation server directly to perform
manual backup and restore tasks.
57.3.1 Local Backup and Restore of a Standalone

Automation Server
In WorkStation, you can log on to an Automation Server to perform a manual
backup of the server data. If you have multiple standalone Automation Servers, the
Backup and Restore processes on one Automation Server remain self-contained
and, therefore, separate from any another Automation Server on the network.
Figure: Backup and Restore for multiple 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 on to an Automation Server.

1608
57.3 Local Backup and Restore of Building Operation Servers
57.3.2 Local Backup and Restore of an Enterprise

Server
In WorkStation, you can log on to an Enterprise Server to perform a manual backup
of the server data. If you have multiple Enterprise Servers, the Backup and Restore
processes on one Enterprise Server remain self-contained and, therefore, separate
from any another Enterprise Server on the network.
Figure: Backup and Restore for multiple Enterprise Servers

1609
57.4 Remote Backup and Restore of Automation Servers
57.4 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 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 Automation Server backup files in the Restore
Options dialog box that are stored on the Enterprise Server. In the event that the
backup file is damaged or lost, or not the one you want to use, you can select a
valid backup file to restore the Automation Server. The restore operation overwrites
the locally stored server backup file located on the Automation Server with the
selected backup file. For more information, see section 61.4 “Restoring an
Automation Server from the Enterprise Server” on page 1672.

1610
58 Backups
Topics
Backup
Types of Data
Backup Status
Checking the Backup Status of a Server
Manual Backups
Mass Backup
Backing Up Servers Manually
System Backup
58 Backups
58.1 Backup
58.1 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.
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 59.1 “Backup Sets” on page 1629.
Building Operation provides two backup options:
• Configuration only: Useful for new installations, Building Operation backs up
the configuration database, which preserves a snapshot of the configuration
data for a particular date and time.
• All data: Useful for existing systems, Building Operation backs up the
configuration data and historical data, which preserves a snapshot of the
configuration data for a particular date and includes a copy of the trend logs
and event logs.
58.1.1 Types of Data

In Building Operation, there are two types of data that are backed up: Historical and
Configuration.
For more information, see section 58.2 “Types of Data” on page 1615.
58.1.2 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
in the Local folder within 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. However, an Enterprise Server can
store multiple backup sets locally.
For more information, see section 59.1 “Backup Sets” on page 1629.
58.1.3 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 60.1 “Scheduled Backups” on page 1651.

1613
58 Backups
58.1 Backup
58.1.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.
For more information, see section 58.5 “Manual Backups” on page 1618.
58.1.5 Mass Backup

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.
For more information, see section 58.6 “Mass Backup” on page 1620.
58.1.6 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.
For more information, see section 58.8 “System Backup” on page 1624.
58.1.7 Backup Status

Backup Status displays the statuses of a server: Ready, Backing up, or Backup
succeeded.
For more information, see section 58.3 “Backup Status” on page 1616.

1614
58 Backups
58.2 Types of Data
58.2 Types of Data

In Building Operation, there are two types of data that are backed up: Historical and
Configuration.
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 perform an All data backup back up an
Automation Server weekly if multiple operators use their WorkStations frequently.
As a precaution, you can perform a Configuration only backup before installing a
new application or modifying the current configuration.
The following table lists the types of data that you can back up and the purposes of
each.
Table: Backup Data

Type of Data Contents
Historical Includes trend logs and event logs stored on a server.
Configuration Includes configuration data comprised of points, values, alarm objects,

trend objects, programs, graphics, and custom object type data.
Also includes the configuration properties of variables, such as Unit.
Depending on the retain level of the variable, some configuration
properties like Value are also included in a backup. For more
information, see section 52.30 “Retain Level ” on page 1548.
Note
Depending on the type of data, the system locks changes to the database while a
backup is in progress in different ways. For configuration changes, 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.
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.
values, which can overwrite any changes made since the last backup. For more
information, see section 52.30 “Retain Level ” on page 1548.

1615
58 Backups
58.3 Backup Status
58.3 Backup Status

Backup Status displays the statuses of a server: Ready, Backing up, or Backup
succeeded.
If a backup does not succeed, the system displays a default alarm informing you of
the backup or server issue. For more information, see the Backup and Restore
Alarms topic on WebHelp.

1616
58 Backups
58.4 Checking the Backup Status of a Server
58.4 Checking the Backup Status of a Server

You check the backup status of a server to view the server status and note the date
and time of the last backup.
For more information, see section 58.3 “Backup Status” on page 1616.
To check the backup status of a server

1. In WorkStation, on the Tools menu, select Control 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 Backup and Restore Manager.
4. View the server status or date and time of the last successful backup.

1617
58 Backups
58.5 Manual Backups
58.5 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 on to one of the following Building Operation servers to initiate a manual
backup:
• Automation Server or Enterprise Server to perform a local backup. For more
information, see section 57.3 “Local Backup and Restore of Building Operation
Servers” on page 1608.
• Enterprise Server to perform a remote backup of any Automation Servers that
are created under the Enterprise Server. For more information, see section
57.4 “Remote Backup and Restore of Automation Servers” on page 1610.
58.5.1 Backup Set Naming

For manual backups, the system initially names the backup set by combining the
server name with the localized date and time of the machine running WorkStation.
For scheduled backups, however, the system combines the server name with the
UTC time in the backup set name rather than the local time.
Tip
The system also retains the UTC time of manually generated backups. To view
the UTC time rather than the localized time for a manual backup set, select the
Backup date property from the column selector of the Backup Sets List view.
For more information, see the Columns in Views and Panes topic on WebHelp.
If you log on to 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 the Duplicate Backup Set Names
in Multi-server Systems topic on WebHelp.
58.5.2 Local Backup and Restore of Building

Operation Servers
In WorkStation, you can log on to a Building Operation server directly to perform
manual backup and restore tasks.
For more information, see section 57.3 “Local Backup and Restore of Building
Operation Servers” on page 1608.

1618
58 Backups
58.5 Manual Backups
58.5.3 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 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 57.4 “Remote Backup and Restore of
Automation Servers” on page 1610.

1619
58 Backups
58.6 Mass Backup
58.6 Mass Backup

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.
In smaller installations, a server group may include an Enterprise Server comprised
of one or more Automation Servers. In larger installations, multiple server groups
may include an Enterprise Server with a distinct set of Automation Servers. In either
case, the Enterprise Server is the hierarchical top server with one or more lower tier
Automation Servers.
Figure: Mass backup of an Enterprise Server and lower tier Automation Servers
You log on to the Enterprise Server to create a mass backup. For more information,
see section 62.5 “Backup Options Dialog Box” on page 1683.

1620
58 Backups
58.7 Backing Up Servers Manually

You back up multiple servers manually to copy and store data that is frequently
updated.
For more information, see section 58.5 “Manual Backups” on page 1618.
To back up servers manually

1. In WorkStation, in the System Tree pane, select the server.
2. On the Actions menu, click 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.
4. In the Backup set name suffix box, type some text at the end of the file
name that helps identify the backup set.
5. In the Include column, select the 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 data, and custom
object type data.

1621
58 Backups
7. In the Backup set description column, type a brief description up to 255

characters to help identify the content of each backup.
8. Click the Synchronize Description button to add the same backup set
description entered for one server to all the other backup sets.
9. Click the Synchronize Content button to add the same content type
chosen for one server to all the other backup sets.
10. Click the Synchronize All button to add both the backup set
description and the content type chosen for one server to all the other backup
sets.
11. Click Backup.

1622
58 Backups
12. Verify that the backups succeeded and click Close.

1623
58 Backups
58.8 System Backup
58.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 section 49.7 “Manually
Creating an Archive” on page 1419.
2 Back up current servers Create an All data backup for the Enterprise
Server and each Automation Server. The
backups do not need to follow any particular
order. For more information, see section 58.7
“Backing Up Servers Manually” on page 1621.
3 Save backup sets to an external Save the Enterprise Server and Automation
location Server backup sets (.xbk) to a safe location on
a file system that is external to the Enterprise
Server. For more information, see section 59.2
“Backup Set Storage and Protection” on page
1631.

1624
58 Backups
58.8 System Backup
Continued
Step Procedure Description
4 Back up current Reports For systems that include a Reports Server,

database back up the WebReports database. For more
information, see the Backing Up the
WebReports Database topic on WebHelp.
You can also back up the Reports database
folder to another location on the file system (not
the default source location in the C:\Program
Files\ directory).

1625
59 Backup Sets
Topics
Backup Sets
Backup Set Storage and Protection
Locating the Local Backup Path on the Enterprise Server
Copying an Enterprise Server Backup Set to WorkStation
Copying an Automation Server Backup Set to WorkStation
Copying a Backup Set to the Enterprise Server Local
Directory
Backup Set Import from WorkStation
Importing a Backup Set to an Enterprise Server
Importing a Backup Set to an Automation Server
Automatic Purge of Backup Sets
Configuring Purge Settings on an Enterprise Server
Deleting a Backup Set from the Enterprise Server
59 Backup Sets
59.1 Backup Sets
59.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
in the Local folder within 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. However, an Enterprise Server can
store multiple backup sets locally.
Figure: Backup sets in the Local folder

Unlike an Automation Server, an Enterprise Server can store multiple local and
remote backup files. In multiple server sites, the Enterprise Server manages all the
Automation Servers in its group. Consequently, the backup set is actually stored in
two places: on the Automation Server and on the Enterprise Server. In the Backup
sets folder of the installation directory, Building Operation creates two directories:
• ASArchives: Lists separate subfolders that reflect the name of each
Automation Server. Each subfolder contains the backup files for that server.
• 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 59.3 “Locating
the Local Backup Path on the Enterprise Server” on page 1633.
Tip
Going forward, you must create new backups for the renamed server.

1629
59 Backup Sets
59.1 Backup Sets
59.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 59.2 “Backup Set Storage and Protection” on
page 1631.
59.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 59.7 “Backup Set Import from WorkStation” on
page 1640.
59.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, you can configure the Enterprise Server to remove outdated backup sets.
For more information, see section 59.10 “Automatic Purge of Backup Sets” on
page 1644.

1630
59 Backup Sets
59.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 60.1 “Scheduled Backups” on page
1651.

1631
59 Backup Sets
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 59.12 “Deleting a Backup Set from the Enterprise Server” on page
1646.
• Periodically. You can configure the system to remove backup sets on a regular
basis. For more information, see section 59.10 “Automatic Purge of Backup
Sets” on page 1644.

1632
59 Backup Sets
59.3 Locating the Local Backup Path on the Enterprise Server
59.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.
page 1631.
To locate a local backup path on the Enterprise Server

1. In WorkStation, log on to the Enterprise Server.
2. On the Tools menu, select Control Panel.
3. In the Server box, select the Enterprise Server.
4. In the Backup and archiving area, select Backup and Restore
Manager.
5. In the Backup sets path box, view the local backup path on the server.

1633
59 Backup Sets
59.4 Copying an Enterprise Server Backup Set to WorkStation
59.4 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.
page 1631.
To copy an Enterprise Server backup set to WorkStation

4. In the Backup and archiving area, click Backup Sets.
5. In the List View, open the Local folder.
6. Select the Enterprise Server backup set that you want to save to a different
location.
7. On the Actions menu, click Save To.

8. In the Save As dialog box, enter a storage location and click Save.

1634
59 Backup Sets
59.4 Copying an Enterprise Server Backup Set to WorkStation
9. Make a note of the destination and click Close.

1635
59 Backup Sets
59.5 Copying an Automation Server Backup Set to WorkStation
59.5 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, log on to the Enterprise Server or Automation Server.
3. In the Server box, select the server.
4. In the Backup and archiving area, click Backup Sets.
5. In the List View, open the Local folder for an Automation Server or the AS
Archives folder for an Enterprise Server.
6. If connected to the Enterprise Server, open the Automation Server folder that
contains the backup set.
7. Select the backup set that you want to save to a different location.
8. On the Actions menu, click Save To.

9. In the Save As dialog box, enter a storage location and click Save.

1636
59 Backup Sets
59.5 Copying an Automation Server Backup Set to WorkStation
10. Make a note of the destination and click Close.

1637
59 Backup Sets
59.6 Copying a Backup Set to the Enterprise Server Local Directory
59.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.
page 1631.
To copy a backup set to the Enterprise Server local directory

3. In the Servers box, select the Enterprise Server.
4. In the Backup and archiving area, click the Backup and Restore
Manager.
5. In the Backup sets path box, copy the entire backup sets path of the
Enterprise Server.
6. Open a browser, such as Windows Explorer.

7. In the browser Address box, paste the backup sets path and press Enter.

1638
59 Backup Sets
59.6 Copying a Backup Set to the Enterprise Server Local Directory
8. In the db_backup folder, open the LocalBackup folder.
9. Right click the backup set that you want to copy and click Copy.
10. Navigate to the db_backup folder of the Enterprise Server that you want to
restore.
11. Paste the backup set into the LocalBackup folder of the targeted Enterprise
Server.
Note
If the LocalBackup folder does not appear within the db_backup
folder, you can create one using the exact name, LocalBackup.
You can now restore the Enterprise Server using this backup set. For more
information, see section 61.3 “Restoring a Server” on page 1670.

1639
59 Backup Sets
59.7 Backup Set Import from WorkStation
59.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 (including service pack). To help identify the
usable backup sets, the system displays the compatible files in black text and the
incompatible files in red text. If you select an incompatible backup set to restore a
server, no backup set displays after importing.

1640
59 Backup Sets
59.8 Importing a Backup Set to an Enterprise Server
59.8 Importing a Backup Set to an Enterprise

Server
You import a backup set from a network storage location to restore an Enterprise
Server, or to replace a lost or damaged backup set.
page 1640.
To import a backup set to an Enterprise Server

1. In WorkStation, in the System Tree pane, select the Enterprise Server.
2. On the Actions menu, click Restore.
3. Click Import Backup Set.
4. Select a backup set that is stored on a file system and click Open.
5. Click Yes.

1641
59 Backup Sets
59.8 Importing a Backup Set to an Enterprise Server
6. Click Close.
You can now restore the Enterprise Server with the imported backup set.

1642
59 Backup Sets
59.9 Importing a Backup Set to an Automation Server
59.9 Importing a Backup Set 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.
page 1640.
To import a backup set to an Automation Server

1. Log on to the Automation Server to which you want to import a backup set.
2. In WorkStation, in the System Tree pane, select the Automation Server.
4. Click Import Backup Set.
5. Click OK.
6. Select a valid backup set that is stored on a file system and click Open.
You can now restore the Automation Server with the imported backup set.

1643
59 Backup Sets
59.10 Automatic Purge of Backup Sets
59.10 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, you can configure the Enterprise Server to remove outdated backup sets.
You configure purge settings on an Enterprise Server, rather than an Automation
Server. For more information, see section 62.3 “Backup and Restore Manager on
the Enterprise Server” on page 1681.
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, the most recent backup set
replaces the most outdated backup set. In other words, the system adds a file and
then deletes the oldest file to maintain the maximum number that you set for the
server.
Local and Remote Purge Settings

You can manage automatic purging on an Enterprise Server by setting a maximum
number of files to store. There are two purge settings:
• Local setting for the Enterprise Server: The local setting, Number of local
backup sets to store, manages the backups stored on an Enterprise Server.
• Global setting for Automation Servers: The global setting, Number of AS
backup sets to store, manages all the backups stored on the Automation
Servers. You cannot configure each Automation Server separately because the
global setting affects all the servers created under the Enterprise Server.
You can vary the number of local and remote backup sets that you store. For
example, you can configure the system to store a maximum of five local backup
sets for the Enterprise Server and two remote backup sets for each Automation
Server.
Enable/Disable Automatic Purging

By default, 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 62.3 “Backup
and Restore Manager on the Enterprise Server” on page 1681.

1644
59 Backup Sets
59.11 Configuring Purge Settings on an Enterprise Server
59.11 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 59.10 “Automatic Purge of Backup Sets” on
page 1644.
To configure purge settings on an Enterprise Server

5. In the Number of Automation Server backup sets to store box, enter
the maximum number of backups that the Enterprise Server can store for
each Automation Server.
6. In the Number of local backup sets to store box, enter the maximum
number of backup sets that the system can store for the Enterprise Server.

1645
59 Backup Sets
59.12 Deleting a Backup Set from the Enterprise Server
59.12 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 59.1 “Backup Sets” on page 1629.
To delete a backup set from the Enterprise Server

5. In the Backup sets path box, copy the entire backup sets path of the
Enterprise Server.
6. Open a browser, such as Windows Explorer.

7. In the browser Address box, paste the backup sets path and press Enter.

1646
59 Backup Sets
59.12 Deleting a Backup Set from the Enterprise Server
8. In the db_backup folder, open the ASArchives or LocalBackup folder.
9. Right-click on the backup set that you want to delete and click Delete.
10. Click Yes to remove the backup set.

1647
60 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
60.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 58.5 “Manual Backups” on page
1618.
Figure: Backup on an Enterprise Server
60.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.

1651
For more information, see section 60.2 “Backup Rules” on page 1653.
60.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 60.7 “Backup Schedules” on page 1660.
60.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 60.9 “Synchronized Backups” on page 1662.

1652
60.2 Backup Rules
60.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.
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 62.8 “Backup Rules View” on page 1687.

1653
60.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.
To create a backup rule

2. In the Server box, select a server where you want to create a backup rule.
3. In the Backup and archiving area, click Backup Rules.
4. Click the Add backup rule button .
5. In the Name box, type a name for the backup rule.
6. In the Description box, type a description for the backup rule and click
Next.

1654
7. In the Backup set description box, type a comment up to 255 characters

to help identify the content of the backup.
8. In the Backup content box, select the type of data you want to back up:
custom object type data. For example, use this option to restore data to a
replaced server with the same name in the system.
• Select All data to back up the configuration, historical, and custom
object type data. For example, use this option to preserve the
configuration and historical data for a specified date and time.
9. In the Lead rule box, enter a backup rule that references a lead schedule
managed on another server.
10. In the Enabled box, select Yes to enable the backup rule.
11. Click Create.

1655
60.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.
To edit a backup rule

2. In the Server box, select a server.
4. Select a backup rule and then click the Edit backup rule button .
5. In the Backup set description box, type or modify the backup comment.
6. In the Backup content box, change the type of data you want to back up:
custom object type data. For example, use this option to restore data to a
replaced server with the same name in the system.

1656

object type data. For example, use this option to preserve the
configuration and historical data for a specified date and time.
7. In the Lead rule box, enter a backup rule that references a lead schedule
managed on another server.
8. In the Enabled box, select Yes to enable the backup rule.
9. Click OK.

1657
60.5 Deleting a Backup Rule
60.5 Deleting a Backup Rule

You delete a backup rule to remove the rule from the server.
To delete a backup rule

2. In the Server box, select the server where you want to delete a backup rule.
4. Select the backup rule and then click the Remove backup rule button .
5. Click Yes to delete the backup rule from the server.

1658
60.6 Removing a Lead Rule from a Backup Rule
60.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.
To remove a lead rule from a backup rule

2. In the Servers box, select the server where you want to remove a lead rule
from a backup rule.
4. Select the backup rule and click the Edit backup rule button .
5. In the Lead rule box, delete the lead backup rule, which removes the lead
and shadow relationship for the selected server.
6. Click OK.

1659
60.7 Backup Schedules
60.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 62.8 “Backup Rules View” on page
1687.

1660
60.8 Editing a Backup Schedule
60.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 60.7 “Backup Schedules” on page 1660.
To edit a backup schedule

2. In the Server box, select a server where you want to modify a backup
schedule.
4. In the Schedule column, click the schedule that you want to modify.
5. Revise the schedule and then click the Save button .

1661
60.9 Synchronized Backups
60.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 60.10
“Synchronizing Server Backups on a Network” on page 1663.

1662
60.10 Synchronizing Server Backups on a Network
60.10 Synchronizing Server Backups on a

Network
You synchronize all the Building Operation server backups to increase efficiency by
centralizing the automated backup management on a single server, rather than
across multiple servers.
For more information, see section 60.9 “Synchronized Backups” on page 1662.
To synchronize server backups on a network

4. In the Lead rule column, enter a backup rule that you want to use as the lead
rule 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.

1663
61 Restore
Topics
Restore
Restored Data
Restoring a Server
Restoring an Automation Server from the Enterprise Server
Automation Server Replacement Using Restore
61 Restore
61.1 Restore
61.1 Restore
Restore is the process of restoring data to an original or former state. Using
Restore, you can revert to a previous snapshot of the server data despite any
configuration changes made since the last backup. In Building Operation, Restore
is a manual process designed to avoid the accidental overwriting of current server
data.
61.1.1 Restored Data

Depending on what is contained in the backup file, you can restore different types
of data.
• Configuration 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: Building Operation restores the configuration, historical, and custom
object types data.
For more information, see section 61.2 “Restored Data” on page 1668.
61.1.2 Automation Server Replacement Using

Restore
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 61.5 “Automation Server Replacement Using
Restore” on page 1674.

1667
61 Restore
61.2 Restored Data
61.2 Restored Data

Depending on what is contained in the backup file, you can restore different types
of data.
• Configuration 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: Building Operation restores the configuration, historical, and custom
object types data.
Table: Types of Data and Content

Types of Data Content
Historical Includes Trend logs and Event logs stored on the 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.
Impact on Configuration Values and Variables

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
61.4 “Restoring an Automation Server from the Enterprise Server” on page 1672.

1668
61 Restore
61.2 Restored Data
Restore status
The server properties indicate if a restore was performed:
• Enterprise Server. For more information, see the Enterprise Server Properties –
Basic Tab topic on WebHelp.
• Automation Server. For more information, see the Automation Server
Properties – Basic Tab topic on WebHelp.

1669
61 Restore
61.3 Restoring a Server

You restore a server to revert back to a previous snapshot of the server data.
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 the Stopping
a Windows Service topic on WebHelp.
To restore a server
1. In WorkStation, in the System Tree pane, select the server that you want to
restore.
Tip
Take manual control of any output points that could potentially
damage equipment before restoring the server. If you cannot
disconnect the physical outputs, restore the server using a trusted
restore file that will turn off/on the outputs predictably and safely.
3. In the Available restore points list, select a backup set in black text, which
indicates that the backup set is compatible with the current version of the
server.

1670
61 Restore
4. In an All data backup set, 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.
5. Click Restore.
6. Click Yes.
7. Click Close.
If your system includes a Reports Server, the Reporting Agent Windows
service restarts automatically.

1671
61 Restore
61.4 Restoring an Automation Server from the Enterprise Server
61.4 Restoring an Automation Server from

the Enterprise Server
You log on to an Enterprise Server to restore an Automation Server.
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.
Tip
Take manual control of any output points that could potentially
damage equipment before restoring the server. If you cannot
disconnect the physical outputs, restore the server using a trusted
restore file that will turn off/on the outputs predictably and safely.
3. In the Available restore points list, select a backup set in black text, which
indicates that the backup set is compatible with the current version of the
server.
4. In an All data backup set, select the type of data you want to restore:
• Select Configuration only to back up only configuration and custom
object types data.
object types data
5. Click Restore.
6. Click Yes.

1672
61 Restore
61.4 Restoring an Automation Server from the Enterprise Server
7. 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.

1673
61 Restore
61.5 Automation Server Replacement Using Restore
61.5 Automation Server Replacement Using

Restore
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 the Device Administrator Overview topic on WebHelp.
Important
• Make sure that you have a valid Automation Server backup set before
performing a restore. A backup set can contain either configuration data only,
or both configuration and historical data.
Standalone Automation Server Site

In a single Automation Server site, you log onto the 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.

1674
61 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 59.5
“Copying an Automation Server Backup Set to WorkStation” on page 1636.
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 59.5 “Copying an
Automation Server Backup Set to WorkStation” on
page 1636.
Add the new server to the network Choose one of the following methods:
and configure the IP address.
• DHCP configuration. For more information, see
the Configuring an Automation Server to Use
DHCP topic on WebHelp.
• Static IP configuration. For more information,
see the Setting the Automation Server IP
Address topic on 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 59.9 “Importing a
Backup Set to an Automation Server” on page 1643.
Restore the new server using the Restore a server.

imported backup set.
For more information, see section 61.3 “Restoring a
Server” on page 1670.
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.

1675
61 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 the Automation Server Remains Offline After
Restore topic on WebHelp.

1676
62 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
Create Object Wizard – Configure Backup Rule Page
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
Backup and Restore System Tree Icons
Restore Options Dialog Box
Restore Status Dialog Box
Backup and Restore Folder Properties
62 Backup and Restore User Interface
62.1 Backup and Restore Manager Properties (Enterprise Server) – Basic Tab
62.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 properties for the Enteprise Server
Table: Backup and Restore Manager Properties (Enterprise Server) – Basic Tab
Backup folder Displays the storage location of the backup set.
Backup and restore Displays the current status, such as backing up.
status
Last backup Displays the date and time of the last successful backup.
Purge AS backup Select Yes to enable automatic purging of remote Automation

sets Server backup files at the next backup.
Purge local backup Select Yes to enable automatic purging of local Enterprise Server
sets backup files at the next backup.
Number of remote Enter the maximum number of backup sets that the system can
AS backup sets to store for each Automation Server.
store
Number of local Enter the maximum number of backup sets that the system can
backup sets to store store for the Enterprise Server.

1679
62.2 Backup and Restore Manager Properties (Automation Server) – Basic Tab
62.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 for the Automation Server
Table: Backup and Restore Manager Properties (Automation Server) – Basic Tab
Backup and restore Displays the current status, such as backing up.
status
Backup folder Displays the storage location of the backup set.

1680
62.3 Backup and Restore Manager on the Enterprise Server
62.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

Status Displays the current backup status, such as backing up.
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 Enter the maximum number of backups that the Enterprise

Automation Server Server can store for each Automation Server.
backup sets to 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.

1681
62.4 Backup and Restore Manager on an Automation Server
62.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

Status Displays the current status, such as backing up.

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

Backup set Type the text that you want to add to the beginning of the file name to
name prefix help identify the backup set.
Backup set Type the text that you want to add to the end of the file name to help
name 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.

1683
Continued
Backup set Displays the name of the backup set that you entered.
name
Backup content Select the type of data that you want to back up for the server:
• All data: Backs up both the historical and configuration
databases, which are useful for existing systems. This combined
data option protects the configuration, historical data, and
custom object type data for a specified date and time.
• Configuration only: Backs up the configuration database and
custom object type data, which are useful for new installations.
This data option protects the configuration data for a specified
date and time.
Backup set Type a backup comment up to 255 characters that helps identify the
description type, content, or purpose of the scheduled backup.

1684
62.6 Create Object Wizard – Configure Backup Rule Page
62.6 Create Object Wizard – Configure

Backup Rule Page
Use the Configure Backup Rule page to define the type of data that you want to
back up and configure a lead rule.
Figure: Configure Backup Rule page
Table: Configure Backup Rules Page

Name Displays the name of the backup rule.
Backup set Type a description up to 255 characters that helps to identify the
description type and contents of the scheduled backup.
Backup content Select the type of data that you want to back up.
Lead rule Enter a backup rule that can act as a lead backup rule.
Enabled Select Yes to enable the backup rule.

1685
62.7 Backup Rule Properties – Basic Tab
62.7 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

Backup set description Type a description up to 255 characters that helps to

identify the type and contents of the scheduled backup.

1686
62.8 Backup Rules View
62.8 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 62.9 “Backup
Rules Toolbar” on page 1688.
Use the Backup Rules list to modify backup schedules or set

up lead rules. For more information, see section 62.10 “Backup
Rules List” on page 1689.

1687
62.9 Backup Rules Toolbar
62.9 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 60.3 “Creating a Backup Rule” on
page 1654.
Edit backup rule

Click to open the Backup rule dialog box where you modify a backup
rule. For more information, see section 60.4 “Editing a Backup Rule” on
page 1656.
Remove backup rule

Click to delete a backup rule. For more information, see section 60.5
“Deleting a Backup Rule” on page 1658.

1688
62.10 Backup Rules List
62.10 Backup Rules List

Use the Backup rules list to select a lead rule or modify a backup schedule for a
backup rule.
Figure: Backup rules list view
Table: Backup Rules List View

Path Displays the location of the backup rule on the server.
Schedule Click to open the Schedule Editor where you modify the backup
schedule contained in the backup rule. For more information, see the
Editing a Weekly Event topic on WebHelp.

1689
62.11 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

Description Type a description that explains what the object is used for.
Type Displays the schedule type.
Foreign Address
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.

1690
Continued
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, Failed, and
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.
Previous transition Displays the date and time the value most recently changed.
time
Time since Displays the amount of time in minutes that has elapsed since the
previous transition value last changed, rounded to the next minute.
Next transition Displays what the Value property will be when it next changes.
value
Time to next Displays the amount of time in minutes before the value changes.
transition
Following Displays the subsequent value following the next transition value.
transition value
Following Displays the subsequent date and time following the next transition
transition time time.
Time to following Displays the amount of time in minutes before the value changes to
transition the following transition value.
Remove past Select True to enable the system to automatically purge obsolete
events 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.
Lead object Select a lead schedule to reference.

1691
62.12 Backup Set Properties – Basic Tab
62.12 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

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.
Server type Displays the type of Building Operation server that can be
restored using this backup set.

1692
62.13 Backup Sets View
62.13 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 section 52.23 “List View Toolbar”
on page 1540.
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.

1693
62.14 Backup Status Dialog Box
62.14 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

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.

1694
62.15 Control Panel – Backup and Archiving
62.15 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

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 62.8 “Backup Rules View” on page 1687.
Backup Sets Click to open the Backup Sets view where you manage
backup sets. For more information, see section 62.13
“Backup Sets View” on page 1693.
Backup and Restore Click to open the Backup and Restore Manager where
Manager you view current backup and restore statuses and configure
Purge settings for an Enterprise Server. For more information,
see section 62.3 “Backup and Restore Manager on the
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 section 50.3 “Archiving
Settings Properties – Basic Tab” on page 1462.

1695
62.16 Backup Rule Dialog Box
62.16 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

Backup set description Type a description up to 255 characters that helps to identify
the type and contents of the scheduled backup.

1696
62.17 Backup and Restore System Tree Icons
62.17 Backup and Restore System Tree Icons

The following table describes the Backup and Restore icons in the System Tree.
Table: Backup and Restore System Tree Icons

Icon Description
Backup
Indicates one of the following backup and restore objects:
• Backup rule. For more information, see section 58.1 “Backup” on page
1613.
• Backup and Restore Manager. For more information, see section 62.3
“Backup and Restore Manager on the Enterprise Server” on page
1681.
Backup schedule
Indicates a backup schedule. For more information, see section 60.7
“Backup Schedules” on page 1660.

1697
62.18 Restore Options Dialog Box
62.18 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

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: Restores only configuration and custom
object type data.
• All 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.

1698
62.19 Restore Status Dialog Box
62.19 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

1699
62.20 Backup and Restore Folder Properties
62.20 Backup and Restore Folder Properties

Use the Backup and Restore Folder Properties view or dialog box to
configure and view the general properties.
Figure: Basic tab

1700
Schneider Electric | Buildings Division
www.schneider-electric.com/buildings
© 2013 Schneider Electric. All rights reserved.
04-14005-04-en
October 2013

System Reference Guide (Oct 2013)

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

System Reference Guide (Oct 2013)

Uploaded by

Copyright:

Available Formats

StruxureWare

2 Additional Information .................................................. 43

04-14005-04-en, October 2013 System

System 04-14005-04-en, October 2013

5 Installation Repair ......................................................... 97

6 Reinstallation ............................................................. 123

7 Computer Maintenance ............................................. 153

8 Uninstallation ............................................................. 163

9 Installation User interface ........................................... 187

04-14005-04-en, October 2013 System

10 Licensing Introduction ............................................... 195

11 Type of Licenses ........................................................ 219

System 04-14005-04-en, October 2013

12 Licensing Configuration and Diagnostics .................... 249

13 License Server and License Administrator .................. 257

04-14005-04-en, October 2013 System

15 Software Administrator .............................................. 297

16 Localization Language and Units ................................ 309

System 04-14005-04-en, October 2013

17 Localization Time and Time Zone ............................... 327

18 Localization User Interface ......................................... 351

19 User Account Management ....................................... 365

04-14005-04-en, October 2013 System

20 User Account Groups ................................................ 399

21 Domains .................................................................... 433

System 04-14005-04-en, October 2013

22 Software Permissions ................................................ 457

23 Login Configuration .................................................... 485

24 Workspaces .............................................................. 499

04-14005-04-en, October 2013 System

25 Audit Trails ................................................................. 543

26 User Management User Interface ............................... 555

System 04-14005-04-en, October 2013

27 Alarms Introduction .................................................... 619

04-14005-04-en, October 2013 System

28 Alarm Types ............................................................... 643

System 04-14005-04-en, October 2013

29 Alarms Functions ....................................................... 721

04-14005-04-en, October 2013 System

30 User Actions .............................................................. 777

31 Alarms User Interface ................................................. 799

System 04-14005-04-en, October 2013

04-14005-04-en, October 2013 System

32 Events ....................................................................... 937

33 Events User Interface ................................................. 957

34 Trend Log Introduction ............................................... 969

System 04-14005-04-en, October 2013

35 Trend Log Types ........................................................ 983

04-14005-04-en, October 2013 System

37 Trend Charts ............................................................ 1081

System 04-14005-04-en, October 2013

38 Trend Log Lists ........................................................ 1133

39 Trends User interface ............................................... 1157

04-14005-04-en, October 2013 System

40 Mass Create Alarms and Trends .............................. 1225

System 04-14005-04-en, October 2013

41 Schedules Introduction ............................................ 1251

42 Schedule Editor ....................................................... 1257

04-14005-04-en, October 2013 System

44 Schedule Events ...................................................... 1291

45 Calendars ................................................................ 1321

System 04-14005-04-en, October 2013

46 Schedules User Interface ......................................... 1345

47 WorkStation ............................................................. 1375