Sunteți pe pagina 1din 1512

StruxureWare Building Operation

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

Introduction
1 About This Guide ......................................................... 33
1.1 Purpose of This Guide ................................................................. 35
1.2 How This Guide is Organized ...................................................... 36
1.3 Typographical Conventions ......................................................... 37

2 Additional Information .................................................. 39


2.1 Where to Find Additional Information ........................................... 41
2.2 Regulatory Notices ...................................................................... 42

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

04-13005-02-en, October 2012 System


5
3.2.12 WebReports ............................................................................. 52
3.2.13 Language Package ................................................................... 52
3.3 Installation Example .................................................................... 53
3.4 Version Numbers and Parallel Installations ................................... 55
3.5 Installing the License Administrator and the License Server ......... 57
3.6 Installing WorkStation and Client Tools ........................................ 61
3.7 Installing a Language Package .................................................... 65
3.8 Installing the Enterprise Server .................................................... 68
3.9 Installing the Device Administrator ............................................... 74

4 Installation Repair ......................................................... 77


4.1 Installation Reparation ................................................................. 79
4.2 Repairing the License Administrator and the License Server ........ 80
4.3 Repairing WorkStation and Client Tools Installation ..................... 86
4.4 Repairing the Enterprise Server ................................................... 91
4.5 Repairing the Device Administrator Installation ............................. 98

5 Reinstallation ............................................................. 103


5.1 Reinstallation ............................................................................ 105
5.2 Reinstalling the License Administrator and the License Server ... 106
5.3 Reinstalling WorkStation and Client Tools .................................. 114
5.4 Reinstalling the Enterprise Server .............................................. 120
5.5 Reinstalling the Device Administrator Installation ........................ 128

6 Computer Maintenance ............................................. 133


6.1 Replace Enterprise Server or WebReports Computer Workflow . 135
6.1.1 Preparation ............................................................................. 135
6.1.2 Install Building Operation Software .......................................... 136
6.1.3 Restore the Enterprise Server Database .................................. 136
6.1.4 WebReports Migration Preparation ......................................... 138
6.1.5 Install WebReports .................................................................. 139

7 Uninstallation ............................................................. 141


7.1 Uninstallation ............................................................................ 143
7.2 Uninstalling the License Administrator ....................................... 144
7.3 Uninstalling the License Server .................................................. 147
7.4 Uninstalling WorkStation ........................................................... 152
7.5 Uninstalling Enterprise Server .................................................... 155
7.6 Uninstalling the Device Administrator ......................................... 160

8 Installation User interface ........................................... 163


8.1 Installation Wizard – Choose Components Page ....................... 165
8.2 Installation Wizard – Installation Type Page ................................ 167
8.3 Installation Wizard – License Server Configuration Page ............ 168
8.4 Enterprise Server Installation Wizard – Configuration Page ........ 169

9 Licensing Introduction ............................................... 171


9.1 Licensing Overview ................................................................... 173
9.1.1 License System ...................................................................... 173

System 04-13005-02-en, October 2012


6
9.1.2 License Management .............................................................. 173
9.1.3 Service and Maintenance ........................................................ 173
9.2 License System ........................................................................ 174
9.2.1 License Activation Server ........................................................ 174
9.2.2 License Server ........................................................................ 174
9.2.3 License Administrator ............................................................. 174
9.2.4 Licenses ................................................................................. 175
9.3 License Management ................................................................ 176
9.3.1 License System Installation and Configuration ......................... 176
9.3.2 Network License Management ................................................ 177
9.3.3 Local License Management .................................................... 177
9.4 Service and Maintenance ......................................................... 178
9.4.1 License Service Maintenance .................................................. 178
9.4.2 License Maintenance .............................................................. 178
9.4.3 Diagnostics ............................................................................. 178
9.5 License Maintenance ................................................................ 180
9.5.1 Local License Removal ........................................................... 180
9.5.2 Network License Return .......................................................... 180
9.5.3 Lost License ........................................................................... 180
9.5.4 License Reparation ................................................................. 180
9.5.5 License Backup ...................................................................... 180
9.6 Licenses ................................................................................... 181
9.6.1 End User License Agreement .................................................. 181
9.6.2 Local Licenses ........................................................................ 182
9.6.3 Network Licenses .................................................................. 182
9.6.4 Time-Limited Licenses ............................................................ 182
9.6.5 Permanent License ................................................................. 182
9.6.6 License Selection Process ...................................................... 182
9.7 Viewing Activated Licenses ...................................................... 183
9.8 Editing Registration Details ........................................................ 184
9.9 License Selection Process ........................................................ 186
9.10 Order Information Request ........................................................ 187
9.11 Lost License ............................................................................. 189
9.12 License Repair .......................................................................... 190
9.13 License Backup ........................................................................ 191
9.14 Backing Up Licenses ................................................................ 192
9.15 Restoring Licenses .................................................................... 193

10 Type of Licenses ........................................................ 195


10.1 Network Licenses .................................................................... 197
10.2 Network License Management .................................................. 201
10.2.1 Order Information Request ...................................................... 201
10.2.2 Network Licenses Activation ................................................... 201
10.2.3 Enterprise Server Address Configuration ................................. 201
10.2.4 WorkStation and Client Tools Address Configuration ............... 202
10.2.5 Network License Upgrade ....................................................... 202
10.3 Network Licenses Activation ..................................................... 203

04-13005-02-en, October 2012 System


7
10.4 Network License Return ............................................................ 205
10.5 Activating Network Licenses .................................................... 207
10.6 Removing a Local License or Returning a Network License ....... 210
10.7 Network License Upgrade ......................................................... 212
10.8 Upgrading Network Licenses .................................................... 214
10.9 Repairing a Network License .................................................... 218
10.10 Local Licenses .......................................................................... 220
10.11 Local License Management ...................................................... 222
10.11.1 Local License Activation .......................................................... 222
10.12 Activating a Local License ........................................................ 223

11 Licensing Configuration and Diagnostics .................... 227


11.1 Enterprise Server Address Configuration ................................... 229
11.2 WorkStation and Client Tools Address Configuration ................. 231
11.3 Viewing Diagnostic Information .................................................. 232
11.4 Copying Diagnostics to the Clipboard ....................................... 233

12 License Server and License Administrator .................. 235


12.1 License Server .......................................................................... 237
12.1.1 Flexnet License Manager, License Server Manager ................. 237
12.2 Starting the License Server ........................................................ 238
12.3 Stopping the License Server ..................................................... 239
12.4 Restarting the License Server .................................................... 240
12.5 Flexnet License Administrator, License Server Manager ............ 241
12.5.1 License Server Port Number ................................................... 242
12.5.2 FLEXnet License Administrator Port Number ........................... 243
12.6 Accessing Flexnet lmadmin ....................................................... 244
12.7 Changing the lmadmin License Server Manager Port Number ... 245
12.8 License Server Address ............................................................ 246
12.9 Configuring the Address to the License Server .......................... 248
12.10 License Server Reset ................................................................ 250
12.11 Resetting the License Server ..................................................... 251
12.12 Configuring License Server Recovery Settings ........................ 253
12.13 License Server Maintenance ..................................................... 255
12.13.1 License Server Address Change ............................................. 255
12.13.2 License Server Reinstallation .................................................. 255
12.13.3 License Server Replacement ................................................... 255
12.13.4 License Server Reset .............................................................. 257
12.14 License Administrator ............................................................... 258
12.14.1 Registration Details ................................................................. 258
12.14.2 License Server Address .......................................................... 258
12.15 Starting the License Administrator ............................................. 259

13 Licensing User Interface ............................................. 261


13.1 Registration Details View ........................................................... 263
13.2 Licenses View .......................................................................... 265
13.3 Licenses View Toolbar .............................................................. 266
13.4 Licenses View Icons .................................................................. 267

System 04-13005-02-en, October 2012


8
13.5 Licenses View Columns ............................................................ 268
13.6 Add License Dialog Box ............................................................ 269
13.7 License Activation Dialog Box ................................................... 270
13.8 License Progress Dialog Box ..................................................... 272
13.9 License Server Address View .................................................... 273
13.10 Diagnostics View ....................................................................... 274

14 Software Administrator .............................................. 275


14.1 Software Administrator ............................................................. 277
14.1.1 Service ................................................................................... 277
14.1.2 Ports ...................................................................................... 277
14.1.3 Database Location .................................................................. 277
14.1.4 Enterprise Server System Log ................................................. 277
14.2 Enterprise Server ...................................................................... 278
14.3 Starting Software Administrator ................................................. 279
14.4 Configuring Enterprise Server Port Settings ............................... 280
14.5 Starting the Enterprise Server Windows Service ........................ 281
14.6 Stopping the Enterprise Server Windows Service ...................... 282
14.7 Restarting the Enterprise Server Windows Service ..................... 283
14.8 Enterprise Server System Log ................................................... 285
14.9 Viewing Enterprise Server System Log ...................................... 286
14.10 Software Administrator – Enterprise Server View ....................... 287

15 Localization Language and Units ................................ 289


15.1 Regional and Language Conventions ........................................ 291
15.1.1 Language and Translation Packages ....................................... 291
15.1.2 Value Presentation .................................................................. 291
15.1.3 Time and Time Zone ............................................................... 291
15.2 Configuring Regional Settings ................................................... 292
15.3 Language Packages ................................................................. 293
15.3.1 Languages in WorkStation ...................................................... 293
15.3.2 Languages in WebStation ....................................................... 293
15.4 Changing WorkStation Language .............................................. 294
15.5 Adding a Language in WebStation ............................................ 295
15.6 Changing the Language in WebStation ..................................... 296
15.7 Value Presentation .................................................................... 297
15.7.1 Units ....................................................................................... 297
15.7.2 Metric Prefixes ........................................................................ 297
15.7.3 Precision Format ..................................................................... 297
15.8 Units ......................................................................................... 298
15.8.1 Delta Temperature Conversion ............................................... 298
15.9 Adding or Changing a Unit and Prefix for a Value ....................... 299
15.10 Metric Prefixes .......................................................................... 302
15.11 Precision Format ....................................................................... 303
15.12 Adding a Unit Conversion Exception ......................................... 304
15.13 Removing a Unit Conversion Exception ..................................... 306

16 Localization Time and Time Zone ............................... 307

04-13005-02-en, October 2012 System


9
16.1 Time and Time Zone ................................................................. 309
16.1.1 Network Time ......................................................................... 309
16.1.2 Time and Time Zone Configuration in WorkStation .................. 309
16.1.3 Time and Time Zone Configuration in Enterprise Server ........... 309
16.1.4 Time and Time Zone Configuration in Automation Server ......... 309
16.2 Lead and Shadow Relationship ................................................. 310
16.2.1 Synchronize Network Time Settings ........................................ 311
16.2.2 Synchronize Time Zone Settings ............................................. 311
16.2.3 Synchronize Schedules and Calendars ................................... 311
16.2.4 Set Inheritance Between Graphic Elements ............................. 311
16.3 Time and Time Zone Configuration in WorkStation .................... 312
16.3.1 Server Time in WorkStation ..................................................... 312
16.4 Time and Time Zone Configuration in Enterprise Server ............. 313
16.5 Time and Time Zone Configuration in Automation Server ........... 314
16.6 Changing the Time Zone of an Enterprise Server or Automation
Server ....................................................................................... 315
16.7 Creating a Custom Time Zone of an Enterprise Server or Automation
Server ....................................................................................... 317
16.8 Configuring Enterprise Server and WorkStation Date and Time .. 319
16.9 Synchronizing the Automation Server Clock ............................. 320
16.10 Manually Changing the Automation Server Time and Date ......... 322
16.11 Network Time ........................................................................... 324
16.11.1 Network Time on WorkStation and Enterprise Server .............. 324
16.11.2 Network Time Server on Automation Server ............................ 324
16.12 Synchronize Network Time Settings .......................................... 325
16.13 Synchronizing Time Settings on Multiple Automation Servers .... 326
16.14 Synchronize Time Zone Settings ............................................... 328
16.15 Synchronizing Time Zone Settings on Multiple Automation
Servers ..................................................................................... 329

17 Localization User Interface ......................................... 331


17.1 Unit Selection Dialog Box .......................................................... 333
17.2 Date and Time Properties – Basic Tab ....................................... 334
17.3 Date and Time Properties – Time Tab ........................................ 335
17.4 Time Zone Properties – Basic Tab ............................................ 336
17.5 Time Zone Properties – Zone Info Tab ....................................... 337
17.6 Enterprise Server – Date & Time View ........................................ 339
17.7 Automation Server – Date & Time View ..................................... 341
17.8 Add or Remove Languages Dialog Box ..................................... 343
17.9 Unit Conversion Exceptions View .............................................. 344

18 User Account Management ....................................... 345


18.1 User Account Management Overview ....................................... 347
18.1.1 User Accounts and User Account Groups ............................... 348
18.1.2 Domains ................................................................................. 348
18.1.3 Software Permissions ............................................................. 348
18.1.4 Log on Methods ..................................................................... 348
18.1.5 Workspaces ........................................................................... 348

System 04-13005-02-en, October 2012


10
18.1.6 Guest Log On in WebStation ................................................... 349
18.2 Opening the Account Management Control Panel ..................... 350
18.3 User Accounts and User Account Groups ................................. 351
18.3.1 Window Active Directory User Groups ..................................... 352
18.3.2 WorkStation Account Management ......................................... 353
18.4 Creating a User Account ........................................................... 354
18.5 Editing a User Account Profile ................................................... 358
18.6 Renaming a User Account ........................................................ 360
18.7 Disabling a User Account .......................................................... 362
18.8 Enabling a Disabled User Account ............................................. 364
18.9 Setting an Expiration Date for a User Account ........................... 366
18.10 Removing the Expiration Date for a User Account ...................... 368
18.11 Deleting a User Account ............................................................ 370

19 User Account Groups ................................................ 373


19.1 Windows Active Directory User Groups ..................................... 375
19.2 Creating a User Account Group ................................................ 377
19.3 Editing the Description of a User Account Group ....................... 382
19.4 Adding a User Account to a User Account Group ..................... 384
19.5 Removing a User Account from a User Account Group ............. 386
19.6 Reviewing the User Account Group Memberships for a User
Account .................................................................................... 388
19.7 Adding a User Account Group to a User Account Group ........... 390
19.8 Removing a User Account Group from another User Account
Group ....................................................................................... 393
19.9 Reviewing the User Account Group Memberships for a User
Account Group ......................................................................... 395
19.10 Preventing a Group of Users from Exiting WorkStation .............. 397
19.11 Enabling a Group of Users to Exit Workstation ........................... 399
19.12 Deleting a User Account Group ................................................. 401

20 Domains .................................................................... 403


20.1 Domains ................................................................................... 405
20.1.1 Windows Active Directory Domain ........................................... 406
20.1.2 Server Local Domain ............................................................... 407
20.1.3 Administration Accounts in Server Local Domain ..................... 407
20.2 Log On Methods ....................................................................... 408
20.2.1 Log On as a Windows User ..................................................... 408
20.2.2 Log On as a Building Operation User ....................................... 408
20.2.3 Password Administration ........................................................ 408
20.3 Guest Log On in WebStation ..................................................... 409
20.4 Creating and Configuring a Domain ........................................... 410
20.5 Editing the Windows Domain Name .......................................... 414
20.6 Editing the Description of a Domain ........................................... 416
20.7 Editing the Maximum Logon Attempts ....................................... 418
20.8 Assigning a Server to a Domain ................................................. 420
20.9 Removing a Server from a Domain ............................................ 422
20.10 Deleting a Domain ..................................................................... 424

04-13005-02-en, October 2012 System


11
20.11 Administration Accounts in Server Local Domain ....................... 426
20.11.1 Admin Account ....................................................................... 426
20.11.2 Reports Administrator Account ............................................... 426

21 Software Permissions ................................................ 427


21.1 Software Permissions ............................................................... 429
21.1.1 Path Permissions .................................................................... 429
21.1.2 Command Permissions ........................................................... 429
21.1.3 Software Permission Rules ...................................................... 429
21.1.4 Software Permissions and User Account Groups .................... 429
21.1.5 Software Permissions Summary .............................................. 430
21.2 Software Permissions and User Account Groups ...................... 431
21.3 Software Permission Rules ........................................................ 433
21.4 Path Permissions ...................................................................... 434
21.5 Command Permissions ............................................................ 437
21.6 Assigning Software Permissions to a User Account ................... 439
21.7 Editing the Software Permissions of a User Account .................. 441
21.8 Assigning Software Permissions to a User Account Group ........ 443
21.9 Editing the Software Permissions of a User Account Group ....... 446

22 Login Configuration .................................................... 451


22.1 Password Administration .......................................................... 453
22.2 Editing a User Account Password ............................................. 454
22.3 Allowing Users to Change their Password ................................. 456
22.4 Changing Your Password ......................................................... 458
22.5 Turning off Remember Me On This Computer ........................... 459
22.6 Forcing a User to Change the Password at Next Logon ............. 460
22.7 Preventing Users from Changing Their Passwords .................... 462
22.8 Resetting the Administrator Password ....................................... 464

23 Workspaces .............................................................. 465


23.1 Workspaces ............................................................................. 467
23.1.1 Predefined Workspaces .......................................................... 467
23.1.2 Workspace Components and Customization .......................... 468
23.1.3 WebStation in Kiosk Mode ...................................................... 468
23.2 Predefined Workspaces ............................................................ 469
23.3 Workspace Components and Customization ............................ 470
23.3.1 Workspace Component Customization ................................... 470
23.3.2 Workspace Content References .............................................. 471
23.3.3 Panel Components ................................................................. 471
23.4 Workspace Component Customization ..................................... 472
23.5 Workspace Content References ................................................ 474
23.6 Panel Components ................................................................... 475
23.7 Creating a Workspace ............................................................... 476
23.8 Editing the Layout of a Workspace ............................................ 480
23.9 Editing the Description of a Workspace ..................................... 483
23.10 Adding a Component to a Workspace ....................................... 485
23.11 Removing a Component from a Workspace .............................. 489

System 04-13005-02-en, October 2012


12
23.12 Editing a Workspace Component .............................................. 491
23.13 Adding a Workspace to a User Account Group ......................... 493
23.14 Removing a Workspace from a User Account Group ................. 495
23.15 Reviewing the Workspace Memberships for a User Account
Group ....................................................................................... 497
23.16 Creating a Panel ....................................................................... 499
23.17 Editing a Panel .......................................................................... 503
23.18 WebStation in Kiosk Mode ........................................................ 504
23.18.1 Configure WebStation to Run in Kiosk Mode ........................... 504
23.19 Configuring WebStation to Run in Kiosk Mode .......................... 506

24 Audit Trails ................................................................. 509


24.1 WorkStation Account Management .......................................... 511
24.1.1 Audit Trailing of User Activity ................................................... 511
24.1.2 WorkStation Account Validation .............................................. 511
24.2 Audit Trailing of User Activity ..................................................... 512
24.3 Disabling Audit Trail for a Group of Users ................................... 513
24.4 Enabling Audit Trail for a Group of Users ................................... 515
24.5 Viewing an Audit Trail Log ......................................................... 517
24.6 WorkStation Account Validation ................................................ 519

25 User Management User Interface ............................... 521


25.1 User Management System Tree Icons ....................................... 525
25.2 Domain Properties .................................................................... 526
25.3 Profile Properties ....................................................................... 527
25.4 Workspace Properties ............................................................... 528
25.5 Pane Properties ........................................................................ 530
25.6 Panel Properties ........................................................................ 531
25.7 Building Operation WorkStation Window ................................... 532
25.8 Domain Control Panel ............................................................... 534
25.9 Account Management Control Panel ......................................... 535
25.10 Select Default Workspace Window ............................................ 538
25.11 Change Password Dialog Box ................................................... 539
25.12 Domain Wizard – Authentication Page ....................................... 540
25.13 Domain Wizard – Domain Policies Page .................................... 541
25.14 Domain – Summary Tab ........................................................... 542
25.15 Domain – Policies Tab ............................................................... 543
25.16 Domain – Domain Members Tab ............................................... 544
25.17 User Account – Summary Tab .................................................. 545
25.18 User Account – Group Membership Tab ................................... 546
25.19 User Account – Profile Tab ........................................................ 548
25.20 User Account – Software Permissions Tab ................................ 549
25.21 User Account – Audit Trailing Events Tab .................................. 550
25.22 User Account Group Properties ................................................ 551
25.23 User Account Properties ........................................................... 552
25.24 User Account Group Wizard – Users Belonging to this Group
Page ......................................................................................... 553

04-13005-02-en, October 2012 System


13
25.25 User Account Group Wizard – Workspaces Belonging to this Group
Page ......................................................................................... 555
25.26 User Account Group Wizard – Windows Group Name and Group
Polices Page ............................................................................. 557
25.27 User Account Group – Summary Tab ........................................ 559
25.28 User Account Group – Policies Tab ........................................... 560
25.29 User Account Group – Group Membership Tab ........................ 561
25.30 User Account Group – Software Permissions Tab ..................... 563
25.31 User Account Group – Workspaces Tab ................................... 565
25.32 User Account Wizard – General Page ........................................ 566
25.33 User Account Wizard – Member Of Page .................................. 567
25.34 User Account Management Folder Properties ........................... 569
25.35 Workspace Wizard – Workspace Configuration Page ................ 570
25.36 Workspace Wizard – Pane Configuration Page .......................... 572
25.37 Workspace – Summary Tab ...................................................... 573
25.38 Workspace – Content Tab ........................................................ 574
25.39 Edit Layout Workspace ............................................................. 576
25.40 Workspace – Members Tab ...................................................... 577
25.41 Panel Wizard – Panel Configuration Page .................................. 578
25.42 Domain Wizard – Domain Members Page ................................. 579
25.43 Domains Properties ................................................................... 580
25.44 Local Properties ........................................................................ 581
25.45 Work Area Window Properties .................................................. 582
25.46 Create Work Area Window Wizard – Name Page ...................... 583

26 Alarms Introduction .................................................... 585


26.1 Alarm Overview ......................................................................... 587
26.1.1 Alarm States ........................................................................... 587
26.1.2 Building Operation Alarm Types .............................................. 587
26.1.3 Alarm Functions ...................................................................... 587
26.1.4 Alarm Objects in Multiple Servers ............................................ 588
26.1.5 Alarms Pane and Alarm View Customization ........................... 588
26.2 Alarm States ............................................................................. 589
26.3 Alarm Functions ........................................................................ 590
26.3.1 Time Delay .............................................................................. 590
26.3.2 Shunt Variable ......................................................................... 590
26.3.3 Deadband .............................................................................. 590
26.3.4 Alarm Messages ..................................................................... 590
26.3.5 Priority .................................................................................... 590
26.3.6 Categories .............................................................................. 591
26.3.7 Acknowledgement .................................................................. 591
26.3.8 User Actions ........................................................................... 591
26.3.9 Notifications ............................................................................ 591
26.3.10 Automatic Assignment ............................................................ 591
26.3.11 Unit of Measure in Alarms ....................................................... 592
26.3.12 Attachments ........................................................................... 592
26.4 Alarm Objects in Multiple Servers .............................................. 593

System 04-13005-02-en, October 2012


14
26.5 Alarms Pane and Alarm View Customization .............................. 594
26.6 Styling the Alarm States in the Alarms Pane and Alarm Views .... 595
26.7 Alarm Filter Conditions .............................................................. 598
26.8 Creating a Filtered Alarm View ................................................... 602
26.9 Displaying Alarm View on an Alarm ............................................ 604

27 Alarm Types ............................................................... 605


27.1 Alarm Types .............................................................................. 607
27.1.1 Change of State Alarm ............................................................ 607
27.1.2 Out of Range Alarm ................................................................. 607
27.1.3 Out of Reference Range Alarm ................................................ 607
27.1.4 Multistate Alarm ...................................................................... 607
27.1.5 Matching Text String Alarm ..................................................... 608
27.1.6 Variable Status Alarm .............................................................. 608
27.1.7 Sum Alarm .............................................................................. 608
27.1.8 Enumeration Alarm ................................................................. 608
27.1.9 System Information Alarms ..................................................... 608
27.2 Change of State Alarm .............................................................. 609
27.3 Creating a Change of State Alarm ............................................ 610
27.4 Multistate Alarm ........................................................................ 617
27.5 Creating a Multistate Alarm ....................................................... 618
27.6 Matching Text String Alarm ....................................................... 625
27.7 Creating a Matching Text String Alarm ...................................... 626
27.8 Variable Status Alarm ................................................................ 632
27.9 Creating a Variable Status Alarm ............................................... 633
27.10 Out of Range Alarm ................................................................... 639
27.11 Creating an Out of Range Alarm ................................................ 640
27.12 Out of Reference Range Alarm .................................................. 648
27.13 Creating an Out of Reference Range Alarm ............................... 649
27.14 Sum Alarm ................................................................................ 657
27.15 Creating a Sum Alarm ............................................................... 658
27.16 Enumeration Alarm ................................................................... 664
27.17 Creating an Enumeration Alarm ................................................. 665
27.18 System Information Alarms ....................................................... 671
27.19 Configuring the Description of an Alarm ..................................... 672
27.20 Configuring Attachments of an Alarm ........................................ 673
27.21 Removing Attachments from an Alarm ...................................... 674

28 Alarms Functions ....................................................... 675


28.1 Time Delay ................................................................................ 677
28.2 Configuring the Delay Time of an Alarm ..................................... 678
28.3 Shunt Variable ........................................................................... 679
28.4 Editing the Shunt Variable ......................................................... 680
28.5 Deadband ................................................................................ 681
28.6 Alarm Messages ....................................................................... 682
28.7 Configuring the Alarm Message of an Alarm .............................. 683
28.8 Priority ...................................................................................... 684

04-13005-02-en, October 2012 System


15
28.9 Configuring the Priority of an Alarm ............................................ 685
28.10 Categories ................................................................................ 686
28.11 Creating a Category .................................................................. 687
28.12 Configuring the Category of an Alarm ........................................ 689
28.13 Editing a Category ..................................................................... 690
28.14 Acknowledgement .................................................................... 692
28.14.1 Single Acknowledge ................................................................ 692
28.14.2 No Acknowledge .................................................................... 692
28.14.3 Extended Acknowledge .......................................................... 692
28.15 Configuring the Acknowledgement Type of an Alarm ................. 693
28.16 Single Acknowledge .................................................................. 694
28.17 No Acknowledge ...................................................................... 695
28.18 Extended Acknowledge ............................................................ 696
28.19 User Actions ............................................................................. 697
28.19.1 Comments ............................................................................. 697
28.19.2 Cause Notes ........................................................................... 697
28.19.3 Action Notes ........................................................................... 697
28.19.4 Checklists ............................................................................... 697
28.19.5 Summary of User Actions ........................................................ 698
28.20 Configuring Forced User Action ................................................. 699
28.21 Notifications .............................................................................. 700
28.21.1 E-mail Notification ................................................................... 700
28.21.2 Write to File Notification ........................................................... 700
28.21.3 Substitution Codes for Notification .......................................... 701
28.22 Creating an E-mail Notification .................................................. 702
28.23 Setting Up a Write to File Notification ......................................... 706
28.24 Selecting the Schneider Electric E-mail Server for E-mail
Notifications .............................................................................. 709
28.25 Substitution Codes for Notifications ........................................... 711
28.26 Automatic Assignment .............................................................. 715
28.27 Creating an Automatic Assignment ........................................... 716
28.28 Unit of Measure in Alarms .......................................................... 718
28.29 Configuring the Limits of an Alarm ............................................. 719
28.30 Configuring the Flashing of an Alarm ......................................... 720
28.31 Configuring the Audibility of an Alarm ........................................ 721

29 User Actions .............................................................. 723


29.1 Comments ................................................................................ 725
29.2 Cause Notes ............................................................................. 726
29.3 Creating a Cause Note .............................................................. 727
29.4 Editing a Cause Note ................................................................ 729
29.5 Adding a Cause Note to an Alarm ............................................. 731
29.6 Action Notes ............................................................................. 732
29.7 Creating an Action Note ............................................................ 733
29.8 Editing an Action Note ............................................................... 735
29.9 Adding an Action Note to an Alarm ............................................ 737
29.10 Checklists ................................................................................. 738

System 04-13005-02-en, October 2012


16
29.11 Creating a Checklist .................................................................. 739
29.12 Editing a Checklist ..................................................................... 741
29.13 Adding a Checklist to an Alarm .................................................. 743

30 Alarms User Interface ................................................. 745


30.1 Alarms Pane and Alarm View .................................................... 749
30.2 Alarms Pane and Alarm View Toolbar ........................................ 750
30.3 Alarms Pane and Alarm View Icons ........................................... 752
30.4 Alarm and Event Details View ................................................... 753
30.5 Alarm System Tree Icons .......................................................... 754
30.6 Change of State Alarm Properties – Basic Tab .......................... 756
30.7 Change of State Alarm Properties – Advanced Tab ................... 758
30.8 Multistate Alarm Properties – Basic Tab .................................... 760
30.9 Multistate Alarm Properties – Advanced Tab ............................. 762
30.10 Matching Text String Alarm Properties – Basic Tab ................... 764
30.11 Matching Text String Alarm Properties – Advanced Tab ............ 766
30.12 Out of Range Alarm Properties – Basic Tab ............................... 768
30.13 Out of Range Alarm Properties – Advanced Tab ........................ 771
30.14 Out of Reference Range Alarm Properties – Basic Tab .............. 773
30.15 Out of Reference Range Alarm Properties – Advanced Tab ....... 776
30.16 Sum Alarm Properties – Basic Tab ............................................ 778
30.17 Sum Alarm Properties – Advanced Tab ..................................... 780
30.18 Enumeration Alarm Properties – Basic Tab ................................ 782
30.19 Enumeration Alarm Properties – Advanced Tab ......................... 784
30.20 Variable Status Alarm Properties – Basic Tab ............................ 786
30.21 Variable Status Alarm Properties – Advanced Tab ..................... 788
30.22 Function Block Program Internal Alarm Properties - Basic Tab .. 790
30.23 Function Block Program Internal Alarm Properties - Advanced
Tab ........................................................................................... 792
30.24 Create Alarm Wizard – Presentation Page ................................. 794
30.25 Create Alarm Wizard – User Action Page ................................... 796
30.26 Create Alarm Wizard – Attachment Page ................................... 798
30.27 Create Change of State Alarm Wizard – Alarm Trigger Page ...... 799
30.28 Create Multistate Alarm Wizard – Alarm Trigger Page ................ 800
30.29 Create Matching Text String Alarm Wizard – Alarm Trigger
Page ......................................................................................... 802
30.30 Create Out of Range Alarm Wizard – Alarm Trigger Page .......... 804
30.31 Create Out of Reference Range Alarm Wizard – Alarm Trigger
Page ......................................................................................... 806
30.32 Create Sum Alarm Wizard – Alarm Trigger Page ........................ 808
30.33 Create Enumeration Alarm Wizard – Alarm Trigger Page ........... 810
30.34 Create Variable Status Alarm Wizard – Alarm Trigger Page ........ 811
30.35 Alarm Trigger Properties - Basic Tab ......................................... 813
30.36 Alarm Trigger Properties – Range Tab ....................................... 814
30.37 Alarm Trigger Properties – Value tab ......................................... 815
30.38 Alarm Trigger Properties – Value tab ......................................... 816
30.39 Attachment Properties .............................................................. 817
30.40 Alarm Control Panel Properties .................................................. 818

04-13005-02-en, October 2012 System


17
30.41 User Action Properties .............................................................. 819
30.42 Alarm Styles View ...................................................................... 821
30.43 Alarm Styles Properties ............................................................. 822
30.44 Acknowledged Style Properties ................................................. 823
30.45 Alarm Style Properties ............................................................... 824
30.46 Disabled Style Properties .......................................................... 825
30.47 Fault Style Properties ................................................................ 826
30.48 Reset Style Properties ............................................................... 827
30.49 Alarm Control Panel – Categories View ..................................... 828
30.50 Add Category Dialog Box .......................................................... 829
30.51 Edit Category Dialog Box .......................................................... 830
30.52 Category Properties .................................................................. 831
30.53 Categories Properties ............................................................... 832
30.54 Alarm Control Panel – Cause Notes View .................................. 833
30.55 Add Cause Note Dialog Box ...................................................... 834
30.56 Edit Cause Note Dialog Box ...................................................... 835
30.57 Cause Notes Properties ............................................................ 836
30.58 Cause Note Group Properties ................................................... 837
30.59 Cause Note Properties .............................................................. 838
30.60 Alarm Control Panel – Action Notes View .................................. 839
30.61 Add Action Note Dialog Box ...................................................... 840
30.62 Edit Action Note Dialog Box ...................................................... 841
30.63 Action Notes Properties ............................................................ 842
30.64 Action Note Group Properties ................................................... 843
30.65 Action Note Properties .............................................................. 844
30.66 Alarm Control Panel – Checklists View ...................................... 845
30.67 Add Checklist Dialog Box .......................................................... 846
30.68 Edit Checklist Dialog Box .......................................................... 848
30.69 Add Checklist Step Dialog Box .................................................. 850
30.70 Edit Checklist Step Dialog Box .................................................. 851
30.71 Checklists Properties ................................................................ 852
30.72 Checklist Properties .................................................................. 853
30.73 Checklist Step Properties .......................................................... 854
30.74 Alarm – Basic Settings View ...................................................... 855
30.75 Select Conditions Dialog Box – Alarm Filter Properties ............... 856
30.76 Create Email Notification Wizard – Email Notification Page ........ 857
30.77 Email Notification View .............................................................. 859
30.78 E-Mail Notification Properties .................................................... 861
30.79 Write to File Notification View .................................................... 862
30.80 Write to File Notification Properties ............................................ 864
30.81 Assignment View ...................................................................... 865
30.82 Assignment Properties .............................................................. 867
30.83 Alarm Properties ....................................................................... 868
30.84 Object Specific Event View Toolbar ........................................... 869
30.85 Progress View ........................................................................... 870
30.86 Alarm Handling Properties ......................................................... 871
30.87 Alarm Properties ....................................................................... 872

System 04-13005-02-en, October 2012


18
31 Events ....................................................................... 873
31.1 How Events Work .................................................................... 875
31.2 Events Pane and Event View Customization .............................. 876
31.3 Styling a Certain Event in the Events Pane or Event View ........... 877
31.4 Event Filter Conditions .............................................................. 880
31.5 Applying an Event Filter ............................................................. 884
31.6 Creating a Filtered Event View ................................................... 886

32 Events User Interface ................................................. 889


32.1 Object Specific Event View ........................................................ 891
32.2 Event Styles Dialog Box ............................................................ 892
32.3 Event View Properties ............................................................... 893
32.4 Select Conditions Dialog Box – Events Filter Properties ............. 894
32.5 Add/Remove Columns Dialog Box ........................................... 895

33 Trend Log Introduction ............................................... 901


33.1 Trend Overview ......................................................................... 903
33.1.1 Trend Log Types ..................................................................... 905
33.1.2 Trend Log Functions ............................................................... 905
33.1.3 Trend Log List ......................................................................... 905
33.1.4 Trend Charts ........................................................................... 905
33.1.5 Move or Copy Trend Logs or Extended Trend Logs ................. 906
33.2 Clearing a Trend Log ................................................................. 907
33.3 Editing or Commenting a Trend Log Record ............................. 908
33.4 Displaying the History of a Trend Log Record ............................ 909
33.5 Trend Units ............................................................................... 910
33.6 Enabling a Trend Log ................................................................ 913
33.7 Disabling a Trend Log ............................................................... 914
33.8 Editing the Activation Method in a Trend Log ............................. 915

34 Trend Log Types ........................................................ 917


34.1 Trend Log Types ....................................................................... 919
34.1.1 Interval Trend Logs ................................................................ 921
34.1.2 Meter Trend Logs ................................................................... 921
34.1.3 Change of Value Trend Logs ................................................... 921
34.1.4 Variable Triggered Trend Logs ................................................ 921
34.1.5 Manual Trend Log .................................................................. 921
34.1.6 Implicit Trend Logs ................................................................. 922
34.2 Interval Trend Logs .................................................................. 923
34.3 Interval Trend Log Delta ............................................................ 928
34.4 Creating an Interval Trend Log .................................................. 931
34.5 Configuring an Interval Trend Log .............................................. 937
34.6 Editing the Interval of an Interval Trend Log ................................ 938
34.7 Editing the Delta in an Interval Trend Log ................................... 939
34.8 Meter Trend Logs ..................................................................... 940
34.9 Creating a Meter Trend Log and Associated Objects ................ 943
34.10 Creating a Meter Trend Log ...................................................... 961
34.11 Managing Replacement of a Meter ........................................... 965

04-13005-02-en, October 2012 System


19
34.12 Configuring a Meter Trend Log .................................................. 967
34.13 Displaying Meter Change History ............................................... 968
34.14 Change of Value Trend Logs ..................................................... 969
34.15 Creating a Change of Value Trend Log ..................................... 972
34.16 Configuring a Change of Value Trend Log ................................. 977
34.17 Variable Triggered Trend Logs .................................................. 978
34.18 Creating a Variable Triggered Trend Log .................................... 981
34.19 Configuring a Variable Triggered Trend Log ............................... 984
34.20 Manual Trend Logs ................................................................... 985
34.21 Creating a Manual Trend Log .................................................... 988
34.22 Configuring a Manual Trend Log ............................................... 991
34.23 Adding a Trend Log Record to a Manual Trend Log ................... 992
34.24 Implicit Trend Logs ................................................................... 993

35 Trend Log Functions .................................................. 995


35.1 Trend Log Functions ................................................................. 997
35.1.1 Log Record Storage ................................................................ 997
35.1.2 Activation Methods ................................................................. 997
35.1.3 Extended Trend Logs .............................................................. 997
35.2 Log Record Storage .................................................................. 998
35.3 Activation Methods ................................................................... 999
35.3.1 Always active .......................................................................... 999
35.3.2 Variable Controlled .................................................................. 999
35.3.3 Start at activation time ........................................................... 1001
35.4 Extended Trend Logs .............................................................. 1003
35.5 Creating an Extended Trend Log ............................................. 1007
35.6 Configuring an Extended Trend Log ........................................ 1010
35.7 Editing the Threshold Property of an Extended Trend Log ....... 1011
35.8 Editing the Maximum Transfer Interval Property of an Extended
Trend Log ............................................................................... 1012
35.9 Editing the Number of Log Records for a Trend Log ................ 1013
35.10 Editing an Extended Trend Log to be Included in Reports ........ 1014
35.11 Manually Transferring Records to the Extended Trend Log ...... 1015

36 Trend Charts ............................................................ 1017


36.1 Trend Charts ........................................................................... 1019
36.1.1 Trend Chart Series ................................................................ 1025
36.1.2 Trend Chart Axes in WorkStation .......................................... 1025
36.1.3 Trend Chart Axes in WebStation ........................................... 1025
36.1.4 Real-time Plotting .................................................................. 1025
36.1.5 Time Zone Modes in a Trend Chart ....................................... 1025
36.1.6 Calculation Methods ............................................................. 1025
36.1.7 Temporary Trend Charts ....................................................... 1026
36.2 Configuring a Trend Chart ....................................................... 1027
36.3 Showing Trend Chart Grid Lines .............................................. 1030
36.4 Adding a Trend Log Series to a Trend Chart ............................ 1032
36.5 Adding a Real-time Trend Series to a Trend Chart ................... 1033
36.6 Editing the Trend Chart Settings .............................................. 1037

System 04-13005-02-en, October 2012


20
36.7 Activating Trend Chart Live Update ......................................... 1038
36.8 Trend Chart Axes .................................................................... 1039
36.9 Scroll the Trend Chart X-Axis to the Current Time .................... 1041
36.10 Configuring the X-Axis with a Relative Time Span .................... 1042
36.11 Configuring the X-Axis with an Absolute Time Span ................. 1043
36.12 Manually Configuring the Y-Axis Scale .................................... 1044
36.13 Automatically Configuring the Y-Axis Scale ............................. 1045
36.14 Assigning a Series to a Y-Axis ................................................. 1046
36.15 Real-time Plotting .................................................................... 1047
36.16 Creating a Real-time Plot Trend Chart ..................................... 1049
36.17 Creating a Trend Chart that Monitors a Variable in Real-Time .. 1050
36.18 Trend Chart Series .................................................................. 1054
36.19 Creating a Trend Chart that Monitors a Trend Log Series ......... 1056
36.20 Attaching a Calculation Method to a Trend Chart Series .......... 1060
36.21 Time Zone Modes in a Trend Chart ......................................... 1062
36.21.1 Local Time Zone ................................................................... 1062
36.21.2 Server Time Zone .................................................................. 1063
36.21.3 UTC Time Zone ..................................................................... 1063
36.22 Configuring the Trend Chart Time Zone Mode ........................ 1065
36.23 Temporary Trend Log Lists and Trend Charts .......................... 1066
36.24 Opening a Trend Log in a Temporary Trend Chart .................. 1067
36.25 Saving a Temporary Trend Chart ............................................. 1068

37 Trend Log Lists ........................................................ 1069


37.1 Trend Log Lists ....................................................................... 1071
37.1.1 Time Zone Modes in a Trend Log List .................................... 1073
37.1.2 Calculation Methods ............................................................. 1073
37.1.3 Temporary Trend Log Lists ................................................... 1073
37.2 Creating a Trend Log List ........................................................ 1074
37.3 Configuring a Trend Log List ................................................... 1077
37.4 Time Zone Modes in a Trend Log List ...................................... 1078
37.4.1 Local Time Zone ................................................................... 1078
37.4.2 Server Time Zone .................................................................. 1078
37.4.3 UTC Time Zone ..................................................................... 1079
37.5 Displaying the Trend Log List Time Stamps with Fractions ....... 1081
37.6 Configuring the Trend Log List Time Zone .............................. 1082
37.7 Calculation Methods ............................................................... 1083
37.7.1 Maximum ............................................................................. 1083
37.7.2 Minimum .............................................................................. 1084
37.7.3 Average ................................................................................ 1084
37.7.4 Summary .............................................................................. 1085
37.7.5 Delta ..................................................................................... 1086
37.7.6 Delta over Period .................................................................. 1087
37.7.7 Meter Consumption .............................................................. 1087
37.8 Attaching a Calculation Method to a Trend Log List ................. 1088
37.9 Temporary Trend Log Lists and Trend Charts .......................... 1090
37.10 Saving a Temporary Trend Log List ......................................... 1091

04-13005-02-en, October 2012 System


21
38 Trends User interface ............................................... 1093
38.1 Trend Log System Tree Icons .................................................. 1095
38.2 Actions Menu – Activation Submenu ....................................... 1096
38.3 Actions Menu – View Submenu ............................................... 1097
38.4 Actions Menu - View Submenu - Trend Charts Submenu ........ 1098
38.5 Actions Menu - View Submenu - Trend Log Lists Submenu .... 1099
38.6 Actions Menu – Modification Submenu ................................... 1100
38.7 Interval Trend Log Properties .................................................. 1101
38.8 Meter Trend Log Properties .................................................... 1103
38.9 Change of Value Trend Log Properties .................................... 1104
38.10 Variable Triggered Trend Log Properties ................................. 1106
38.11 Manual Trend Log Properties ................................................. 1108
38.12 Extended Trend Log Properties .............................................. 1109
38.13 Trend Chart Properties ........................................................... 1111
38.14 Trend Log List Properties ........................................................ 1113
38.15 Manage Replacement of Meter Dialog Box .............................. 1115
38.16 Meter Change History Dialog Box ............................................ 1117
38.17 Trend Chart View .................................................................... 1119
38.18 Trend Chart Toolbar ................................................................ 1121
38.19 Trend Chart Event Icons .......................................................... 1123
38.20 Trend Chart Navigation Bar ..................................................... 1125
38.21 Series Tab Shortcut Menu ....................................................... 1126
38.22 Trend Chart Settings Dialog Box – Axes Tab ........................... 1127
38.23 Trend Chart Settings Dialog Box – Series Tab ......................... 1129
38.24 Trend Chart Settings Dialog Box – Calculation Tab .................. 1130
38.25 Trend Chart Series Properties ................................................. 1131
38.26 Real Time Trend Series Properties ........................................... 1133
38.27 Trend Log List View ................................................................ 1134
38.28 Trend Log List Toolbar ............................................................ 1136
38.29 Trend Log List Event Icons ...................................................... 1138
38.30 Trend Log List – Log Info View ................................................ 1140
38.31 Trend Log List Shortcut Menu ................................................. 1141
38.32 Add Trend Log Record Dialog Box .......................................... 1142
38.33 Edit/Comment Trend Log Record Dialog Box .......................... 1143
38.34 Create Trend Log Wizard – Configure Interval Trend Log Page 1144
38.35 Create Trend Log Wizard – Configure Meter Trend Log Page .. 1145
38.36 Create Trend Log Wizard – Configure Change of Value Trend Log
Page ....................................................................................... 1146
38.37 Create Trend Log Wizard – Configure Variable Triggered Trend
Log ......................................................................................... 1147
38.38 Create Trend Log Wizard – Configure Manual Log Page .......... 1148
38.39 Create Trend Log Wizard – Configure Extended Trend Log
Page ....................................................................................... 1149
38.40 Create Trend Log Wizard – Configure Trend Chart Page ......... 1150
38.41 Create Trend Log Wizard – Configure Real-Time Trend Series
Page ....................................................................................... 1152
38.42 Create Trend Log Wizard – Configure Trend Log Series Page . 1153

System 04-13005-02-en, October 2012


22
38.43 Create Trend Log Wizard – Configure Trend Log List Page ...... 1154
38.44 Create Trend Log Wizard – Connect Objects to the Trend Log
Page ....................................................................................... 1155
38.45 Trend Log Wizard – Initial Meter Settings Page ........................ 1156

39 Mass Create Alarms and Trends .............................. 1157


39.1 Mass Create .......................................................................... 1159
39.1.1 Object or Property Variable Type ........................................... 1159
39.1.2 Suffix and Prefix .................................................................... 1160
39.1.3 Mass Create Unit Managing .................................................. 1160
39.1.4 Mass Create from Properties with the Search Method ........... 1160
39.1.5 Mass Create Resulting Location ............................................ 1160
39.2 Mass Create Unit Managing ................................................... 1161
39.3 Object or Property Variable Type ............................................. 1162
39.4 Suffix and Prefix ...................................................................... 1164
39.5 Mass Create Resulting Location .............................................. 1165
39.6 Mass Creating Alarms ............................................................ 1166
39.7 Mass Creating Alarms Using the Search Method ..................... 1168
39.8 Mass Creating Trend Logs ...................................................... 1171
39.9 Mass Creating Trend Logs Using the Search Method .............. 1173
39.10 Mass Creating Extended Trend Logs ...................................... 1176
39.11 Mass Creating Extended Trend Logs Using the Search
Method ................................................................................... 1178
39.12 Mass Create Object Wizard – Name Page ............................... 1180

40 Schedules Introduction ............................................ 1183


40.1 Schedules Overview ............................................................... 1185
40.1.1 Schedule Editor Overview ..................................................... 1185
40.1.2 Schedule Types .................................................................... 1185
40.1.3 Schedule Events ................................................................... 1185
40.1.4 Calendars ............................................................................. 1186
40.1.5 Schedule and Calendar Synchronization ............................... 1186
40.1.6 Schedule Bindings ................................................................ 1186
40.2 Schedule Bindings .................................................................. 1187
40.3 Configuring a Schedule as a Shadow ..................................... 1190

41 Schedule Editor ....................................................... 1191


41.1 Schedule Editor Overview ....................................................... 1193
41.1.1 Basic View of the Schedule Editor ......................................... 1193
41.1.2 Advanced View of the Schedule Editor .................................. 1193
41.1.3 Schedule Colors .................................................................. 1193
41.2 Schedule Editor in WorkStation ............................................... 1194
41.3 Advanced View of the Schedule Editor ................................... 1195
41.3.1 Text View .............................................................................. 1196
41.3.2 Event Preview ....................................................................... 1197
41.4 Time Zones ............................................................................. 1198
41.5 Priorities ................................................................................. 1199
41.6 Editing an Event Priority ........................................................... 1202

04-13005-02-en, October 2012 System


23
41.7 Schedule Colors in WorkStation .............................................. 1204
41.7.1 Colors in the Basic View ........................................................ 1204
41.7.2 Colors in the Advanced View ................................................. 1205

42 Schedule Types ....................................................... 1207


42.1 Schedule Types ..................................................................... 1209
42.1.1 Analog Schedules ................................................................. 1209
42.1.2 Digital Schedules .................................................................. 1209
42.1.3 Multistate Schedules ............................................................. 1209
42.2 Digital Schedules .................................................................... 1210
42.3 Creating a Digital Schedule ..................................................... 1211
42.4 Binding a Digital Value to a Digital Schedule ............................ 1212
42.5 Multistate Schedules ............................................................... 1214
42.6 Creating a Multistate Schedule ................................................ 1215
42.7 Binding a Multistate Value to a Multistate Schedule ................. 1216
42.8 Analog Schedules ................................................................... 1217
42.9 Creating an Analog Schedule .................................................. 1218
42.10 Binding an Analog Value to an Analog Schedule ...................... 1219

43 Schedule Events ...................................................... 1221


43.1 Schedule Events ..................................................................... 1223
43.1.1 Weekly Events in WorkStation ............................................... 1223
43.1.2 Weekly Events in WebStation ................................................ 1223
43.1.3 Exception Events in WorkStation ........................................... 1223
43.1.4 Exception Events in WebStation ............................................ 1223
43.1.5 Priorities ............................................................................... 1224
43.1.6 Time Zones ........................................................................... 1224
43.2 Displaying Client Time and Server Time in a Schedule ............. 1225
43.3 Deleting a Date List Entry from a Calendar .............................. 1226
43.4 Weekly Events in WorkStation ................................................. 1227
43.5 Exception Events in WorkStation ............................................. 1228
43.5.1 Date Exception Events .......................................................... 1228
43.5.2 Date Range Exception Events ............................................... 1228
43.5.3 Calculated Exception Events ................................................. 1229
43.5.4 Calendar Exception Events ................................................... 1229
43.6 Editing a Date Exception Event ................................................ 1230
43.7 Editing a Date Range Exception Event ..................................... 1233
43.8 Editing a Calculated Exception Event ...................................... 1236
43.9 Adding a Date Range Exception Event .................................... 1239
43.10 Adding a Calculated Exception Event ...................................... 1242
43.11 Adding a Weekly Event ........................................................... 1244
43.12 Adding a Calendar Exception Event ........................................ 1245
43.13 Adding a Date Exception Event .............................................. 1248

44 Calendars ................................................................ 1251


44.1 Calendar Editor Overview ........................................................ 1253
44.2 Calendars in WorkStation ........................................................ 1254
44.2.1 Calendar Editor Overview ...................................................... 1254

System 04-13005-02-en, October 2012


24
44.2.2 Calendar Events .................................................................... 1255
44.3 Calendar Events ..................................................................... 1256
44.3.1 Date Calendar Events ........................................................... 1256
44.3.2 Date Range Calendar Events ................................................ 1256
44.3.3 Calculated Calendar Events .................................................. 1257
44.4 Creating a Calendar ................................................................ 1258
44.5 Adding a Date Calendar Event ................................................. 1260
44.6 Adding a Date Range Calendar Event ...................................... 1262
44.7 Adding a Calculated Date Calendar Event ............................... 1264
44.8 Configuring a Calendar as a Shadow ...................................... 1266
44.9 Storing Expired Calendar Events ............................................. 1267
44.10 Editing a Date Calendar Event ................................................. 1268
44.11 Editing a Date Range Calendar Event ...................................... 1270
44.12 Editing a Calculated Date Calendar Event ................................ 1272
44.13 Schedule and Calendar Synchronization ................................. 1274

45 Schedules User Interface ......................................... 1277


45.1 Schedule Editor – Basic View .................................................. 1279
45.2 Basic Schedule Editor Toolbar ............................................... 1280
45.3 Advanced Schedule Editor – Graphic View ............................. 1281
45.4 Advanced Schedule Editor Toolbar ........................................ 1283
45.5 Edit Effective Period Dialog Box .............................................. 1284
45.6 Edit Exception Dialog Box ...................................................... 1285
45.7 Edit Time Value Period Dialog Box .......................................... 1286
45.8 Snap To Menu ........................................................................ 1287
45.9 Show Client Time Zone .......................................................... 1288
45.10 Schedule Properties – Basic Tab ............................................. 1289
45.11 Schedule Event Properties Dialog Box – Weekly View ............. 1291
45.12 Schedule Event Properties Dialog Box – Single Date Exception View
............................................................................................... 1293
45.13 Schedule Event Properties Dialog Box – Date Range Exception View
............................................................................................... 1295
45.14 Schedule Event Properties Dialog Box – Calculated Exception
View ....................................................................................... 1297
45.15 Schedule Event Properties Dialog Box – Calendar Reference View
............................................................................................... 1299
45.16 Calendar Editor View ............................................................... 1301
45.17 Calendar Editor Toolbar .......................................................... 1302
45.18 Calendar Properties – Basic Tab ............................................. 1303
45.19 Edit Calendar Entry Dialog Box – Add Date ............................. 1304
45.20 Edit Calendar Entry Dialog Box – Date Range ......................... 1305
45.21 Edit Calendar Entry Dialog Box – Calculated Date .................. 1307

46 WorkStation ............................................................. 1309


46.1 WorkStation ............................................................................ 1311
46.1.1 Flexible Workspace ............................................................... 1311
46.1.2 User rights ............................................................................ 1312
46.2 System Tree Pane ................................................................... 1313

04-13005-02-en, October 2012 System


25
46.3 List View ................................................................................. 1315
46.4 Control Panel .......................................................................... 1316
46.5 Opening Control Panel ............................................................ 1317
46.6 Quick Filter ............................................................................. 1318
46.7 Hyperlinks ............................................................................... 1321
46.8 Creating a Hyperlink ................................................................ 1322
46.9 Utilities .................................................................................... 1323
46.9.1 Signal Generator ................................................................... 1323
46.9.2 Simple Math Operators ......................................................... 1323

47 Building Operation Objects ...................................... 1325


47.1 Object Types .......................................................................... 1327
47.2 Object Names ......................................................................... 1328
47.3 Object Properties .................................................................... 1329
47.4 Opening an Object in a New Window ...................................... 1331
47.5 Object Tab Display .................................................................. 1332
47.6 Showing the Same Tab While Navigating Between Objects ..... 1333
47.7 Showing Non-Presentation Objects in the System Tree Pane .. 1334
47.8 Multi-edit ................................................................................ 1335
47.9 Editing Multiple Objects ........................................................... 1336
47.10 Move, Rename, and Delete ..................................................... 1337
47.11 Deleting an Object ................................................................... 1338
47.12 Renaming a Folder or Object ................................................... 1339
47.13 Creating a Folder .................................................................... 1340
47.14 Copying a Folder or Object ...................................................... 1341

48 Archive .................................................................... 1343


48.1 Archiving Overview ................................................................. 1345
48.1.1 Manual and Scheduled Archiving .......................................... 1345
48.1.2 Archiving Formats ................................................................. 1345
48.1.3 Archiving Configuration ......................................................... 1345
48.1.4 Archive Folders, Files, and Names ......................................... 1346
48.1.5 Read Event Archive and Trend Log Archive ........................... 1346
48.1.6 Archiving System Alarms ....................................................... 1346
48.2 Manually Creating an Archive .................................................. 1347
48.3 Creating a Scheduled Archive ................................................. 1348
48.4 Selecting an Archive File Format .............................................. 1349
48.5 Including Trend Logs in the Archive ......................................... 1350
48.6 Removing Trend Logs from the Archive ................................... 1351
48.7 Including Alarm Events in the Archive ...................................... 1352
48.8 Including User Events in the Archive ........................................ 1353
48.9 Including System Events in the Archive .................................... 1354
48.10 Event Archive and Trend Log Archive ...................................... 1355
48.10.1 Event and Alarm Enumerations ............................................. 1355
48.10.2 Trend Log Enumerations ....................................................... 1355
48.11 Archiving Formats ................................................................... 1356
48.11.1 CSV ...................................................................................... 1356

System 04-13005-02-en, October 2012


26
48.11.2 XML ...................................................................................... 1356
48.12 Archive Folders, Files, and Names ........................................... 1357
48.12.1 Archive Folder Names ........................................................... 1357
48.12.2 File Names for Trend Log Archives ........................................ 1357
48.12.3 File Names for Events Log Archives ....................................... 1357
48.12.4 Unique Archive File Names .................................................... 1358
48.13 Enabling the Archiving Function and Defining the Archive
Folder ..................................................................................... 1359
48.14 Manual and Scheduled Archiving ............................................ 1360
48.14.1 Manual Archiving ................................................................... 1360
48.14.2 Scheduled Archiving ............................................................. 1360
48.14.3 About Trend Logs and Event Archives Creation ..................... 1360
48.15 Event and Alarm Enumerations ............................................... 1361
48.16 Trend Log Enumerations ......................................................... 1368

49 Search ..................................................................... 1369


49.1 Search Overview ..................................................................... 1371
49.1.1 Simple Search ...................................................................... 1371
49.1.2 Search View .......................................................................... 1371
49.1.3 Saved Search ....................................................................... 1371
49.2 Simple Search ........................................................................ 1373
49.2.1 Wildcard Search ................................................................... 1373
49.2.2 Search Result List ................................................................. 1374
49.3 Performing a Search Using Simple Search ............................. 1375
49.4 Saving a Search ...................................................................... 1376
49.5 Search View ............................................................................ 1377
49.5.1 Wildcard Search ................................................................... 1377
49.5.2 Search Result List ................................................................. 1378
49.5.3 Subserver Search ................................................................. 1378
49.5.4 Advanced Search ................................................................. 1378
49.6 Advanced Search ................................................................... 1380
49.6.1 Object Types Search ............................................................. 1380
49.6.2 Properties Conditions Search ................................................ 1381
49.6.3 Setpoint Search Example ...................................................... 1383
49.6.4 Non-Validated Programs Search Example ............................. 1383
49.7 Search for Objects Using Advanced Search ............................ 1384
49.8 Setpoint Search Example ........................................................ 1386
49.9 Non-Validated Programs Search Example ............................... 1389

50 WorkStation User Interface ...................................... 1393


50.1 Basic Functionality Icons in the System Tree Pane ................... 1397
50.2 File Menu ............................................................................... 1398
50.3 File Menu – New Submenu ..................................................... 1400
50.4 Edit Menu ............................................................................... 1410
50.5 Actions Menu .......................................................................... 1411
50.6 Actions Menu – Activation Submenu ....................................... 1417
50.7 Actions Menu – Advanced Submenu ...................................... 1418
50.8 Actions Menu – Advanced Commands Submenu ................... 1419

04-13005-02-en, October 2012 System


27
50.9 Actions Menu – Modification Submenu ................................... 1420
50.10 Actions Menu – View Submenu ............................................... 1421
50.11 Actions Menu - View Submenu - Watch Submenu .................. 1422
50.12 Watch Select Property Dialog Box ........................................... 1423
50.13 Tools Menu ............................................................................. 1424
50.14 Options Dialog Box ................................................................. 1425
50.15 Control Panel View .................................................................. 1426
50.16 Progress View – Advanced ..................................................... 1428
50.16.1 Detail View ............................................................................ 1428
50.17 Progress View – Simple .......................................................... 1430
50.17.1 Simple Progress View ........................................................... 1430
50.17.2 Detail View ............................................................................ 1430
50.18 Operation Details Dialog Box ................................................... 1432
50.19 Error Details – Progress View .................................................. 1433
50.20 Create Object Wizard – Naming the Object Page .................... 1434
50.21 List View Toolbar ..................................................................... 1436
50.22 System Tree Pane Toolbar ...................................................... 1437
50.23 Confirm Delete Dialog Box ...................................................... 1438
50.24 Confirm Rename Dialog Box ................................................... 1439
50.25 Rename Object Dialog Box ..................................................... 1440
50.26 General and References Properties ......................................... 1441
50.27 Retain Level ........................................................................... 1443
50.28 Configure Dialog Box - Configuration Tab ................................ 1444
50.29 Configure Dialog Box – Operation Tab .................................... 1446
50.30 Archive Settings Icon .............................................................. 1447
50.31 Archiving Settings Properties – Basic Tab ............................... 1448
50.32 Archiving Settings Properties – Content Tab ............................ 1450
50.33 Search Icons ........................................................................... 1451
50.34 Search View ............................................................................ 1452
50.35 Search View Toolbar ............................................................... 1454
50.36 Search Toolbar ....................................................................... 1455
50.37 Select Folder Dialog Box ......................................................... 1456
50.38 Select Types Dialog Box ......................................................... 1457
50.39 Select Conditions Dialog Box .................................................. 1458
50.40 Event Archive File ................................................................... 1459
50.41 Trend Log Archive File ............................................................. 1462
50.42 Add/Remove Columns Dialog Box ......................................... 1464
50.43 Analog Value Properties .......................................................... 1469
50.44 Digital Value Properties ........................................................... 1470
50.45 Multistate Value Properties ...................................................... 1471
50.46 String Value Properties ............................................................ 1472
50.47 Signal Generator Dialog Box ................................................... 1473
50.48 Simple Math Operator Dialog Box ........................................... 1474
50.49 Create Hyperlink Wizard – URL Page ...................................... 1475
50.50 Path Type ............................................................................... 1476
50.51 Select Object Dialog Box ......................................................... 1477
50.52 Select Object and Properties Dialog Box ................................. 1478

System 04-13005-02-en, October 2012


28
50.53 Progress View ......................................................................... 1479
50.54 System Object Properties ....................................................... 1480
50.55 System Control Panel Properties ............................................. 1481
50.56 Commit Page .......................................................................... 1482

51 Shortcuts ................................................................ 1483


51.1 Shortcuts Overview ................................................................. 1485
51.2 Shortcut Functionality ............................................................. 1486
51.3 User Access to Shortcuts and Targets .................................... 1487
51.4 Shortcut Presentation ............................................................. 1488
51.5 Viewing Shortcuts ................................................................... 1489
51.6 Viewing Shortcut Properties .................................................... 1490
51.7 Shortcut Creation ................................................................... 1491
51.7.1 Shortcuts in Servers and Folders ........................................... 1491
51.7.2 Shortcuts to Objects and Points ............................................ 1491
51.8 Creating a Shortcut ................................................................. 1492
51.9 Configuring the Target of a Shortcut ........................................ 1493
51.10 Editing Shortcuts .................................................................... 1494

52 Shortcuts User Interface .......................................... 1495


52.1 Shortcuts Icon ........................................................................ 1497
52.2 Create Shortcut Wizard – Shortcut Target Page ...................... 1498
52.3 Shortcut Properties – Basic Tab .............................................. 1499

53 Documents .............................................................. 1501


53.1 Documents ............................................................................. 1503
53.2 Creating a Document in WorkStation ....................................... 1504

54 Documents User Interface ........................................ 1507


54.1 Document Properties – Basic Tab ........................................... 1509
54.2 New Document Wizard – Import Document Page ................... 1510

04-13005-02-en, October 2012 System


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

04-13005-02-en, October 2012 System


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

System 04-13005-02-en, October 2012


36
1 About This Guide
1.3 Typographical Conventions

1.3 Typographical Conventions


Building Operation Guides use the following specially marked texts:

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

Note
Provides you with supplementary information.

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

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

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

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

04-13005-02-en, October 2012 System


37
2 Additional Information

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

2.1 Where to Find Additional Information


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

04-13005-02-en, October 2012 System


41
2 Additional Information
2.2 Regulatory Notices

2.2 Regulatory Notices

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

WEEE - Directive of the European Union (EU)


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

CE - Compliance to European Union (EU)


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

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

C-Tick (Australian Communications Authority (ACA))


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

Federal Communications Commission


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

System 04-13005-02-en, October 2012


42
Reference

The Reference part contains conceptual information,


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

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

3.1 Installation of Building Operation


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

3.1.1 Installation Packages


Building Operation consists of the following installation packages:
• WorkStation: Graphics Editor, Script Editor, Menta Editor, Function Block
Editor, WorkPlace Tech Editor
• Language Packages
• Device Administrator
• License Administrator
• Enterprise Server
The installation files for Graphic Editor, Script Editor, Menta Editor, Function Block
Editor, and WorkPlace Tech Editor are bundled into the WorkStation installation
package.
All Building Operation products are installed in a default application folder. On
Windows operating systems this folder is located in C:\ProgramData\Schneider
Electric StruxureWare\Building Operation x.x, where x.x is the version number.

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

3.1.3 Installation Example


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

3.1.4 Installation Reparation


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

04-13005-02-en, October 2012 System


47
3 Installation
3.1 Installation of Building Operation

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

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

3.1.6 System Upgrade Overview


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

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

3.1.8 Version Numbers and Parallel Installations


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

3.1.9 Software Administrator


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

System 04-13005-02-en, October 2012


48
3 Installation
3.2 Products

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

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

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

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 46.1 “WorkStation” on page 1311.

3.2.2 Graphics Editor


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

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

The installation of Graphics Editor is bundled into the WorkStation installation


package.
For more information, see WebHelp.

3.2.3 Script Editor


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

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

04-13005-02-en, October 2012 System


49
3 Installation
3.2 Products

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

3.2.4 Menta Editor


Menta Editor is a graphical programming tool for Xenta 208/300/401 LonWorks
device, which you use to create function block programs that control and monitor
building automation systems. For example, you create a program to control an air
handling unit.

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

The installation of Menta Editor is bundled into the WorkStation installation


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

3.2.5 Function Block Editor


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

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

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

3.2.6 WorkPlace Tech


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

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

System 04-13005-02-en, October 2012


50
3 Installation
3.2 Products

The installation of WorkPlace Tech is bundled into the WorkStation installation


package.
For more information, see WebHelp.

3.2.7 Enterprise Server


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

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

For more information, see WebHelp.

3.2.8 Software Administrator


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

3.2.9 Device Administrator


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

3.2.10 License Administrator


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

3.2.11 License Server


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

04-13005-02-en, October 2012 System


51
3 Installation
3.2 Products

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

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

3.2.13 Language Package


At the main installation, WorkStation and servers only contain English. To support a
language other than English, you need to install the specific language package on
your WorkStation.
For more information, see section 15.3 “Language Packages” on page 293.

System 04-13005-02-en, October 2012


52
3 Installation
3.3 Installation Example

3.3 Installation Example


Schneider Electric recommends that you install the license server framework before
other Building Operation hardware or software. The license server installation is
included in the License Administrator license package. During the installation of
WorkStation or Enterprise Server, the installation software asks for the address to
the license server.
License files to activate as time-limited local licenses are included in the installation
of Building Operation. The local license files are in the following paths:
• Windows XP: \Documents and Settings\All Users\Application Data\Schneider
Electric StruxureWare\Building Operation x.x\License Files\
• Windows server 2008: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\License Files\
• Windows 7: \ProgramData\Schneider Electric StruxureWare\Building
Operation x.x\License Files\
The x.x represents the version number. For more information, see section 10.10
“Local Licenses” on page 220.

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

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

Figure: Installation and configuration order

04-13005-02-en, October 2012 System


53
3 Installation
3.3 Installation Example

Table: Installation and Configuration Order


Number, client/server Description

1. License Server • Install the License Server and License


Administrator.
• When the License Administrator
installation wizard prompts, type the
address to the license server. In this
case, type @localhost.
• Activate network licenses, on the
license server. For more information,
see section 10.2 “Network License
Management” on page 201.
• 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.

System 04-13005-02-en, October 2012


54
3 Installation
3.4 Version Numbers and Parallel Installations

3.4 Version Numbers and Parallel


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

Figure: Building Operation version number structure

Table: Building Operation Version Number Structure


Version number Description

Major Increment when major functionality changes


are released.

Minor Increment when minor functionality changes


are released.

Maintenance Increment when correctional changes are


released.

Build A sequential number to guarantee


uniqueness of the version release.

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

04-13005-02-en, October 2012 System


55
3 Installation
3.4 Version Numbers and Parallel Installations

Caution
Do not execute or run two different versions of a product simultaneously on your
server or computer. Running parallel installations can cause data loss or
corruption.

On the same computer or server, you can install products parallel to each other that
have different major or minor version numbers. For example, you can install
WorkStation 2.1.6.0 on a computer that already has version 1.2.1.0 installed.

System 04-13005-02-en, October 2012


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

3.5 Installing the License Administrator and


the License Server
You install License Administrator and License Server to administer the activation,
return, repair, check out, and the check in of Building Operation licenses. A Building
Operation system must consist of at least one license server. The License
Administrator has to be installed on all clients or servers that run any licensed
Building Operation products.
For more information, see section 3.2 “Products” on page 49.

To install the License Administrator and License Server


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

3. Click Next
Next.

Continued on next page

04-13005-02-en, October 2012 System


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

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

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

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

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

Continued on next page

System 04-13005-02-en, October 2012


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

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

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

Continued on next page

04-13005-02-en, October 2012 System


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

9. Click Finish
Finish.

It is recommended that you configure the license server recovery settings to ensure
that the license server restarts if it unexpectedly stops. For more information, see
section 12.12 “Configuring License Server Recovery Settings ” on page 253.

System 04-13005-02-en, October 2012


60
3 Installation
3.6 Installing WorkStation and Client Tools

3.6 Installing WorkStation and Client Tools


You install WorkStation and client tools to create and supervise your Building
Operation system.

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

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

To install WorkStation and client tools


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

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

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

Continued on next page

04-13005-02-en, October 2012 System


61
3 Installation
3.6 Installing WorkStation and Client Tools

3. Click Next
Next.

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

Continued on next page

System 04-13005-02-en, October 2012


62
3 Installation
3.6 Installing WorkStation and Client Tools

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

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

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

7. Click Install
Install.
Continued on next page

04-13005-02-en, October 2012 System


63
3 Installation
3.6 Installing WorkStation and Client Tools

8. Click Next
Next.

9. Click Finish
Finish.

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

System 04-13005-02-en, October 2012


64
3 Installation
3.7 Installing a Language Package

3.7 Installing a Language Package


You install language packages to support languages other than English.

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

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

To install language package


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

Continued on next page

04-13005-02-en, October 2012 System


65
3 Installation
3.7 Installing a Language Package

3. Click Next
Next.

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

5. Click Next
Next.

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

Continued on next page

System 04-13005-02-en, October 2012


66
3 Installation
3.7 Installing a Language Package

6. Click Finish
Finish.

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


language on which the WorkStation is installed

04-13005-02-en, October 2012 System


67
3 Installation
3.8 Installing the Enterprise Server

3.8 Installing the Enterprise Server


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

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

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

To install the Enterprise Server


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

Continued on next page

System 04-13005-02-en, October 2012


68
3 Installation
3.8 Installing the Enterprise Server

3. Click Next
Next.

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

Continued on next page

04-13005-02-en, October 2012 System


69
3 Installation
3.8 Installing the Enterprise Server

5. Select Enterprise Server and then click Next


Next.

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

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

7. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


70
3 Installation
3.8 Installing the Enterprise Server

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

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

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

Continued on next page

04-13005-02-en, October 2012 System


71
3 Installation
3.8 Installing the Enterprise Server

13. Click Install


Install.
14. Click Next
Next.

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

Continued on next page

System 04-13005-02-en, October 2012


72
3 Installation
3.8 Installing the Enterprise Server

15. Click Finish


Finish.

04-13005-02-en, October 2012 System


73
3 Installation
3.9 Installing the Device Administrator

3.9 Installing the Device Administrator


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

To install the Device Administrator


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

3. Click Next
Next.

Continued on next page

System 04-13005-02-en, October 2012


74
3 Installation
3.9 Installing the Device Administrator

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

5. Select Device Administrator and then click Next.

6. Click Next
Next.

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

Continued on next page

04-13005-02-en, October 2012 System


75
3 Installation
3.9 Installing the Device Administrator

7. Click Finish
Finish.

System 04-13005-02-en, October 2012


76
4 Installation Repair

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

4.1 Installation Reparation


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

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

04-13005-02-en, October 2012 System


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

4.2 Repairing the License Administrator and


the License Server
You repair the License Administrator and the License Server installation if any
problems are caused by the current installation.
For more information, see section 4.1 “Installation Reparation” on page 79.

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

To repair the License Administrator and License Server


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

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

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


Server.

Continued on next page

System 04-13005-02-en, October 2012


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

3. Select Stop
Stop.
4. Double-click on the License Administrator installation file to start the
installation wizard.
5. Click Yes
Yes, to confirm that you want to run the License Administrator
installation package.

6. Click Next
Next.

Continued on next page

04-13005-02-en, October 2012 System


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

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

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

Continued on next page

System 04-13005-02-en, October 2012


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

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


installation.

10. Click Next


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

12. Click Next


Continued on next page

04-13005-02-en, October 2012 System


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

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

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

14. Click Install


Install.
15. Click Next
Next.

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

Continued on next page

System 04-13005-02-en, October 2012


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

16. Click Finish


Finish.

04-13005-02-en, October 2012 System


85
4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

4.3 Repairing WorkStation and Client Tools


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

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

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

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

To repair the WorkStation and client tool installation


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

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

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

Continued on next page

System 04-13005-02-en, October 2012


86
4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

3. Click Next
Next.

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

Continued on next page

04-13005-02-en, October 2012 System


87
4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

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

6. Select Repair current version


version.

7. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


88
4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

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

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

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

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

Continued on next page

04-13005-02-en, October 2012 System


89
4 Installation Repair
4.3 Repairing WorkStation and Client Tools Installation

11. Click Finish


Finish.

System 04-13005-02-en, October 2012


90
4 Installation Repair
4.4 Repairing the Enterprise Server

4.4 Repairing the Enterprise Server


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

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

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

To repair the Enterprise Server


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

Continued on next page

04-13005-02-en, October 2012 System


91
4 Installation Repair
4.4 Repairing the Enterprise Server

5. Click Stop Service


Service.

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


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

Continued on next page

System 04-13005-02-en, October 2012


92
4 Installation Repair
4.4 Repairing the Enterprise Server

8. Click Next
Next.

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

Continued on next page

04-13005-02-en, October 2012 System


93
4 Installation Repair
4.4 Repairing the Enterprise Server

10. Select Enterprise Server and then click Next


Next.

11. Click Next


Next.

Continued on next page

System 04-13005-02-en, October 2012


94
4 Installation Repair
4.4 Repairing the Enterprise Server

12. In the Enterprise Server Installation Type


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

13. Click Next


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

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

04-13005-02-en, October 2012 System


95
4 Installation Repair
4.4 Repairing the Enterprise Server

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

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

18. Click Install


Install.
19. Click Next
Next.

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

Continued on next page

System 04-13005-02-en, October 2012


96
4 Installation Repair
4.4 Repairing the Enterprise Server

20. Click Finish


Finish.

04-13005-02-en, October 2012 System


97
4 Installation Repair
4.5 Repairing the Device Administrator Installation

4.5 Repairing the Device Administrator


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

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

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

To repair the Device Administrator installation


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

Continued on next page

System 04-13005-02-en, October 2012


98
4 Installation Repair
4.5 Repairing the Device Administrator Installation

3. Click Next
Next.

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

Continued on next page

04-13005-02-en, October 2012 System


99
4 Installation Repair
4.5 Repairing the Device Administrator Installation

5. Select Device Administrator and then click Next


Next.

6. Select Repair current version


version.

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

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

Continued on next page

System 04-13005-02-en, October 2012


100
4 Installation Repair
4.5 Repairing the Device Administrator Installation

9. Click Finish
Finish.

04-13005-02-en, October 2012 System


101
5 Reinstallation

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

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

Caution
Back up the Enterprise Server before reinstalling the product. All user settings,
database information, and system files related to this product are erased and
replaced. For more information, see WebHelp.

To replace your current version, you start with the installation package of the
product you want to reinstall. If the installation package recognizes an earlier
installation of the Building Operation product within the same major and minor
version number but lower maintenance number, the installation wizard asks if you
want to uninstall the current version before installing this package.

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

04-13005-02-en, October 2012 System


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

5.2 Reinstalling the License Administrator


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

To reinstall the License Administrator and License Server


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

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

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


Server.

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

System 04-13005-02-en, October 2012


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

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

6. Click Next
Next.

Continued on next page

04-13005-02-en, October 2012 System


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

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

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

Continued on next page

System 04-13005-02-en, October 2012


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

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


License Administrator installation.

10. Click Next


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

12. Click Next


Next.
Continued on next page

04-13005-02-en, October 2012 System


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

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

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

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


Continued on next page

System 04-13005-02-en, October 2012


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

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


before the new version is installed.

16. Click Close


Close.

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

Continued on next page

04-13005-02-en, October 2012 System


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

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

18. Click Close


Close.

Continued on next page

System 04-13005-02-en, October 2012


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

19. Click Next


Next.

20. Click Finish to close the installation wizard.

04-13005-02-en, October 2012 System


113
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

5.3 Reinstalling WorkStation and Client


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

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

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

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

To reinstall WorkStation and client tool installation


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

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

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

Continued on next page

System 04-13005-02-en, October 2012


114
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

3. Click Next
Next.

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

Continued on next page

04-13005-02-en, October 2012 System


115
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

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

6. Select Uninstall current version before reinstalling


reinstalling.

7. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


116
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

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

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

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

Continued on next page

04-13005-02-en, October 2012 System


117
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

11. Click Close


Close.

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

12. Click Next


Next.

Continued on next page

System 04-13005-02-en, October 2012


118
5 Reinstallation
5.3 Reinstalling WorkStation and Client Tools

13. Click Finish


Finish.

04-13005-02-en, October 2012 System


119
5 Reinstallation
5.4 Reinstalling the Enterprise Server

5.4 Reinstalling the Enterprise Server


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

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

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

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

To reinstall the Enterprise Server


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

Continued on next page

System 04-13005-02-en, October 2012


120
5 Reinstallation
5.4 Reinstalling the Enterprise Server

6. Click Stop Service


Service.

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


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

Continued on next page

04-13005-02-en, October 2012 System


121
5 Reinstallation
5.4 Reinstalling the Enterprise Server

9. Click Next
Next.

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

Continued on next page

System 04-13005-02-en, October 2012


122
5 Reinstallation
5.4 Reinstalling the Enterprise Server

11. Select Enterprise Server and then click Next


Next.

12. Click Next


Next.

Continued on next page

04-13005-02-en, October 2012 System


123
5 Reinstallation
5.4 Reinstalling the Enterprise Server

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

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

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

System 04-13005-02-en, October 2012


124
5 Reinstallation
5.4 Reinstalling the Enterprise Server

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

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

18. Click Install


Install.
Continued on next page

04-13005-02-en, October 2012 System


125
5 Reinstallation
5.4 Reinstalling the Enterprise Server

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

20. Click Close


Close.

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

Continued on next page

System 04-13005-02-en, October 2012


126
5 Reinstallation
5.4 Reinstalling the Enterprise Server

21. Click Next


Next.

22. Click Finish


Finish.

04-13005-02-en, October 2012 System


127
5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

5.5 Reinstalling the Device Administrator


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

To reinstall the Device Administrator installation


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

3. Click Next
Next.

Continued on next page

System 04-13005-02-en, October 2012


128
5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

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

5. Select Device Administrator and then click Next


Next.

Continued on next page

04-13005-02-en, October 2012 System


129
5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

6. Select Uninstall current version before reinstalling


reinstalling.

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

9. Click Close
Close.

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

Continued on next page

System 04-13005-02-en, October 2012


130
5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

10. Click Next


Next.

Continued on next page

04-13005-02-en, October 2012 System


131
5 Reinstallation
5.5 Reinstalling the Device Administrator Installation

11. Click Finish


Finish.

System 04-13005-02-en, October 2012


132
6 Computer Maintenance

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

6.1 Replace Enterprise Server or


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

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

Figure: Enterprise Server Replacement Preparation flowchart

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

Stop Enterprise Server Windows service


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

04-13005-02-en, October 2012 System


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

Stop License Server Windows service


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

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.

6.1.2 Install Building Operation Software


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

Figure: Reinstall Building Operation software flowchart

Install Enterprise Server


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

Install other Building Operation software


Install any other Building Operation software, such as WorkStation.

6.1.3 Restore the Enterprise Server Database


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

System 04-13005-02-en, October 2012


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

Figure: Restore Enterprise Database flowchart

Stop Reporting Agent Windows service


If your system includes WebReports, stop the Reporting Agent Windows service.
For more information, see 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 WebHelp.

Verify TCP protocol and server communication


Use the Communications properties of the Enterprise Server to verify that TCP is
set as the communications protocol for the Automation Servers and Enterprise
Server, and the servers are communicating with each other. For more information,
see WebHelp.

04-13005-02-en, October 2012 System


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

Verify control and monitoring operations


Use Software Administrator (or the Services tool) to verify that the Enterprise Server
Windows service is running, which ensures that extended trend logging restarts.
For more information, see section 14.5 “Starting the Enterprise Server Windows
Service” on page 281.
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 WebHelp.

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

The process of changing the operating system or replacing the computer is now
complete.

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

6.1.4 WebReports Migration Preparation


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

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

Export Reports schedules


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

System 04-13005-02-en, October 2012


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

6.1.5 Install WebReports


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

Figure: Reinstall WebReports flowchart

Configure Windows roles and features


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

04-13005-02-en, October 2012 System


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

Install Microsoft SQL Server 2008 64-bit


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

Attach WebReports database


Use SQL Server Management Studio to attach the WebReports database. For
more information, see WebHelp.

Confirm administrator role memberships for WebReports database


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

Install WebReports Installer


Run the WebReports installation package to install the WebReports Installer. For
more information, see 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 WebHelp.

Import or recreate Reports schedules


Import or recreate the Reports schedules on the computer running WebReports.
For more information, see WebHelp.

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

The WebReports migration is now complete.

System 04-13005-02-en, October 2012


140
7 Uninstallation

Topics
Uninstallation
Uninstalling the License Administrator
Uninstalling the License Server
Uninstalling WorkStation
Uninstalling Enterprise Server
Uninstalling the Device Administrator
7 Uninstallation
7.1 Uninstallation

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

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

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

04-13005-02-en, October 2012 System


143
7 Uninstallation
7.2 Uninstalling the License Administrator

7.2 Uninstalling the License Administrator


You uninstall License Administrator to permanently remove the application from
your computer 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 10.6
“Removing a Local License or Returning a Network License” on page 210.

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

To uninstall the License Administrator


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

Continued on next page

System 04-13005-02-en, October 2012


144
7 Uninstallation
7.2 Uninstalling the License Administrator

3. Select Schneider Electric StruxureWare Building Operation License


Administrator and then click Uninstall
Uninstall.

4. Click Uninstall
Uninstall.

Continued on next page

04-13005-02-en, October 2012 System


145
7 Uninstallation
7.2 Uninstalling the License Administrator

5. Click Close
Close.

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

System 04-13005-02-en, October 2012


146
7 Uninstallation
7.3 Uninstalling the License Server

7.3 Uninstalling the License Server


You uninstall a License Server to permanently remove the application from your
computer 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 10.6
“Removing a Local License or Returning a Network License” on page 210.

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

To uninstall the License Server


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

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

Continued on next page

04-13005-02-en, October 2012 System


147
7 Uninstallation
7.3 Uninstalling the License Server

3. Right-click Building Operation License Server


Server.

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

System 04-13005-02-en, October 2012


148
7 Uninstallation
7.3 Uninstalling the License Server

6. Click Uninstall a program


program.

Continued on next page

04-13005-02-en, October 2012 System


149
7 Uninstallation
7.3 Uninstalling the License Server

7. Select Schneider Electric StruxureWare Building Operation License


Server and then click Uninstall
Uninstall.

8. Click Uninstall
Uninstall.

Continued on next page

System 04-13005-02-en, October 2012


150
7 Uninstallation
7.3 Uninstalling the License Server

9. Click Close
Close.

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

04-13005-02-en, October 2012 System


151
7 Uninstallation
7.4 Uninstalling WorkStation

7.4 Uninstalling WorkStation


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

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

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

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

Continued on next page

System 04-13005-02-en, October 2012


152
7 Uninstallation
7.4 Uninstalling WorkStation

3. Select the Schneider Electric StruxureWare Building Operation


WorkStation and then click Uninstall
Uninstall.

4. Click Uninstall
Uninstall.

Continued on next page

04-13005-02-en, October 2012 System


153
7 Uninstallation
7.4 Uninstalling WorkStation

5. Click Close
Close.

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

System 04-13005-02-en, October 2012


154
7 Uninstallation
7.5 Uninstalling Enterprise Server

7.5 Uninstalling Enterprise Server


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

Caution
Back up the Enterprise Server before uninstalling the product. All user settings,
database information, and system files related to this product are erased. Files
and backups created by the user remain and are not erased. For more
information, see WebHelp.

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

To uninstall Enterprise Server


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

Continued on next page

04-13005-02-en, October 2012 System


155
7 Uninstallation
7.5 Uninstalling Enterprise Server

6. Click Stop Service


Service.

7. On the Windows toolbar, select Start


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

System 04-13005-02-en, October 2012


156
7 Uninstallation
7.5 Uninstalling Enterprise Server

8. Click Uninstall a program


program.

Continued on next page

04-13005-02-en, October 2012 System


157
7 Uninstallation
7.5 Uninstalling Enterprise Server

9. Select the Schneider Electric StruxureWare Building Operation Enterprise


Server and then click Uninstall
Uninstall.

10. Click Uninstall


Uninstall.

Continued on next page

System 04-13005-02-en, October 2012


158
7 Uninstallation
7.5 Uninstalling Enterprise Server

11. Click Close


Close.

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

04-13005-02-en, October 2012 System


159
7 Uninstallation
7.6 Uninstalling the Device Administrator

7.6 Uninstalling the Device Administrator


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

To uninstall the Device Administrator


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

Continued on next page

System 04-13005-02-en, October 2012


160
7 Uninstallation
7.6 Uninstalling the Device Administrator

3. Select the Schneider Electric StruxureWare Building Operation Device


Administrator and then click Uninstall
Uninstall.

4. Click Uninstall
Uninstall.

Continued on next page

04-13005-02-en, October 2012 System


161
7 Uninstallation
7.6 Uninstalling the Device Administrator

5. Click Close
Close.

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

System 04-13005-02-en, October 2012


162
8 Installation User interface

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

8.1 Installation Wizard – Choose


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

Figure: Choose components page

Table: Choose Components Page


Component Description

Device Administrator Select to install Device Administrator, which


you use to discover and upgrade
Automation Servers.

License Administrator Select to install the License Administrator,


which you use to configure and maintain the
license system.

License Server Select to install the license server, which you


use to manage network licenses.

WorkStation Select to install WorkStation, which you use


to configure and supervise your Building
Operation system.

Graphics Editor Select to install Graphics Editor, which you


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

Script Editor Select to install Script Editor, which you use


to create custom script program for your
Building Automation System.

04-13005-02-en, October 2012 System


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

Continued
Component Description

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

Workplace Tech Editor Select to program, modify, and compile


control applications for MNL LonWorks
devices.

Enterprise Server Select to install Enterprise Server and


Software Administrator, which administrates
your Building Operation site.

System 04-13005-02-en, October 2012


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

8.2 Installation Wizard – Installation Type


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

Figure: Installation Type

Table: Installation Type


Component Description

Uninstall current version before Select to uninstall your current installation


reinstalling before the installation of a fresh copy starts.

Repair current version Select to repair your current installation.

Upgrade current version Select to upgrade your current installation to


a newer version.

Upgrade existing database Select to upgrade your current Enterprise


Server database to a newer version.

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


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

Replace database Select to replace your current Enterprise


Server database with an empty installation.

04-13005-02-en, October 2012 System


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

8.3 Installation Wizard – License Server


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

Figure: License server configuration page

Table: License Server Configuration Page


Component Description

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

System 04-13005-02-en, October 2012


168
8 Installation User interface
8.4 Enterprise Server Installation Wizard – Configuration Page

8.4 Enterprise Server Installation Wizard –


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

Figure: Configuration Page

Table: Configuration Page


Component Description

HTTP Port Type the port number that the Enterprise


Server listens to when communicating
through the Hypertext Transfer Protocol.

HTTPS Port Type the port number that the Enterprise


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

TCP Port Type the port number that the Enterprise


Server listens to when communicating
through the Transmission Control Protocol.

04-13005-02-en, October 2012 System


169
9 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
9 Licensing Introduction
9.1 Licensing Overview

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

9.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 9.2 “License System” on page 174.

9.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 9.3 “License Management” on page 176.

9.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 9.4 “Service and Maintenance ” on page 178.

04-13005-02-en, October 2012 System


173
9 Licensing Introduction
9.2 License System

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

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

9.2.2 License Server


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

9.2.3 License Administrator


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

System 04-13005-02-en, October 2012


174
9 Licensing Introduction
9.2 License System

9.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 9.6 “Licenses” on page 181.

04-13005-02-en, October 2012 System


175
9 Licensing Introduction
9.3 License Management

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

9.3.1 License System Installation and Configuration


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

System 04-13005-02-en, October 2012


176
9 Licensing Introduction
9.3 License Management

9.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 10.2 “Network License Management” on page
201.

9.3.3 Local License Management


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

04-13005-02-en, October 2012 System


177
9 Licensing Introduction
9.4 Service and Maintenance

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

9.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 12.13 “License Server Maintenance” on page
255.

9.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 9.5 “License Maintenance” on page 180.

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

System 04-13005-02-en, October 2012


178
9 Licensing Introduction
9.4 Service and Maintenance

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

04-13005-02-en, October 2012 System


179
9 Licensing Introduction
9.5 License Maintenance

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

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

9.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 10.4 “Network License Return” on page 205.

9.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 9.11 “Lost License” on page 189.

9.5.4 License Reparation


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

9.5.5 License Backup


Schneider Electric recommends backing up the license server files on a regular
basis. To back up the license files, copy all files in the folder to an external resource.
For more information, see section 9.13 “License Backup” on page 191.

System 04-13005-02-en, October 2012


180
9 Licensing Introduction
9.6 Licenses

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

Table: Building Operation Licenses


License File Name Description

Client Station client.station Use this license to start and


run WorkStation.

Client tool licenses client.graphiceditor This license product group


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

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


run an Enterprise Server.

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

9.6.1 End User License Agreement


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

04-13005-02-en, October 2012 System


181
9 Licensing Introduction
9.6 Licenses

9.6.2 Local Licenses


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

9.6.3 Network Licenses


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

9.6.4 Time-Limited Licenses


A time-limited license is a license that gives license rights for a predetermined
period of time, usually 30 days. When the time period is over, the license expires.

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

9.6.5 Permanent License


A permanent license does not expire.

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

9.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 9.9 “License Selection Process” on page 186.

System 04-13005-02-en, October 2012


182
9 Licensing Introduction
9.7 Viewing Activated Licenses

9.7 Viewing Activated Licenses


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

To view activated licenses


1. In License Administrator, click the Licenses view.

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

04-13005-02-en, October 2012 System


183
9 Licensing Introduction
9.8 Editing Registration Details

9.8 Editing Registration Details


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

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

For more information, see section 12.14 “License Administrator” on page 258.

To edit registration details


1. In License Administrator, click the Registration Details view.

2. In the License owner box, type the name of the organization that owns the
license.
3. In the Industry box, select the license owner’s field of business.
4. In the Type of project boxes, select the proposed field of application for the
license.
5. In the Name box, type the name of the account manager that supplied the
license.
6. In the E-mail box, type the e-mail address to the account manager that
supplied the license.
Continued on next page

System 04-13005-02-en, October 2012


184
9 Licensing Introduction
9.8 Editing Registration Details

7. In the Telephone number box, type the telephone number to the account
manager that supplied the license.

8. Click OK
OK.
9. Click Yes
Yes.

Any changes in the registration details updates all activated licenses on the license
server.

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

04-13005-02-en, October 2012 System


185
9 Licensing Introduction
9.9 License Selection Process

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

System 04-13005-02-en, October 2012


186
9 Licensing Introduction
9.10 Order Information Request

9.10 Order Information Request


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

Figure: Entitle Certificate with entitlement ID

04-13005-02-en, October 2012 System


187
9 Licensing Introduction
9.10 Order Information Request

Figure: Work flow when requesting order information

Table: Request Order Information


Number Description

1 The Entitlement IDID, which contains the


licenses to activate, is entered into the
License Administrator.

2 The License Administrator sends the


entitlement ID to the License Activation
Server.

3 The License Activation Server sends the


order information to the License
Administrator.

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

System 04-13005-02-en, October 2012


188
9 Licensing Introduction
9.11 Lost License

9.11 Lost License


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

04-13005-02-en, October 2012 System


189
9 Licensing Introduction
9.12 License Repair

9.12 License Repair


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

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

Figure: Damaged local and network licenses.

System 04-13005-02-en, October 2012


190
9 Licensing Introduction
9.13 License Backup

9.13 License Backup


Schneider Electric recommends backing up the license server files on a regular
basis. To back up the license files, copy all files in the folder to an external resource.
Backed up licenses can only be restored on the same license server that the files
were backed up from. If you plan to move the licenses to another licenses server,
you first have to return the liceses to the License Activtation Server and then
activate them on the new license server.
The license server files are located in the following locations:
• Windows XP: \Documents and Settings\All Users\Application Data\FLEXnet.
• Windows 7: \ProgramData\FLEXnet
• Windows Server 2008: \ProgramData\FLEXnet
Licenses restored from a backup can be considered damaged by the license
server. For more information, see section 9.12 “License Repair” on page 190.

04-13005-02-en, October 2012 System


191
9 Licensing Introduction
9.14 Backing Up Licenses

9.14 Backing Up Licenses


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

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

System 04-13005-02-en, October 2012


192
9 Licensing Introduction
9.15 Restoring Licenses

9.15 Restoring Licenses


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

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

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

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

04-13005-02-en, October 2012 System


193
10 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
10 Type of Licenses
10.1 Network Licenses

10.1 Network Licenses


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

04-13005-02-en, October 2012 System


197
10 Type of Licenses
10.1 Network Licenses

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

System 04-13005-02-en, October 2012


198
10 Type of Licenses
10.1 Network Licenses

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

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

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

04-13005-02-en, October 2012 System


199
10 Type of Licenses
10.1 Network Licenses

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

System 04-13005-02-en, October 2012


200
10 Type of Licenses
10.2 Network License Management

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

10.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 9.10 “Order Information Request” on page 187.

10.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 10.3 “Network Licenses Activation” on page 203.

10.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 11.1 “Enterprise Server Address Configuration”
on page 229.

04-13005-02-en, October 2012 System


201
10 Type of Licenses
10.2 Network License Management

10.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 11.2 “WorkStation and Client Tools Address
Configuration” on page 231.

10.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 10.7 “Network License Upgrade” on page 212.

System 04-13005-02-en, October 2012


202
10 Type of Licenses
10.3 Network Licenses Activation

10.3 Network Licenses Activation


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

Figure: Activation of network license on license server by the License Activation Server
Use the License Administrator to activate a network license. When activating a
network license, the License Administrator on the receiving computer requests and
administrates the activation.

04-13005-02-en, October 2012 System


203
10 Type of Licenses
10.3 Network Licenses Activation

Figure: Work flow when activating licenses on license server

Table: Activation of Licenses on License Server


Number Description

1 To activate a license, the registration details


need to be correctly entered.

2 The License Administrator sends an


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

3 License Activation Server activates the


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

The activated licenses are now available on the license server. Before the license
server can distribute the network licenses, the license server has to be restarted.

System 04-13005-02-en, October 2012


204
10 Type of Licenses
10.4 Network License Return

10.4 Network License Return


To return a network license means that a license is transferred from the license
server back to the License Activation Server. A returned network license, located on
the License Activation Server, is not available for the WorkStation or Enterprise
Server to check out.
When returning a license, all the licenses that were activated in the same session
are also returned. For example, if seven licenses are activated in the same activation
transaction, a single license cannot be returned to the License Activation Server.
To once again activate the returned licenses, use the entitlement ID that contains
the returned licenses.
This workflow describes the return transaction of licenses from a license server to
the License Activation Server.

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

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

1 In the License Administrator, select the


licenses to return.

2 The License Administrator returns the


licenses to the License Activation Server.

04-13005-02-en, October 2012 System


205
10 Type of Licenses
10.4 Network License Return

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

System 04-13005-02-en, October 2012


206
10 Type of Licenses
10.5 Activating Network Licenses

10.5 Activating Network Licenses


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

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

For more information, see section 9.6 “Licenses” on page 181.

To activate network licenses


1. In License Administrator, click the Licenses view.

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

04-13005-02-en, October 2012 System


207
10 Type of Licenses
10.5 Activating Network Licenses

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

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

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

6. Click Activate
Activate.
Continued on next page

System 04-13005-02-en, October 2012


208
10 Type of Licenses
10.5 Activating Network Licenses

7. Click Close
Close.

8. Click Restart now to restart the license server and activate the network
license.

The activated licenses are now available on the license server.

04-13005-02-en, October 2012 System


209
10 Type of Licenses
10.6 Removing a Local License or Returning a Network License

10.6 Removing a Local License or Returning


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

Note
You cannot reactivate a removed local license.
• When you return a license to the License Activation Server, all the licenses
that were activated in the same transaction with that license are also
returned.

To remove a local license or return a network license


1. In License Administrator, click the Licenses view.

2. Select the local license to remove or the network license to return.

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


Continued on next page

System 04-13005-02-en, October 2012


210
10 Type of Licenses
10.6 Removing a Local License or Returning a Network License

4. Click Yes
Yes.

5. Click Close
Close.

6. Click Restart now


now, to apply the changes to the license server.

04-13005-02-en, October 2012 System


211
10 Type of Licenses
10.7 Network License Upgrade

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

System 04-13005-02-en, October 2012


212
10 Type of Licenses
10.7 Network License Upgrade

Continued
Number Description

2 All licenses with old versions are returned to


the License Activation Server.

3 Licenses with the new version are activated


on the License Server.

04-13005-02-en, October 2012 System


213
10 Type of Licenses
10.8 Upgrading Network Licenses

10.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 10.7 “Network License Upgrade” on page 212.

To upgrade network licenses


1. In License Administrator, click the Licenses view.

Continued on next page

System 04-13005-02-en, October 2012


214
10 Type of Licenses
10.8 Upgrading Network Licenses

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

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

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

4. Click OK
OK.
Continued on next page

04-13005-02-en, October 2012 System


215
10 Type of Licenses
10.8 Upgrading Network Licenses

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

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

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

Continued on next page

System 04-13005-02-en, October 2012


216
10 Type of Licenses
10.8 Upgrading Network Licenses

8. Click Close
Close.

9. Click Restart now


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

04-13005-02-en, October 2012 System


217
10 Type of Licenses
10.9 Repairing a Network License

10.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 9.12 “License Repair” on page 190.

To repair a network license


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

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


4. Click Yes
Yes.

Continued on next page

System 04-13005-02-en, October 2012


218
10 Type of Licenses
10.9 Repairing a Network License

5. Click Close
Close.

6. Click Restart now


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

The license is now repaired and available to be checked out.

04-13005-02-en, October 2012 System


219
10 Type of Licenses
10.10 Local Licenses

10.10 Local Licenses


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

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

System 04-13005-02-en, October 2012


220
10 Type of Licenses
10.10 Local Licenses

04-13005-02-en, October 2012 System


221
10 Type of Licenses
10.11 Local License Management

10.11 Local License Management


A local license is activated from a license file with the extension .asr. Local licenses
must be activated to a dedicated WorkStation or Enterprise Server. The local
license cannot be distributed and shared between different WorkStations or servers
as the network license can.
License files to activate as time-limited local licenses are included in the installation
of Building Operation. The local license files are in the following paths:
• Windows XP: \Documents and Settings\All Users\Application Data\Schneider
Electric StruxureWare\Building Operation x.x\License Files\
• Windows server 2008: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\License Files\
• Windows 7: \ProgramData\Schneider Electric StruxureWare\Building
Operation x.x\License Files\
The x.x represents the version number. For more information, see section 10.10
“Local Licenses” on page 220.
For more information on how to order additional license files or license files for client
tools, please contact your Building Operation vendor.

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

System 04-13005-02-en, October 2012


222
10 Type of Licenses
10.12 Activating a Local License

10.12 Activating a Local License


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

Note
• Plan the license management carefully and purchase licenses early to avoid
unexpected operational stops caused by expired time limit.
• For more information on how to order local licenses for client tools, please
contact your Building Operation vendor.

For more information, see section 9.6 “Licenses” on page 181.

04-13005-02-en, October 2012 System


223
10 Type of Licenses
10.12 Activating a Local License

To activate a local license


1. In License Administrator, click the Licenses view.

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

System 04-13005-02-en, October 2012


224
10 Type of Licenses
10.12 Activating a Local License

3. Select the license file and then click Open


Open.

4. Click Close
Close.

Continued on next page

04-13005-02-en, October 2012 System


225
10 Type of Licenses
10.12 Activating a Local License

5. Click Restart now to restart the license server and activate the local license.

The local license is now activated and the WorkStation, client tool or Enterprise
Server can start.

System 04-13005-02-en, October 2012


226
11 Licensing Configuration and
Diagnostics

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

11.1 Enterprise Server Address


Configuration
After licenses are activated on the license server, you configure the Enterprise
Server connection to the license server. The address to the license server is defined
either during the installation of Enterprise Server, through License Administrator, or
Windows registry.

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

Table: Enterprise Server Configuration


Number Description

1 Configure the Enterprise Server address to


the license server.

2 Remove any activated local licenses.

3 When the Enterprise Server starts, it


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

When the Enterprise Server starts, it automatically checks out an available network
license from a license server. A checked out network license is not physically
moved to or activated on the Enterprise Server. The license remains in the license
server but is allocated to the dedicated Enterprise Server. The license is therefore
not available for other servers to check out.

04-13005-02-en, October 2012 System


229
11 Licensing Configuration and Diagnostics
11.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 14.9 “Viewing Enterprise
Server System Log” on page 286.

System 04-13005-02-en, October 2012


230
11 Licensing Configuration and Diagnostics
11.2 WorkStation and Client Tools Address Configuration

11.2 WorkStation and Client Tools Address


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

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

Table: WorkStation Configuration


Number Description

1 Configure the WorkStation and client tool


address to the license server.

2 Remove any activated local licenses.

3 When you logon to WorkStation or start a


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

A checked out network license is not physically moved to or activated on


WorkStation. The client station and client tool licenses remain in the license server
but are allocated to the dedicated WorkStation. The license is therefore not
available for other WorkStations to check out.

04-13005-02-en, October 2012 System


231
11 Licensing Configuration and Diagnostics
11.3 Viewing Diagnostic Information

11.3 Viewing Diagnostic Information


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

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.

System 04-13005-02-en, October 2012


232
11 Licensing Configuration and Diagnostics
11.4 Copying Diagnostics to the Clipboard

11.4 Copying Diagnostics to the Clipboard


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

To copy the diagnostics to the clipboard


1. In License Administrator, click the Diagnostics view.

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

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


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

04-13005-02-en, October 2012 System


233
12 License Server and License
Administrator

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

12.1 License Server


The license server manages the administration of network licenses. A Building
Operation system running with network licenses must contain at least one license
server.
The license server is designed to not require user intervention. The license server is
a Microsoft Windows service named Building Operation License Server. Because of
the lack of user interface and graphical notifications that display the status of the
license server, it is recommended that you configure the license server to
automatically restart if it unexpectedly stops. For more information, see section
12.12 “Configuring License Server Recovery Settings ” on page 253.
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 12.14
“License Administrator” on page 258.

12.1.1 Flexnet License Manager, License Server


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

04-13005-02-en, October 2012 System


237
12 License Server and License Administrator
12.2 Starting the License Server

12.2 Starting the License Server


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

To start the license server


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

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

2. Right-click Building Operation License Server


Server.

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

System 04-13005-02-en, October 2012


238
12 License Server and License Administrator
12.3 Stopping the License Server

12.3 Stopping the License Server


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

To stop the license server


1. On the license server computer, open the Service management console.
2. Right-click Building Operation License Server
Server.

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

04-13005-02-en, October 2012 System


239
12 License Server and License Administrator
12.4 Restarting the License Server

12.4 Restarting the License Server


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

To restart the license server


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

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

2. Right-click Building Operation License Server


Server.

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

System 04-13005-02-en, October 2012


240
12 License Server and License Administrator
12.5 Flexnet License Administrator, License Server Manager

12.5 Flexnet License Administrator, License


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

Figure: FLEXnet License Administrator, Dashboard part.


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

04-13005-02-en, October 2012 System


241
12 License Server and License Administrator
12.5 Flexnet License Administrator, License Server Manager

Figure: FLEXnet License Administrator, Administration part.


For more information about FLEXnet License Administrator, click the FLEXnet

License Administrator Help button .

12.5.1 License Server Port Number


With a default installation the License server port range is set to 27000-27009. A
valid number is any unused port between 0 and 64000. The license server port
number is configured in the Administration part, Server Configuration tab.

System 04-13005-02-en, October 2012


242
12 License Server and License Administrator
12.5 Flexnet License Administrator, License Server Manager

Figure: FLEXnet License Administrator, Server Configuration


If the license server uses other ports than the default port range 27000-27009, the
port has to be added in front of the @ in the license server address on the
WorkStation, Enterprise Server, or Client tools.

For more information, click FLEXnet License Administrator Help button .

12.5.2 FLEXnet License Administrator Port Number


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

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

04-13005-02-en, October 2012 System


243
12 License Server and License Administrator
12.6 Accessing Flexnet lmadmin

12.6 Accessing Flexnet lmadmin


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

To access Flexnet lmadmin


1. On a computer that has access to the network where the license server to
configure is located, open a web browser.
2. In the address field, type the license server IP or network. End the address
with colon and then the port number.

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

For more information, click the Flexnet lmadmin Help button .

System 04-13005-02-en, October 2012


244
12 License Server and License Administrator
12.7 Changing the lmadmin License Server Manager Port Number

12.7 Changing the lmadmin License Server


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

To change the lmadmin license server manager port number


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

4. Save the file and close the editor.


5. Restart the license server.
To access the lmadmin license server manager, open a web browser and type in
the address to the license server with the new port number.

04-13005-02-en, October 2012 System


245
12 License Server and License Administrator
12.8 License Server Address

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

System 04-13005-02-en, October 2012


246
12 License Server and License Administrator
12.8 License Server Address

Figure: Example of license server addresses in License Administrator


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

04-13005-02-en, October 2012 System


247
12 License Server and License Administrator
12.9 Configuring the Address to the License Server

12.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 10.6 “Removing a Local License or Returning a
Network License” on page 210.

For more information, see section 10.2 “Network License Management” on page
201.

To configure the address to the license server


1. In License Administrator, click the Licenses server address view.
Continued on next page

System 04-13005-02-en, October 2012


248
12 License Server and License Administrator
12.9 Configuring the Address to the License Server

2. In the License server address box, type @ and then type the address to the
server.

Note
• The address must begin with an @.
• If you use a port other than the default port of 27000, type the
port number in front of @. For example, 567@localhost.
• Use a semicolon to separate addresses to different license
servers.

3. Click Save
Save.
Next time a WorkStation, client tool, or Enterprise Server starts, it checks out
available network licenses from a defined license server.

Note
• The license server address is configured individually on all WorkStations and
Enterprise Servers.

04-13005-02-en, October 2012 System


249
12 License Server and License Administrator
12.10 License Server Reset

12.10 License Server Reset


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

Note
• If you delete the license server files, all activated network licenses are lost.

System 04-13005-02-en, October 2012


250
12 License Server and License Administrator
12.11 Resetting the License Server

12.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 12.10 “License Server Reset” on page 250.

To reset the license server


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

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


Continued on next page

04-13005-02-en, October 2012 System


251
12 License Server and License Administrator
12.11 Resetting the License Server

4. Click Yes
Yes.

5. Click Close
Close.

6. Close all running Building Operation programs.


7. Stop the license server.
8. In the license server application folder, remove all .data files that start with
taclic
taclic:
• Windows XP: \Documents and Settings\All Users\Application
Data\FLEXnet
• Windows 7: \ProgramData\FLEXnet
• Windows Server 2008: \ProgramData\FLEXnet
9. Start the license server.
10. Reactivate the returned network licenses.
When you reactivate all returned network licenses, new license server .data files are
created together with the activation of the first license.

System 04-13005-02-en, October 2012


252
12 License Server and License Administrator
12.12 Configuring License Server Recovery Settings

12.12 Configuring License Server Recovery


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

To configure the license server recovery settings


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

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

2. Right-click Building Operation License Server


Server.

3. Select Properties
Properties.
Continued on next page

04-13005-02-en, October 2012 System


253
12 License Server and License Administrator
12.12 Configuring License Server Recovery Settings

4. Click the Recovery tab.

5. In the First failure box, select Restart the Service


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

System 04-13005-02-en, October 2012


254
12 License Server and License Administrator
12.13 License Server Maintenance

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

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

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

12.13.3 License Server Replacement


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

04-13005-02-en, October 2012 System


255
12 License Server and License Administrator
12.13 License Server Maintenance

Figure: Replacing the License Server or moving licenses

Table: Replace of Licenses or Move of Licenses


Number Description

1 All licenses, located on the old license


server, are returned to the License Activation
Server.

2 The License Activation Server activates the


licenses on the new license server using the
entitlement ID that originally was used to
activate the licenses.

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

System 04-13005-02-en, October 2012


256
12 License Server and License Administrator
12.13 License Server Maintenance

12.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 12.10 “License Server Reset” on page 250.

04-13005-02-en, October 2012 System


257
12 License Server and License Administrator
12.14 License Administrator

12.14 License Administrator


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

12.14.1 Registration Details


Before the first network license is activated on a license server, details about the
customer’s organization and the contact information to the account manager must
be entered. The registration details are written to the license details when a license
is activated. Building Operation automatically saves these registration details and
reuses the details the next time a license is activated.

Note
Only English letters are allowed in the license details.

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

Note
• To ensure that all the licenses have the same information, the registration
details must be updated on all license servers in the Building Operation
system.

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

System 04-13005-02-en, October 2012


258
12 License Server and License Administrator
12.15 Starting the License Administrator

12.15 Starting the License Administrator


The License Administrator administrates the licenses on the license server and
defines the address to the license servers for all licensed Building Operation
products.
For more information, see section 12.14 “License Administrator” on page 258.

To start the license administrator


1. Click Start
Start, point to Schneider Electric\StruxureWare
Electric\StruxureWare, and then click
License Administrator
Administrator.
2. Click Yes
Yes, to confirm that you want to run License Administrator.

04-13005-02-en, October 2012 System


259
13 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
13 Licensing User Interface
13.1 Registration Details View

13.1 Registration Details View


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

Note
Only English letters are allowed in the license details.

Figure: Registration details view

Table: Registration Details View


Component Description

License owner Type the name of the organization that


purchased the license.

Industry Select the end user’s field of business.

Type of project Select the proposed fields of application for


the license.

Name Type the name of the account manager that


supplied the license.

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


manager that supplied the license.

04-13005-02-en, October 2012 System


263
13 Licensing User Interface
13.1 Registration Details View

Continued
Component Description

Telephone number Type the phone number of the account


manager that supplied the license.

System 04-13005-02-en, October 2012


264
13 Licensing User Interface
13.2 Licenses View

13.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 13.3 “Licenses View Toolbar” on
page 266.

Use the Licenses view columns to view


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

Use the Licenses view icons to get


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

04-13005-02-en, October 2012 System


265
13 Licensing User Interface
13.3 Licenses View Toolbar

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

System 04-13005-02-en, October 2012


266
13 Licensing User Interface
13.4 Licenses View Icons

13.4 Licenses View Icons


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

Table: Licenses View Icons


Icon Description

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

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

Damaged Local License


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

Damaged Network License


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

04-13005-02-en, October 2012 System


267
13 Licensing User Interface
13.5 Licenses View Columns

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

System 04-13005-02-en, October 2012


268
13 Licensing User Interface
13.6 Add License Dialog Box

13.6 Add License Dialog Box


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

Figure: Add license dialog box

Table: Add License Dialog Box


Component Description

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


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

04-13005-02-en, October 2012 System


269
13 Licensing User Interface
13.7 License Activation Dialog Box

13.7 License Activation Dialog Box


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

Figure: License activation dialog box

Table: License Activation Dialog Box


Component Description

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

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

Product Displays the name of the license.

Version Displays the version number of the license.

Location Displays whether the license is a local


license or a network license.

Quantity Displays the number of licenses tha are


available to activate.

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

System 04-13005-02-en, October 2012


270
13 Licensing User Interface
13.7 License Activation Dialog Box

Continued
Component Description

Activate (button) Click to activate the selected number of


licenses.

04-13005-02-en, October 2012 System


271
13 Licensing User Interface
13.8 License Progress Dialog Box

13.8 License Progress Dialog Box


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

Figure: License progress dialog box

Table: License Progress Dialog Box


Component Description

Network License
Indicates that network licenses are activated
or returned.

Local License
Indicates that local licenses are activated or
removed.

Product Displays the name of the license.

Version Displays the version number of the license.

Quantity Displays the number of licenses to activate


or return.

Progress Displays the progress of the license


activation or return.

Status Displays the status of the activation or


return.

System 04-13005-02-en, October 2012


272
13 Licensing User Interface
13.9 License Server Address View

13.9 License Server Address View


Use the License Server Address view to specify the address to a license server.

Figure: License server address view

Table: License Server Address View


Component Description

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

04-13005-02-en, October 2012 System


273
13 Licensing User Interface
13.10 Diagnostics View

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

System 04-13005-02-en, October 2012


274
14 Software Administrator

Topics
Software Administrator
Enterprise Server
Starting Software Administrator
Configuring Enterprise Server Port Settings
Starting the Enterprise Server Windows Service
Stopping the Enterprise Server Windows Service
Restarting the Enterprise Server Windows Service
Enterprise Server System Log
Viewing Enterprise Server System Log
Software Administrator – Enterprise Server View
14 Software Administrator
14.1 Software Administrator

14.1 Software Administrator


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

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

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

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

14.1.4 Enterprise Server System Log


The Enterprise Server System log contains events logged by the Enterprise Server.
Examples of logged events are start up sequence, port settings, failures, run time,
and current server status.

04-13005-02-en, October 2012 System


277
14 Software Administrator
14.2 Enterprise Server

14.2 Enterprise Server


Depending on the size and requirements of the Building Operation system, one or
(in future releases) several Enterprise Servers are connected on the network. Both
Script and Function Block programmed Automation Servers are supported by the
Enterprise Server.
Enterprise Servers run on Windows PCs and operate as fully distributed peer-to-
peer devices.

Figure: An Enterprise Server network

System 04-13005-02-en, October 2012


278
14 Software Administrator
14.3 Starting Software Administrator

14.3 Starting Software Administrator


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

To start Software Administrator


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

04-13005-02-en, October 2012 System


279
14 Software Administrator
14.4 Configuring Enterprise Server Port Settings

14.4 Configuring Enterprise Server Port


Settings
You configure the Enterprise Server HTTP and TCP ports to define the
communication of the different protocols.
For more information, see section 14.1 “Software Administrator” on page 277.

To configure the ports for the Enterprise Server


1. In Software Administrator
Administrator, click Stop Service
Service.

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

System 04-13005-02-en, October 2012


280
14 Software Administrator
14.5 Starting the Enterprise Server Windows Service

14.5 Starting the Enterprise Server Windows


Service
You start the Enterprise Server to manage your Building Operation system.

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

Note
• The Enterprise Server is automatically started when installed or when the
server is restarted.

For more information, see section 14.1 “Software Administrator” on page 277.

To start the Enterprise Server windows service


1. In Software Administrator
Administrator, click Start Service
Service.

04-13005-02-en, October 2012 System


281
14 Software Administrator
14.6 Stopping the Enterprise Server Windows Service

14.6 Stopping the Enterprise Server


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

To stop the Enterprise Server Windows service


1. In Software Administrator
Administrator, click Stop Service
Service.

System 04-13005-02-en, October 2012


282
14 Software Administrator
14.7 Restarting the Enterprise Server Windows Service

14.7 Restarting the Enterprise Server


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

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

For more information, see section 14.1 “Software Administrator” on page 277.

To restart the Enterprise Server Windows service


1. In Software Administrator
Administrator, click Stop Service
Service.

Continued on next page

04-13005-02-en, October 2012 System


283
14 Software Administrator
14.7 Restarting the Enterprise Server Windows Service

2. Click Start Service


Service.

System 04-13005-02-en, October 2012


284
14 Software Administrator
14.8 Enterprise Server System Log

14.8 Enterprise Server System Log


The Enterprise Server System log contains events logged by the Enterprise Server.
Examples of logged events are start up sequence, port settings, failures, run time,
and current server status.
The log is displayed in the SoftWare Administrator dialog box. The log can also be
found in the db, database folder, in the Enterprise folder.

04-13005-02-en, October 2012 System


285
14 Software Administrator
14.9 Viewing Enterprise Server System Log

14.9 Viewing Enterprise Server System Log


You view logged server events in the Enterprise Server system log to troubleshoot
server problems that are traced to the Enterprise Server.
For more information, see section 14.8 “Enterprise Server System Log” on page
285.

To view the Enterprise Server system log


1. In the Software Administrator, in the System box, view the events in the
system log.

2. When finished, click OK


OK.

System 04-13005-02-en, October 2012


286
14 Software Administrator
14.10 Software Administrator – Enterprise Server View

14.10 Software Administrator – Enterprise


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

Figure: Enterprise Server view

Table: Enterprise Server View


Component Description

Status Displays the current status of the Enterprise


Server Windows service.

Start Service Click to start the Enterprise Server.

Stop Service Click to stop the Enterprise Server.

HTTP Port Type the port number that the Enterprise


Server listens to when communicating
through the Hypertext Transfer Protocol.

HTTPS Port Type the port number that the Enterprise


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

TCP Port Type the port number that the Enterprise


Server listens to when communicating
through the Transmitting Control Protocol.

04-13005-02-en, October 2012 System


287
14 Software Administrator
14.10 Software Administrator – Enterprise Server View

Continued
Component Description

System Displays the system log.

Path Displays the path to the folder where the


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

System 04-13005-02-en, October 2012


288
15 Localization Language and
Units

Topics
Regional and Language Conventions
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
15 Localization Language and Units
15.1 Regional and Language Conventions

15.1 Regional and Language Conventions


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.

15.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.
For more information, see section 15.3 “Language Packages” on page 293.

15.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.
For more information, see section 15.7 “Value Presentation” on page 297.

15.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 16.1 “Time and Time Zone” on page 309.

04-13005-02-en, October 2012 System


291
15 Localization Language and Units
15.2 Configuring Regional Settings

15.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 15.1 “Regional and Language Conventions” on
page 291.

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.

System 04-13005-02-en, October 2012


292
15 Localization Language and Units
15.3 Language Packages

15.3 Language Packages


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

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

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

04-13005-02-en, October 2012 System


293
15 Localization Language and Units
15.4 Changing WorkStation Language

15.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.
For more information, see section 15.3 “Language Packages” on page 293.

To change workstation language


1. Close all Building Operation-related applications.
2. For more information on how to change your operating system language, refer
to the manufacturer’s manual for the operating system.

System 04-13005-02-en, October 2012


294
15 Localization Language and Units
15.5 Adding a Language in WebStation

15.5 Adding a Language in WebStation


You add a language to WebStation so that the user is able to change to this
language.

Note
When the Enterprise Server or Automation Server is upgraded, the language pack
in WebStation must be added once again.

Important
To add a language in WebStation, you must log on with an account connected to
a group that has access to the Automation Server web device configuration.

For more information, see section 15.3 “Language Packages” on page 293.

To add a language in WebStation


1. In WebStation, on the Settings menu, click Add or remove language
language.
2. Click Add
Add.
3. Browse to the language you want to add.
4. Click Open
Open.
5. Click OK.

04-13005-02-en, October 2012 System


295
15 Localization Language and Units
15.6 Changing the Language in WebStation

15.6 Changing the Language in WebStation


You change the language in WebStation to adapt WebStation to a new region.
For more information, see WebHelp.

To change the language in WebStation


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

System 04-13005-02-en, October 2012


296
15 Localization Language and Units
15.7 Value Presentation

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

15.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.
For more information, see section 15.8 “Units” on page 298.

15.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 15.10 “Metric Prefixes” on page 302.

15.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 15.11 “Precision Format” on page 303.

04-13005-02-en, October 2012 System


297
15 Localization Language and Units
15.8 Units

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

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

System 04-13005-02-en, October 2012


298
15 Localization Language and Units
15.9 Adding or Changing a Unit and Prefix for a Value

15.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.
For more information, see section 15.8 “Units” on page 298.

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

3. Click the Value Configuration button .

Continued on next page

04-13005-02-en, October 2012 System


299
15 Localization Language and Units
15.9 Adding or Changing a Unit and Prefix for a Value

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.

Continued on next page

System 04-13005-02-en, October 2012


300
15 Localization Language and Units
15.9 Adding or Changing a Unit and Prefix for a Value

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


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

04-13005-02-en, October 2012 System


301
15 Localization Language and Units
15.10 Metric Prefixes

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

System 04-13005-02-en, October 2012


302
15 Localization Language and Units
15.11 Precision Format

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

04-13005-02-en, October 2012 System


303
15 Localization Language and Units
15.12 Adding a Unit Conversion Exception

15.12 Adding a Unit Conversion Exception


You add unit conversion exceptions to override regional settings within a domain.
For more information, see section 15.8 “Units” on page 298.

To add a unit conversion exception


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

Continued on next page

System 04-13005-02-en, October 2012


304
15 Localization Language and Units
15.12 Adding a Unit Conversion Exception

6. In the Unit Selection dialog box, select the unit for which you want a
conversion exception.

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

04-13005-02-en, October 2012 System


305
15 Localization Language and Units
15.13 Removing a Unit Conversion Exception

15.13 Removing a Unit Conversion Exception


You remove unit conversion exceptions to return to regional default settings within a
domain.
For more information, see section 15.8 “Units” on page 298.

To remove a unit conversion exception


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

7. Click the Save button .

System 04-13005-02-en, October 2012


306
16 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
16 Localization Time and Time Zone
16.1 Time and Time Zone

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

16.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 16.11 “Network Time” on page 324.

16.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 16.3 “Time and Time Zone Configuration in
WorkStation” on page 312.

16.1.3 Time and Time Zone Configuration in


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.
For more information, see section 16.4 “Time and Time Zone Configuration in
Enterprise Server” on page 313.

16.1.4 Time and Time Zone Configuration in


Automation Server
To adjust the Automation Server time, time zone, and DST, you have to access the
Automation Server through a WorkStation. In WorkStation, you configure the time
settings in the Date & Time view of the Automation Server.
For more information, see section 16.5 “Time and Time Zone Configuration in
Automation Server” on page 314.

04-13005-02-en, October 2012 System


309
16 Localization Time and Time Zone
16.2 Lead and Shadow Relationship

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

System 04-13005-02-en, October 2012


310
16 Localization Time and Time Zone
16.2 Lead and Shadow Relationship

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.

16.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 16.12 “Synchronize Network Time Settings” on
page 325.

16.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 16.14 “Synchronize Time Zone Settings” on page
328.

16.2.3 Synchronize Schedules and Calendars


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

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

04-13005-02-en, October 2012 System


311
16 Localization Time and Time Zone
16.3 Time and Time Zone Configuration in WorkStation

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

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

System 04-13005-02-en, October 2012


312
16 Localization Time and Time Zone
16.4 Time and Time Zone Configuration in Enterprise Server

16.4 Time and Time Zone Configuration in


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 16.12
“Synchronize Network Time Settings” on page 325.

04-13005-02-en, October 2012 System


313
16 Localization Time and Time Zone
16.5 Time and Time Zone Configuration in Automation Server

16.5 Time and Time Zone Configuration in


Automation Server
To adjust the Automation Server time, time zone, and DST, you have to access the
Automation Server through a WorkStation. In WorkStation, you configure the time
settings in the Date & Time view of the 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.

System 04-13005-02-en, October 2012


314
16 Localization Time and Time Zone
16.6 Changing the Time Zone of an Enterprise Server or Automation Server

16.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.
For more information, see section 16.4 “Time and Time Zone Configuration in
Enterprise Server” on page 313.

To change the time zone of an Enterprise Server or


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

3. Click Network time and time zones


zones.
Continued on next page

04-13005-02-en, October 2012 System


315
16 Localization Time and Time Zone
16.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


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

System 04-13005-02-en, October 2012


316
16 Localization Time and Time Zone
16.7 Creating a Custom Time Zone of an Enterprise Server or Automation Server

16.7 Creating a Custom Time Zone of an


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

To customize a time zone of an Enterprise Server or


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

3. Click Network time and time zones.


Continued on next page

04-13005-02-en, October 2012 System


317
16 Localization Time and Time Zone
16.7 Creating a Custom Time Zone of an Enterprise Server or Automation Server

4. Select Custom time zone


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.

11. Click the Save button .

System 04-13005-02-en, October 2012


318
16 Localization Time and Time Zone
16.8 Configuring Enterprise Server and WorkStation Date and Time

16.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.
For more information, see section 16.3 “Time and Time Zone Configuration in
WorkStation” on page 312.

To configure the Enterprise Server and WorkStation date and


time
1. Close all Building Operation-related applications.
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.

04-13005-02-en, October 2012 System


319
16 Localization Time and Time Zone
16.9 Synchronizing the Automation Server Clock

16.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 16.11 “Network Time” on page 324.

To synchronize the Automation Server clock


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

3. Click Network time and time zones


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

Continued on next page

System 04-13005-02-en, October 2012


320
16 Localization Time and Time Zone
16.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.

7. Click the Save button .

04-13005-02-en, October 2012 System


321
16 Localization Time and Time Zone
16.10 Manually Changing the Automation Server Time and Date

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

For more information, see section 16.5 “Time and Time Zone Configuration in
Automation Server” on page 314.

To manually changing the Automation Server time and date


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

3. Click Network time and time zones


zones.
Continued on next page

System 04-13005-02-en, October 2012


322
16 Localization Time and Time Zone
16.10 Manually Changing the Automation Server Time and Date

4. In the Automation Server Date & time view, click Manually adjust date &
time
time.

5. In the Local date & time boxes, enter the date and time of the Automation
Server.

6. Click the Save button .

04-13005-02-en, October 2012 System


323
16 Localization Time and Time Zone
16.11 Network Time

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

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

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

System 04-13005-02-en, October 2012


324
16 Localization Time and Time Zone
16.12 Synchronize Network Time Settings

16.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
16.11 “Network Time” on page 324.

04-13005-02-en, October 2012 System


325
16 Localization Time and Time Zone
16.13 Synchronizing Time Settings on Multiple Automation Servers

16.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 16.12 “Synchronize Network Time Settings” on
page 325.

To synchronize time settings on multiple Automation Servers


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the Enterprise Server that you want to synchronize
the Automation Server time settings with.

3. Click Network time and time zones


zones.
4. In the Enterprise Server Date & Time view, under Network time
synchronization on shadow Automation Servers
Servers, click Enable
Enable.

Continued on next page

System 04-13005-02-en, October 2012


326
16 Localization Time and Time Zone
16.13 Synchronizing Time Settings on Multiple Automation Servers

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.
7. On the File menu, click Save
Save.
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 .


12. Click the Time tab.

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


Settings/Date and Time
Time.
14. On the File menu, click Save
Save.

04-13005-02-en, October 2012 System


327
16 Localization Time and Time Zone
16.14 Synchronize Time Zone Settings

16.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
zone, on the Enterprise Server.

System 04-13005-02-en, October 2012


328
16 Localization Time and Time Zone
16.15 Synchronizing Time Zone Settings on Multiple Automation Servers

16.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 16.14 “Synchronize Time Zone Settings” on page
328.

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.

2. Click the Search button .


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
Zone.
7. On the File menu, click Save
Save.

04-13005-02-en, October 2012 System


329
17 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
17 Localization User Interface
17.1 Unit Selection Dialog Box

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


Component Description

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.

04-13005-02-en, October 2012 System


333
17 Localization User Interface
17.2 Date and Time Properties – Basic Tab

17.2 Date and Time Properties – Basic Tab


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

Figure: Basic tab

System 04-13005-02-en, October 2012


334
17 Localization User Interface
17.3 Date and Time Properties – Time Tab

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


Component Description

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.

04-13005-02-en, October 2012 System


335
17 Localization User Interface
17.4 Time Zone Properties – Basic Tab

17.4 Time Zone Properties – Basic Tab


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

Figure: Basic tab

System 04-13005-02-en, October 2012


336
17 Localization User Interface
17.5 Time Zone Properties – Zone Info Tab

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


Component Description

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.

04-13005-02-en, October 2012 System


337
17 Localization User Interface
17.5 Time Zone Properties – Zone Info Tab

Continued
Component Description

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.

System 04-13005-02-en, October 2012


338
17 Localization User Interface
17.6 Enterprise Server – Date & Time View

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


Component Description

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.

04-13005-02-en, October 2012 System


339
17 Localization User Interface
17.6 Enterprise Server – Date & Time View

Continued
Component Description

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.

Description Type a description or name for the


customized time zone DST settings.

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


the daylight saving time.

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.

System 04-13005-02-en, October 2012


340
17 Localization User Interface
17.7 Automation Server – Date & Time View

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


Component Description

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.

04-13005-02-en, October 2012 System


341
17 Localization User Interface
17.7 Automation Server – Date & Time View

Continued
Component Description

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.

Description Type a description or name for the


customized time zone DST settings.

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


the daylight saving time.

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.

System 04-13005-02-en, October 2012


342
17 Localization User Interface
17.8 Add or Remove Languages Dialog Box

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


Component Description

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


information, see section 15.3 “Language
Packages” on page 293.

Remove Click to remove the selected language. For


more information, see section 15.3
“Language Packages” on page 293.

04-13005-02-en, October 2012 System


343
17 Localization User Interface
17.9 Unit Conversion Exceptions View

17.9 Unit Conversion Exceptions View


Use the Unit Conversion Exceptions view to override regional settings within a
domain.

Figure: Unit Conversion Exceptions view

Component Description

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.

System 04-13005-02-en, October 2012


344
18 User Account Management

Topics
User Account Management Overview
Opening the Account Management Control Panel
User Accounts and User Account Groups
Creating a User Account
Editing a User Account Profile
Renaming a User Account
Disabling a User Account
Enabling a Disabled User Account
Setting an Expiration Date for a User Account
Removing the Expiration Date for a User Account
Deleting a User Account
18 User Account Management
18.1 User Account Management Overview

18.1 User Account Management Overview


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

Figure: To log on to a Building Operation server you have to use a valid user account that
is located in the same domain as the server.
Building Operation considers a user account valid when:
• The user account exists
• The user account is not disabled or expired
• The user account belongs to a user account group or mapped active directory
user group
• The user account group belongs to a domain

04-13005-02-en, October 2012 System


347
18 User Account Management
18.1 User Account Management Overview

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

18.1.1 User Accounts and User Account Groups


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

18.1.2 Domains
A Building Operation domain contains user accounts, user account groups,
software permissions, workspaces, and one or several Building Operation servers.
The Building Operation server that host and administrates the domain is called the
domain controller.
For more information, see section 20.1 “Domains” on page 405.

18.1.3 Software Permissions


Software Permissions are used to control user activities in a software application.
For example, you can set up these permissions to manage the type of data and
commands the user has permission to within a workspace, panel, or domain.
Software permissions comprise path permissions and command permissions.
For more information, see section 21.1 “Software Permissions” on page 429.

18.1.4 Log on Methods


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

18.1.5 Workspaces
The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted to users or user account groups different
tasks.
For more information, see WebHelp.

System 04-13005-02-en, October 2012


348
18 User Account Management
18.1 User Account Management Overview

18.1.6 Guest Log On in WebStation


A guest log on is used if you want the user to get immediate access to Building
Operation using WebStation.
For more information, see section 20.3 “Guest Log On in WebStation” on page 409.

04-13005-02-en, October 2012 System


349
18 User Account Management
18.2 Opening the Account Management Control Panel

18.2 Opening the Account Management


Control Panel
You open the Account Management control panel in the Work area to create and
configure Building Operation objects.
For more information, see section 46.4 “Control Panel” on page 1316.

To open the Account Management control panel


1. On the Tools menu, click Control Panel
Panel.
2. Click Account management
management.

System 04-13005-02-en, October 2012


350
18 User Account Management
18.3 User Accounts and User Account Groups

18.3 User Accounts and User Account


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

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

User Account Groups


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

04-13005-02-en, October 2012 System


351
18 User Account Management
18.3 User Accounts and User Account Groups

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

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

18.3.1 Window Active Directory User Groups


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

System 04-13005-02-en, October 2012


352
18 User Account Management
18.3 User Accounts and User Account Groups

18.3.2 WorkStation Account Management


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

04-13005-02-en, October 2012 System


353
18 User Account Management
18.4 Creating a User Account

18.4 Creating a User Account


You create and configure a user account for each person requiring access to
Building Operation.
For more information, see section 18.3 “User Accounts and User Account Groups”
on page 351.

To create a user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select a server for the user account.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


354
18 User Account Management
18.4 Creating a User Account

4. In the Domain box, select the domain the account is to be created in.

5. In the User Accounts area, click Add


Add.
6. In the Name box, type a name for the user account.

7. In the Description box, type a description.


8. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


355
18 User Account Management
18.4 Creating a User Account

9. In the First name box, type the user's name.

10. In the Middle name box, type the user's middle name.
11. In the Last name box, type the user's last name.
12. In the Home E-mail address box, type the user's e-mail address.
13. In the Work E-mail address
address, type the users work e-mail address.
14. In the Expires on box, enter a date and time when the user account expires
or leave these fields empty if you do not want the user account to expire.
Continued on next page

System 04-13005-02-en, October 2012


356
18 User Account Management
18.4 Creating a User Account

15. In the Password box, type a password for the user.

16. In the Confirm Password box, type the password again.


17. Click Create
Create.
18. Click OK
OK.

04-13005-02-en, October 2012 System


357
18 User Account Management
18.5 Editing a User Account Profile

18.5 Editing a User Account Profile


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

To edit a user account profile


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list box, select the server where the user
account is located.

3. Click Account management


management.
4. In the Domain list box, select the domain the user account belongs to.

5. In the User Accounts list box, select the user account you want to edit the
profile information.
6. Click Summary
Summary.
7. Click the Profile tab.
Continued on next page

System 04-13005-02-en, October 2012


358
18 User Account Management
18.5 Editing a User Account Profile

8. Edit the user account profile information.

9. Click the Save button .

04-13005-02-en, October 2012 System


359
18 User Account Management
18.6 Renaming a User Account

18.6 Renaming a User Account


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

To rename a user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account you are
renaming.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


360
18 User Account Management
18.6 Renaming a User Account

4. Click List users


users.

5. Select the user account you want to rename.

6. On the Edit menu, click Rename


Rename.
7. In the Object Name box, type a new name for the user account.

8. Click OK
OK.

04-13005-02-en, October 2012 System


361
18 User Account Management
18.7 Disabling a User Account

18.7 Disabling a User Account


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

To disable a user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.

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

System 04-13005-02-en, October 2012


362
18 User Account Management
18.7 Disabling a User Account

3. Click Account management


management.

4. In the Domain list, select the domain the user account belongs to.
5. In the User Accounts list, select the user account you want to disable.
6. Click Summary
Summary.
7. In the Disabled box, select True to disable the account.

8. Click the Save button .

04-13005-02-en, October 2012 System


363
18 User Account Management
18.8 Enabling a Disabled User Account

18.8 Enabling a Disabled User Account


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

To enable a disabled user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account you want to
enable.

Continued on next page

System 04-13005-02-en, October 2012


364
18 User Account Management
18.8 Enabling a Disabled User Account

3. Click Account management


management.

4. In the Domain list, select the domain the user account belongs to.
5. In the User Accounts list, select the user account.
6. Click Summary
Summary.
7. In the Disabled box, select False to enable the account.

8. Click the Save button .

04-13005-02-en, October 2012 System


365
18 User Account Management
18.9 Setting an Expiration Date for a User Account

18.9 Setting an Expiration Date for a User


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

To set an expiration date for a user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account you want to set
an expiration date for.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


366
18 User Account Management
18.9 Setting an Expiration Date for a User Account

4. In the Domain list, select the domain the user account belongs to.

5. In the User Accounts list, select the user account.


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

8. Click the Save button .

04-13005-02-en, October 2012 System


367
18 User Account Management
18.10 Removing the Expiration Date for a User Account

18.10 Removing the Expiration Date for a


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

To remove the expiration date for a user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account for which you
are removing the expiration date.
3. Click Account management
management.

Continued on next page

System 04-13005-02-en, October 2012


368
18 User Account Management
18.10 Removing the Expiration Date for a User Account

4. In the Domain list, select the domain the user account belongs to.

5. In the User Accounts list, select the user account.


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

8. Click the Save button .

04-13005-02-en, October 2012 System


369
18 User Account Management
18.11 Deleting a User Account

18.11 Deleting a User Account


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

To delete a user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list box, select the server with the domain
the user account belongs to.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


370
18 User Account Management
18.11 Deleting a User Account

4. In the Domain list box, select the domain the user account belongs to.

5. In the User Accounts list box, select the user account you want to delete.

6. Click the Delete button .


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

04-13005-02-en, October 2012 System


371
19 User Account Groups

Topics
Windows Active Directory User Groups
Creating a User Account Group
Editing the Description of a User Account Group
Adding a User Account to a User Account Group
Removing a User Account from a User Account Group
Reviewing the User Account Group Memberships for a User
Account
Adding a User Account Group to a User Account Group
Removing a User Account Group from another User Account
Group
Reviewing the User Account Group Memberships for a User
Account Group
Preventing a Group of Users from Exiting WorkStation
Enabling a Group of Users to Exit Workstation
Deleting a User Account Group
19 User Account Groups
19.1 Windows Active Directory User Groups

19.1 Windows Active Directory User Groups


You can map Windows Active Directory groups to Building Operation user account
groups if Building Operation runs on a network that uses this directory to manage
users and user account groups. A Building Operation user account group that
includes a Windows account group can be member of another Building Operation
user account group.
Mapping Windows Active Directory account groups to Building Operation user
account groups has advantages both for administrators and operators.
Administrators can manage the user accounts in the Windows Active Directory,
rather than managing the accounts in two places. Any changes are instantly
implemented to the mapped Building Operation user account group. Operators
only have to remember the Windows login. Once logged in to a Windows user
account that is mapped to a Building Operation account, the user is authenticated
to access WorkStation without having to log in a second time.

Note
• The Building Operation domain used to map the Windows Active Directory
user account groups must be a member of the Windows domain where the
Active Directory is located.
Windows Active Directory account groups can only be mapped on servers that
are based upon Microsoft Windows operating system. Other servers, for example
Automation Servers, cannot map Windows Active Directory groups.

For example, the Windows Active Directory user account groups Main Admin and
Main User are mapped to the Building Operation user account groups
Administrators and External Users. The External Users user account group is a
member of the Operator user account group. The Administrators account group,
which is a member of the External Users, inherits access to the Operator
workspace.

04-13005-02-en, October 2012 System


375
19 User Account Groups
19.1 Windows Active Directory User Groups

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

System 04-13005-02-en, October 2012


376
19 User Account Groups
19.2 Creating a User Account Group

19.2 Creating a User Account Group


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

To create a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select a server for the user account group.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


377
19 User Account Groups
19.2 Creating a User Account Group

4. In the Domain box, select the server where you want to create the user
account group.

5. In the User Account Groups area, click Add


Add.
6. In the Name box, type a name for the user account group.

7. In the Description box, type a description for the user account group.
8. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


378
19 User Account Groups
19.2 Creating a User Account Group

9. In the Select from box, select a user account group to auto select the user
accounts belonging to that group in the Available User Accounts list.

10. In the Available User Account list, select the user accounts you want to add
to the user account group.

11. Click the Add button .


12. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


379
19 User Account Groups
19.2 Creating a User Account Group

13. In the Select from box, select a user account group to auto select the
workspaces assigned to that group in the Selected Workspaces list box.

14. In the Selected Workspaces box, select the workspaces you want available
to the user account group.

15. Click the Add button .


16. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


380
19 User Account Groups
19.2 Creating a User Account Group

17. Select Allow members to close WorkStation if you want the users in the
user account group to be able to close the WorkStation software.

18. Select Log user actions of group members if you want to activate logging
for the users in the user account group.
19. Select Allow members to change password if you want the users in the
user account group to be able to change their own passwords.
20. Select Allow members to access AS Web Configuration if you want the
users in the user account group to be able to log on to Automation Servers'
Web configuration sites.

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

Note
To connect a Windows Active Directory user account group to a
Building Operation user account group, you need to establish the
connection between the Building Operation domain and Active
Directory Windows domain. For more information, see section 20.4
“Creating and Configuring a Domain” on page 410.
Windows Active Directory account groups can only be mapped on
servers that are based upon Microsoft Windows operating system.
Other servers, for example Automation Servers, cannot map
Windows Active Directory groups.

22. In the Windows group name box, select the Windows Active Directory user
account group you want to map to the Building Operation user account
group.
23. Click Create
Create.

04-13005-02-en, October 2012 System


381
19 User Account Groups
19.3 Editing the Description of a User Account Group

19.3 Editing the Description of a User


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

To edit the description of a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group you
want to edit the description for.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


382
19 User Account Groups
19.3 Editing the Description of a User Account Group

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group you want to
edit the description for.
6. Click Summary
Summary.

7. In the Description box, type a new description for the user account group.

8. Click the Save button .

04-13005-02-en, October 2012 System


383
19 User Account Groups
19.4 Adding a User Account to a User Account Group

19.4 Adding a User Account to a User


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

To add a user account to a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list, select the server where the user
account is located.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


384
19 User Account Groups
19.4 Adding a User Account to a User Account Group

4. In the Domain list, select the domain the user account belongs to.

5. In the User Accounts list, select the user account you wish to add to a user
account group.
6. Click Group membership
membership.
7. In the Available User Account Groups list, select a user account group and

click the Add button .

8. On the File menu, click Save


Save.

04-13005-02-en, October 2012 System


385
19 User Account Groups
19.5 Removing a User Account from a User Account Group

19.5 Removing a User Account from a User


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

To remove a user account from a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account whose user
account group membership you want to remove.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


386
19 User Account Groups
19.5 Removing a User Account from a User Account Group

4. In the Domain list, select the domain the user account belongs to.

5. In the User Accounts list, select the user account.


6. Click Group membership
membership.
7. In the Selected User Account Groups list, select the user account group you

want to remove, and click the Remove button .

8. Click the Save button .

04-13005-02-en, October 2012 System


387
19 User Account Groups
19.6 Reviewing the User Account Group Memberships for a User Account

19.6 Reviewing the User Account Group


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

To review the group memberships for a user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account you want to
review the user account group memberships for.

3. Click Account Management


Management.
Continued on next page

System 04-13005-02-en, October 2012


388
19 User Account Groups
19.6 Reviewing the User Account Group Memberships for a User Account

4. In the Domain list, select the domain the user account belongs to.

5. In the User Account list, select the user account.


6. Click Group membership
membership.

04-13005-02-en, October 2012 System


389
19 User Account Groups
19.7 Adding a User Account Group to a User Account Group

19.7 Adding a User Account Group to a User


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

To add a user account group to a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group you
want to add to another user account group.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


390
19 User Account Groups
19.7 Adding a User Account Group to a User Account Group

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group.
6. Click Group membership
membership.
7. In the Available User Account Groups list, select the user account group you

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

Continued on next page

04-13005-02-en, October 2012 System


391
19 User Account Groups
19.7 Adding a User Account Group to a User Account Group

8. Click the Save button .

System 04-13005-02-en, October 2012


392
19 User Account Groups
19.8 Removing a User Account Group from another User Account Group

19.8 Removing a User Account Group from


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

To remove a user account group from another user account


group
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server that contain the user account group with
the user account group membership you want to remove.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


393
19 User Account Groups
19.8 Removing a User Account Group from another User Account Group

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group.
6. Click Group membership
membership.
7. In the Selected User Account Groups list, select the user account group you

are removing the user account group from and click the Remove button .

8. Click the Save button .

System 04-13005-02-en, October 2012


394
19 User Account Groups
19.9 Reviewing the User Account Group Memberships for a User Account Group

19.9 Reviewing the User Account Group


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

To review the user account group memberships for a user


account group
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group whose
group membership you want to view.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


395
19 User Account Groups
19.9 Reviewing the User Account Group Memberships for a User Account Group

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group.
6. Click Group Membership
Membership.

System 04-13005-02-en, October 2012


396
19 User Account Groups
19.10 Preventing a Group of Users from Exiting WorkStation

19.10 Preventing a Group of Users from


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

To prevent a group of users from exiting WorkStation


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group whose
members you want to prevent from exiting WorkStation.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


397
19 User Account Groups
19.10 Preventing a Group of Users from Exiting WorkStation

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group.
6. Click Policies
Policies.
7. Clear the May close User Interface box.

8. Click the Save button .

System 04-13005-02-en, October 2012


398
19 User Account Groups
19.11 Enabling a Group of Users to Exit Workstation

19.11 Enabling a Group of Users to Exit


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

To enable a group of users to exit WorkStation


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


399
19 User Account Groups
19.11 Enabling a Group of Users to Exit Workstation

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group.
6. Click Policies
Policies.
7. Select the May close User Interface box.

8. Click the Save button .

System 04-13005-02-en, October 2012


400
19 User Account Groups
19.12 Deleting a User Account Group

19.12 Deleting a User Account Group


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

To delete a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list, select the server with the domain the
user account group belongs to.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


401
19 User Account Groups
19.12 Deleting a User Account Group

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group you want to
delete.

6. Click the Delete button .


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

System 04-13005-02-en, October 2012


402
20 Domains

Topics
Domains
Log On Methods
Guest Log On in WebStation
Creating and Configuring a Domain
Editing the Windows Domain Name
Editing the Description of a Domain
Editing the Maximum Logon Attempts
Assigning a Server to a Domain
Removing a Server from a Domain
Deleting a Domain
Administration Accounts in Server Local Domain
20 Domains
20.1 Domains

20.1 Domains
A Building Operation domain contains user accounts, user account groups,
software permissions, workspaces, and one or several Building Operation servers.
The Building Operation server that host and administrates the domain is called the
domain controller.
A user or user account group that is a member of a domain which hosts several
Building Operation servers has access to all servers within the domain without
additional logon. Provided that the user account does not have any restricted path
permissions which prevent the user to access the servers.
You can set up domains in several ways. You can have a communication domain
that only contains Building Operation servers and one domain that contains users,
workspaces, and software permissions. Or you can have a combined domain that
manages both servers and users.

Note
A Building Operation server can belong to more than one domain.

For example, a Building Operation system consist of two domains, the Inner City
domain and the Outer city domain. The user Larry has a user account at the Inner
City domain. The Inner City domain contains several Enterprise Servers and
Automation Servers. One of the Automation Servers belongs to both the Inner City
domain and the Outer City domain. Larry cannot access the servers in the Outer
City domain, beside the shared Automation Server.

04-13005-02-en, October 2012 System


405
20 Domains
20.1 Domains

Figure: Building Operation domain and its components.

Note
You cannot change the name of a domain that is shared between servers.

20.1.1 Windows Active Directory Domain


If your domain controller is within a network that has a Windows Active Directory,
you can establish a connection between your Building Operation domain and the
Windows Active Directory. This connection enables inherit user account groups
from the Windows Active Directory to Building Operation, and allows users to login
to WorkStation with their Windows user account.

Important
If the Windows Active Directory name is changed, you have to manually update
the change in Building Operation.

System 04-13005-02-en, October 2012


406
20 Domains
20.1 Domains

20.1.2 Server Local Domain


All servers have by default a local domain that includes a local administrator
account, administrator user account group, and administrator workspace. The local
domain of a server cannot hold a Building Operation multiserver system. When
logging on to the local domain of a server, you access only the unique server.
A local domain and its content cannot be deleted, edited or include other Building
Operation servers.

20.1.3 Administration Accounts in Server Local


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

04-13005-02-en, October 2012 System


407
20 Domains
20.2 Log On Methods

20.2 Log On Methods


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

20.2.1 Log On as a Windows User


If you are logged on with a Windows user account that is mapped in Building
Operation to the Windows Active Directory user account group that you belong to,
you can select a Building Operation server and log on in a single sign-on. For more
information, see WebHelp.
You can also log on using another Windows account that is mapped in Building
Operation. For more information, see WebHelp.

20.2.2 Log On as a Building Operation User


When logging on as a Building Operation user, you authenticate yourself with a
Building Operation account user name and password. For more information, see
WebHelp.
You also select which Building Operation domain and server that you want to
access. For more information, see section 18.3 “User Accounts and User Account
Groups” on page 351.
With a Building Operation user account, you can also connect directly to the local
domain of a server. For more information, see section 20.11 “Administration
Accounts in Server Local Domain” on page 426.

20.2.3 Password Administration


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

System 04-13005-02-en, October 2012


408
20 Domains
20.3 Guest Log On in WebStation

20.3 Guest Log On in WebStation


A guest log on is used if you want the user to get immediate access to Building
Operation using WebStation.
When using a guest logon for WebStation, the user does not have to provide a user
name or password. Anyone who tries to access the system is logged on
automatically if the guest log on is used.
The guest log on is created using WorkStation and must be named GUEST and use
the password GUEST. The guest log on is valid for the domain it is created on. The
guest log on can be added to any user group in the system.

04-13005-02-en, October 2012 System


409
20 Domains
20.4 Creating and Configuring a Domain

20.4 Creating and Configuring a Domain


You create a domain to group servers, users, and user groups in one domain so
that all users and user groups of the domain have access to all servers within the
domain. You can connect the domain to a Windows Active Directory domain to
make user accounts from the Windows Active Directory accessible to Building
Operation, and to allow users to log on to WorkStation with their Windows user
account.
For more information, see section 20.1 “Domains” on page 405.

To create and configure a domain


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select a server for which you want to create a domain.

3. Click Domain
Domain.
4. Click Add
Add.

Continued on next page

System 04-13005-02-en, October 2012


410
20 Domains
20.4 Creating and Configuring a Domain

5. In the Name box, type a name for the domain.

6. In the Description box, type a description for the domain.


7. Click Next
Next.
8. In the Windows domain name box, type the name of a Windows Active
Directory domain to connect the domain to a Windows domain.

Note
• The Windows domain name box is case sensitive. The name
must be spelled exactly as the name of the Windows Active
Directory domain.

Continued on next page

04-13005-02-en, October 2012 System


411
20 Domains
20.4 Creating and Configuring a Domain

9. Click Next
Next.
10. In the Available Servers box, select the servers that you want to connect to
the domain.

Note
• The Domain Members page appears only if there are any
servers available to connect to the domain.

Continued on next page

System 04-13005-02-en, October 2012


412
20 Domains
20.4 Creating and Configuring a Domain

11. Click the Add button .


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

14. Click Create


Create.

04-13005-02-en, October 2012 System


413
20 Domains
20.5 Editing the Windows Domain Name

20.5 Editing the Windows Domain Name


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

To edit the Windows domain name


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the domain is located.

3. Click Domain
Domain.
4. In the Domains box, select the domain that you want to edit.

5. Click Summary
Summary.
Continued on next page

System 04-13005-02-en, October 2012


414
20 Domains
20.5 Editing the Windows Domain Name

6. In the Windows domain name box, type the name of the customer's
Windows domain, using the same spelling as the name of the Windows Active
Directory domain you want to connect to.

7. Click the Save button .

04-13005-02-en, October 2012 System


415
20 Domains
20.6 Editing the Description of a Domain

20.6 Editing the Description of a Domain


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

To edit the description of a domain


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the domain is located.

3. Click Domain
Domain.
4. In the Domains box, select the domain for which you wish to edit the
description.

5. Click Summary
Summary.
Continued on next page

System 04-13005-02-en, October 2012


416
20 Domains
20.6 Editing the Description of a Domain

6. In the Description box, type a description for the domain.

7. Click the Save button .

04-13005-02-en, October 2012 System


417
20 Domains
20.7 Editing the Maximum Logon Attempts

20.7 Editing the Maximum Logon Attempts


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

To edit the maximum logon attempts


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the domain is located.

3. Click Domain
Domain.
4. In the Domains box, select the domain that you want to edit.

5. Click Policies
Policies.
Continued on next page

System 04-13005-02-en, October 2012


418
20 Domains
20.7 Editing the Maximum Logon Attempts

6. In the Maximum logon attempts box, enter a new number.

7. On the File menu, click the Save


Save.

04-13005-02-en, October 2012 System


419
20 Domains
20.8 Assigning a Server to a Domain

20.8 Assigning a Server to a Domain


You assign a server to a domain in the live system to extend your current domain.
For more information, see section 20.1 “Domains” on page 405.

To assign a server to a domain


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. Click Domain
Domain.

3. In the Domains list, select the domain you are adding a server to.

4. Click Domain members


members.
Continued on next page

System 04-13005-02-en, October 2012


420
20 Domains
20.8 Assigning a Server to a Domain

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

6. Click the Save button .

04-13005-02-en, October 2012 System


421
20 Domains
20.9 Removing a Server from a Domain

20.9 Removing a Server from a Domain


You remove a server from a domain, for example, limit the Building Operation
system to only hold servers in use.
For more information, see section 20.1 “Domains” on page 405.

To remove a server from a domain


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. Click Domain
Domain.

3. In the Domains list, select a domain.

4. Click Domain members


members.
Continued on next page

System 04-13005-02-en, October 2012


422
20 Domains
20.9 Removing a Server from a Domain

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

6. Click the Save button .

04-13005-02-en, October 2012 System


423
20 Domains
20.10 Deleting a Domain

20.10 Deleting a Domain


You delete a domain that is not anymore necessary in the Building Operation
system.
For more information, see section 20.1 “Domains” on page 405.

Note
• You cannot delete the default local domain that was installed with the system.
• You cannot restore a domain that you have deleted.

To delete a domain
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the domain you are deleting is
located.

3. Click Domain
Domain.
4. In the Domain list, select the domain you are deleting.

Continued on next page

System 04-13005-02-en, October 2012


424
20 Domains
20.10 Deleting a Domain

5. Click the Delete button .


6. Click Yes
Yes.

7. In the Confirm Delete dialog box, click Yes


Yes.

04-13005-02-en, October 2012 System


425
20 Domains
20.11 Administration Accounts in Server Local Domain

20.11 Administration Accounts in Server Local


Domain
You can manage user accounts on a domain controller by logging on to the local
domain of the server, using the local administrator and local reports administrator
accounts.

20.11.1 Admin Account


Each Building Operation server has a local administrator account, named admin.
This account is preferably used to log on to the server the first time to create a new
domain with an administration account. To manage and administrate the new
domain, it is recommended that you log on to the domain with your domain
administration account.
The local administrator account cannot be changed or deleted.

20.11.2 Reports Administrator Account


SystemReportsService is the user account for the Reporting Agent service. The
account allows the Reporting Agent service to log on to the Enterprise Server. This
user account is set up during the installation of the Enterprise Server and
WorkStation and does not require any configuration.
For more information, see WebHelp.

System 04-13005-02-en, October 2012


426
21 Software Permissions

Topics
Software Permissions
Software Permissions and User Account Groups
Software Permission Rules
Path Permissions
Command Permissions
Assigning Software Permissions to a User Account
Editing the Software Permissions of a User Account
Assigning Software Permissions to a User Account Group
Editing the Software Permissions of a User Account Group
21 Software Permissions
21.1 Software Permissions

21.1 Software Permissions


Software Permissions are used to control user activities in a software application.
For example, you can set up these permissions to manage the type of data and
commands the user has permission to within a workspace, panel, or domain.
Software permissions comprise path permissions and command permissions.
If no software permissions are configured for a user account or its belonging user
account group, the user has no access to Building Operation.

Note
• When creating a new user account, the account has by default no
permissions to access Building Operation.
• Any changes to a software permission settings of a user or user group are
applied next time the user logs on.

21.1.1 Path Permissions


Path permissions give a user or user account group basic permissions to the
objects defined in a path. The permission level set on a path applies to all
subbranches unless you set a new permission level for a subbranch.
For more information, see section 21.4 “Path Permissions” on page 434.

21.1.2 Command Permissions


To make the system even more flexible and useful, you can assign a user account
group with special command permissions. Use the command permission to control
exceptions from path permissions that allow or deny actions on specific
commands.
For more information, see section 21.5 “Command Permissions ” on page 437.

21.1.3 Software Permission Rules


Software permissions provide members of user account groups with certain rights
and privileges.
For more information, see section 21.3 “Software Permission Rules” on page 433.

21.1.4 Software Permissions and User Account


Groups
A user account group assembles both user accounts and other user account
groups with similar interests. By using a well planned strategy for your user account
groups, you easily apply software permissions and polices to multiple user
accounts.

04-13005-02-en, October 2012 System


429
21 Software Permissions
21.1 Software Permissions

For more information, see section 21.2 “Software Permissions and User Account
Groups” on page 431.

21.1.5 Software Permissions Summary


Similar to branches on a tree, software permissions direct users down a particular
path in Building Operation. Along this path or branch, users can be granted
permission to a set of read/write commands that control what they see and do. For
example, an operator uses only a few objects on the WorkStation System Tree,
such as Alarms and trend charts to acknowledge an alarm and survey the system.
The operator has therefore access to those object, while other objects and
commands that are not within the operator's responsibility are hidden.

System 04-13005-02-en, October 2012


430
21 Software Permissions
21.2 Software Permissions and User Account Groups

21.2 Software Permissions and User Account


Groups
A user account group assembles both user accounts and other user account
groups with similar interests. By using a well planned strategy for your user account
groups, you easily apply software permissions and polices to multiple user
accounts.
For optimal efficiency, assign software permissions to user account groups rather
than individual user accounts, wherever possible. Using this approach, you can
associate user accounts to at least one user account group for controlled
permission to Building Operation applications. For instance, you can group
software permissions with user accounts based on common tasks and
responsibilities
You create user accounts groups and then apply one or more software
permissions. For example, create a user account for Paul and associate him with
the two user account groups: Administrators and Janitors. Paul inherits the
software permissions of both user account groups. You can also set up general
policies for the user accounts that are members to the user account group. For
example, you can enable or disable the ability of group members to change their
passwords or to close the User Interface. For more information, see section 21.1
“Software Permissions” on page 429.

Figure: Users inherit the user account group permissions of which they are members
Paul and Susan are members of the Janitor user account group, which includes an
Operator workspace and a set of software permissions. The Janitor group is also a
member of the Operator group. Therefore, the Janitor group inherits the settings
and workspaces of the Operator group. In other words, Paul and Susan share the
software permissions of both the Janitor and the Operator groups, and have access
to the Operator and Janitor workspaces.

04-13005-02-en, October 2012 System


431
21 Software Permissions
21.2 Software Permissions and User Account Groups

Figure: Software permissions and workspaces are assigned to user account groups

System 04-13005-02-en, October 2012


432
21 Software Permissions
21.3 Software Permission Rules

21.3 Software Permission Rules


Software permissions provide members of user account groups with certain rights
and privileges.
Building Operation uses the following basic rules to interpret software permission
priorities:
• The path permission settings of lower branches overrule the settings of higher
branches within a user account group.
For example, a user account group has the Read permission to the path
/Trend_Logs and Full Access permission to the subbranch /Trend_Charts.
Users in the user account group have permission to modify the objects in the
/Trend_Charts but can only view the objects in the superior /Trend_Logs.
If the path /System has the permission level Read, and the subbranch /Alarms
has the permission level Full Access, the users in the group have full access to
the objects in the /Alarms path.
• The highest permission rule wins between user account groups.
For example, if a user has inherited the permission to accept an alarm from one
group, this overrules settings from other groups that deny the user the
permission to acknowledge alarms.
• The software permissions for a single user account overrule the permissions of
any inherited user account group permissions.
• The path permission rules also apply to the basic commands Create, Copy,
Paste, Cut, Move, Rename, and Delete. For example, you only need the Read
path permission level to copy an object but you need the Full Access path
permission level to paste an object. See the table for more details.

Figure: Required permission levels to perform the basic commands.

04-13005-02-en, October 2012 System


433
21 Software Permissions
21.4 Path Permissions

21.4 Path Permissions


Path permissions give a user or user account group basic permissions to the
objects defined in a path. The permission level set on a path applies to all
subbranches unless you set a new permission level for a subbranch.
The following permissions can be set for a path:
• No Access: Users cannot navigate to or modify any of the objects in the path.
• Read: Users can navigate to the objects but cannot modify them.
• Full Access: Users can navigate to and modify the objects.
For example, a user has the permission Full Access to the folder Building A. The
user account group has also Read permissions to the folder Building B, but No
access to the subbranches of Building B. Therefore the user has permission to
navigate and modify the objects in the Building A folder, but only permission to view
the objects in the Building B main folder.

Figure: Path permission levels in Building Operation


The path permission rules rely on the actual path string with the name of the server
or folder. If you change the name of a server or folder, users that earlier had
permission are denied access. For example, a user group has full access to the
folder LABB. The folder is renamed to Laboratory B. The users that had access to
the LABB folder do not have access to the Laboratory B folder or its subfolders.

Note
The local admin account is always granted access on the local server. For more
information, see section 20.11 “Administration Accounts in Server Local Domain”
on page 426.

System 04-13005-02-en, October 2012


434
21 Software Permissions
21.4 Path Permissions

Figure: If you change the name of server or folder, you also have to configure the path
permission to the folder.
The System folder and its subfolder, beside the domain folder, are always
accessible by a user though the path permission for the folders are set to No
Access. This means that a user can always at least navigate and view the objects in
the System and its subfolder.

Note
The Domain folder is the only folder subordinated by the System folder that
restricts access to users with the path permission No Access.

04-13005-02-en, October 2012 System


435
21 Software Permissions
21.4 Path Permissions

Figure: The Domain folder is the only folder of the System subfolders that can be restricted
by the path permission.

System 04-13005-02-en, October 2012


436
21 Software Permissions
21.5 Command Permissions

21.5 Command Permissions


To make the system even more flexible and useful, you can assign a user account
group with special command permissions. Use the command permission to control
exceptions from path permissions that allow or deny actions on specific
commands.
You can set the following permissions for a command:
• No Setting: No Setting is the default command permission setting. No settings
means that the path permission, for the folder where the object is located,
decides whether the user has permission to modify the object or not.
• Deny: Users are not allowed to use the command.
• Allow: Users are allowed to use the command.
For example, you allow a user account group to only add comments to trend log
records. All other command permissions for trend logs are set to Deny. Users with
this command permissions can comment on existing records but are not allowed to
perform other actions such as add records or clear the trend log. This assumes that
the users have path permission to access the trend logs.

Figure: The user account group has only permission to read and comment trend log
objects
Another example could be that a user account group has the path permission Full
Access to a folder that contains BacNet objects. To prevent the users in the user
account group from updating the BacNet firmware, you set the command
permission for this action to Deny. All other command permissions are set to No
Settings. Due to the Full Access path permission, the users can perform all
commands on BacNet devices, beside updating the firmware.

04-13005-02-en, October 2012 System


437
21 Software Permissions
21.5 Command Permissions

Figure: The user account group has full permission to open and modify BacNet objects,
beside performing firmware update
Building Operation software permissions follow a series of permission rules. You
can use these permission rules to manage the type of data and commands the user
has access to within a workspace, panel, or domain. For more information, see
section 21.1 “Software Permissions” on page 429.

System 04-13005-02-en, October 2012


438
21 Software Permissions
21.6 Assigning Software Permissions to a User Account

21.6 Assigning Software Permissions to a


User Account
You assign a user account individual path permissions to overrule the settings
inherited from the user account groups the user account is a member of.

Note
• To facilitate the administration of users and software permissions, it is
recommended that you assign software permissions to groups rather than to
individual user accounts.
• You cannot assign command permissions to an individual user, only path
permissions.

For more information, see section 21.1 “Software Permissions” on page 429.

To assign software permissions to a user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list, select the server where the user
account is located.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


439
21 Software Permissions
21.6 Assigning Software Permissions to a User Account

4. In the Domain list, select the domain the user account belongs to.

5. In the User Accounts list, select the user account you wish to assign path
permissions.
6. Click Software Permissions
Permissions.
7. On the Software Permissions tab, in the path box, step-wise enter a path by
clicking the forward arrow and selecting a new branch in the tree view.

8. Click the Add button .


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

10. Click the Save button .

System 04-13005-02-en, October 2012


440
21 Software Permissions
21.7 Editing the Software Permissions of a User Account

21.7 Editing the Software Permissions of a


User Account
You edit the permission level of a path that has been assigned to an individual user
account to configure the user's access in the Building Operation system.

Note
• You cannot assign command permissions to an individual user, only path
permissions.

For more information, see section 21.1 “Software Permissions” on page 429.

To edit the software permissions of a user account


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list box, select the server where the user
account is located.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


441
21 Software Permissions
21.7 Editing the Software Permissions of a User Account

4. In the Domain list box, select the domain the user account belongs to.

5. In the User Accounts list box, select the user account you wish to edit path
permissions.
6. Click Software permissions
permissions.
7. On the Software Permissions tab, in the path box, step-wise enter a path by
clicking the forward arrow and selecting a new branch in the tree view.

8. Click the Add button .


9. Click the path you have created.

10. In the Permission column, select a permission level.

11. Click the Save button .

System 04-13005-02-en, October 2012


442
21 Software Permissions
21.8 Assigning Software Permissions to a User Account Group

21.8 Assigning Software Permissions to a


User Account Group
You assign software permissions to user account groups for controlling user
activities and access in Building Operation.
For more information, see section 21.1 “Software Permissions” on page 429.

To assign software permissions to a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select a server for the user account group.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


443
21 Software Permissions
21.8 Assigning Software Permissions to a User Account Group

4. In the Domain box, select a domain for the user account group.

5. In the User Account Groups box, select a user account group.


6. In the User Account Group area, click Software permissions
permissions.
7. In the Path Permissions box, click the forward arrow and select a folder or an
object. Repeat until the folder or object for which you want to assign
permissions is selected.

8. Click the Add button .


Continued on next page

System 04-13005-02-en, October 2012


444
21 Software Permissions
21.8 Assigning Software Permissions to a User Account Group

9. In the Permission box, select a permission level for the path.

10. In the Category column, select a category that you want to configure
permissions for.
11. In the Command column, select a command.
12. In the Permission box for the command, select a permission level.

13. On the File menu, click Save


Save.

04-13005-02-en, October 2012 System


445
21 Software Permissions
21.9 Editing the Software Permissions of a User Account Group

21.9 Editing the Software Permissions of a


User Account Group
You edit the software permissions of a user account group to add or remove
permissions to objects and system features for the users that belong to the group.
For more information, see section 21.2 “Software Permissions and User Account
Groups” on page 431.

To edit the software permissions of a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the user account group is located.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


446
21 Software Permissions
21.9 Editing the Software Permissions of a User Account Group

4. In the Domain box, select the domain the user account group belongs to.

5. In the User Account Groups box, select the user account group for which
you want to edit the software permissions.
6. Under User Account Groups
Groups, click Software permissions
permissions.
7. In the Path Permissions box, click the forward arrow and select a folder or an
object. Repeat until the folder or object for which you want to assign

permissions is selected.

8. Click the Add button .


Continued on next page

04-13005-02-en, October 2012 System


447
21 Software Permissions
21.9 Editing the Software Permissions of a User Account Group

9. In the Permission box, select a permission level for the path.

10. In the Category column, select a category that you want to configure
permissions for.
11. In the Command column, select a command.
Continued on next page

System 04-13005-02-en, October 2012


448
21 Software Permissions
21.9 Editing the Software Permissions of a User Account Group

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

13. Click the Save button .

04-13005-02-en, October 2012 System


449
22 Login Configuration

Topics
Password Administration
Editing a User Account Password
Allowing Users to Change their Password
Changing Your Password
Turning off Remember Me On This Computer
Forcing a User to Change the Password at Next Logon
Preventing Users from Changing Their Passwords
Resetting the Administrator Password
22 Login Configuration
22.1 Password Administration

22.1 Password Administration


As a WorkStation administrator, you can change users’ passwords, force users to
change their passwords at next logon, or enable and disable the ability of users to
change their passwords.
Passwords are managed at the user account group level. Building Operation
applies password changes to all user accounts that belong to the user account
group.

Note
• If you are an administrator and have forgotten your password, contact the
Building Operation support team.

04-13005-02-en, October 2012 System


453
22 Login Configuration
22.2 Editing a User Account Password

22.2 Editing a User Account Password


You edit the password for a user account to give a user that has been locked out of
the system by exceeding the number of allowed failed logon attempts a new
password.
For more information, see section 22.1 “Password Administration” on page 453.

To edit a user account password


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, in the Server list box, select the server where the user
account is located.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


454
22 Login Configuration
22.2 Editing a User Account Password

4. In the Domain list box, select the domain the user account to belongs to.

5. In the User Accounts list box, select the user account for which you wish to
change the password.
6. Click Summary
Summary.
7. On the Summary tab, in the Password box, type the new password.

8. In the Confirm Password box, confirm the password by retyping it.

9. Click the Save button .

04-13005-02-en, October 2012 System


455
22 Login Configuration
22.3 Allowing Users to Change their Password

22.3 Allowing Users to Change their


Password
You allow a group of users to change their password. The default setting is that all
users can change their password.
For more information, see section 21.2 “Software Permissions and User Account
Groups” on page 431.

To allow users to change their password


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group whose
users you want to allow to change their passwords.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


456
22 Login Configuration
22.3 Allowing Users to Change their Password

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select a user account group.


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

8. Click the Save button .

04-13005-02-en, October 2012 System


457
22 Login Configuration
22.4 Changing Your Password

22.4 Changing Your Password


You change your Building Operation user password on a regular basis to keep your
information secure.

To change your password


1. In WorkStation, on the File menu, click Change Password
Password.
2. In the Present Password box, type your current password.

3. In the New password box, type your new password.


4. In the Confirm new password box, type your new password again.
5. Click OK
OK.

System 04-13005-02-en, October 2012


458
22 Login Configuration
22.5 Turning off Remember Me On This Computer

22.5 Turning off Remember Me On This


Computer
You turn off Remember me on this computer to clear the information you have
stored in the Building Operation WorkStation window. For example, you want to be
able to use different accounts when logging on, or log on to different servers in the
domain.
For more information, see section 20.2 “Log On Methods” on page 408.

To turn off Remember me on this Computer


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

3. Log on again to activate the change.

04-13005-02-en, October 2012 System


459
22 Login Configuration
22.6 Forcing a User to Change the Password at Next Logon

22.6 Forcing a User to Change the Password


at Next Logon
You force a user to change the password at next logon to increase the security,for
example when distributing a user account to a new user.
For more information, see section 22.1 “Password Administration” on page 453.

To force a user to change the password at next logon


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list box, select the server containing the user account of the user
you want to force to change the password at next logon.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


460
22 Login Configuration
22.6 Forcing a User to Change the Password at Next Logon

4. In the Domain list box, select the domain the user account belongs to.

5. In the User Accounts list, select the user account.


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

8. Click the Save button .


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

04-13005-02-en, October 2012 System


461
22 Login Configuration
22.7 Preventing Users from Changing Their Passwords

22.7 Preventing Users from Changing Their


Passwords
You prevent a group of users from changing their passwords.
For more information, see section 22.1 “Password Administration” on page 453.

To prevent users from changing their passwords


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list box, select the server containing the user account group
whose members you want to prevent from changing their passwords.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


462
22 Login Configuration
22.7 Preventing Users from Changing Their Passwords

4. In the Domain list box, select the domain the user account group belongs to.

5. In the User Account Groups list box, select the user account group.
6. Click Policies
Policies.
7. Clear the May change Password box.

8. Click the Save button .

04-13005-02-en, October 2012 System


463
22 Login Configuration
22.8 Resetting the Administrator Password

22.8 Resetting the Administrator Password


You reset the administrator password, if you are an administrator. For example if
you have locked yourself out of WorkStation. Schneider Electric Buildings support
team provides you with a temporary password for logging on to Building Operation
and changing your administrator password.
For more information, see section 22.1 “Password Administration” on page 453.

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.

System 04-13005-02-en, October 2012


464
23 Workspaces

Topics
Workspaces
Predefined Workspaces
Workspace Components and Customization
Workspace Component Customization
Workspace Content References
Panel Components
Creating a Workspace
Editing the Layout of a Workspace
Editing the Description of a Workspace
Adding a Component to a Workspace
Removing a Component from a Workspace
Editing a Workspace Component
Adding a Workspace to a User Account Group
Removing a Workspace from a User Account Group
Reviewing the Workspace Memberships for a User Account
Group
Creating a Panel
Editing a Panel
WebStation in Kiosk Mode
Configuring WebStation to Run in Kiosk Mode
23 Workspaces
23.1 Workspaces

23.1 Workspaces
The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted to users or user account groups different
tasks.
You can create different workspaces for different user categories and link them to
user account groups. A user has access to all workspaces linked to the user
account groups to which the user is a member. This way, users can easily switch
workspaces during a work session. For example, Paul, a member of the
Administrators and Janitors user account groups, has access to the Administrator
workspace and Janitor workspace.

Figure: Users gain access to the workspaces linked to their user account groups
If a user account or user account group is assigned to more than one workspace,
WorkStation asks the user to select a default workspace at the first log on. Next
time you log on to Building Operation on the same computer, your default
workspace is automatically displayed. Once logged in you can change your default
workspace settings.

23.1.1 Predefined Workspaces


Some workspace layouts are included in the Building Operation main installation
and cannot be deleted or edited. Those workspaces are located in the local domain
of the Enterprise Server or Automation Server.
For more information, see section 23.2 “Predefined Workspaces” on page 469.

04-13005-02-en, October 2012 System


467
23 Workspaces
23.1 Workspaces

23.1.2 Workspace Components and Customization


A workspace consists of panes, windows, and a work area that can be customized
to suit a user's specific needs. Dialog boxes are presented on top of the
workspace.
For more information, see section 23.3 “Workspace Components and
Customization” on page 470.

23.1.3 WebStation in Kiosk Mode


You can configure to run WebStation in Internet Explorer in kiosk mode if you want
to limit the users’ access to toolbar and shortcuts in Internet Explorer.
For more information, see section 23.18 “WebStation in Kiosk Mode” on page 504.

System 04-13005-02-en, October 2012


468
23 Workspaces
23.2 Predefined Workspaces

23.2 Predefined Workspaces


Some workspace layouts are included in the Building Operation main installation
and cannot be deleted or edited. Those workspaces are located in the local domain
of the Enterprise Server or Automation Server.

Table: Predefined Workspaces


Predefined Workspaces Description

System Default Workspace The System Default Workspace displays if


there is no workspace available for users
that log on to WorkStation. For example,
Building Operation uses this workspace
when the user account group the user
belongs to has no workspaces associated
with it, or the user's default workspace is
deleted by the system administrator.

Administration Workspace The Administration Workspace displays if


there is no other workspace available for
administrators logging on to WorkStation.
The purpose of the Administration
workspace is to ensure that users with
administrator rights always have access to
all properties and functions.

Engineering Workspace In addition to the System Default Workspace


and Administration Workspace that are
installed when Building Operation is installed,
you also have the option to install a
predefined engineering workspace. The
purpose of the Engineering workspace is to
configure WorkStation, view events and
alarms.

04-13005-02-en, October 2012 System


469
23 Workspaces
23.3 Workspace Components and Customization

23.3 Workspace Components and


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

Figure: Workspace components


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

23.3.1 Workspace Component Customization


You customize the workspace layout to suit the specific user requirements. For
example, you hide or show toobars and menus based on user permissions. You
can save workspace layouts on the server. In this case, the layout becomes the
default workspace layout for all users. A user can modify the workspace layout and
save it on the local computer. In this case, the modified workspace layout is

System 04-13005-02-en, October 2012


470
23 Workspaces
23.3 Workspace Components and Customization

accessible only to that user. A user-modified layout overrides the default layout and
is displayed the next time the user logs on to WorkStation. Workspaces are task
oriented, which means that a user can switch workspaces during a single
WorkStation session.
For more information, see section 23.4 “Workspace Component Customization” on
page 472.

23.3.2 Workspace Content References


Workspace component references are used to customize the workspace by
refering the components you want to display in the workspace panes and Work
Area window.
For more information, see section 23.5 “Workspace Content References” on page
474.

23.3.3 Panel Components


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

04-13005-02-en, October 2012 System


471
23 Workspaces
23.4 Workspace Component Customization

23.4 Workspace Component Customization


You customize the workspace layout to suit the specific user requirements. For
example, you hide or show toobars and menus based on user permissions. You
can save workspace layouts on the server. In this case, the layout becomes the
default workspace layout for all users. A user can modify the workspace layout and
save it on the local computer. In this case, the modified workspace layout is
accessible only to that user. A user-modified layout overrides the default layout and
is displayed the next time the user logs on to WorkStation. Workspaces are task
oriented, which means that a user can switch workspaces during a single
WorkStation session.
You can configure a workspace to contain a limited number of views to which users
have access. Specifically, you can add, edit, or remove the following panes and
windows:
• Graphics
• Alarms, Events, or Watch
• Basic or Advanced Schedules
• Functional Block Programs
• Trend Log Lists or Charts
• Work Areas
• Calendars
• Panels
• System Tree
For example, you can create a workspace that only displays an Alarms pane along
with a graphic in the work area representing a building.
You can undo a saved workspace by resetting it to the earlier layout. For more
information, see For more information, see WebHelp.Resetting All User Settings

Workspace Path, Object, and Command Customization


Software permissions limit the paths, objects, and commands that are available in a
workspace. For example, a user with No Access permissions for a particular path
cannot see any of the path objects displayed in the System Tree pane. A user with
Read permissions for a path can see the path objects but cannot issue any
commands because these objects are not made available. For more information,
see section 21.1 “Software Permissions” on page 429.For more information, see
Software Permissions
Workspaces and software permissions are linked to user account groups.
Therefore, a user inherits the workspaces and permissions of all groups to which
the user is a member. For more information, see For more information, see section
21.2 “Software Permissions and User Account Groups” on page 431.Software
Permissions and User Account Groups

User Customized Workspace Layout


Depending on permissions, users can modify the workspace layouts to suit their
specific requirements. If the user saves the layout modifications, the layout is
displayed next time the user logs on to WorkStation. Workspaces are task oriented
so users can switch workspaces during a single WorkStation session.

System 04-13005-02-en, October 2012


472
23 Workspaces
23.4 Workspace Component Customization

Note
A user customized workspace is locally stored on the computer. The user cannot
access the customized layout when logging on to WorkStation through another
computer.

04-13005-02-en, October 2012 System


473
23 Workspaces
23.5 Workspace Content References

23.5 Workspace Content References


Workspace component references are used to customize the workspace by
refering the components 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.

System 04-13005-02-en, October 2012


474
23 Workspaces
23.6 Panel Components

23.6 Panel Components


You use a panel to combine different viewable windows, for example, a graphic,
trend chart, report, or another panel into a seamless view. A panel consists of one
or several panes and one work area. The panel is available through the System
Tree and opens as a window in the work area of the current workspace.

Figure: Example of panel components


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

Note
• A panel can not contain a System Tree.
• A maximum of six levels of panels are allowed in a single pane, the
recommendation for a good user experience is to only use three levels.

In a graphic or in the content of a pane or work area, you can create links that point
to a panel. By using panels you simply streamline the information you want to
present to the user. For example, you have a graphic that represents a room. In the
room illustration you add a fan symbol to which you link a panel containing panes
and a work area that displays the current room airflow and temperature.

04-13005-02-en, October 2012 System


475
23 Workspaces
23.7 Creating a Workspace

23.7 Creating a Workspace


You create a customized workspace so that the WorkStation windows and panes
are tailored to meet the operational needs of a user or a user account group.
For more information, see section 23.3 “Workspace Components and
Customization” on page 470.

To create a workspace
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where you want to create the workspace.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


476
23 Workspaces
23.7 Creating a Workspace

4. In the Domain box, select the server where you want to create the
workspace.

5. In the Workspaces area, click Add


Add.
6. In the Name box, type a name for the workspace.

7. In the Description box, type a description for the workspace.


8. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


477
23 Workspaces
23.7 Creating a Workspace

9. Select Visible to display the standard toolbars and menus in the workspace.

10. In the Root path (Applies to Address Bar and System Tree) box, type the
path to the folder that you want to be the root folder for the System Tree and
the Address bar.
11. Click Add to add panes to the workspace.
12. In the object type list, select the type of pane you want to add to the Work
area.

Continued on next page

System 04-13005-02-en, October 2012


478
23 Workspaces
23.7 Creating a Workspace

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


14. In the Description box, type a description for the pane.
15. Click Next
Next.
16. In the Default dock position box, select the location of the pane for display in
the WorkStation window.

17. In the Default visibility box, select Hidden to make the pane available only
from the View menu and not open in the Work area.
18. In the Display name box, type the name to be displayed on the pane.
19. In the Initial path box, enter the path to the object you want to display in the
pane.
20. Click Create
Create.
21. In the Workspace wizard, click Create
Create.

04-13005-02-en, October 2012 System


479
23 Workspaces
23.8 Editing the Layout of a Workspace

23.8 Editing the Layout of a Workspace


You edit the layout of a workspace to arrange the panes in the Work area to meet
the operational needs of a user or a user group.
For more information, see section 23.3 “Workspace Components and
Customization” on page 470.

To edit the layout of a workspace


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where the workspace is located.

3. Click Account management


management.
Continued on next page

System 04-13005-02-en, October 2012


480
23 Workspaces
23.8 Editing the Layout of a Workspace

4. In the Domain box, select the domain the workspace belongs to.

5. In the Workspaces box, select the workspace you want to edit.


6. Click Edit Layout
Layout.
Continued on next page

04-13005-02-en, October 2012 System


481
23 Workspaces
23.8 Editing the Layout of a Workspace

7. In the workspace, resize the frames and adjust the dock positions of the
panes.

8. On the File menu, click Save to save and exit the layout editor.

System 04-13005-02-en, October 2012


482
23 Workspaces
23.9 Editing the Description of a Workspace

23.9 Editing the Description of a Workspace


You edit the description of a workspace to specify what the workspace is used for.
For more information, see section 23.1 “Workspaces” on page 467.

To edit the description of a workspace


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the workspace is located.

3. Click Account management


management.
4. In the Domain box, select the domain the workspace belongs to.

Continued on next page

04-13005-02-en, October 2012 System


483
23 Workspaces
23.9 Editing the Description of a Workspace

5. In the Workspaces list, select the workspace.


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

8. Click the Save button .

System 04-13005-02-en, October 2012


484
23 Workspaces
23.10 Adding a Component to a Workspace

23.10 Adding a Component to a Workspace


You add a component to a workspace to extend the content and usage of the
workspace.
For more information, see section 23.1 “Workspaces” on page 467.

To add a component to a workspace


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the workspace is located.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


485
23 Workspaces
23.10 Adding a Component to a Workspace

4. In the Domain box, select the domain the workspace belongs to.

5. In the Workspaces list, select the workspace.


6. Click Content
Content.
7. Click Add
Add.

Continued on next page

System 04-13005-02-en, October 2012


486
23 Workspaces
23.10 Adding a Component to a Workspace

8. Select the type of component you want to add to the workspace.

9. In the Name box, type a name for the component.


10. In the Location box, change the location of the component you are adding if
you do not want to save the component at the default location.
11. In the Description box, type a description for the component.
12. Click Next
Next.
13. In the Default dock position box, select the dock position of the component.

Continued on next page

04-13005-02-en, October 2012 System


487
23 Workspaces
23.10 Adding a Component to a Workspace

14. In the Default visibility box, select Visible to display the graphic in the
workspace.
15. In the Display name box, type the name to be displayed on the pane.
16. In the Initial path box, select the System Tree location of the component to
add to the workspace.
17. Click Create
Create.

System 04-13005-02-en, October 2012


488
23 Workspaces
23.11 Removing a Component from a Workspace

23.11 Removing a Component from a


Workspace
You remove a component from a workspace to reduce components and the usage
of the workspace.
For more information, see section 23.1 “Workspaces” on page 467.

To remove a component from a workspace


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the workspace is located.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


489
23 Workspaces
23.11 Removing a Component from a Workspace

4. In the Domain box, select the domain the workspace belongs to.

5. In the Workspaces list, select the workspace you want to configure.


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

8. Click Remove
Remove.

9. Click the Save button .

System 04-13005-02-en, October 2012


490
23 Workspaces
23.12 Editing a Workspace Component

23.12 Editing a Workspace Component


You edit the workspace components to adapt the usage of the workspace.
For more information, see section 23.1 “Workspaces” on page 467.

To edit a workspace component


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the workspace is located.

3. Click Account management


management.
4. In the Domain box, select the domain the workspace belongs to.

Continued on next page

04-13005-02-en, October 2012 System


491
23 Workspaces
23.12 Editing a Workspace Component

5. In the Workspaces list, select the workspace.


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

8. Click Edit
Edit.
9. Edit the workspace component properties.

10. Click the Save button .

System 04-13005-02-en, October 2012


492
23 Workspaces
23.13 Adding a Workspace to a User Account Group

23.13 Adding a Workspace to a User Account


Group
You add a workspace to a user account group to make the workspace available to
the users that are members of the user account group.
For more information, see section 23.3 “Workspace Components and
Customization” on page 470.

To add a workspace to a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group you
want to add the workspace to.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


493
23 Workspaces
23.13 Adding a Workspace to a User Account Group

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group you want to
add a workspace to.
6. Click Workspaces
Workspaces.
7. In the Available Workspaces list, select the workspace you want to add to

the user account group and click the Add button .

8. Click the Save button .

System 04-13005-02-en, October 2012


494
23 Workspaces
23.14 Removing a Workspace from a User Account Group

23.14 Removing a Workspace from a User


Account Group
You remove a workspace from a user account group so that it no longer is available
to the users belonging to the user account group.
For more information, see WebHelp.

To remove a workspace from a user account group


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the workspace for which you
want to remove the link to a user account group.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


495
23 Workspaces
23.14 Removing a Workspace from a User Account Group

4. In the Domain box, select the domain the workspace belongs to.

5. In the Workspaces list, select the workspace.


6. Click User Account Groups
Groups.
7. In the Selected User Account Groups list, select the user account group you

want to remove the workspace from, and click the Remove button .

8. Click the Save button .

System 04-13005-02-en, October 2012


496
23 Workspaces
23.15 Reviewing the Workspace Memberships for a User Account Group

23.15 Reviewing the Workspace Memberships


for a User Account Group
You review the workspace memberships for a user account group to determin if the
user account group, for example, needs additional workspaces.
For more information, see section 23.1 “Workspaces” on page 467.

To review the workspace memberships for a user account


group
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group you
want to review the workspace memberships for.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


497
23 Workspaces
23.15 Reviewing the Workspace Memberships for a User Account Group

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group.
6. Click Workspaces
Workspaces.

System 04-13005-02-en, October 2012


498
23 Workspaces
23.16 Creating a Panel

23.16 Creating a Panel


You create panels to customize framing in a workspace. For example, panels can
display particular graphics or menus that are visible as frames in the WorkStation
Work area.
For more information, see section 23.6 “Panel Components” on page 475.

To create a panel
1. In WorkStation, in the System Tree pane, select in the folder where you want
to create the panel.
2. On the File menu, click New
New, and then Panel
Panel.
3. In the Name box, type a name for the panel.

4. In the Description box, type a description for the panel.


5. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


499
23 Workspaces
23.16 Creating a Panel

6. Click Add to add an object to the panel.you add an object to the panel.

7. In the object type list, select the type of panel component you want to add.

8. In the Name box, type a name for the component.


9. In the Description box, type a description for the panel component.
10. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


500
23 Workspaces
23.16 Creating a Panel

11. In the Show toolbar box, select Yes to show the toolbar of the component.

12. In the Default dock position box, select where the component should be
located.
13. In the Default visibility box, select Visible to show the component in the
panel by default.
14. In the Display name box, type the name to be displayed on the pane.
15. In the Initial path box, enter the path to the object you are adding to the
panel.

Continued on next page

04-13005-02-en, October 2012 System


501
23 Workspaces
23.16 Creating a Panel

16. Click Create


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

19. Click Create


Create.

System 04-13005-02-en, October 2012


502
23 Workspaces
23.17 Editing a Panel

23.17 Editing a Panel


You edit the properties of the panel and the components included in the panel to
rearange its appearance.
For more information, see section 23.6 “Panel Components” on page 475.

To edit of a panel
1. In WorkStation, in the System Tree pane, select the panel you want to edit.
2. Click Properties
Properties.
3. In the Properties pane, edit the properties of the panel.

4. Click OK
OK.
5. Click Close
Close.

04-13005-02-en, October 2012 System


503
23 Workspaces
23.18 WebStation in Kiosk Mode

23.18 WebStation in Kiosk Mode


You can configure to run WebStation in Internet Explorer in kiosk mode if you want
to limit the users’ access to toolbar and shortcuts in Internet Explorer.
When kiosk mode is used the toolbar, menus and right-click menus are disabled.
Most keyboard shortcuts, such as alt + F4, to close Internet Explorer will still work.
Use the guest log on if you want the user to get immediate access to WebStation in
kiosk mode. For more information, see section 20.3 “Guest Log On in WebStation”
on page 409.

23.18.1 Configure WebStation to Run in Kiosk Mode


To be able to run WebStation in kiosk mode, you decide which object in
WebStation the users' will have access to, such as a graphic, a viewer, or a panel.
The easiest way to configure WebStation to run in kiosk mode is to create a
shortcut to Internet Explorer and add the command for kiosk mode (-k).
After you have created the shortcut, you open the object in WebStation you want
the users' to have access to. Then you copy the full address to the object and paste
it, within quotation marks, after the command –k in the target box in the Shortcut
tab in the properties dialog box of the Shortcut.
The syntax in the Target box in the properties dialog box in the shortcut will looks
like this:

System 04-13005-02-en, October 2012


504
23 Workspaces
23.18 WebStation in Kiosk Mode

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

04-13005-02-en, October 2012 System


505
23 Workspaces
23.19 Configuring WebStation to Run in Kiosk Mode

23.19 Configuring WebStation to Run in Kiosk


Mode
You configure WebStation to run in kiosk mode when you want the user to access
only a single object in your system, without any toolbars.
For more information, see section 23.18 “WebStation in Kiosk Mode” on page 504.

To configure WebStation to run in kiosk mode


1. Right-click on the desktop, point to New, and click Shortcut
Shortcut.
2. In the Type the location of the item box, click Browse
Browse.
3. In the Browse for File or Folders box, browse to iexplore.
4. Click OK
OK.
5. Add "-k" after the address to iexplore.

6. Click Next
Next.
7. In the Type name for this shortcut box, type the name, for example
WebStation in Kiosk Mode.
8. Click Finish
Finish.
9. Log on to WebStation using the same account as you want to use for the
kiosk mode.
10. Open the object you want WebStation to display in kiosk mode.
11. Copy the address in the address field.
12. Right-click the Shortcut and click Properties
Properties.
Continued on next page

System 04-13005-02-en, October 2012


506
23 Workspaces
23.19 Configuring WebStation to Run in Kiosk Mode

13. Click Shortcut


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

15. Click OK
OK.

04-13005-02-en, October 2012 System


507
24 Audit Trails

Topics
WorkStation Account Management
Audit Trailing of User Activity
Disabling Audit Trail for a Group of Users
Enabling Audit Trail for a Group of Users
Viewing an Audit Trail Log
WorkStation Account Validation
24 Audit Trails
24.1 WorkStation Account Management

24.1 WorkStation Account Management


As a WorkStation administrator, you can change passwords, track user activities,
validate accounts, and set up user and user and user group accounts.

24.1.1 Audit Trailing of User Activity


An audit trail tracks all actions of a user that has logged on to the system. For
example, you can view when a user logged on or off WorkStation, what commands
the user made, and if the user changed or removed an object. Not all user actions
are logged. For example, the system does not log user interface navigation and
workspace switching.
For more information, see section 24.2 “Audit Trailing of User Activity” on page 512.

24.1.2 WorkStation Account Validation


Building Operation stores all account information centrally in a user database, which
contains information about software permissions, user account memberships,
workspaces, and domains.
For more information, see section 24.6 “WorkStation Account Validation” on page
519.

04-13005-02-en, October 2012 System


511
24 Audit Trails
24.2 Audit Trailing of User Activity

24.2 Audit Trailing of User Activity


An audit trail tracks all actions of a user that has logged on to the system. For
example, you can view when a user logged on or off WorkStation, what commands
the user made, and if the user changed or removed an object. Not all user actions
are logged. For example, the system does not log user interface navigation and
workspace switching.
For each user action, the system logs the following information:
• User name and domain name
• Date and time of the logged action
• Path of the object that was changed
• Type of action, such as Object created
• Old values and new values
The audit trailing log shown in WorkStation is simple a filtered Event view that
shows user related events. You can limit the number of events that are shown in the
Audit trail log:
• Select a time span
• Select how many of the most recent events to view.

Note
• The system retains a user's historic audit trail even if the user is deleted from
the system.
• Audit trailing is enabled by default.

Audit Trail Configuration at the User Account Group Level


Audit trailing is enabled and disabled at the user account group level in the user
account group policies. The default setting is that audit trail is enabled.
A user inherits the settings from all user account groups the user is a member of. To
activate audit trailing for a user, enable audit trailing for one of the user account
groups the user is a member of. To disable audit trail logging for a user, you must
disable audit trail logging for all user account groups that the user is a member of.
In addition, you can enable audit trailing as a policy in a user account group.

Figure: The Policies tab with audit trailing enabled

System 04-13005-02-en, October 2012


512
24 Audit Trails
24.3 Disabling Audit Trail for a Group of Users

24.3 Disabling Audit Trail for a Group of


Users
You disable audit trail for a group of users that do not need auditing, such as users
who can only view the objects in the system. To disable audit trail for a user, you
must disable audit trail for all user account groups the user is, directly or indirectly, a
member of. Audit trail is by default enabled.

Note
• The system retains a user's historic audit trail even if the user is deleted from
the system.
• Audit trailing is enabled by default.

For more information, see section 24.2 “Audit Trailing of User Activity” on page 512.

To disable audit trail for a group of users


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group for
which you want to disable audit trail.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


513
24 Audit Trails
24.3 Disabling Audit Trail for a Group of Users

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select the user account group.
6. Click Policies
Policies.
7. Clear the Enable Audit Trailing box.

8. Click the Save button .

System 04-13005-02-en, October 2012


514
24 Audit Trails
24.4 Enabling Audit Trail for a Group of Users

24.4 Enabling Audit Trail for a Group of


Users
You enable audit trail for a group of users to be able to trace their actions and
activities. To enable audit trail for a user, it is enough that audit trail is enabled for
one of the user account groups the user is a member of. The feature is by default
enabled.
For more information, see section 24.2 “Audit Trailing of User Activity” on page 512.

To enable audit trail for a group of users


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account group for
which you want to enable audit trail.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


515
24 Audit Trails
24.4 Enabling Audit Trail for a Group of Users

4. In the Domain list, select the domain the user account group belongs to.

5. In the User Account Groups list, select a user account group.


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

8. Click the Save button .

System 04-13005-02-en, October 2012


516
24 Audit Trails
24.5 Viewing an Audit Trail Log

24.5 Viewing an Audit Trail Log


You open an audit trail log to view the activities of a specific user.
For more information, see section 24.2 “Audit Trailing of User Activity” on page 512.

To view an audit trail log


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server containing the user account for which you
want to view the audit trail log.

3. Click Account management


management.
Continued on next page

04-13005-02-en, October 2012 System


517
24 Audit Trails
24.5 Viewing an Audit Trail Log

4. In the Domain list, select the domain the user account belongs to.

5. In the User Accounts list, select the user account.


6. Click Audit Trailing Events
Events.

7. In the Show Events box, select an interval of events to view.

8. Click the Refresh button .

System 04-13005-02-en, October 2012


518
24 Audit Trails
24.6 WorkStation Account Validation

24.6 WorkStation Account Validation


Building Operation stores all account information centrally in a user database, which
contains information about software permissions, user account memberships,
workspaces, and domains.

Account Validation
When you log on to WorkStation you have to quote your user name and password
together with the domain and server you want to log on to. Building Operation
confirms that you are using a valid user account and verifies that correct password
is used. Building Operation also authenticates access to workspaces associated
with your user account group memberships. After validation, Building Operation
retrieves your software permissions and stores them in a user token, valid for this
log on session.

Note
User name, password, and domain name are case sensitive.

WorkStation User Token


A user token remains active as long as you are logged onto WorkStation. Any
changes to your software permissions during your current sessions take effect the
next time you log on.

04-13005-02-en, October 2012 System


519
25 User Management User
Interface

Topics
User Management System Tree Icons
Domain Properties
Profile Properties
Workspace Properties
Pane Properties
Panel Properties
Building Operation WorkStation Window
Domain Control Panel
Account Management Control Panel
Select Default Workspace Window
Change Password Dialog Box
Domain Wizard – Authentication Page
Domain Wizard – Domain Policies Page
Domain – Summary Tab
Domain – Policies Tab
Domain – Domain Members Tab
User Account – Summary Tab
User Account – Group Membership Tab
User Account – Profile Tab
User Account – Software Permissions Tab
User Account – Audit Trailing Events Tab
User Account Group Properties
User Account Properties
User Account Group Wizard – Users Belonging to this Group
Page
User Account Group Wizard – Workspaces Belonging to this
Group Page
User Account Group Wizard – Windows Group Name and
Group Polices Page
User Account Group – Summary Tab
User Account Group – Policies Tab
User Account Group – Group Membership Tab
User Account Group – Software Permissions Tab
User Account Group – Workspaces Tab
User Account Wizard – General Page
User Account Wizard – Member Of Page
User Account Management Folder Properties
Workspace Wizard – Workspace Configuration Page
Workspace Wizard – Pane Configuration Page
Workspace – Summary Tab
Workspace – Content Tab
Edit Layout Workspace
Workspace – Members Tab
Panel Wizard – Panel Configuration Page
Domain Wizard – Domain Members Page
Domains Properties
Local Properties
Work Area Window Properties
Create Work Area Window Wizard – Name Page
25 User Management User Interface
25.1 User Management System Tree Icons

25.1 User Management System Tree Icons


Use the User Management System Tree icons to get information on the objects in
the System Tree pane.

Table: User Management Icons


Icon Description

Panel
Indicates the object is a panel. For more
information, see section 23.6 “Panel
Components” on page 475.

Folder of User Accounts


Indicates that the folder contains user
accounts. For more information, see section
18.3 “User Accounts and User Account
Groups” on page 351.

User Account
Indicates that the object is a user account.
For more information, see section 18.3 “User
Accounts and User Account Groups” on
page 351.

Domain
Indicates that the object is a domain. For
more information, see section 20.1
“Domains” on page 405.

User Account Groups


Indicates that the object is a user account
group. For more information, see section
18.3 “User Accounts and User Account
Groups” on page 351.

Workspace
Indicates that the object is a workspace. For
more information, see WebHelp.

04-13005-02-en, October 2012 System


525
25 User Management User Interface
25.2 Domain Properties

25.2 Domain Properties


Use the Domain properties to configure the properties of a domain.

Figure: Domain properties

Table: Domain Properties


Component Description

Maximum logon attempts Select the maximum number of failed logon


attempts that a user can make before
WorkStation is temporarily locked.

Password Type the password servers internally use to


enhance the server communication security
in the domain.

Confirm Password Type the password servers internally use to


enhance the server communication security
in the domain.

Windows domain name Type the name of the Windows domain


where the Windows Active directory is
located from which you want to map user
account groups. For more information, see
section 19.1 “Windows Active Directory User
Groups” on page 375.

System 04-13005-02-en, October 2012


526
25 User Management User Interface
25.3 Profile Properties

25.3 Profile Properties


Use the Profile properties to edit the information about the user the account
belongs to.

Figure: Profile properties

Table: Profile Properties


Component Description

First name Type the first name of the user.

Middle name Type the middle name of the user.

Last name Type the last name of the user.

Home E-mail address Type the e-mail address of the user.

Work E-mail address Type the work e-mail address of the user.

04-13005-02-en, October 2012 System


527
25 User Management User Interface
25.4 Workspace Properties

25.4 Workspace Properties


Use the Workspace properties to configure the properties of a workspace.

Figure: Workspace properties

Table: Workspace Properties


Component Description

Add Click to add a pane to the workspace. For


more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit Click to edit a workspace pane. For more


information, see section 25.5 “Pane
Properties” on page 530.

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.

System 04-13005-02-en, October 2012


528
25 User Management User Interface
25.4 Workspace Properties

Continued
Component Description

Address bar Select Visible to show the address bar in the


workspace.

Status bar Select Visible to show the status bar in the


workspace.

Search bar Select Visible to show the search bar in the


workspace.

History bar Select Visible to show the history bar in the


workspace.

Root path Enter the path for the workspace


component.

04-13005-02-en, October 2012 System


529
25 User Management User Interface
25.5 Pane Properties

25.5 Pane Properties


Use the Pane properties to configure the settings of the pane.

Figure: Pane properties

Table: Pane Properties


Component Description

Show toolbar Select Yes to show the toolbars for the pane
component.

Default dock position Select where to place the pane in the


workspace.

Default visibility Select Hidden to hide the pane.

Dipslay name Type the pane name that is to be displayed.


Display name is available only in
Workstation.

Initial path Enter the path to the pane component.

System 04-13005-02-en, October 2012


530
25 User Management User Interface
25.6 Panel Properties

25.6 Panel Properties


Use the Panel properties to configure the properties of a panel.

Figure: Panel properties

Table: Panel Properties


Component Description

Initial path Enter the path, for example a graphical link,


that points to the panel.

Show toolbars Select Yes to show the toolbar of the panel.

Add Click to add a pane component to the panel.


For more information, see section 50.20
“Create Object Wizard – Naming the Object
Page” on page 1434.

Edit Click to edit a pane component. For more


information, see section 25.5 “Pane
Properties” on page 530.

Remove Click to remove a panel component.

04-13005-02-en, October 2012 System


531
25 User Management User Interface
25.7 Building Operation WorkStation Window

25.7 Building Operation WorkStation


Window
Use the Building Operation WorkStation window to log on to WorkStation.

Figure: Building Operation WorkStation

Table: Building Operation WorkStation


Component Description

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


Windows credentials of the current Windows
account. For more information, see section
18.3 “User Accounts and User Account
Groups” on page 351.

Other user Click to log on to WorkStation as another


Windows user or using a Building Operation
account. For more information, see section
18.3 “User Accounts and User Account
Groups” on page 351.

User name Type the user name.

Password Type the password.

System 04-13005-02-en, October 2012


532
25 User Management User Interface
25.7 Building Operation WorkStation Window

Continued
Component Description

Domain Type the name of the domain that you want


to log on to. If you do not enter a domain,
you log on to the default domain. For more
information, see section 20.1 “Domains” on
page 405.

Server Enter a server to log on to.

Remember me on this computer Select to save the entered information. The


information is automatically filled in the next
time you log on.

Log on Click to log on to WorkStation.

Click here to learn more about Building Click to open the WebHelp home page. For
Operation more information, see WebHelp.

04-13005-02-en, October 2012 System


533
25 User Management User Interface
25.8 Domain Control Panel

25.8 Domain Control Panel


Use the Domain Control Panel to create and configure domains.

Table: Domain Control Panel


Component Description

Server Displays the server that acts as domain


controller.

Domains Select a domain to edit.

Add Click to create a new domain. For more


information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Delete Click to delete a domain.

List domains Click to view all domains in the List View.

Unit Conversion Exceptions Click to enter unit conversion exceptions for


the selected domain.

Account management Click to open the Account Management


Control Panel. For more information, see
section 25.9 “Account Management Control
Panel” on page 535.

Summary Click to open the Summary tab for the


domain. For more information, see section
25.14 “Domain – Summary Tab” on page
542.

Policies Click to open the Policies tab where you edit


the policies of the domain. For more
information, see section 25.15 “Domain –
Policies Tab” on page 543.

Domain members Click to open the Domain members tab


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

System 04-13005-02-en, October 2012


534
25 User Management User Interface
25.9 Account Management Control Panel

25.9 Account Management Control Panel


Use the Account Management Control Panel to create and configure user
account groups, user accounts, and workspaces.

Figure: Account management control panel

Table: Account Management Control Panel


Component Description

Server Displays the selected server.

Domain Select a domain. The domain you logged


onto is the default domain.

User Accounts Select a user account.

Add (user account) Click to add a new user account. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Delete (user account) Click to delete a user account. For more


information, see section 50.23 “Confirm
Delete Dialog Box” on page 1438.

List users Click to open the user accounts list view


where you can select a user account. For
more information, see section 46.3 “List
View” on page 1315.

Summary (user account) Click to open the user accounts Summary


tab with information about the user account,
such as expiration date an the password for
the user account. For more information, see
section 25.17 “User Account – Summary
Tab” on page 545.

04-13005-02-en, October 2012 System


535
25 User Management User Interface
25.9 Account Management Control Panel

Continued
Component Description

Group membership (user account) Click to open the Group Membership tab
where you can edit the group membership of
the selected user account. For more
information, see section 25.18 “User
Account – Group Membership Tab” on page
546.

Software permissions (user account) Click to open the Software Permissions tab
where you can edit or assign individual
software permissions to the selected user
account. For more information, see section
25.20 “User Account – Software
Permissions Tab” on page 549.

Audit trailing events Click to open the Audit Trailing Events tab
where you can view the user triggered
events for the selected user account. For
more information, see section 25.21 “User
Account – Audit Trailing Events Tab” on
page 550.

User Account Groups Select a user account group.

Add (user account groups) Click to add a new user account group. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Delete (user account group) Click to delete a user account group. For
more information, see section 50.23
“Confirm Delete Dialog Box” on page 1438.

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
46.3 “List View” on page 1315.

Summary (user account groups) Click to open the user account groups
Summary tab where you can edit the
description of the group. For more
information, see section 25.27 “User
Account Group – Summary Tab” on page
559.

Group membership (user account Click to open the Group Membership tab
groups) where you can edit the groups membership
in other groups, and add and remove user
accounts. For more information, see section
25.29 “User Account Group – Group
Membership Tab” on page 561.

Software permissions Click to open the Software Permissions tab


where you can edit the software permissions
of the user account group. For more
information, see section 25.30 “User
Account Group – Software Permissions
Tab” on page 563.

System 04-13005-02-en, October 2012


536
25 User Management User Interface
25.9 Account Management Control Panel

Continued
Component Description

Workspaces (user account groups) Click to open the Workspaces tab where
you edit the workspace membership
settings for a user account group. For more
information, see section 25.31 “User
Account Group – Workspaces Tab” on page
565.

Policies Click to open the Policies tab where you can


edit the policies of the user account group.
For more information, see section 25.28
“User Account Group – Policies Tab” on
page 560.

Workspaces Select a workspace.

Add (workspaces) Click to add a new workspace. For more


information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Delete (workspaces) Click to delete a workspace. For more


information, see section 50.23 “Confirm
Delete Dialog Box” on page 1438.

List workspaces Click to open the Workspace menu where


you can select a workspace. For more
information, see section 46.3 “List View” on
page 1315.

Summary (workspaces) Click to open the workspace Summary tab


where you can edit the description of the
workspace. For more information, see
section 25.37 “Workspace – Summary Tab”
on page 573.

User account groups (workspaces) Click to open the workspace Members tab
where you edit the group membership of the
workspace. For more information, see
section 25.40 “Workspace – Members Tab”
on page 577.

Content Click to open the Content tab where you edit


the content of the workspace. For more
information, see section 25.38
“Workspace – Content Tab” on page 574.

Edit layout Click to open the view where you edit the
layout of the workspace. For more
information, see section 25.39 “Edit Layout
Workspace” on page 576.

04-13005-02-en, October 2012 System


537
25 User Management User Interface
25.10 Select Default Workspace Window

25.10 Select Default Workspace Window


Use the Select Default Workspace window to select the workspace you want to
open by default when you log on to WorkStation.

Figure: Select default workspace window

Table: Select Default Workspace Window


Component Description

Select Default Workspace Select a default workspace in the list of


workspaces available to you.

Click the History icon to return to the


previous page.

System 04-13005-02-en, October 2012


538
25 User Management User Interface
25.11 Change Password Dialog Box

25.11 Change Password Dialog Box


Use the Change Password dialog box to change your password.

Figure: Change Password dialog box

Table: Change Password Dialog Box


Component Description

Present password Type your present password.

New password Type your new password.

Confirm new password Type your new password again.

04-13005-02-en, October 2012 System


539
25 User Management User Interface
25.12 Domain Wizard – Authentication Page

25.12 Domain Wizard – Authentication Page


Use the Authentication page to map the Building Operation domain to a Windows
Active Directory domain.

Figure: Authentication page

Table: Authentication Page


Component Description

Windows domain name Type the name of the Windows domain


where the Windows Active directory is
located from which you want to map user
account groups. For more information, see
section 19.1 “Windows Active Directory User
Groups” on page 375.

System 04-13005-02-en, October 2012


540
25 User Management User Interface
25.13 Domain Wizard – Domain Policies Page

25.13 Domain Wizard – Domain Policies Page


Use the Domain Policies page to enter domain polices that are applicable to all
user accounts in the domain.

Figure: Domain policies page

Table: Domain Policies page


Component Description

Maximum logon attempts Select the maximum number of failed logon


attempts that a user can make before
WorkStation is temporarily locked.

04-13005-02-en, October 2012 System


541
25 User Management User Interface
25.14 Domain – Summary Tab

25.14 Domain – Summary Tab


Use the Summary tab to edit the description and domain controller password for a
domain.

Figure: Summary tab

Table: Summary Tab


Component Description

Description Type a description of the object.

Windows domain name Type the name of the Windows domain


where the Windows Active directory is
located from which you want to map user
account groups. For more information, see
section 19.1 “Windows Active Directory User
Groups” on page 375.

Domain Controller Displays the path and name of the domain


controller.

System 04-13005-02-en, October 2012


542
25 User Management User Interface
25.15 Domain – Policies Tab

25.15 Domain – Policies Tab


Use the Policies tab to edit the policies for the domain. For example, the number of
failed logon attempts a user can make before the account is temporarily locked.

Figure: Policies tab

Table: Policies tab


Component Description

Maximum log on attempts Enter the maximum number of failed logon


attempts a user can make before the user´s
account is temporarily locked.

04-13005-02-en, October 2012 System


543
25 User Management User Interface
25.16 Domain – Domain Members Tab

25.16 Domain – Domain Members Tab


Use the Domain Members tab to add and remove servers to and from the domain.

Figure: Domain members tab

Table: Domain Members Tab


Component Description

Available Servers List of all available servers.

Servers that are members of this Domain List of all servers in the domain.

Add All
Click to add all available servers to the
domain.

Add
Click to add a server to the domain.

Remove
Click to remove a server from the domain.

Remove All
Click to remove all servers from the domain.

System 04-13005-02-en, October 2012


544
25 User Management User Interface
25.17 User Account – Summary Tab

25.17 User Account – Summary Tab


Use the Summary tab to edit the basic settings for a user account. For example,
you can enable or disable the user account, or change the password for the
account.

Figure: Summary tab

Table: Summary Tab


Component Description

Expires on Enter an expiration date and time for the


user account. By default, there is no
expiration date for the account.

Disabled Select True to disable the user account.

Force password change Select True to force the user to change


password after the initial logon.

Password Type a password for the user account.

Confirm password Type a password for the user account.

04-13005-02-en, October 2012 System


545
25 User Management User Interface
25.18 User Account – Group Membership Tab

25.18 User Account – Group Membership Tab


Use the Group Membership tab to edit the group membership settings for a user
account.

Figure: Group membership tab

Table: Group Membership Tab


Component Description

Available User Account Groups Lists available user account groups the
account can be a member of.

Selected User Account Groups Lists the user account groups the account is
a member of.

Add all
Click to connect all available user account
groups to the user account.

Add
Click to connect a user account group to the
user account.

System 04-13005-02-en, October 2012


546
25 User Management User Interface
25.18 User Account – Group Membership Tab

Continued
Component Description

Remove
Click to remove a user account group from
the user account.

Remove all
Click to remove all user account groups from
the user account.

Workspace Workspaces the user account has access


to.

Owner The user account groups a workspace is a


member of.

04-13005-02-en, October 2012 System


547
25 User Management User Interface
25.19 User Account – Profile Tab

25.19 User Account – Profile Tab


Use the Profile tab to edit the information about the user the account belongs to.

Figure: Profile tab

Table: Profile Tab


Component Description

First name Type the first name of the user.

Middle name Type the middle name of the user.

Last name Type the last name of the user.

Home E-mail address Type the e-mail address of the user.

Work E-mail address Type the work e-mail address of the user.

System 04-13005-02-en, October 2012


548
25 User Management User Interface
25.20 User Account – Software Permissions Tab

25.20 User Account – Software Permissions


Tab
Use the Software Permissions tab to enter individual path permissions for a user
account.

Note
• To simplify the task of administering software permissions, it is recommended
that you assign software permissions to user account groups rather than user
accounts.

Figure: Software permissions tab

Table: Software Permissions Tab


Component Description

Add Adds a new path to the list of paths that the


user account can access.

Path The paths the user account has access to.

Permission Click to assign a permission level to a path


you have selected.

Owner The owners of the paths the user has access


to. The owner can be a user account group
the account is a member of, or the actual
user account.

Delete
Click to remove a path you have selected.

04-13005-02-en, October 2012 System


549
25 User Management User Interface
25.21 User Account – Audit Trailing Events Tab

25.21 User Account – Audit Trailing Events


Tab
Use the Audit Trailing Events tab to monitor the events triggered by the actions of
a user.

Figure: Audit trailing events tab

Table: Audit Trailing Events Tab


Component Description

Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.

Show Events Select an available option for limiting the


events displayed.

Refresh
Click to refresh the Audit Trailing Events list..

Filter Enter a word or a character to filter on. For


more information, see section 46.6 “Quick
Filter ” on page 1318.

System 04-13005-02-en, October 2012


550
25 User Management User Interface
25.22 User Account Group Properties

25.22 User Account Group Properties


Use the User Account Group properties dialog box to configure the properties of a
user account group.

Figure: User account group properties

Table: User Account Group Properties


Component Description

Allow members to close WorkStation Select to let users log off and close
WorkStation.

Log user actions of group members Select to enable audit trailing for users
belonging to this group.

Allow members to access AS Web Select to enable users to access the Web
Configuration Configuration where you configure the
settings of an Automation Server.

Windows group name Select the Windows Active Directory user


account group that you want to map to this
Building Operation user account group. For
more information, see section 19.1
“Windows Active Directory User Groups” on
page 375.

04-13005-02-en, October 2012 System


551
25 User Management User Interface
25.23 User Account Properties

25.23 User Account Properties


Use the User Account properties dialog box to configure the properties of a user
account.

Figure: User account properties

Table: User Account Properties


Component Description

Add Click to create a new user profile. For more


information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit Click to edit a user profile. For more


information, see section 25.3 “Profile
Properties” on page 527.

Remove Click to remove a user profile.

Disabled Select True to disable the user account.

Force password change Select True to force the user to change


password after the initial logon.

Password Type a password for the user account.

Confirm Password Type a password for the user account.

Expires on Enter an expiration date and time for the


user account. By default, there is no
expiration date for the account.

System 04-13005-02-en, October 2012


552
25 User Management User Interface
25.24 User Account Group Wizard – Users Belonging to this Group Page

25.24 User Account Group Wizard – Users


Belonging to this Group Page
Use the Users Belonging to this Group page to add users to the group.

Figure: Users belonging to this group page

Table: Users Belonging to this Group Page


Component Description

Select from Select a group with user accounts you want


to include in the group.

Available User Accounts Lists available user accounts.

Selected User Accounts Lists user accounts that are members of the
user account group.

Add all
Click to add all user accounts to the user
account group.

Add
Click to add a user account to the user
account group.

Remove
Click to remove a user account from the user
account group.

04-13005-02-en, October 2012 System


553
25 User Management User Interface
25.24 User Account Group Wizard – Users Belonging to this Group Page

Continued
Component Description

Remove all
Click to remove all user accounts from the
user account group.

System 04-13005-02-en, October 2012


554
25 User Management User Interface
25.25 User Account Group Wizard – Workspaces Belonging to this Group Page

25.25 User Account Group Wizard –


Workspaces Belonging to this Group
Page
Use the Workspaces Belonging to this Group page to add workspaces to the
group.

Figure: Workspaces belonging to this group page

Table: Workspaces Belonging to this Group Page


Component Description

Select from Select a user account group with


workspaces you want to include in the user
account group.

Selected Workspaces Lists available workspaces.

Available Workspaces Lists the workspaces that are added to the


user account group.

Add all
Click to add all available workspaces to the
user account group.

Add
Click to add a workspace to the user
account group.

04-13005-02-en, October 2012 System


555
25 User Management User Interface
25.25 User Account Group Wizard – Workspaces Belonging to this Group Page

Continued
Component Description

Remove
Click to remove a workspace from the user
account group.

Remove all
Click to remove all workspaces from the user
account group.

System 04-13005-02-en, October 2012


556
25 User Management User Interface
25.26 User Account Group Wizard – Windows Group Name and Group Polices Page

25.26 User Account Group Wizard – Windows


Group Name and Group Polices Page
Use the Windows group name and group polices page to map a Windows Active
Directory and enter policies for the group.

Note
• The default setting is that all options on the Policies page are selected.

Figure: Windows group name and group polices page

Table: Windows Group name and Group Polices Page


Component Description

User Interactivity Select to let users log off and close


WorkStation.

Audit trailing Select to enable audit trailing for users


belonging to this group.

Password Select to allow members of this user


account group to change their password.
Not applicable if the user account group is
mapped to a Windows Active Directory user
account group.

AS web configuration Select to enable users to access the Web


Configuration where you configure the
settings of an Automation Server.

04-13005-02-en, October 2012 System


557
25 User Management User Interface
25.26 User Account Group Wizard – Windows Group Name and Group Polices Page

Continued
Component Description

Windows group name Select the Windows Active Directory user


account group that you want to map to this
Building Operation user account group. For
more information, see section 19.1
“Windows Active Directory User Groups” on
page 375.

System 04-13005-02-en, October 2012


558
25 User Management User Interface
25.27 User Account Group – Summary Tab

25.27 User Account Group – Summary Tab


Use the Summary tab to edit the description of a user account group.

Figure: Summary tab

Table: Summary Tab


Component Description

Description Type a description of the object.

Windows Domain Displays the name of the Windows domain


this user account group is mapped to.

Windows group name Select the Windows Active Directory user


account group that you want to map to this
Building Operation user account group. For
more information, see section 19.1
“Windows Active Directory User Groups” on
page 375.

04-13005-02-en, October 2012 System


559
25 User Management User Interface
25.28 User Account Group – Policies Tab

25.28 User Account Group – Policies Tab


Use the Policies tab to edit the policy settings for a user account group.

Figure: Policies tab

Table: Policies Tab


Component Description

May close User Interface Select to let users log off and close
WorkStation.

Enable Audit Trailing Select to enable audit trailing for users


belonging to this group.

May change Password Select to enable users to change their


passwords.

May access web user interface Select to enable users to access the Web
Configuration where you configure the
settings of an Automation Server.

System 04-13005-02-en, October 2012


560
25 User Management User Interface
25.29 User Account Group – Group Membership Tab

25.29 User Account Group – Group


Membership Tab
Use the Group Membership tab to edit the group membership settings of a user
account group.

Figure: Group membership tab

Table: Group Membership Tab


Component Description

Available User Accounts Lists available user accounts that can be


added to the user account group.

Selected User Accounts Lists user accounts that have been added to
the user account group.

Available User Account Groups Lists user account groups that can be added
to the user account group.

Selected User Account Groups Lists user account groups that have been
added to the user account group.

Add all
Click to add all available user accounts or
user account groups to the list of selected
user accounts or user account groups.

04-13005-02-en, October 2012 System


561
25 User Management User Interface
25.29 User Account Group – Group Membership Tab

Continued
Component Description

Add
Click to add the user account or user
account group to the list of selected user
accounts or user account groups.

Remove
Click to remove the user account or user
account group from the list of selected user
accounts or user account groups.

Remove all
Click to remove all user accounts or user
account groups from the list of selected user
accounts or user account groups.

System 04-13005-02-en, October 2012


562
25 User Management User Interface
25.30 User Account Group – Software Permissions Tab

25.30 User Account Group – Software


Permissions Tab
Use the Software Permissions tab to add software permissions to a user account
group by adding paths and assigning command permissions to the group.

Figure: Software permissions tab

Table: Software Permissions Tab


Component Description

Add
Click to add the path to which you want to
add software permissions.

Path Displays the paths that have been defined


for the user account group.

Permission Select a permission level for the path.

Owner Displays the user account group the path


has been added to.

04-13005-02-en, October 2012 System


563
25 User Management User Interface
25.30 User Account Group – Software Permissions Tab

Continued
Component Description

Delete
Click to remove a path. For more
information, see section 50.23 “Confirm
Delete Dialog Box” on page 1438.

Category Click a category to display the commands


included in the category.

Command Displays all commands for the category.

Permission Select a permission level for a command.

Command Displays all commands that are available to


the user account group members.

Permission Select a permission level for the command.

Owner Displays the user account groups the


commands have been added to.

System 04-13005-02-en, October 2012


564
25 User Management User Interface
25.31 User Account Group – Workspaces Tab

25.31 User Account Group – Workspaces Tab


Use the Workspaces tab to edit the workspace membership settings for a user
account group.

Figure: Workspaces tab

Table: Workspaces Tab


Component Description

Available Workspaces Lists workspaces that are available to add to


the user account group.

Selected Workspaces Lists workspaces that are available to add to


the user account group.

Add all
Click to add all available workspaces to the
user account group.

Add
Click to add a workspace to the user
account group.

Remove
Click to remove a workspace from the user
account group.

Remove all
Click to remove all workspaces from the user
account group.

04-13005-02-en, October 2012 System


565
25 User Management User Interface
25.32 User Account Wizard – General Page

25.32 User Account Wizard – General Page


Use the General page to enter information about the user the account belongs to,
and a password for the account.

Figure: General page

Table: General Page


Component Description

First name Type the first name of the user.

Middle name Type the middle name of the user.

Last name Type the last name of the user.

Home E-mail address Type the e-mail address of the user.

Work E-mail address Type the e-mail address of the user.

Expires on Enter an expiration date and time for the


user account. By default, there is no
expiration date for the account.

Password Type a password for the user account.

Confirm Password Type a password for the user account.

System 04-13005-02-en, October 2012


566
25 User Management User Interface
25.33 User Account Wizard – Member Of Page

25.33 User Account Wizard – Member Of Page


Use the Member Of page to make the user account a member of an existing user
account group.

Figure: Member of page

Table: Member of Page


Component Description

Select from Select a user account that is member of the


user account group you want to connect
your user account.

Available User Accounts Groups Lists available user account groups.

Selected User Accounts Groups Lists user account groups that are
connected to the user account group.

Add all
Click to add all user account groups to the
user account.

Add
Click to add a user account group to the
user account.

Remove
Click to remove a user account group from
the user account.

04-13005-02-en, October 2012 System


567
25 User Management User Interface
25.33 User Account Wizard – Member Of Page

Continued
Component Description

Remove all
Click to remove all user account groups from
the user account.

System 04-13005-02-en, October 2012


568
25 User Management User Interface
25.34 User Account Management Folder Properties

25.34 User Account Management Folder


Properties
Use the User Account Management Folder Properties view or dialog box to
configure and view the general and object-reference properties. For more
information, see section 50.26 “General and References Properties” on page 1441.

Figure: User Management Folder properties

04-13005-02-en, October 2012 System


569
25 User Management User Interface
25.35 Workspace Wizard – Workspace Configuration Page

25.35 Workspace Wizard – Workspace


Configuration Page
Use the Workspace configuration page to add, edit, and remove workspace
components.

Figure: Workspace configuration page

Table: Workspace Configuration Page


Component Description

Menu Select Visible to show the menu in the


workspace.

Address bar Select Visible to show the address bar in the


workspace.

Search bar Select Visible to show the search bar in the


workspace.

Toolbar Select Visible to show the toolbar in the


workspace.

Status bar Select Visible to show the status bar in the


workspace.

History bar Select Visible to show the history bar in the


workspace.

Root path (Applies to Address Bar and Enter the path to the workspace component.
System Tree)

System 04-13005-02-en, October 2012


570
25 User Management User Interface
25.35 Workspace Wizard – Workspace Configuration Page

Continued
Component Description

Components Lists the standard components included in


the workspace. Select a component and
click the Add
Add, Edit or Remove button.

Add Click to add a new component to the


workspace. For more information, see
section 50.20 “Create Object Wizard –
Naming the Object Page” on page 1434.

Edit Click to edit a component. The workspace


properties pane is displayed. For more
information, see section 25.5 “Pane
Properties” on page 530.

Remove Click to remove a component.

04-13005-02-en, October 2012 System


571
25 User Management User Interface
25.36 Workspace Wizard – Pane Configuration Page

25.36 Workspace Wizard – Pane


Configuration Page
Use the Pane configuration page to determine the layout of the component you
are adding to the workspace.

Figure: Pane configuration page

Table: Pane Configuration Page


Component Description

Show toolbar Select No to hide the component toolbar.

Default dock position Select a default dock position in the


workspace for the component.

Default visibility Select Hidden to hide the component.

Display name Type the pane name that is to be displayed.


Display name is available only in
WorkStation.

Initial path Click to change the location of the


component. For more information, see
section 25.35 “Workspace Wizard –
Workspace Configuration Page” on page
570.

System 04-13005-02-en, October 2012


572
25 User Management User Interface
25.37 Workspace – Summary Tab

25.37 Workspace – Summary Tab


Use the Summary tab to edit the description of the workspace.

Figure: Summary tab

Table: Summary Tab


Component Description

Name Displays the name of the workspace.

Description Displays the description of the workspace.

Location Displays the location of the workspace.

04-13005-02-en, October 2012 System


573
25 User Management User Interface
25.38 Workspace – Content Tab

25.38 Workspace – Content Tab


Use the Content tab to edit the content and layout of a workspace.

Figure: Content tab

Table: Content Tab


Component Description

Menu Select Visible to show the menu in the


workspace.

Address bar Select Visible to show the address bar in the


workspace.

Search bar Select Visible to show the search bar in the


workspace.

Toolbar Select Visible to show the toolbar in the


workspace.

Status bar Select Visible to show the status bar in the


workspace.

History bar Select Visible to show the history bar in the


workspace.

Root path (Applies to Address Bar and Displays the path to the workspace.
System Tree)

Add Click to add a new component to the


workspace. For more information, see
section 50.20 “Create Object Wizard –
Naming the Object Page” on page 1434.

System 04-13005-02-en, October 2012


574
25 User Management User Interface
25.38 Workspace – Content Tab

Continued
Component Description

Edit Click to edit a pane. For more information,


see section 25.5 “Pane Properties” on page
530.

Remove Click to remove a component.

04-13005-02-en, October 2012 System


575
25 User Management User Interface
25.39 Edit Layout Workspace

25.39 Edit Layout Workspace


Use the Edit Layout Workspace to edit the layout of a workspace. You can also
move and resize panes and panels and save the changes.

Figure: Edit layout workspace

Table: Edit Layout Workspace


Button Description

Save
Click to store and close the workspace
layout.

System 04-13005-02-en, October 2012


576
25 User Management User Interface
25.40 Workspace – Members Tab

25.40 Workspace – Members Tab


Use the Members tab to edit the workspace user account group associations.

Figure: Members tab

Table: Members tab


Component Description

Available User Account Groups Lists user account groups that are available
to be connected to the workspace.

Selected User Account Groups Lists user account groups that are
connected to the workspace.

Add all
Click to connect all available user account
groups to the workspace.

Add
Click to connect a user account group to the
workspace.

Remove
Click to disconnect a user account group
from the workspace.

Remove all
Click to disconnect all user account groups
from the workspace.

04-13005-02-en, October 2012 System


577
25 User Management User Interface
25.41 Panel Wizard – Panel Configuration Page

25.41 Panel Wizard – Panel Configuration


Page
Use the Panel Configuration page to add components to the panel.

Figure: Panel configuration page

Table: Panel Configuration Page


Component Description

Add Click to add a new component to the panel.


For more information, see section 50.20
“Create Object Wizard – Naming the Object
Page” on page 1434.

Edit Click to edit the properties of a component.


For more information, see section 25.5
“Pane Properties” on page 530.

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.

System 04-13005-02-en, October 2012


578
25 User Management User Interface
25.42 Domain Wizard – Domain Members Page

25.42 Domain Wizard – Domain Members


Page
Use the Domain Members page to add servers to the domain.

Figure: Domain members tab

Table: Domain Members Tab


Component Description

Available Servers List of all available servers.

Servers that are members of this Domain List of all servers in the domain.

Add All
Click to add all available servers to the
domain.

Add
Click to add a server to the domain.

Remove
Click to remove a server from the domain.

Remove All
Click to remove all servers from the domain.

04-13005-02-en, October 2012 System


579
25 User Management User Interface
25.43 Domains Properties

25.43 Domains Properties


Use the Domains properties to configure the Building Operation domains.

Figure: Domains properties

System 04-13005-02-en, October 2012


580
25 User Management User Interface
25.44 Local Properties

25.44 Local Properties


Use the Local properties to configure the local Building Operation domain.

Figure: Local properties

Table: Local Properties


Component Description

Maximum logon attempts Enter the maximum number of failed logon


attempts a user can make before the user´s
account is temporarily locked.

04-13005-02-en, October 2012 System


581
25 User Management User Interface
25.45 Work Area Window Properties

25.45 Work Area Window Properties


Use the Work Area Window Properties view or dialog box to view or edit the path
of the default object to be presented in the Work Area.

Figure: Work Area Window properties

Table: Work Area Window Properties


Property Description

Initial path Displays the path of the default object


presented the Work Area Window. For more
information, see section 23.3 “Workspace
Components and Customization” on page
470.

System 04-13005-02-en, October 2012


582
25 User Management User Interface
25.46 Create Work Area Window Wizard – Name Page

25.46 Create Work Area Window Wizard –


Name Page
Use the Name page to enter the path to the default object to be presented in the
Work Area Window.

Figure: Name page properties

Table: Name Page Properties


Property Description

Initial path Enter the path of the default object to be


presented the Work Area Window.
For more information, see section 23.3
“Workspace Components and
Customization” on page 470.

04-13005-02-en, October 2012 System


583
26 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
Displaying Alarm View on an Alarm
26 Alarms Introduction
26.1 Alarm Overview

26.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: Acknowledged and triggered alarms presented in Alarm View

26.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 26.2 “Alarm States” on page 589.

26.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 27.1 “Alarm Types” on page 607.

26.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 26.3 “Alarm Functions” on page 590.

04-13005-02-en, October 2012 System


587
26 Alarms Introduction
26.1 Alarm Overview

26.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 26.4 “Alarm Objects in Multiple Servers” on page
593.

26.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.
For more information, see section 26.5 “Alarms Pane and Alarm View
Customization” on page 594.

System 04-13005-02-en, October 2012


588
26 Alarms Introduction
26.2 Alarm States

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

04-13005-02-en, October 2012 System


589
26 Alarms Introduction
26.3 Alarm Functions

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

26.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 28.1 “Time Delay” on page 677.

26.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 28.3 “Shunt Variable” on page 679.

26.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 28.5 “Deadband” on page 681.

26.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 28.6 “Alarm Messages” on page 682.

26.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 28.8 “Priority” on page 684.

System 04-13005-02-en, October 2012


590
26 Alarms Introduction
26.3 Alarm Functions

26.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 28.10 “Categories” on page 686.

26.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 28.14 “Acknowledgement” on page 692.

26.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 28.19 “User Actions” on page 697.

26.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 28.21 “Notifications” on page 700.

26.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 28.26 “Automatic Assignment” on page 715.

04-13005-02-en, October 2012 System


591
26 Alarms Introduction
26.3 Alarm Functions

26.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 28.28 “Unit of Measure in Alarms” on page 718.

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

System 04-13005-02-en, October 2012


592
26 Alarms Introduction
26.4 Alarm Objects in Multiple Servers

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

04-13005-02-en, October 2012 System


593
26 Alarms Introduction
26.5 Alarms Pane and Alarm View Customization

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

System 04-13005-02-en, October 2012


594
26 Alarms Introduction
26.6 Styling the Alarm States in the Alarms Pane and Alarm Views

26.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.
For more information, see section 26.5 “Alarms Pane and Alarm View
Customization” on page 594.

To style the alarm states in the Alarms pane and Alarm Views
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Alarm appearance
appearance.

3. In the Alarm Styles view, double-click the alarm state you want to style.

Continued on next page

04-13005-02-en, October 2012 System


595
26 Alarms Introduction
26.6 Styling the Alarm States in the Alarms Pane and Alarm Views

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
OK.
7. In the Background color box, click the Browse button.
Continued on next page

System 04-13005-02-en, October 2012


596
26 Alarms Introduction
26.6 Styling the Alarm States in the Alarms Pane and Alarm Views

8. Select the color for the background of the alarm state row.

9. Click OK
OK.
10. In the Font color box
box, click the Browse button.
11. Select the color for the font of the alarm state text.
12. Click OK
OK.

13. Click the Save button .

04-13005-02-en, October 2012 System


597
26 Alarms Introduction
26.7 Alarm Filter Conditions

26.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 for when a sum alarm is to be triggered, an
e-mail notification is to be sent, a write to file notification is to be written, or an alarm
is to be automatically assigned to a user.

Table: Alarm Filter Conditions


Component Description

Acknowledge time Select to filter by the time and date the alarm
was acknowledged.

Acknowledged by Select to filter by the name of the user that


acknowledged the alarm.

Acknowledgement required Select to filter BACnet alarms by whether the


notification requires acknowledgement. True
specifies that an acknowledgement is
required.

ActionMessage Select to filter alarms by a message of up to


64 characters that has been assigned to the
I/NET point.

Alarm state Select to filter alarms by the present state of


the alarm.

Alarm text Select to filter alarms by the alarm messages


that are added to the alarm.

Assigned state Select to filter alarms that have been


assigned to and accepted by any user or
group.

Assigned to domain Select to filter alarms by the domain of the


user or group that the alarm is assigned to.

Assigned to ID Select to filter alarms by the ID of the user or


group that the alarm is assigned to.

Assigned to name Select to filter alarms by the name of the


user or group that the alarm is assigned to.

BACnet alarm type Select to filter alarms by the BACnet alarm


that monitors a variable within a BACnet
network.

BACnet notification Select to filter alarms by the BACnet


Notification Class of the event.

BACnet notification type Select to filter alarms by the BACnet


notification, whether the notification is an
event or an alarm.

Basic evaluation state Select to filter alarms by the current


evaluation state of the alarm. True indicates
that the alarm is triggered.

System 04-13005-02-en, October 2012


598
26 Alarms Introduction
26.7 Alarm Filter Conditions

Continued
Component Description

Category Select to filter alarms by the category name


of the alarm.

Command value Select to filter alarms by the value that was


commanded.

Confirmed notification Select to filter alarms by the request requires


acknowledgement, by the recipient's PC.

Count Select to filter alarms by the number of times


the alarm has toggled between the alarm
and reset state.

Deadband Select to filter alarms by the deadband value


of the alarm.

Disabled cause Select 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 Select to filter alarms by the difference limit


that was exceeded.

Evaluation state Select 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.

Event from state Select 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 Select to filter alarms by the ID the alarm has


on the external system.

EWS source ID Select to filter alarms by the external ID of


the object that generated the alarm.

EWS source name Select to filter alarms by the external name of


the object that generated the alarm.

Exceeded limit Select to filter alarms by the limit that was


exceeded.

Exceeding value Select to filter alarms by the value that


exceeded a limit.

Feedback value Select to filter alarms by the value that differs


from the Command value.

First Name Select to filter alarms by the first name of the


individual whose key/card was used at the
I/NET door point.

04-13005-02-en, October 2012 System


599
26 Alarms Introduction
26.7 Alarm Filter Conditions

Continued
Component Description

Group Name Select to filter alarms by the name of the


primary group assigned to the individual
whose key/card was used at the I/NET door
point.

Hidden Select to filter alarms by the visible status.


True is displayed when the object is hidden.

Individual Select to filter alarms by the individual


number of the individual whose key/card
was used at the I/NET door point.

Last Name Select to filter alarms by the last name of the


individual whose key/card was used at the
I/NET door point.

Logging Select to filter alarms by whether or not


associated alarm events are generated and
recorded in the Event log.

Monitored variable Select to filter alarms by path of the


monitored variable.

New mode Select to filter alarms by the new mode of


the referenced object.

New state Select to filter alarms by the new state of the


referenced property.

New value Select to filter alarms by the new value of the


referenced property.

Operation expected Select to filter alarms by the next operation


requested by the referenced object.

Possible operator actions Select to filter alarms by the possible actions


one can perform on the record, given
permissions.

Previous alarm state Select to filter alarms by the previous state of


the alarm.

Priority Select to filter alarms by the current priority


level of the alarm state.

Process ID Select to filter alarms by the unique process


ID in the receiving device for which a BACnet
notification is intended.

Referenced bit string Select to filter alarms by the new value of the
referenced bit string property.

Referenced value Select to filter alarms by the value of the


referenced property.

Setpoint value Select to filter alarms by the value of the


reference variable.

System 04-13005-02-en, October 2012


600
26 Alarms Introduction
26.7 Alarm Filter Conditions

Continued
Component Description

Source Select to filter alarms by the path of the


source object.

Source server Select to filter alarms by the path where the


alarm is located.

Status flags Select to filter alarms by the status flag.

System alarm ID Select to filter alarms by the alarm ID


generated by the system.

Tenant Select to filter alarms by the tenant number


of the individual whose key/card was used at
the I/NET door point.

Timestamp Select to filter alarms by the time and date.

Triggered time Select to filter alarms by the time and date of


the last state transfer from normal state to
alarm state.

Type Select to filter alarms by the type of the


object.

Value at change Select to filter alarms by the value of the


monitored variable.

04-13005-02-en, October 2012 System


601
26 Alarms Introduction
26.8 Creating a Filtered Alarm View

26.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.
For more information, see section 26.5 “Alarms Pane and Alarm View
Customization” on page 594.

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
View.
3. In the object type list, click Alarm View
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
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.
Continued on next page

System 04-13005-02-en, October 2012


602
26 Alarms Introduction
26.8 Creating a Filtered Alarm View

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

04-13005-02-en, October 2012 System


603
26 Alarms Introduction
26.9 Displaying Alarm View on an Alarm

26.9 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 System Tree pane, select the Alarm View that you want to open.
2. On the File menu, click Properties
Properties.
3. In the Display on alarm box, select True to automatically open the Alarm
View when an alarm is triggered.

4. Click OK
OK.

System 04-13005-02-en, October 2012


604
27 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
Configuring the Description of an Alarm
Configuring Attachments of an Alarm
Removing Attachments from an Alarm
27 Alarm Types
27.1 Alarm Types

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

27.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 27.2 “Change of State Alarm” on page 609.

27.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 27.10 “Out of Range Alarm” on page 639.

27.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 27.12 “Out of Reference Range Alarm” on page
648.

27.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 27.4 “Multistate Alarm” on page 617.

04-13005-02-en, October 2012 System


607
27 Alarm Types
27.1 Alarm Types

27.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 27.6 “Matching Text String Alarm” on page 625.

27.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 27.8 “Variable Status Alarm” on page 632.

27.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.
For more information, see section 27.14 “Sum Alarm” on page 657.

27.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 27.16 “Enumeration Alarm” on page 664.

27.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 an additional
description in the Events pane or Event View, Description column.
For more information, see section 27.18 “System Information Alarms” on page 671.

System 04-13005-02-en, October 2012


608
27 Alarm Types
27.2 Change of State Alarm

27.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.
For more information, see section 26.3 “Alarm Functions” on page 590.

04-13005-02-en, October 2012 System


609
27 Alarm Types
27.3 Creating a Change of State Alarm

27.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 27.2 “Change of State Alarm” on page 609.

To create a change of state alarm


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the object type list, select Change of State Alarm
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
Next.
Continued on next page

System 04-13005-02-en, October 2012


610
27 Alarm Types
27.3 Creating a Change of State Alarm

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
True.
• Click False to trigger the alarm when the monitored variable is equal to
False
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
variable, in the Alarm delay box, enter the
time delay.
11. In the Reset delay box, enter the time delay.
Continued on next page

04-13005-02-en, October 2012 System


611
27 Alarm Types
27.3 Creating a Change of State Alarm

12. In the Shunt variable box, enter the shunt variable.

13. Click Next


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

System 04-13005-02-en, October 2012


612
27 Alarm Types
27.3 Creating a Change of State Alarm

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


Next.
Continued on next page

04-13005-02-en, October 2012 System


613
27 Alarm Types
27.3 Creating a Change of State Alarm

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
connect to the alarm.
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.
Continued on next page

System 04-13005-02-en, October 2012


614
27 Alarm Types
27.3 Creating a Change of State Alarm

31. Under Required user actions


actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to specify how the user should respond to the listed
actions.

32. Click Next


Next.
Continued on next page

04-13005-02-en, October 2012 System


615
27 Alarm Types
27.3 Creating a Change of State Alarm

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


Create.

System 04-13005-02-en, October 2012


616
27 Alarm Types
27.4 Multistate Alarm

27.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 26.3 “Alarm Functions” on page 590.

04-13005-02-en, October 2012 System


617
27 Alarm Types
27.5 Creating a Multistate Alarm

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


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the object type list, select Multistate Alarm
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
Next.
7. Click Add row
row.
Continued on next page

System 04-13005-02-en, October 2012


618
27 Alarm Types
27.5 Creating a Multistate Alarm

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.

Continued on next page

04-13005-02-en, October 2012 System


619
27 Alarm Types
27.5 Creating a Multistate Alarm

10. In the Unit selection dialog box, select a unit.

11. In the Prefix box, select a prefix for the unit.


12. Click Select
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.
16. In the Disable alarm box, select whether or not to create the alarm in
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
Next.
Continued on next page

System 04-13005-02-en, October 2012


620
27 Alarm Types
27.5 Creating a Multistate Alarm

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

04-13005-02-en, October 2012 System


621
27 Alarm Types
27.5 Creating a Multistate Alarm

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
connect to the alarm.
32. In the Action note group box, select the action note group that you want to
connect to the alarm.
33. In the Checklist box, select the checklist that you want to connect to the
alarm.
34. 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.
35. 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.
Continued on next page

System 04-13005-02-en, October 2012


622
27 Alarm Types
27.5 Creating a Multistate Alarm

36. 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.
37. 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.
38. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to specify how the user should respond to the listed
actions.
39. Click Next
Next.

40. Click the Add attachment button to add an attachment to the alarm.

Continued on next page

04-13005-02-en, October 2012 System


623
27 Alarm Types
27.5 Creating a Multistate Alarm

41. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
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
Create.

System 04-13005-02-en, October 2012


624
27 Alarm Types
27.6 Matching Text String Alarm

27.6 Matching Text String Alarm


A matching text string alarm evaluates if the monitored value equals the given text
strings.
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.
For more information, see section 26.3 “Alarm Functions” on page 590.

04-13005-02-en, October 2012 System


625
27 Alarm Types
27.7 Creating a Matching Text String Alarm

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


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the object type list, select Matching Text String Alarm
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
Next.
7. Under Trigger alarm when variable is 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.

Continued on next page

System 04-13005-02-en, October 2012


626
27 Alarm Types
27.7 Creating a Matching Text String Alarm

8. Click Add row to add another text string.


9. In the Monitored variable box, enter the variable that the alarm monitors.
10. In the Disable alarm box, select whether or not to create the alarm in
disabled mode.
11. In the Alarm delay box, enter the time delay before the alarm is triggered.
12. In the Reset delay box, enter the time delay before the alarm is reset.
13. In the Shunt variable box, enter the boolean variable that enables or disables
the alarm.
14. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


627
27 Alarm Types
27.7 Creating a Matching Text String Alarm

15. In the Alarm message box, enter the message to display when the monitored
variable goes with or is equal to the alarm limits.

16. In the Reset message box, enter the message to display when the alarm is
reset.
17. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
18. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
19. In the Reset priority box, enter the priority of the alarm when it is reset.
20. In the Category box, enter the category that the alarm belongs to.
21. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
22. Select Audible alert to make the alarm sound when it is triggered.
23. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


628
27 Alarm Types
27.7 Creating a Matching Text String Alarm

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

25. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
26. In the Action note group box, select the action note group that you want to
connect to the alarm.
27. In the Checklist box, select the checklist that you want to connect to the
alarm.
28. 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.
Continued on next page

04-13005-02-en, October 2012 System


629
27 Alarm Types
27.7 Creating a Matching Text String Alarm

29. 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.
30. 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.
31. 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.
32. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
33. Click Next
Next.

34. Click the Add attachment button to add an attachment to the alarm.

Continued on next page

System 04-13005-02-en, October 2012


630
27 Alarm Types
27.7 Creating a Matching Text String Alarm

35. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.

36. In 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
Create.

04-13005-02-en, October 2012 System


631
27 Alarm Types
27.8 Variable Status Alarm

27.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 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.
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 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 WebHelp.
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 change of state alarms using shunt variable and time delay.
For more information, see section 26.3 “Alarm Functions” on page 590.

Monitored Value in Alarms Pane or Alarm View


The Monitored value 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 Monitored value column displays the status of the monitored variable:
• (Blank: Neither forced nor overridden)
• Forced
• Overridden
• Both forced and overridden

Figure: The text in the Monitored value column shows that the status of the variable is
forced

System 04-13005-02-en, October 2012


632
27 Alarm Types
27.9 Creating a Variable Status Alarm

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


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the object type list, select Variable Status Alarm
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
Next.
Continued on next page

04-13005-02-en, October 2012 System


633
27 Alarm Types
27.9 Creating a Variable Status Alarm

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. In the Monitored variable box, enter the variable that the alarm monitors.
10. In the Disable alarm box, select whether or not to create the alarm in
disabled mode.
11. In the Alarm delay box, enter the time delay before the alarm is triggered.
12. In the Reset delay box, enter the time delay before the alarm is reset.
13. In the Shunt variable box, enter the boolean variable that enables or disables
the alarm.
14. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


634
27 Alarm Types
27.9 Creating a Variable Status Alarm

15. In the Alarm message box, enter the message to display when the monitored
variable goes with or is equal to the alarm limits.

16. In the Reset message box, enter the message to display when the alarm is
reset.
17. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
18. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
19. In the Reset priority box, enter the priority of the alarm when it is reset.
20. In the Category box, enter the category that the alarm belongs to.
21. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
22. Select Audible alert to make the alarm sound when it is triggered.
23. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


635
27 Alarm Types
27.9 Creating a Variable Status Alarm

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

25. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
26. In the Action note group box, select the action note group that you want to
connect to the alarm.
27. In the Checklist box, select the checklist that you want to connect to the
alarm.
28. 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.
Continued on next page

System 04-13005-02-en, October 2012


636
27 Alarm Types
27.9 Creating a Variable Status Alarm

29. 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.
30. 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.
31. 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.
32. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
33. Click Next
Next.

34. Click the Add attachment button to add an attachment to the alarm.

Continued on next page

04-13005-02-en, October 2012 System


637
27 Alarm Types
27.9 Creating a Variable Status Alarm

35. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.

36. In 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
Create.

System 04-13005-02-en, October 2012


638
27 Alarm Types
27.10 Out of Range Alarm

27.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 26.3 “Alarm Functions” on page 590.

04-13005-02-en, October 2012 System


639
27 Alarm Types
27.11 Creating an Out of Range Alarm

27.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 27.10 “Out of Range Alarm” on page 639.

To create an out of range alarm


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the object type list, select Out of Range Alarm
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
Next.
Continued on next page

System 04-13005-02-en, October 2012


640
27 Alarm Types
27.11 Creating an Out of Range Alarm

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.
10. In the Monitored variable box, enter the variable that the alarm monitors.

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.

Continued on next page

04-13005-02-en, October 2012 System


641
27 Alarm Types
27.11 Creating an Out of Range Alarm

12. Select the unit of measure.

13. In the Prefix box, select a prefix for the unit.


14. Click Select
Select.
15. In the Disable alarm box, select whether or not to create the alarm in
disabled mode.
16. Under Time delay and shunt variable
variable, in the Alarm delay box, enter the
time delay.
17. In the Reset delay box, enter the time delay.
Continued on next page

System 04-13005-02-en, October 2012


642
27 Alarm Types
27.11 Creating an Out of Range Alarm

18. In the Shunt variable box, enter the digital variable that enables or disables
the alarm.

19. Click Next


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

04-13005-02-en, October 2012 System


643
27 Alarm Types
27.11 Creating an Out of Range Alarm

22. In the Reset message box, type the message to display when the alarm is
reset.
23. In the Priorities area, in the Above upper limit priority box, enter the priority
for the upper limit of the alarm state.
24. Select the Same priority check box to let all priorities inherit the value in the
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
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


Next.
Continued on next page

System 04-13005-02-en, October 2012


644
27 Alarm Types
27.11 Creating an Out of Range Alarm

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

32. In the Cause note group box, enter the cause note group that you want to
connect to the alarm.
33. In the Action note group box, enter the action note group that you want to
connect to the alarm.
34. In the Checklist box, enter the checklist that you want to connect to the
alarm.
35. 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.
36. 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.
37. 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.
38. 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.
Continued on next page

04-13005-02-en, October 2012 System


645
27 Alarm Types
27.11 Creating an Out of Range Alarm

39. Under Required user action


action, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.

40. Click Next


Next.
Continued on next page

System 04-13005-02-en, October 2012


646
27 Alarm Types
27.11 Creating an Out of Range Alarm

41. Click the Add attachment button to add an attachment.

42. In the Select Object dialog box, select the object you want to attach to the
alarm.
43. Click Select
Select.
44. On the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.

45. Click Create


Create.

04-13005-02-en, October 2012 System


647
27 Alarm Types
27.12 Out of Reference Range Alarm

27.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 26.3 “Alarm Functions” on page
590.

System 04-13005-02-en, October 2012


648
27 Alarm Types
27.13 Creating an Out of Reference Range Alarm

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


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the object type list, select Out of Reference Range Alarm
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
Next.
Continued on next page

04-13005-02-en, October 2012 System


649
27 Alarm Types
27.13 Creating an Out of Reference Range Alarm

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.
10. In the Monitored variable box, enter the variable that the alarm monitors.

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.

Continued on next page

System 04-13005-02-en, October 2012


650
27 Alarm Types
27.13 Creating an Out of Reference Range Alarm

12. Select the unit of measure.

13. In the Prefix box, select a prefix for the unit.


14. Click Select
Select.
15. In the Reference variable box, enter the reference variable to compare with
the monitored variable.
16. In the Disable alarm box, select whether or not to create the alarm in
disabled mode.
17. Under Time delay and shunt variable
variable, 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.
Continued on next page

04-13005-02-en, October 2012 System


651
27 Alarm Types
27.13 Creating an Out of Reference Range Alarm

19. In the Shunt variable box, enter the digital variable that enables or disables
the alarm.

20. Click Next


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.

Continued on next page

System 04-13005-02-en, October 2012


652
27 Alarm Types
27.13 Creating an Out of Reference Range Alarm

22. In the Below lower limit message box, type the message to display when
the monitored variable falls below the lower alarm limit.
23. In the Reset message box, type the message to display when the alarm is
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.
25. Select the Same priority check box to let all priorities inherit the value in the
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
Alerts, in the Category box, enter the category that the
alarm belongs to.
29. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
30. Select Audible alert to make a sound when the alarm is triggered.

31. Click Next


Next.
Continued on next page

04-13005-02-en, October 2012 System


653
27 Alarm Types
27.13 Creating an Out of Reference Range Alarm

32. 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 once, either in
the alarm state or reset state.
• Click Extended when the alarm needs to be acknowledged in both the
alarm state and the reset state.

33. In the Cause note group box, enter the cause note group that you want to
connect to the alarm.
34. In the Action note group box, enter the action note group that you want to
connect to the alarm.
35. In the Checklist box, enter the checklist that you want to connect to the
alarm.
36. 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.
37. 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.
38. 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.
39. 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.
Continued on next page

System 04-13005-02-en, October 2012


654
27 Alarm Types
27.13 Creating an Out of Reference Range Alarm

40. Under Required user actions


actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.

41. Click Next


Next.
Continued on next page

04-13005-02-en, October 2012 System


655
27 Alarm Types
27.13 Creating an Out of Reference Range Alarm

42. Click the Add attachment button to add an attachment to the alarm.

43. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
44. On the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
45. Click Create
Create.

System 04-13005-02-en, October 2012


656
27 Alarm Types
27.14 Sum Alarm

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

04-13005-02-en, October 2012 System


657
27 Alarm Types
27.15 Creating a Sum Alarm

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


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the object type list, select Sum Alarm
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
Next.
Continued on next page

System 04-13005-02-en, October 2012


658
27 Alarm Types
27.15 Creating a Sum Alarm

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.
9. In the Disable alarm box, select whether or not to create the alarm in disabled
mode.
10. In the Alarm delay box, enter the time delay before the alarm is triggered.
11. In the Reset delay box, enter the time delay before the alarm is reset.
12. In the Shunt variable box, enter the boolean variable that enables or disables
the alarm.
13. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


659
27 Alarm Types
27.15 Creating a Sum Alarm

14. In the Alarm message box, enter the message to display when the monitored
variable goes with or is equal to the alarm limits.

15. In the Reset message box, enter the message to display when the alarm is
reset.
16. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
17. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
18. In the Reset priority box, enter the priority of the alarm when it is reset.
19. In the Category box, enter the category that the alarm belongs to.
20. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
21. Select Audible alert to make the alarm sound when it is triggered.
22. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


660
27 Alarm Types
27.15 Creating a Sum Alarm

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

24. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
25. In the Action note group box, select the action note group that you want to
connect to the alarm.
26. In the Checklist box, select the 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.
Continued on next page

04-13005-02-en, October 2012 System


661
27 Alarm Types
27.15 Creating a Sum Alarm

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.
31. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
32. Click Next
Next.

33. Click the Add attachment button to add an attachment to the alarm.

Continued on next page

System 04-13005-02-en, October 2012


662
27 Alarm Types
27.15 Creating a Sum Alarm

34. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.

35. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
36. Click Create
Create.

04-13005-02-en, October 2012 System


663
27 Alarm Types
27.16 Enumeration Alarm

27.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 26.3 “Alarm Functions” on page 590.

System 04-13005-02-en, October 2012


664
27 Alarm Types
27.17 Creating an Enumeration Alarm

27.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.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the object type list, select Enumeration Alarm
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
Next.
Continued on next page

04-13005-02-en, October 2012 System


665
27 Alarm Types
27.17 Creating an Enumeration Alarm

7. In the Monitored variable box, enter the object and its enumeration type that
the alarm monitors.

8. Under Trigger alarm when variable is is, select the enumeration options of the
enumeration type that triggers the alarm.
9. Click Select
Select.
10. In the Disable alarm box, select whether or not to create the alarm in
disabled mode.
11. In the Alarm delay box, enter the time delay before the alarm is triggered.
12. In the Reset delay box, enter the time delay before the alarm is reset.
13. In the Shunt variable box, enter the boolean variable that enables or disables
the alarm.
14. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


666
27 Alarm Types
27.17 Creating an Enumeration Alarm

15. In the Alarm message box, enter the message to display when the monitored
variable goes with or is equal to the alarm limits.

16. In the Reset message box, enter the message to display when the alarm is
reset.
17. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
18. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
19. In the Reset priority box, enter the priority of the alarm when it is reset.
20. In the Category box, enter the category that the alarm belongs to.
21. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
22. Select Audible alert to make the alarm sound when it is triggered.
23. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


667
27 Alarm Types
27.17 Creating an Enumeration Alarm

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

25. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
26. In the Action note group box, select the action note group that you want to
connect to the alarm.
27. In the Checklist box, select the checklist that you want to connect to the
alarm.
28. 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.
Continued on next page

System 04-13005-02-en, October 2012


668
27 Alarm Types
27.17 Creating an Enumeration Alarm

29. 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.
30. 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.
31. 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.
32. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
33. Click Next
Next.

34. Click the Add attachment button to add an attachment to the alarm.

Continued on next page

04-13005-02-en, October 2012 System


669
27 Alarm Types
27.17 Creating an Enumeration Alarm

35. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.

36. In 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
Create.

System 04-13005-02-en, October 2012


670
27 Alarm Types
27.18 System Information Alarms

27.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 an additional
description in the Events pane or Event View, Description column.
For example, a Building Operation system alarm notifies the user when a Xenta
device becomes offline.
System alarms have the category 'System Alarm'. If a System alarm has an alarm
text, this texts always begins with “System alarm:”.
The common system alarms are handled similarly to other alarms. After
acknowledging a system alarm, the cause of the alarm must be corrected before
the alarm state changes to reset and then return to normal 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.

04-13005-02-en, October 2012 System


671
27 Alarm Types
27.19 Configuring the Description of an Alarm

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

4. Click the Save button .

System 04-13005-02-en, October 2012


672
27 Alarm Types
27.20 Configuring Attachments of an Alarm

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

3. Click the Add attachment button to add an attachment to the alarm.

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.

5. Click the Save button .

04-13005-02-en, October 2012 System


673
27 Alarm Types
27.21 Removing Attachments from an Alarm

27.21 Removing Attachments from an Alarm


You remove an attachment from an alarm to meet the unique needs of your site
For more information, see section 26.3 “Alarm Functions” on page 590.

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.

4. Click the Save button .

System 04-13005-02-en, October 2012


674
28 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
Single Acknowledge
No Acknowledge
Extended Acknowledge
User Actions
Configuring Forced User Action
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
28 Alarms Functions
28.1 Time Delay

28.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 sum alarms
and system information alarms.

04-13005-02-en, October 2012 System


677
28 Alarms Functions
28.2 Configuring the Delay Time of an Alarm

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

System 04-13005-02-en, October 2012


678
28 Alarms Functions
28.3 Shunt Variable

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

04-13005-02-en, October 2012 System


679
28 Alarms Functions
28.4 Editing the Shunt Variable

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

3. In the Changes have been made dialog box, click Yes to save the changes.

System 04-13005-02-en, October 2012


680
28 Alarms Functions
28.5 Deadband

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

04-13005-02-en, October 2012 System


681
28 Alarms Functions
28.6 Alarm Messages

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


Component Description

@(F) Displays the full path of the monitored


variable.

@(O) Displays the monitored object name.

@(P) Displays the monitored variable.

@(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.”

System 04-13005-02-en, October 2012


682
28 Alarms Functions
28.7 Configuring the Alarm Message of an Alarm

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


1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the Presentation tab.
3. Under Alarm message
message, type the alarm message for the different alarm
criterias.

4. In the Changes have been made dialog box, click Yes to save the changes.

04-13005-02-en, October 2012 System


683
28 Alarms Functions
28.8 Priority

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

System 04-13005-02-en, October 2012


684
28 Alarms Functions
28.9 Configuring the Priority of an Alarm

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


1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the Presentation tab.
3. Under Priorities
Priorities, select the Same priority check box to enter the same
priority.

4. In the Priorities boxes, enter the priority for each alarm state.
5. In the Changes have been made dialog box, click Yes to save the changes.

04-13005-02-en, October 2012 System


685
28 Alarms Functions
28.10 Categories

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

System 04-13005-02-en, October 2012


686
28 Alarms Functions
28.11 Creating a Category

28.11 Creating a Category


You create a category to group alarms so that alarms are more easily identified.
For more information, see section 28.10 “Categories” on page 686.

To create a category
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where you want to create the category.

3. In the Alarm handling area, click Categories


Categories.

4. Click the Categories tab, and then click the Add category button .
Continued on next page

04-13005-02-en, October 2012 System


687
28 Alarms Functions
28.11 Creating a Category

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
OK.
8. On the File menu, click Save
Save.

System 04-13005-02-en, October 2012


688
28 Alarms Functions
28.12 Configuring the Category of an Alarm

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


1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the Presentation tab.
3. In the Category box, enter a category for the alarm.

4. Click the Save button .

04-13005-02-en, October 2012 System


689
28 Alarms Functions
28.13 Editing a Category

28.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
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Categories
Categories.

3. In the Categories tab, select the category you want to edit.

Continued on next page

System 04-13005-02-en, October 2012


690
28 Alarms Functions
28.13 Editing a Category

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

8. Click the Save button .

04-13005-02-en, October 2012 System


691
28 Alarms Functions
28.14 Acknowledgement

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

28.14.1 Single Acknowledge


The single acknowledge property means that a triggered alarm only has to be
acknowledged once, either in the alarm state or reset state.
For more information, see section 28.16 “Single Acknowledge” on page 694.

28.14.2 No Acknowledge
The no acknowledge property means that a triggered alarm immediately returns to
normal state when the problem that triggered the alarm is corrected. You can still
acknowledge a triggered alarm to other users that you have responded to the
alarm, although this action is not mandatory or affects the alarm handling.
For more information, see section 28.17 “No Acknowledge” on page 695.

28.14.3 Extended Acknowledge


The extended acknowledge property means that a triggered alarm must at least be
acknowledged when the alarm is in reset state before it goes back to normal state.
To acknowledge to other users that you are troubleshooting the problem, you can
acknowledge the alarm when it is in alarm state. If the problem is corrected that
caused the alarm before anyone has acknowledged the alarm state, the alarm
changes automatically from alarm state to reset state.
For more information, see section 28.18 “Extended Acknowledge” on page 696.

System 04-13005-02-en, October 2012


692
28 Alarms Functions
28.15 Configuring the Acknowledgement Type of an Alarm

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


1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the User Action tab.
3. Select the Aknowledgement type
type:
• 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.

4. In the Changes have been made dialog box, click Yes to save the changes.

04-13005-02-en, October 2012 System


693
28 Alarms Functions
28.16 Single Acknowledge

28.16 Single Acknowledge


The single acknowledge property means that a triggered alarm only has to be
acknowledged once, either in the alarm state or reset state.
A single acknowledgement alarm that is acknowledged when the alarm is in alarm
state goes back to normal state when the problem that triggered the alarm is
corrected.
A single acknowledgement alarm that is acknowledged when the alarm is in reset
state returns immediately to normal state. In this case, the alarm can toggle
between alarm state and reset state several times before a user acknowledges the
alarm.

Figure: Single Acknowledge loop where the alarm is acknowledged either when the alarm
is Acknowledged or reset.

System 04-13005-02-en, October 2012


694
28 Alarms Functions
28.17 No Acknowledge

28.17 No Acknowledge
The no acknowledge property means that a triggered alarm immediately returns to
normal state when the problem that triggered the alarm is corrected. You can still
acknowledge a triggered alarm to other users that you have responded to the
alarm, although this action is not mandatory or affects the alarm handling.

Figure: No Acknowledge loop where the alarm does not have to be acknowledged before
the alarm returns to normal state.

04-13005-02-en, October 2012 System


695
28 Alarms Functions
28.18 Extended Acknowledge

28.18 Extended Acknowledge


The extended acknowledge property means that a triggered alarm must at least be
acknowledged when the alarm is in reset state before it goes back to normal state.
To acknowledge to other users that you are troubleshooting the problem, you can
acknowledge the alarm when it is in alarm state. If the problem is corrected that
caused the alarm before anyone has acknowledged the alarm state, the alarm
changes automatically from alarm state to reset state.

Figure: Extended Acknowledge loop where the alarm reset state must be acknowledged
before the alarm returns to normal state

System 04-13005-02-en, October 2012


696
28 Alarms Functions
28.19 User Actions

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

28.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 29.1 “Comments” on page 725.

28.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 29.2 “Cause Notes” on page 726.

28.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 29.6 “Action Notes” on page 732.

28.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 29.10 “Checklists” on page 738.

04-13005-02-en, October 2012 System


697
28 Alarms Functions
28.19 User Actions

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

System 04-13005-02-en, October 2012


698
28 Alarms Functions
28.20 Configuring Forced User Action

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


1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the User Action tab.
3. Under Required user action
action, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.

4. In the Changes have been made dialog box, click Yes to save the changes.

04-13005-02-en, October 2012 System


699
28 Alarms Functions
28.21 Notifications

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

28.21.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 30.77 “Email Notification
View” on page 859.
When writing the text message, you can use substitution codes to add current
system information. For more information, see section 28.25 “Substitution Codes
for Notifications” on page 711.

Note
If the server fails to send an E-mail notification, this is indicated by a system
information alarm. For more information, see section 27.18 “System Information
Alarms” on page 671.

28.21.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 14.1 “Software Administrator” on page 277. 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 30.79 “Write to File Notification
View” on page 862.
Substitution codes can be used in the notification text. For more information, see
section 28.25 “Substitution Codes for Notifications” on page 711.

System 04-13005-02-en, October 2012


700
28 Alarms Functions
28.21 Notifications

28.21.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 28.25 “Substitution Codes for Notifications” on
page 711.

04-13005-02-en, October 2012 System


701
28 Alarms Functions
28.22 Creating an E-mail Notification

28.22 Creating an E-mail Notification


You create an E-mail notification to send an E-mail message when an alarm event
occurs.
For more information, see section 28.21 “Notifications” on page 700.

To create an E-mail notification


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the notification.
2. On the File menu, point to New and then click Notification
Notification.
3. In the object type list, select Email Notification
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
Next.
Continued on next page

System 04-13005-02-en, October 2012


702
28 Alarms Functions
28.22 Creating an E-mail Notification

7. In the Status box, select Enabled to activate the E-mail notification.

8. In the Notify on 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 28.25 “Substitution Codes for
Notifications” on page 711.
Continued on next page

04-13005-02-en, October 2012 System


703
28 Alarms Functions
28.22 Creating an E-mail Notification

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.

14. Click the Add row button to add another condition of the same type.
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.

Continued on next page

System 04-13005-02-en, October 2012


704
28 Alarms Functions
28.22 Creating an E-mail Notification

16. Click Create


Create.

04-13005-02-en, October 2012 System


705
28 Alarms Functions
28.23 Setting Up a Write to File Notification

28.23 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.
For more information, see section 28.21 “Notifications” on page 700.

To set up a write to file notification


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the notification.
2. On the File menu, point to New and then click Notification
Notification.
3. Select Write to File Notification
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
Next.
Continued on next page

System 04-13005-02-en, October 2012


706
28 Alarms Functions
28.23 Setting Up a Write to File Notification

7. In the Status box, select Enable to activate the write to file notification.

8. In the Notify on 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 14.1 “Software Administrator” on page 277.

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.

Continued on next page

04-13005-02-en, October 2012 System


707
28 Alarms Functions
28.23 Setting Up a Write to File Notification

13. Click the Add row button to add another condition of the same type.
14. Click Create
Create.

System 04-13005-02-en, October 2012


708
28 Alarms Functions
28.24 Selecting the Schneider Electric E-mail Server for E-mail Notifications

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

For more information, see 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.
2. On the File menu, click Properties.
3. Click the E-mail tab.
Continued on next page

04-13005-02-en, October 2012 System


709
28 Alarms Functions
28.24 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
smtpservice.tac.com.
10. In the SMTP port box, confirm that the port number is 25
25.
11. Click OK
OK.

System 04-13005-02-en, October 2012


710
28 Alarms Functions
28.25 Substitution Codes for Notifications

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

04-13005-02-en, October 2012 System


711
28 Alarms Functions
28.25 Substitution Codes for Notifications

Continued
Code Description

@(Count) Writes the number of times the alarm has


toggled between the alarm and reset states.

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

@(EWSSourceName) Writes the name of the external object that


generated the alarm.

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

@(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


key/card was used at the I/NET door point.

@(GroupName) Writes the name of the primary group


assigned to the individual whose key/card
was used at the I/NET door point.

@(Hidden) Writes the visible status of an object. False


is displayed when the object is shown.

System 04-13005-02-en, October 2012


712
28 Alarms Functions
28.25 Substitution Codes for Notifications

Continued
Code Description

@(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


key/card was used at the I/NET door point.

@(Logging) Writes whether the alarm should be logged


or not.

@(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 identifier of the notification class


for the alarm for a BACnet alarm.

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

04-13005-02-en, October 2012 System


713
28 Alarms Functions
28.25 Substitution Codes for Notifications

Continued
Code Description

@(ReferencedBitString) Writes the new value of the monitored


bitstring property for a BACnet change of
bitstring alarm.

@(ReferencedValue) Writes the new value of the monitored


property for a BACnet floating limit alarm.

@(SEQNO) Writes the sequence number of the record.

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

@(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."

System 04-13005-02-en, October 2012


714
28 Alarms Functions
28.26 Automatic Assignment

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

04-13005-02-en, October 2012 System


715
28 Alarms Functions
28.27 Creating an Automatic Assignment

28.27 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 28.26 “Automatic Assignment” on page 715.

To create an automatic assignment


1. In WorkStation, in the System Tree pane, select the folder or Building
Operation server where you want to create the assignment.
2. On the File menu, point to New and then click Assignment
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
Next.
6. In the Status box, select whether to enable or disable the assignment.
Continued on next page

System 04-13005-02-en, October 2012


716
28 Alarms Functions
28.27 Creating an Automatic Assignment

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

04-13005-02-en, October 2012 System


717
28 Alarms Functions
28.28 Unit of Measure in Alarms

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

System 04-13005-02-en, October 2012


718
28 Alarms Functions
28.29 Configuring the Limits of an Alarm

28.29 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


1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the Alarm Trigger tab.
3. In the Alarm limit boxes, enter the limits for the alarm.

4. In the Changes have been made dialog box, click Yes to save the changes.

04-13005-02-en, October 2012 System


719
28 Alarms Functions
28.30 Configuring the Flashing of an Alarm

28.30 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


1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the Presentation tab.
3. Select Flashing to make the alarm flash in the Alarms pane and Alarm Views
when it is triggered.

4. Click the Save button .

System 04-13005-02-en, October 2012


720
28 Alarms Functions
28.31 Configuring the Audibility of an Alarm

28.31 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


1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the Presentation tab.
3. Select Audible to make the alarm sound when it is triggered.

4. Click the Save button .

04-13005-02-en, October 2012 System


721
29 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
29 User Actions
29.1 Comments

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

04-13005-02-en, October 2012 System


725
29 User Actions
29.2 Cause Notes

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

System 04-13005-02-en, October 2012


726
29 User Actions
29.3 Creating a Cause Note

29.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.
For more information, see section 29.2 “Cause Notes” on page 726.

To create a cause note


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Cause notes
notes.

3. In the Cause notes view, click the Add cause note button .

Continued on next page

04-13005-02-en, October 2012 System


727
29 User Actions
29.3 Creating a Cause Note

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

8. Click the Save button .

System 04-13005-02-en, October 2012


728
29 User Actions
29.4 Editing a Cause Note

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


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Cause notes
notes.

3. In the Cause notes view, select the cause note you want to edit.

Continued on next page

04-13005-02-en, October 2012 System


729
29 User Actions
29.4 Editing a Cause Note

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.

6. In the Group name box, type a name to create a new group or select an
existing group.
7. In the Description box, type a description for the cause note
8. Click OK
OK.

9. Click the Save button .

System 04-13005-02-en, October 2012


730
29 User Actions
29.5 Adding a Cause Note to an Alarm

29.5 Adding a Cause Note to an Alarm


You add a cause note to an alarm to report the cause of the alarm.
For more information, see section 29.2 “Cause Notes” on page 726.

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.

3. Click the Save button .


To add a cause note to an alarm you must have created one in advance and
defined its content.

04-13005-02-en, October 2012 System


731
29 User Actions
29.6 Action Notes

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

System 04-13005-02-en, October 2012


732
29 User Actions
29.7 Creating an Action Note

29.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.
For more information, see section 29.6 “Action Notes” on page 732.

To create an action note


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Action notes
notes.

3. In the Action notes view, click the Add action note button .

Continued on next page

04-13005-02-en, October 2012 System


733
29 User Actions
29.7 Creating an Action Note

4. In the Add Action Note dialog box, in the Name box, type the name of the
new action note.

5. In the Group name box, type a name to create a new group or select an
existing group.
6. In the Description box, type a description for the action note.
7. Click OK
OK.

8. Click the Save button .

System 04-13005-02-en, October 2012


734
29 User Actions
29.8 Editing an Action Note

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


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Action notes
notes.

3. In the Action notes view, select the action note you want to edit.

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 .

Continued on next page

04-13005-02-en, October 2012 System


735
29 User Actions
29.8 Editing an Action Note

5. In the Edit Action Note dialog box, in the Name box, type a name for the
action note.

6. In the Group name box, type a name to create a new group or select an
existing group.
7. In the Description box, type a description for the action note.
8. Click OK
OK.

9. Click the Save button .

System 04-13005-02-en, October 2012


736
29 User Actions
29.9 Adding an Action Note to an Alarm

29.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.
For more information, see section 29.6 “Action Notes” on page 732.

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.

3. Click the Save button .


To add a checklist to an alarm you must have created one in advance and defined
its content.

04-13005-02-en, October 2012 System


737
29 User Actions
29.10 Checklists

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

System 04-13005-02-en, October 2012


738
29 User Actions
29.11 Creating a Checklist

29.11 Creating a Checklist


You create a checklist to connect it to an alarm, and to guide the user when
troubleshooting a triggered alarm.
For more information, see section 29.10 “Checklists” on page 738.

To create a checklist
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Checklists
Checklists.

3. In the Checklist view, click the Add checklist button .

Continued on next page

04-13005-02-en, October 2012 System


739
29 User Actions
29.11 Creating a Checklist

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


OK.

10. Click the Save button .

System 04-13005-02-en, October 2012


740
29 User Actions
29.12 Editing a Checklist

29.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
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Checklists
Checklists.

3. In the Checklist view, click the Edit checklist button .

Note
• To permanently remove a checklist, click the Remove checklist

button .

Continued on next page

04-13005-02-en, October 2012 System


741
29 User Actions
29.12 Editing a Checklist

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

12. Click the Save button .

System 04-13005-02-en, October 2012


742
29 User Actions
29.13 Adding a Checklist to an Alarm

29.13 Adding a Checklist to an Alarm


You add a checklist to an alarm to troubleshoot the problem that triggered the
alarm.
For more information, see section 29.10 “Checklists” on page 738.

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.

3. Click the Save button .


To add a cause note to an alarm you must have created one in advance and
defined its content.

04-13005-02-en, October 2012 System


743
30 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
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
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
E-Mail Notification Properties
Write to File Notification View
Write to File Notification Properties
Assignment View
Assignment Properties
Alarm Properties
Object Specific Event View Toolbar
Progress View
Alarm Handling Properties
Alarm Properties
30 Alarms User Interface
30.1 Alarms Pane and Alarm View

30.1 Alarms Pane and Alarm View


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 30.2 “Alarms Pane and Alarm
View Toolbar” on page 750.

Use the columns to sort, show, and hide


information about the triggered alarms. For
more information, see section 50.42
“Add/Remove Columns Dialog Box ” on
page 1464.

Use the list to get information about a


triggered alarm and its current status. For
more information, see section 30.3 “Alarms
Pane and Alarm View Icons” on page 752.

04-13005-02-en, October 2012 System


749
30 Alarms User Interface
30.2 Alarms Pane and Alarm View Toolbar

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

Disable alarm
Click to disable the alarm. The alarm is
inactivated and cannot be acknowledged or
reset until it is enabled.
For more information, see WebHelp.

Unhide alarm
Click to show the alarm.
For more information, see WebHelp.

Hide alarm
Click to hide the alarm in the Alarms pane or
Alarm View. The alarm is still logged in the
Event log.
For more information, see WebHelp.

Add comment
Click to add a comment to the alarm.
For more information, see WebHelp.

Add cause note


Click to add a cause note to the alarm.
For more information, see WebHelp.

Add action note


Click to add an action note to the alarm.
For more information, see WebHelp.

System 04-13005-02-en, October 2012


750
30 Alarms User Interface
30.2 Alarms Pane and Alarm View Toolbar

Continued
Button Description

Checklist
Click to view the checklist for the alarm.
For more information, see WebHelp.

Show disabled alarms


Click to toggle between showing and hiding
disabled alarms.
For more information, see WebHelp.

Show hidden alarms


Click to toggle between hiding alarms and
showing hidden alarms.
For more information, see WebHelp.

Show alarm
Click to open the settings of the alarm in the
Work Area.

Save current settings


Click to save the settings.

Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.

Alarm filter
Click to select the conditions for the alarm
display in the Alarms pane. For more
information, see section 26.7 “Alarm Filter
Conditions” on page 598.

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 30.4 “Alarm and
Event Details View ” on page 753.
For more information, see WebHelp.

04-13005-02-en, October 2012 System


751
30 Alarms User Interface
30.3 Alarms Pane and Alarm View Icons

30.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 26.2 “Alarm States”
on page 589.

Alarm
Indicates that an alarm is triggered. For more
information, see section 26.2 “Alarm States”
on page 589.

Acknowledged
Indicates that a user has acknowledged the
alarm. The problem that caused the alarm
has not been corrected. For more
information, see section 26.2 “Alarm States”
on page 589.

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 26.2 “Alarm States” on page 589.

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 26.2 “Alarm
States” on page 589.

Fault
Indicates that the value reported from
hardware, such as a BACnet device, is not
trustworthy. For more information, see
section 26.2 “Alarm States” on page 589.

Attachment
Indicates that the alarm has an object
attached. For more information, see
WebHelp.

System 04-13005-02-en, October 2012


752
30 Alarms User Interface
30.4 Alarm and Event Details View

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


Component Description

Quick filter Enter a word or a character to filter on. For


more information, see section 46.6 “Quick
Filter ” on page 1318.

Change orientation of the panel


Select the orientation of the Detail view that
you want to use. For more information, see
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.

04-13005-02-en, October 2012 System


753
30 Alarms User Interface
30.5 Alarm System Tree Icons

30.5 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
26.1 “Alarm Overview” on page 587.
Alarm
Indicates that the object is an alarm. For
more information, see section 27.1 “Alarm
Types” on page 607.

Alarm handling
Indicates alarm handling objects that can be
connected to an alarm. For more
information, see section 26.3 “Alarm
Functions” on page 590.

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 26.1 “Alarm Overview” on page 587.

Action note
Indicates the object is an action note. For
more information, see section 29.6 “Action
Notes” on page 732.

Category
Indicates the object is a category that you
can use to group together alarms. For more
information, see WebHelp.

Cause note
Indicates the object is a cause note. For
more information, see section 29.2 “Cause
Notes” on page 726.

Checklists
Indicates the object is a checklist. For more
information, see section 29.10 “Checklists”
on page 738.

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 26.5 “Alarms Pane and Alarm View
Customization” on page 594.

System 04-13005-02-en, October 2012


754
30 Alarms User Interface
30.5 Alarm System Tree Icons

Continued
Icon Description

Assignment
Indicates the object is an assignment. For
more information, see section 28.26
“Automatic Assignment” on page 715.

Notification
Indicates the object is an E-mail notification
or a Write to file notification. For more
information, see section 28.21
“Notifications” on page 700.

04-13005-02-en, October 2012 System


755
30 Alarms User Interface
30.6 Change of State Alarm Properties – Basic Tab

30.6 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


Component Description

Alarm state Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Basic evaluation state Displays False when the alarm is in its


normal state.

Evaluation state Displays the present evaluation state of the


alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.

System 04-13005-02-en, October 2012


756
30 Alarms User Interface
30.6 Change of State Alarm Properties – Basic Tab

Continued
Component Description

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.

04-13005-02-en, October 2012 System


757
30 Alarms User Interface
30.7 Change of State Alarm Properties – Advanced Tab

30.7 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


Component Description

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.

System 04-13005-02-en, October 2012


758
30 Alarms User Interface
30.7 Change of State Alarm Properties – Advanced Tab

Continued
Component Description

Cause note group Enter the cause note group that is used by
the alarm.

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.

Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.

Remove (Action Requirements) Click to remove a user action item.

Add (Attachments) Click to open the Choosing the type and


naming the object dialog box where you
add an attachment item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Attachments) Click to open the property of an attachment


item, where you configure the attachment,
and how it is displayed when an alarm is
triggered. For more information, see section
30.39 “Attachment Properties” on page 817.

Remove (Attachments) Click to remove an attachment item that is


connected to the alarm.

04-13005-02-en, October 2012 System


759
30 Alarms User Interface
30.8 Multistate Alarm Properties – Basic Tab

30.8 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


Component Description

Alarm state Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Basic evaluation state Displays False when the alarm is in its


normal state.

Evaluation state Displays the present evaluation state of the


alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.

System 04-13005-02-en, October 2012


760
30 Alarms User Interface
30.8 Multistate Alarm Properties – Basic Tab

Continued
Component Description

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.

Monitored variable Enter the path to the variable that is


monitored by the alarm.

Add Click to create a new alarm trigger item,


either an integer or range value. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit Click to edit the alarm trigger item.


For more information, see section 30.36
“Alarm Trigger Properties – Range Tab” on
page 814.
For more information, see section 30.37
“Alarm Trigger Properties – Value tab” on
page 815.

Remove Click to remove an alarm trigger item.

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.

04-13005-02-en, October 2012 System


761
30 Alarms User Interface
30.9 Multistate Alarm Properties – Advanced Tab

30.9 Multistate Alarm Properties – Advanced


Tab
Use the Advanced tab to change the alarm properties of a multistate alarm.

Figure: Advanced tab

Table: Advanced Tab


Component Description

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.

System 04-13005-02-en, October 2012


762
30 Alarms User Interface
30.9 Multistate Alarm Properties – Advanced Tab

Continued
Component Description

Cause note group Enter the cause note group that is used by
the alarm.

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.

Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.

Remove (Action Requirements) Click to remove a user action item.

Add (Attachments) Click to open the Choosing the type and


naming the object dialog box where you
add an attachment item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Attachments) Click to open the property of an attachment


item, where you configure the attachment,
and how it is displayed when an alarm is
triggered. For more information, see section
30.39 “Attachment Properties” on page 817.

Remove (Attachments) Click to remove an attachment item that is


connected to the alarm.

04-13005-02-en, October 2012 System


763
30 Alarms User Interface
30.10 Matching Text String Alarm Properties – Basic Tab

30.10 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


Component Description

Alarm state Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Basic evaluation state Displays False when the alarm is in its


normal state.

System 04-13005-02-en, October 2012


764
30 Alarms User Interface
30.10 Matching Text String Alarm Properties – Basic Tab

Continued
Component Description

Evaluation state Displays the present evaluation state of the


alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.

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.

Add Click to create a new alarm trigger item. For


more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit Click to edit the alarm trigger item. For more


information, see section 30.36 “Alarm
Trigger Properties – Range Tab” on page
814.

Remove Click to remove an alarm trigger item.

04-13005-02-en, October 2012 System


765
30 Alarms User Interface
30.11 Matching Text String Alarm Properties – Advanced Tab

30.11 Matching Text String Alarm Properties –


Advanced Tab
Use the Advanced tab to change the alarm properties of a matching text string
alarm.

Figure: Advanced tab

Table: Advanced Tab


Component Description

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.

System 04-13005-02-en, October 2012


766
30 Alarms User Interface
30.11 Matching Text String Alarm Properties – Advanced Tab

Continued
Component Description

Cause note group Enter the cause note group that is used by
the alarm.

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.

Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.

Remove (Action Requirements) Click to remove a user action item.

Add (Attachments) Click to open the Choosing the type and


naming the object dialog box where you
add an attachment item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Attachments) Click to open the property of an attachment


item, where you configure the attachment,
and how it is displayed when an alarm is
triggered. For more information, see section
30.39 “Attachment Properties” on page 817.

Remove (Attachments) Click to remove an attachment item that is


connected to the alarm.

04-13005-02-en, October 2012 System


767
30 Alarms User Interface
30.12 Out of Range Alarm Properties – Basic Tab

30.12 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


Component Description

Alarm state Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Basic evaluation state Displays False when the alarm is in its


normal state.

System 04-13005-02-en, October 2012


768
30 Alarms User Interface
30.12 Out of Range Alarm Properties – Basic Tab

Continued
Component Description

Evaluation state Displays the present evaluation state of the


alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.

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

Shunt variable Enter the shunt variable that is used to


enable or disable the alarm.

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.

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
variable falls below the lower limit.

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.

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.

04-13005-02-en, October 2012 System


769
30 Alarms User Interface
30.12 Out of Range Alarm Properties – Basic Tab

Continued
Component Description

Deadband Enter the range the monitored variable has


to pass within the normal range before the
alarm is reset.

System 04-13005-02-en, October 2012


770
30 Alarms User Interface
30.13 Out of Range Alarm Properties – Advanced Tab

30.13 Out of Range Alarm Properties –


Advanced Tab
Use the Advanced tab for changing the alarm properties of an out of range alarm.

Figure: Advanced tab

Table: Advanced Tab


Component Description

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.

04-13005-02-en, October 2012 System


771
30 Alarms User Interface
30.13 Out of Range Alarm Properties – Advanced Tab

Continued
Component Description

Cause note group Enter the cause note group that is used by
the alarm.

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.

Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.

Remove (Action Requirements) Click to remove a user action item.

Add (Attachments) Click to open the Choosing the type and


naming the object dialog box where you
add an attachment item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Attachments) Click to open the property of an attachment


item, where you configure the attachment,
and how it is displayed when an alarm is
triggered. For more information, see section
30.39 “Attachment Properties” on page 817.

Remove (Attachments) Click to remove an attachment item that is


connected to the alarm.

System 04-13005-02-en, October 2012


772
30 Alarms User Interface
30.14 Out of Reference Range Alarm Properties – Basic Tab

30.14 Out of Reference Range Alarm


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


Component Description

Alarm state Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

04-13005-02-en, October 2012 System


773
30 Alarms User Interface
30.14 Out of Reference Range Alarm Properties – Basic Tab

Continued
Component Description

Basic evaluation state Displays False when the alarm is in its


normal state.

Evaluation state Displays the present evaluation state of the


alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.

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

Shunt variable Enter the shunt variable that is used to


enable or disable the alarm.

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.

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
variable falls below the lower limit.

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.

Reference variable Enter the reference variable that is compared


with the monitored variable.

Lower deviation limit Enter the lowest value the monitored variable
can decrease to before the alarm is
triggered.

System 04-13005-02-en, October 2012


774
30 Alarms User Interface
30.14 Out of Reference Range Alarm Properties – Basic Tab

Continued
Component Description

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

04-13005-02-en, October 2012 System


775
30 Alarms User Interface
30.15 Out of Reference Range Alarm Properties – Advanced Tab

30.15 Out of Reference Range Alarm


Properties – Advanced Tab
Use the Advanced tab to change the alarm properties of an out of reference range
alarm.

Figure: Advanced tab

Table: Advanced Tab


Component Description

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.

System 04-13005-02-en, October 2012


776
30 Alarms User Interface
30.15 Out of Reference Range Alarm Properties – Advanced Tab

Continued
Component Description

Cause note group Enter the cause note group that is used by
the alarm.

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.

Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.

Remove (Action Requirements) Click to remove a user action item.

Add (Attachments) Click to open the Choosing the type and


naming the object dialog box where you
add an attachment item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Attachments) Click to open the property of an attachment


item, where you configure the attachment,
and how it is displayed when an alarm is
triggered. For more information, see section
30.39 “Attachment Properties” on page 817.

Remove (Attachments) Click to remove an attachment item that is


connected to the alarm.

04-13005-02-en, October 2012 System


777
30 Alarms User Interface
30.16 Sum Alarm Properties – Basic Tab

30.16 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


Component Description

Alarm state Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Basic evaluation state Displays False when the alarm is in its


normal state.

Evaluation state Displays the present evaluation state of the


alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.

System 04-13005-02-en, October 2012


778
30 Alarms User Interface
30.16 Sum Alarm Properties – Basic Tab

Continued
Component Description

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.

04-13005-02-en, October 2012 System


779
30 Alarms User Interface
30.17 Sum Alarm Properties – Advanced Tab

30.17 Sum Alarm Properties – Advanced Tab


Use the Advanced tab to change the alarm properties of a sum alarm.

Figure: Advanced tab

Table: Advanced Tab


Component Description

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.

System 04-13005-02-en, October 2012


780
30 Alarms User Interface
30.17 Sum Alarm Properties – Advanced Tab

Continued
Component Description

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.

Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.

Remove (Action Requirements) Click to remove a user action item.

Add (Attachments) Click to open the Choosing the type and


naming the object dialog box where you
add an attachment item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Attachments) Click to open the property of an attachment


item, where you configure the attachment,
and how it is displayed when an alarm is
triggered. For more information, see section
30.39 “Attachment Properties” on page 817.

Remove (Attachments) Click to remove an attachment item that is


connected to the alarm.

04-13005-02-en, October 2012 System


781
30 Alarms User Interface
30.18 Enumeration Alarm Properties – Basic Tab

30.18 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


Component Description

Alarm state Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Basic evaluation state Displays False when the alarm is in its


normal state.

System 04-13005-02-en, October 2012


782
30 Alarms User Interface
30.18 Enumeration Alarm Properties – Basic Tab

Continued
Component Description

Evaluation state Displays the present evaluation state of the


alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.

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

Monitored variable Enter the path to the variable that is


monitored by the alarm.

Add Click to create a new alarm trigger item,


either an integer or range value. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit Click to edit the alarm trigger item. For more


information, see section 30.36 “Alarm
Trigger Properties – Range Tab” on page
814.

Remove Click to remove an alarm trigger item.

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.

04-13005-02-en, October 2012 System


783
30 Alarms User Interface
30.19 Enumeration Alarm Properties – Advanced Tab

30.19 Enumeration Alarm Properties –


Advanced Tab
Use the Advanced tab to change the alarm properties of an enumeration alarm.

Figure: Advanced tab

Table: Advanced Tab


Component Description

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.

System 04-13005-02-en, October 2012


784
30 Alarms User Interface
30.19 Enumeration Alarm Properties – Advanced Tab

Continued
Component Description

Cause note group Enter the cause note group that is used by
the alarm.

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.

Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.

Remove (Action Requirements) Click to remove a user action item.

Add (Attachments) Click to open the Choosing the type and


naming the object dialog box where you
add an attachment item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Attachments) Click to open the property of an attachment


item, where you configure the attachment,
and how it is displayed when an alarm is
triggered. For more information, see section
30.39 “Attachment Properties” on page 817.

Remove (Attachments) Click to remove an attachment item that is


connected to the alarm.

04-13005-02-en, October 2012 System


785
30 Alarms User Interface
30.20 Variable Status Alarm Properties – Basic Tab

30.20 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


Component Description

Alarm state Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Basic evaluation state Displays False when the alarm is in its


normal state.

Evaluation state Displays the present evaluation state of the


alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.

System 04-13005-02-en, October 2012


786
30 Alarms User Interface
30.20 Variable Status Alarm Properties – Basic Tab

Continued
Component Description

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 when variable is Select the statuses of the monitored variable


that trigger the alarm.

04-13005-02-en, October 2012 System


787
30 Alarms User Interface
30.21 Variable Status Alarm Properties – Advanced Tab

30.21 Variable Status Alarm Properties –


Advanced Tab
Use the Advanced tab to change the alarm properties of a variable status alarm.

Figure: Advanced tab

Table: Advanced Tab


Component Description

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.

System 04-13005-02-en, October 2012


788
30 Alarms User Interface
30.21 Variable Status Alarm Properties – Advanced Tab

Continued
Component Description

Cause note group Enter the cause note group that is used by
the alarm.

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.

Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.

Remove (Action Requirements) Click to remove a user action item.

Add (Attachments) Click to open the Choosing the type and


naming the object dialog box where you
add an attachment item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Attachments) Click to open the property of an attachment


item, where you configure the attachment,
and how it is displayed when an alarm is
triggered. For more information, see section
30.39 “Attachment Properties” on page 817.

Remove (Attachments) Click to remove an attachment item that is


connected to the alarm.

04-13005-02-en, October 2012 System


789
30 Alarms User Interface
30.22 Function Block Program Internal Alarm Properties - Basic Tab

30.22 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 50.26 “General and References
Properties” on page 1441.

Figure: Basic tab

Table: Basic Tab


Component Description

Alarm state Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Basic evaluation state Displays False when the alarm is in its


normal state.

Evaluation state Displays the present evaluation state of the


alarm. For example, Upper limit alarm is
displayed when the monitored value reaches
the upper alarm limit.

System 04-13005-02-en, October 2012


790
30 Alarms User Interface
30.22 Function Block Program Internal Alarm Properties - Basic Tab

Continued
Component Description

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

Delay to reset (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.

Delay to alarm (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.

Trigger value Select the statuses of the monitored variable


that trigger the alarm.

Monitored variable Enter the path to the variable that is


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

04-13005-02-en, October 2012 System


791
30 Alarms User Interface
30.23 Function Block Program Internal Alarm Properties - Advanced Tab

30.23 Function Block Program Internal Alarm


Properties - Advanced Tab
Use the Advanced tab to change the alarm properties of a function block program
internal alarm.

Figure: Advanced tab

Table: Advanced Tab


Component Description

Disable alarm Select to disable the alarm, for example,


before deployment.

Acknowledgement type Select the type of acknowledgement for the


alarm.

Flashing alert Select True to make the alert flash in the


Alarms pane and Alarm Views when an
alarm is triggered.

Audible alert Select True to make the alert audible when


an alarm is triggered.

System 04-13005-02-en, October 2012


792
30 Alarms User Interface
30.23 Function Block Program Internal Alarm Properties - Advanced Tab

Continued
Component Description

Category Enter the category that the alarm belongs to.

Cause note group Enter the cause note group that is used by
the alarm.

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.

Add (Action requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Action requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.

Remove (Action requirements) Click to remove a user action item.

Add (Attachments) Click to open the Choosing the type and


naming the object dialog box where you
add an attachment item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit (Attachments) Click to open the property of an attachment


item, where you configure the attachment,
and how it is displayed when an alarm is
triggered. For more information, see section
30.39 “Attachment Properties” on page 817.

Remove (Attachments) Click to remove an attachment item that is


connected to the alarm.

04-13005-02-en, October 2012 System


793
30 Alarms User Interface
30.24 Create Alarm Wizard – Presentation Page

30.24 Create Alarm Wizard – Presentation


Page
Use the Presentation page to configure the presentation settings of the alarm.

Figure: Presentation page

Table: Presentation Page


Component Description

Alarm message Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Above upper limit message Type the message to display when the
variable exceeds the upper limit of the alarm.

Below lower limit message Type the message to display when the
variable falls below the lower limit.

Reset message Type the message to display when the alarm


is reset.

Alarm priority Enter the priority level of the alarm.

Above upper limit priority Enter the priority level of the alarm when the
variable exceeds the upper limit.

Below lower limit priority Enter the priority level of the alarm when the
variable falls below the lower limit.

System 04-13005-02-en, October 2012


794
30 Alarms User Interface
30.24 Create Alarm Wizard – Presentation Page

Continued
Component Description

Reset priority Enter the priority level of the alarm when it is


reset.
Enter the category that the alarm belongs to.

Same priority Select to set all priorities to the same value.

Category Enter the category that the alarm belongs to.

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.

04-13005-02-en, October 2012 System


795
30 Alarms User Interface
30.25 Create Alarm Wizard – User Action Page

30.25 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


Component Description

Acknowledgement type Select the type of acknowledgement for the


alarm.
For more information, see section 28.14
“Acknowledgement” on page 692.

Cause note group Enter the cause note group that is used by
the alarm.

System 04-13005-02-en, October 2012


796
30 Alarms User Interface
30.25 Create Alarm Wizard – User Action Page

Continued
Component Description

Action note group Enter the action note group that is used by
the alarm.

Checklist Enter the checklist that belongs to 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.

04-13005-02-en, October 2012 System


797
30 Alarms User Interface
30.26 Create Alarm Wizard – Attachment Page

30.26 Create Alarm Wizard – Attachment


Page
Use the Attachment page to add attachments to the alarm.

Figure: Attachment page

Table: Attachment Page


Component Description

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.

System 04-13005-02-en, October 2012


798
30 Alarms User Interface
30.27 Create Change of State Alarm Wizard – Alarm Trigger Page

30.27 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


Component Description

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.

Monitored variable Enter the path to the variable that is


monitored by the alarm.

Disable alarm Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Alarm delay Enter the time, in seconds, the alarm has to


be within the reset criteria before the alarm
state is changed from alarm to reset.

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

04-13005-02-en, October 2012 System


799
30 Alarms User Interface
30.28 Create Multistate Alarm Wizard – Alarm Trigger Page

30.28 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


Component Description

between Select a range. If the monitored variable is


within this range, the alarm is triggered.

equals to Select a value. If the monitored variable


equals this value, the alarm is triggered.

Add row Add another alarm condition that triggers the


alarm.

Monitored variable Enter the path to the variable that is


monitored by the alarm.

Disable alarm Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Alarm delay Enter the time, in seconds, the alarm has to


be within the alarm criteria before the alarm
is triggered.

System 04-13005-02-en, October 2012


800
30 Alarms User Interface
30.28 Create Multistate Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Reset delay Enter the time, in seconds, the alarm has to


be within the reset criteria before the alarm
state is changed from alarm to reset.

Shunt variable Enter the shunt variable that is used to


enable or disable the alarm.

Remove
Remove alarm condition.

Set unit
Enter the unit of the alarm.

04-13005-02-en, October 2012 System


801
30 Alarms User Interface
30.29 Create Matching Text String Alarm Wizard – Alarm Trigger Page

30.29 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


Component Description

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

Monitored variable Enter the path to the variable that is


monitored by the alarm.

Disable alarm Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Alarm delay Enter the time, in seconds, the alarm has to


be within the alarm criteria before the alarm
is triggered.

System 04-13005-02-en, October 2012


802
30 Alarms User Interface
30.29 Create Matching Text String Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Reset delay Enter the time, in seconds, the alarm has to


be within the reset criteria before the alarm
state is changed from alarm to reset.

Shunt variable Enter the shunt variable that is used to


enable or disable the alarm.

Remove
Remove alarm condition.

04-13005-02-en, October 2012 System


803
30 Alarms User Interface
30.30 Create Out of Range Alarm Wizard – Alarm Trigger Page

30.30 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


Component Description

Upper limit Enter the highest value the monitored


variable can increase to before the alarm is
triggered.

Lower limit Enter the lowest value the monitored variable


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

Monitored variable Enter the path to the variable that is


monitored by the alarm.

Disable alarm Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Alarm delay Enter the time, in seconds, the alarm has to


be within the alarm criteria before the alarm
is triggered.

System 04-13005-02-en, October 2012


804
30 Alarms User Interface
30.30 Create Out of Range Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Reset delay Enter the time, in seconds, the alarm has to


be within the reset criteria before the alarm
state is changed from alarm to reset.

Shunt variable Enter the shunt variable that is used to


enable or disable the alarm.

Set unit
Enter the unit of the alarm.

04-13005-02-en, October 2012 System


805
30 Alarms User Interface
30.31 Create Out of Reference Range Alarm Wizard – Alarm Trigger Page

30.31 Create Out of Reference Range Alarm


Wizard – Alarm Trigger Page
Use the Alarm Trigge
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


Component Description

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.

Deadband Enter the range the monitored variable has


to pass within the normal range before the
alarm is reset.

Monitored variable Enter the path to the variable that is


monitored by the alarm.

Disable alarm Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Reference variable Enter the reference variable that is compared


with the monitored variable.

System 04-13005-02-en, October 2012


806
30 Alarms User Interface
30.31 Create Out of Reference Range Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Alarm delay Enter the time, in seconds, the alarm has to


be within the alarm criteria before the alarm
is triggered.

Reset delay Enter the time, in seconds, the alarm has to


be within the reset criteria before the alarm
state is changed from alarm to reset.

Shunt variable Enter the shunt variable that is used to


enable or disable the alarm.

Set unit
Enter the unit of the alarm.

04-13005-02-en, October 2012 System


807
30 Alarms User Interface
30.32 Create Sum Alarm Wizard – Alarm Trigger Page

30.32 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


Component Description

Add condition
Select the alarm filter conditions for the
alarms you want to include.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.

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.

System 04-13005-02-en, October 2012


808
30 Alarms User Interface
30.32 Create Sum Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Disable alarm Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Alarm delay Enter the time, in seconds, the alarm has to


be within the alarm criteria before the alarm
is triggered.

Reset delay Enter the time, in seconds, the alarm has to


be within the reset criteria before the alarm
state is changed from alarm to reset.

Shunt variable Enter the shunt variable that is used to


enable or disable the alarm.

04-13005-02-en, October 2012 System


809
30 Alarms User Interface
30.33 Create Enumeration Alarm Wizard – Alarm Trigger Page

30.33 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


Component Description

Trigger alarm when variable is Select the enumeration values that trigger
the alarm.

Monitored variable Enter the variable together with the


enumeration to monitor.

Disable alarm Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Alarm delay Enter the time, in seconds, the alarm has to


be within the alarm criteria before the alarm
is triggered.

Reset delay Enter the time, in seconds, the alarm has to


be within the reset criteria before the alarm
state is changed from alarm to reset.

Shunt variable Enter the shunt variable that is used to


enable or disable the alarm.

System 04-13005-02-en, October 2012


810
30 Alarms User Interface
30.34 Create Variable Status Alarm Wizard – Alarm Trigger Page

30.34 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


Component Description

Forced Select to trigger the alarm when the


monitored variable status is forced. For more
information, see WebHelp.

Overridden Select to trigger the alarm when the


monitored variable status is overridden. For
more information, see WebHelp.

Monitored variable Enter the path to the variable that is


monitored by the alarm.

Disable alarm Displays the present state of the alarm. For


more information, see section 26.2 “Alarm
States” on page 589.

Alarm delay Enter the time, in seconds, the alarm has to


be within the reset criteria before the alarm
state is changed from alarm to reset.

Reset delay Enter the time, in seconds, the alarm has to


be within the alarm criteria before the alarm
is triggered.

04-13005-02-en, October 2012 System


811
30 Alarms User Interface
30.34 Create Variable Status Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Shunt variable Enter the shunt variable that is used to


enable or disable the alarm.

System 04-13005-02-en, October 2012


812
30 Alarms User Interface
30.35 Alarm Trigger Properties - Basic Tab

30.35 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 50.26
“General and References Properties” on page 1441.

Figure: AlarmTrigger Properties

04-13005-02-en, October 2012 System


813
30 Alarms User Interface
30.36 Alarm Trigger Properties – Range Tab

30.36 Alarm Trigger Properties – Range Tab


Use the Range tab to configure the range that triggers the alarm.

Figure: Range tab

Table: Range Tab


Component Description

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.

System 04-13005-02-en, October 2012


814
30 Alarms User Interface
30.37 Alarm Trigger Properties – Value tab

30.37 Alarm Trigger Properties – Value tab


Use the Value tab to configure the integer that triggers the alarm.

Figure: Value tab

Table: Value Tab


Component Description

Value Enter the integer value that triggers the


alarm.

04-13005-02-en, October 2012 System


815
30 Alarms User Interface
30.38 Alarm Trigger Properties – Value tab

30.38 Alarm Trigger Properties – Value tab


Use the Value tab to type the text string that triggers the alarm.

Figure: Value tab

Table: Value Tab


Component Description

Value Type the text string that triggers the alarm.

System 04-13005-02-en, October 2012


816
30 Alarms User Interface
30.39 Attachment Properties

30.39 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


Component Description

Display on alarm Select True to automatically open and


display the attachment when the alarm is
triggered.

Object reference Enter the attachment that you want to attach


to the alarm.

04-13005-02-en, October 2012 System


817
30 Alarms User Interface
30.40 Alarm Control Panel Properties

30.40 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


Property Description

Lead object Displays the referenced lead object from


which all configuration data is copied. For
more information, see section 16.2 “Lead
and Shadow Relationship” on page 310.

System 04-13005-02-en, October 2012


818
30 Alarms User Interface
30.41 User Action Properties

30.41 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


Component Description

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.

04-13005-02-en, October 2012 System


819
30 Alarms User Interface
30.41 User Action Properties

Continued
Component Description

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.

System 04-13005-02-en, October 2012


820
30 Alarms User Interface
30.42 Alarm Styles View

30.42 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


Component Description

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 30.44 “Acknowledged Style
Properties” on page 823.

Alarm Style Click to select the style object that


configures the appearance of a triggered
alarm in the Alarms pane and Alarm View.
For more information, see section 30.45
“Alarm Style Properties” on page 824.

Disabled Style Click to select the style object that


configures the appearance of a disabled
alarm in the Alarms pane and Alarm View.
For more information, see section 30.46
“Disabled Style Properties” on page 825.

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
30.47 “Fault Style Properties” on page 826.

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 30.48 “Reset
Style Properties” on page 827.

04-13005-02-en, October 2012 System


821
30 Alarms User Interface
30.43 Alarm Styles Properties

30.43 Alarm Styles Properties


Use the Alarm Styles Properties view or dialog box to configure and view the
general and object-reference properties. For more information, see section 50.26
“General and References Properties” on page 1441.General and References
Properties

Figure: Alarm Styles Properties

System 04-13005-02-en, October 2012


822
30 Alarms User Interface
30.44 Acknowledged Style Properties

30.44 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


Component Description

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


alarms in the Alarms pane and Alarm Views.

04-13005-02-en, October 2012 System


823
30 Alarms User Interface
30.45 Alarm Style Properties

30.45 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


Component Description

Font Enter the font to use for triggered alarms in


the Alarms pane and Alarm Views.

Background color Enter the background color of the row for


triggered alarms in the Alarms pane and
Alarm Views.

Font color Enter the font color to use for triggered


alarms in the Alarms pane and Alarm Views.

System 04-13005-02-en, October 2012


824
30 Alarms User Interface
30.46 Disabled Style Properties

30.46 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


Component Description

Font Enter the font to use for disabled alarms in


the Alarms pane and Alarm Views.

Background color Enter the background color of the row for


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.

04-13005-02-en, October 2012 System


825
30 Alarms User Interface
30.47 Fault Style Properties

30.47 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


Component Description

Font Enter the font to use for faulty alarms in the


Alarms pane and Alarm Views.

Background color Enter the background color of the row for


faulty alarms in the Alarms pane and Alarm
Views.

Font color Enter the font color for faulty alarms in the
Alarms pane and Alarm Views.

System 04-13005-02-en, October 2012


826
30 Alarms User Interface
30.48 Reset Style Properties

30.48 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


Component Description

Font Enter the font to use for reset alarms in the


Alarms pane and Alarm Views.

Background color Enter the background color to use for reset


alarms in the Alarms pane and Alarm Views.

Font color Enter the font color to use for reset alarms in
the Alarms pane and Alarm Views.

04-13005-02-en, October 2012 System


827
30 Alarms User Interface
30.49 Alarm Control Panel – Categories View

30.49 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 30.50 “Add Category Dialog
Box” on page 829.

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 30.51 “Edit
Category Dialog Box” on page 830.

Remove category
Click to remove a category.

Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.

System 04-13005-02-en, October 2012


828
30 Alarms User Interface
30.50 Add Category Dialog Box

30.50 Add Category Dialog Box


Use the Add Category dialog box to add a category.

Figure: Add Category dialog box

Table: Add Category Dialog Box


Component Description

Name Type the name of the category.

Description Type a description of the category.

04-13005-02-en, October 2012 System


829
30 Alarms User Interface
30.51 Edit Category Dialog Box

30.51 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


Component Description

Name Type the name of the category.

Description Type a description of the category.

System 04-13005-02-en, October 2012


830
30 Alarms User Interface
30.52 Category Properties

30.52 Category Properties


Use the Category Properties view or dialog box to configure and view the general
and object-reference properties. For more information, see section 50.26 “General
and References Properties” on page 1441.

Figure: Category properties

04-13005-02-en, October 2012 System


831
30 Alarms User Interface
30.53 Categories Properties

30.53 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
information, see section 50.26 “General and References Properties” on page 1441.

Figure: Categories properties

Table: Categories Properties


Property Description

Name Diplays the category name. For more


information, see 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
30.52 “Category Properties” on page 831.

Remove Click to remove the selected category.

System 04-13005-02-en, October 2012


832
30 Alarms User Interface
30.54 Alarm Control Panel – Cause Notes View

30.54 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 30.55 “Add Cause
Note Dialog Box” on page 834.

Edit cause note


Click to open the Edit cause note dialog
box where you define the name and
description of an existing cause note. For
more information, see section 30.56 “Edit
Cause Note Dialog Box” on page 835.
Click to edit a cause note.

Remove cause note


Click to remove a cause note.

Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see 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.

04-13005-02-en, October 2012 System


833
30 Alarms User Interface
30.55 Add Cause Note Dialog Box

30.55 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


Component Description

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.

System 04-13005-02-en, October 2012


834
30 Alarms User Interface
30.56 Edit Cause Note Dialog Box

30.56 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


Component Description

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.

04-13005-02-en, October 2012 System


835
30 Alarms User Interface
30.57 Cause Notes Properties

30.57 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 50.26 “General and References Properties” on
page 1441.

Figure: Cause Notes properties

Table: Cause Notes Properties


Property Description

Name Displays the name of the cause note group.


For more information, see section 29.2
“Cause Notes” on page 726.

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.
For more information, see section 30.58
“Cause Note Group Properties” on page
837.

Remove Click to remove the selected cause note


group.

System 04-13005-02-en, October 2012


836
30 Alarms User Interface
30.58 Cause Note Group Properties

30.58 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


Property Description

Name Displays the name of the cause notes in the


cause note group. For more information, see
section 29.2 “Cause Notes” on page 726.

Add Click to open the Cause Note wizard

Edit Click to open the properties dialog box for


the selected cause note. For more
information, see section 30.59 “Cause Note
Properties” on page 838.

Remove Click to remove the selected cause note.

04-13005-02-en, October 2012 System


837
30 Alarms User Interface
30.59 Cause Note Properties

30.59 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 50.26 “General and References Properties” on
page 1441.

Figure: Cause Note properties

Table: Cause Note Properties


Property Description

Properties Type the display name of the cause note.


For more information, see section 29.2
“Cause Notes” on page 726.

System 04-13005-02-en, October 2012


838
30 Alarms User Interface
30.60 Alarm Control Panel – Action Notes View

30.60 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
box where you define the name and
description for a new action note. For more
information, see section 30.61 “Add Action
Note Dialog Box” on page 840.

Edit action note


Click to open the Edit action note dialog
box where you define the name and
description of an existing action note. For
more information, see section 30.62 “Edit
Action Note Dialog Box” on page 841.

Remove action note


Click to remove an action note.

Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see 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.

04-13005-02-en, October 2012 System


839
30 Alarms User Interface
30.61 Add Action Note Dialog Box

30.61 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


Component Description

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.

System 04-13005-02-en, October 2012


840
30 Alarms User Interface
30.62 Edit Action Note Dialog Box

30.62 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


Component Description

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.

04-13005-02-en, October 2012 System


841
30 Alarms User Interface
30.63 Action Notes Properties

30.63 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 properties.
For more information, see section 50.26 “General and References Properties” on
page 1441.

Figure: Action Notes properties

Table: Action Notes Properties


Property Description

Name Displays the name of the action note group.


For more information, see section 29.6
“Action Notes” on page 732.

Add Click to open the Action Note Group wizard,


where you add an action note group.

Edit Click to open the properties dialog box for


the action note group, where you edit the
properties of the action note group. For
more information, see section 30.64 “Action
Note Group Properties” on page 843.

Remove Click to remove the selected action note


group.

System 04-13005-02-en, October 2012


842
30 Alarms User Interface
30.64 Action Note Group Properties

30.64 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


Property Description

Name Displays the name of the action notes in the


action note group. For more information, see
section 29.6 “Action Notes” on page 732.

Add Click to open the Action Note wizard.

Edit Click to open the properties dialog box for


the selected action note. For more
information, see section 30.65 “Action Note
Properties” on page 844.

Remove Click to remove the selected action note.

04-13005-02-en, October 2012 System


843
30 Alarms User Interface
30.65 Action Note Properties

30.65 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.
For more information, see section 50.26 “General and References Properties” on
page 1441.

Figure: Action Note properties

Table: Action Note Properties


Property Description

Action note Type the display name of the action note.


For more information, see section 29.6
“Action Notes” on page 732.

System 04-13005-02-en, October 2012


844
30 Alarms User Interface
30.66 Alarm Control Panel – Checklists View

30.66 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.
For more information, see section 30.61
“Add Action Note Dialog Box” on page 840.

Edit checklist
Click to open the Edit checklist dialog box
where you edit the checklist name,
description, and add or edit checklist steps.
For more information, see section 30.68
“Edit Checklist Dialog Box” on page 848.

Remove checklist
Click to remove a checklist.

Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.

04-13005-02-en, October 2012 System


845
30 Alarms User Interface
30.67 Add Checklist Dialog Box

30.67 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 30.69
“Add Checklist Step Dialog Box” on page
850.

Edit step
Click to open the Edit checklist step dialog
box where you edit a checklist step. For
more information, see section 30.70 “Edit
Checklist Step Dialog Box” on page 851.

Remove step
Click to remove the selected step from the
checklist.

System 04-13005-02-en, October 2012


846
30 Alarms User Interface
30.67 Add Checklist Dialog Box

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.

04-13005-02-en, October 2012 System


847
30 Alarms User Interface
30.68 Edit Checklist Dialog Box

30.68 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 checklist.
For more information, see section 30.69
“Add Checklist Step Dialog Box” on page
850.

Edit step
Click to open the Edit checklist step dialog
box where you edit a checklist step. For
more information, see section 30.70 “Edit
Checklist Step Dialog Box” on page 851.

Remove step
Click to remove the selected step from the
checklist.

System 04-13005-02-en, October 2012


848
30 Alarms User Interface
30.68 Edit Checklist Dialog Box

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.

04-13005-02-en, October 2012 System


849
30 Alarms User Interface
30.69 Add Checklist Step Dialog Box

30.69 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


Component Description

Name Type the name of the checklist step.

System 04-13005-02-en, October 2012


850
30 Alarms User Interface
30.70 Edit Checklist Step Dialog Box

30.70 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


Component Description

Name Type the name of the checklist step.

04-13005-02-en, October 2012 System


851
30 Alarms User Interface
30.71 Checklists Properties

30.71 Checklists Properties


Use the Checklists Properties view or dialog box to add, edit, and remove
checklists.

Figure: Checklists properties

Table: Checklists Properties


Property Description

Name Dipsplays the name of the added checklists.


For more information, see section 29.10
“Checklists” on page 738.

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
checklist. For more information, see section
30.72 “Checklist Properties” on page 853.

Remove Click to remove the selected checklist.

System 04-13005-02-en, October 2012


852
30 Alarms User Interface
30.72 Checklist Properties

30.72 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 50.26 “General and References
Properties” on page 1441.

Figure: Checklist properties

Table: Checklist Properties


Property Description

Name Displays the name of the checklist steps that


have been added to the checklist. For more
information, see section 28.19 “User
Actions” on page 697.

Add Click to start the Checklist Step wizard.

Edit Click to edit the properties of the checklist


step. For more information, see section
30.73 “Checklist Step Properties” on page
854.

Remove Click to remove the selected checklist step.

04-13005-02-en, October 2012 System


853
30 Alarms User Interface
30.73 Checklist Step Properties

30.73 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
50.26 “General and References Properties” on page 1441.

Figure: Checklist Step properites

Table: Checklist Step Properties


Property Description

Checklist step Displays the checklist step instruction. For


more information, see section 28.19 “User
Actions” on page 697.

Position Enter the position of the step on the


checklist.

System 04-13005-02-en, October 2012


854
30 Alarms User Interface
30.74 Alarm – Basic Settings View

30.74 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


Property Description

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.

04-13005-02-en, October 2012 System


855
30 Alarms User Interface
30.75 Select Conditions Dialog Box – Alarm Filter Properties

30.75 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


Component Description

Select the alarm filter conditions for the


alarms you want to include.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.

Remove the alarm filter conditions for the


alarms you want exclude.

Click to add an additional row with the same


condition.

Click to remove a condition row.

System 04-13005-02-en, October 2012


856
30 Alarms User Interface
30.76 Create Email Notification Wizard – Email Notification Page

30.76 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


Component Description

Status Select Enable to activate the email


notification function. Select Disable to
deactivate the email notification function.

Notify on Select the alarm condition that has to be met


before the email notification is sent.

E-mail address Type the e-mail address to the user or group


of users to whom the e-mail 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.

04-13005-02-en, October 2012 System


857
30 Alarms User Interface
30.76 Create Email Notification Wizard – Email Notification Page

Continued
Component Description

Add condition
Click to add a condition that has to be met
for the email to be sent.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.

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.

System 04-13005-02-en, October 2012


858
30 Alarms User Interface
30.77 Email Notification View

30.77 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


Component Description

Name Type the name of the object to create.

Description Type a description that explains what the


object is used for.

Status Select Enable to activate the email


notification function. Select Disable to
deactivate the email notification function.

Notify on Select the alarm condition that has to be met


before the email notification is sent.

E-mail address Type the e-mail address to the user or group


of users to whom the e-mail 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.

04-13005-02-en, October 2012 System


859
30 Alarms User Interface
30.77 Email Notification View

Continued
Component Description

Add condition
Click to add a condition that has to be met
for the email to be sent.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.

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.

System 04-13005-02-en, October 2012


860
30 Alarms User Interface
30.78 E-Mail Notification Properties

30.78 E-Mail Notification Properties


Use the E-mail Notification properties to configure the sender address and the
content of the notification mail.

Figure: E-mail Notification properties

Table: E-mail Notification Properties


Component Description

E-mail address Type the e-mail address to the user or group


of users to whom the e-mail 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.

Status Select Enable to activate the email


notification function. Select Disable to
deactivate the email notification function.

04-13005-02-en, October 2012 System


861
30 Alarms User Interface
30.79 Write to File Notification View

30.79 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


Component Description

Name Type the name of the object to create.

Description Type a description that explains what the


object is used for.

Status Select Enable to activate the write to file


notification function. Select Disable to
deactivate the write to file notification
function, that is, no information is written to
the file.

Notify on Select the alarm condition that has to be met


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 or the substitution


code for the text content that is to be written
to the file when the conditions are met.

[Conditions list] Use the conditions list to add or remove


conditions for when the notification is to be
written to the file and to configure the
conditions.

System 04-13005-02-en, October 2012


862
30 Alarms User Interface
30.79 Write to File Notification View

Continued
Component Description

Add condition
Click to add a condition that has to be met
for the notification to be written to the file.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.

Remove condition
Click to remove a condition that has to be
met for the notification to be written to the
file.

Add row
Click to add a row to the condition.

Remove row
Click to remove the row from the condition.

04-13005-02-en, October 2012 System


863
30 Alarms User Interface
30.80 Write to File Notification Properties

30.80 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


Component Description

File name Type the text content or the substitution


code for the text content that is to be written
to the file when the conditions are met.

Text Type the text content or the substitution


code for the text content that is to be written
to the file when the conditions are met.

Status Select Enable to activate the write to file


notification function. Select Disable to
deactivate the write to file notification
function, that is, no information is written to
the file.

System 04-13005-02-en, October 2012


864
30 Alarms User Interface
30.81 Assignment View

30.81 Assignment View


Use the Assignment view to edit automatic alarm assignments.

Figure: Assignment view

Table: Assignment View


Component Description

Name Type the name of the object to create.

Description Type a description that explains what the


object is used for.

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 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.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.

Remove condition
Click to remove conditions for when the
alarm is to be assigned.

04-13005-02-en, October 2012 System


865
30 Alarms User Interface
30.81 Assignment View

Continued
Component Description

Add row
Click to add a row to the condition.

Remove row
Click to remove the row from the condition.

System 04-13005-02-en, October 2012


866
30 Alarms User Interface
30.82 Assignment Properties

30.82 Assignment Properties


Use the Assignment properties to configure which user or user group to send the
assignment request.

Figure: Assignment properties

Table: Assignment Properties


Component Description

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 Enter the schedule or other multistate


variable that contains the value that is to be
used to activate the assignment.

Status Select Enable to activate the assignment


function. Select Disable to deactivate the
assignment function.

04-13005-02-en, October 2012 System


867
30 Alarms User Interface
30.83 Alarm Properties

30.83 Alarm Properties


Use the Alarm properties to configure and view the general and object references
properties. For more information, see section 50.26 “General and References
Properties” on page 1441.

Figure: Alarm properties

System 04-13005-02-en, October 2012


868
30 Alarms User Interface
30.84 Object Specific Event View Toolbar

30.84 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
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see 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.

Quick filter Enter a word or a character to filter on. For


more information, see section 46.6 “Quick
Filter ” on page 1318.

04-13005-02-en, October 2012 System


869
30 Alarms User Interface
30.85 Progress View

30.85 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


Component Description

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.

System 04-13005-02-en, October 2012


870
30 Alarms User Interface
30.86 Alarm Handling Properties

30.86 Alarm Handling Properties


Use the Alarm Handling Properties view or dialog box to configure and view the
general and object-reference properties. For more information, see section 50.26
“General and References Properties” on page 1441.

Figure: Alarm Handling Properties

04-13005-02-en, October 2012 System


871
30 Alarms User Interface
30.87 Alarm Properties

30.87 Alarm Properties


Use the Alarm properties to configure and view the general and object references
properties. For more information, see section 50.26 “General and References
Properties” on page 1441.

Figure: Alarm properties

System 04-13005-02-en, October 2012


872
31 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
31 Events
31.1 How Events Work

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

04-13005-02-en, October 2012 System


875
31 Events
31.2 Events Pane and Event View Customization

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

System 04-13005-02-en, October 2012


876
31 Events
31.3 Styling a Certain Event in the Events Pane or Event View

31.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 31.2 “Events Pane and Event View
Customization” on page 876.

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
events.
3. In the Event Styles dialog box, click Add
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.

Continued on next page

04-13005-02-en, October 2012 System


877
31 Events
31.3 Styling a Certain Event in the Events Pane or Event View

7. Click the Add row button to add another condition of the same type.
8. Click OK
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
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
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
OK.
18. In the Event Styles dialog box, click OK
OK.

System 04-13005-02-en, October 2012


878
31 Events
31.3 Styling a Certain Event in the Events Pane or Event View

You can add several event styles to different associated events.

04-13005-02-en, October 2012 System


879
31 Events
31.4 Event Filter Conditions

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

Table: Event Filter Conditions


Component Description

Acknowledge time Select to filter events by the time and date an


alarm was acknowledged.

Alarm state Select to filter events by the alarm state.

Alarm text Select to filter events by the alarm message


that was added to the alarm.

Assign state Select to filter events by the assigned state


the alarm had. The possible values are
Unassigned, Assigned and Accepted.

Assigned to domain Select to filter events by the domain of the


user or group that an alarm was assigned to.

Assigned to ID Select to filter events by the ID of the user or


group that an alarm was assigned to.

Assigned to name Select to filter events by the name of the user


or group that an alarm was assigned to.

BACnet alarm type Select to filter events by the BACnet alarm


that monitored a variable within a BACnet
network.

Basic evaluation state Select to filter events by the basic evaluation


state of an alarm. The value True indicates
that an alarm was triggered.

Category Select to filter events by the category name.

Command Select to filter events by the executed


command.

Comment Select to filter events by the comment that


was added to an alarm.

Control Source Select to filter events by the initials of the


controlling I/NET operator.

Control State Select to filter events by the 4 bit I/NET state


descriptor.

Count Select to filter events by the number of times


an alarm has toggled between the alarm and
reset state.

Description Select to filter events by their description.

Device Name Select to filter events by the name of the


I/NET device that generated the event.

System 04-13005-02-en, October 2012


880
31 Events
31.4 Event Filter Conditions

Continued
Component Description

Disabled cause Select 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 to filter events by the domain a user


belonged to.

Evalutation state Select 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 Select to filter events by the id of the event


on the external system.

EWS source ID Select to filter events by the id of the external


object that generated the event.

EWS source name Select to filter events by the name of the


external object that generated the event.

First Name Select to filter events by the first name of the


individual whose key/card was used at the
I/NET door point.

Forced value Select to filter events by forced values.

Group Select to filter events by the name of the


cause note or action note group the user
edited.

Hidden Select to filter events by the visible status an


object had. False is displayed when an
object was shown.

Individual Select to filter events by the individual


number of the individual whose key/card
was used at the I/NET door point.

INET Address Select to filter events by the system address


of the point, or station address of the host or
controller that generated the event.

INET Event Type Select to filter events by the I/NET event


type.

Last Name Select to filter events by the last name of the


individual whose key/card was used at the
I/NET door point.

LinkName Select to filter events by the name assigned


to the link of the device from which the event
originated.

Message Text Select to filter events by the text of an I/NET


actio or dispatch message, if there is one.

04-13005-02-en, October 2012 System


881
31 Events
31.4 Event Filter Conditions

Continued
Component Description

Monitored variable Select to filter events by the path of the


monitored variable.

Note Select to filter events by their note.

Previous alarm state Select to filter events by the previous alarm


state.

Priority Select to filter events by the priority an alarm


had.

Source Select to filter events by the path of the


source object.

Source server Select to filter events by the server path of


the source object.

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

StationName Select to filter events by the name assigned


to the controller from which the event
originated.

System alarm ID Select to filter events by the alarm ID


generated by the system.

System event ID Select to filter events by the event ID


generated by the system.

Tenant Select to filter events by the tenant number


of the individual whose key/card was used at
the I/NET door point.

Timestamp Select to filter events by 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 filter events by event type.

Unique alarm ID Select to filter events by the unique alarm ID


of an alarm.

Unique user ID Select to filter events by the ID of a user.

User action item Select to filter events of which the user has
edited checklist, cause note group, or action
note group items.

User name Select to filter events by the name of the user


that generated the event.

System 04-13005-02-en, October 2012


882
31 Events
31.4 Event Filter Conditions

Continued
Component Description

Value after Select to filter events by the value of an


object after it was changed.

Value at change Select to filter events by the value the


monitored variable had when the alarm was
triggered.

Value before Select to filter events by the value of an


object before it was changed.

Zone Select to filter events by I/NET security zone


number associated with a security event (0-
63).

04-13005-02-en, October 2012 System


883
31 Events
31.5 Applying an Event Filter

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

5. Click the Add row button to add another condition of the same type.

6. Click OK
OK.

System 04-13005-02-en, October 2012


884
31 Events
31.5 Applying an Event Filter

The event filter has been created and is now applied to the Events pane or Event
View.

04-13005-02-en, October 2012 System


885
31 Events
31.6 Creating a Filtered Event View

31.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 31.2 “Events Pane and Event View
Customization” on page 876.

To create a filtered Event View


1. In WorkStation, in the System Tree pane, select the folder or Building
Operation server where you want to create the event.
2. On the File menu, point to New
New, and then click View
View.
3. In the object type list, click Event View
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
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
Filter.
Continued on next page

System 04-13005-02-en, October 2012


886
31 Events
31.6 Creating a Filtered Event View

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.

11. Click the Add row button to add another condition of the same type.
12. Click OK
OK.

04-13005-02-en, October 2012 System


887
32 Events User Interface

introduction to this topic

Topics
Object Specific Event View
Event Styles Dialog Box
Event View Properties
Select Conditions Dialog Box – Events Filter Properties
Add/Remove Columns Dialog Box
32 Events User Interface
32.1 Object Specific Event View

32.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 30.84 “Object
Specific Event View Toolbar” on page 869.

Use the Object Specific Events View


columns to sort, hide, or show information
about the events. For more information, see
section 50.42 “Add/Remove Columns Dialog
Box ” on page 1464.

04-13005-02-en, October 2012 System


891
32 Events User Interface
32.2 Event Styles Dialog Box

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


Component Description

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.

Background color Enter the background color of the row for


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.

System 04-13005-02-en, October 2012


892
32 Events User Interface
32.3 Event View Properties

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


Component Description

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.

04-13005-02-en, October 2012 System


893
32 Events User Interface
32.4 Select Conditions Dialog Box – Events Filter Properties

32.4 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


Component Description

Add condition
Click to customize the conditions to sort out
the events that are of interest.
For more information, see section 31.4
“Event Filter Conditions” on page 880.

Remove condition
Click to remove an added condition.

Click to add an additional row with the same


condition.

Click to remove a condition row.

System 04-13005-02-en, October 2012


894
32 Events User Interface
32.5 Add/Remove Columns Dialog Box

32.5 Add/Remove Columns Dialog Box


Use the Add/Remove columns dialog box to add or remove columns from a list,
such as the trend log list or Events pane.

Figure: Add /Remove column

Table: Add/Remove Columns


Component Description

Acknowledge time Select to display the time and date when the
alarm was acknowledged. For more
information, see section 28.14
“Acknowledgement” on page 692.

Alarm state Select to display the alarm state. For more


information, see section 26.2 “Alarm States”
on page 589.

Alarm text Select to display the alarm message that


was added to the alarm. For more
information, see section 28.6 “Alarm
Messages” on page 682.

Assigned state Select to display the assigned state the


alarm had. For more information, see
WebHelp.

Assigned to domain Select to display the domain of the user or


group that an alarm was assigned to. For
more information, see section 20.1
“Domains” on page 405.

Assigned to ID Select to display the ID of the user or group


that an alarm was assigned to.

04-13005-02-en, October 2012 System


895
32 Events User Interface
32.5 Add/Remove Columns Dialog Box

Continued
Component Description

Assigned to name Select to display the name of the user or


group that an alarm was assigned to. For
more information, see section 26.3 “Alarm
Functions” on page 590.

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

Description Select to display the event description. For


more information, see section 50.26
“General and References Properties” on
page 1441.

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 20.1 “Domains” on page 405.

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.

EWS ID Select to display the EcoStruxure Web


Service identification of the event on the
external system.

System 04-13005-02-en, October 2012


896
32 Events User Interface
32.5 Add/Remove Columns Dialog Box

Continued
Component Description

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


individual whose key/card was used at 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


individual whose key/card was used at 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


individual whose key/card was used at 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


number on the present server.

Source Select to display the path of the source


object.

04-13005-02-en, October 2012 System


897
32 Events User Interface
32.5 Add/Remove Columns Dialog Box

Continued
Component Description

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


individual whose key/card was used at the
I/NET door point.

Text Select to display the text messages in the E-


mail in a E-mail notification. For more
information, see section 28.21
“Notifications” on page 700.

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 50.26 “General and
References Properties” on page 1441.

Unique alarm ID Select to display the ID of the alarm that


generated the event.

Unique user ID Select to display the ID of the user that


generated the event.

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 31.2 “Events Pane and Event
View Customization” on page 876.

Value after Select to display the value of an object after


it was changed.

Value at change Select to display the value the monitored


variable had when the alarm was triggered.

System 04-13005-02-en, October 2012


898
32 Events User Interface
32.5 Add/Remove Columns Dialog Box

Continued
Component Description

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

04-13005-02-en, October 2012 System


899
33 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
33 Trend Log Introduction
33.1 Trend Overview

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

04-13005-02-en, October 2012 System


903
33 Trend Log Introduction
33.1 Trend Overview

System 04-13005-02-en, October 2012


904
33 Trend Log Introduction
33.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 48.15 “Event and Alarm Enumerations” on
page 1361.
For more information, see section 48.16 “Trend Log Enumerations” on page
1368.

33.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 34.1 “Trend Log Types” on page 919.

33.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 35.1 “Trend Log Functions” on page 997.

33.1.3 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 37.1 “Trend Log Lists” on page 1071.

33.1.4 Trend Charts


A trend chart displays the records of a trend log or an extended trend log as a
series.
For more information, see section 36.1 “Trend Charts” on page 1019.

04-13005-02-en, October 2012 System


905
33 Trend Log Introduction
33.1 Trend Overview

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

System 04-13005-02-en, October 2012


906
33 Trend Log Introduction
33.2 Clearing a Trend Log

33.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 33.1 “Trend Overview” on page 903.

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


1. In WorkStation, in the System Tree pane, select the folder or server where 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
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.

04-13005-02-en, October 2012 System


907
33 Trend Log Introduction
33.3 Editing or Commenting a Trend Log Record

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

For more information, see section 37.1 “Trend Log Lists” on page 1071.

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


3. In the Value box, type the new value.

4. In the Comment box, type a comment.


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

System 04-13005-02-en, October 2012


908
33 Trend Log Introduction
33.4 Displaying the History of a Trend Log Record

33.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.
For more information, see section 37.1 “Trend Log Lists” on page 1071.

To display the history of a trend log record


1. In WorkStation, in the System Tree pane, select the trend log list you want to
show.
2. In the Trend log list
list, right-click a record, and then click Show history
history.

3. Click Close
Close.

The dialog box displays all old values and which user that edited the record.

04-13005-02-en, October 2012 System


909
33 Trend Log Introduction
33.5 Trend Units

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

System 04-13005-02-en, October 2012


910
33 Trend Log Introduction
33.5 Trend Units

04-13005-02-en, October 2012 System


911
33 Trend Log Introduction
33.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.

System 04-13005-02-en, October 2012


912
33 Trend Log Introduction
33.6 Enabling a Trend Log

33.6 Enabling a Trend Log


You enable trend log to start recording values.
For more information, see section 35.3 “Activation Methods” on page 999.

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

The trend log is now enabled and starts recording when its start condition is fulfilled.

04-13005-02-en, October 2012 System


913
33 Trend Log Introduction
33.7 Disabling a Trend Log

33.7 Disabling a Trend Log


You disable a trend log to stop recording values.
For more information, see section 35.3 “Activation Methods” on page 999.

To disable a trend log


1. In WorkStation, in the System Tree pane, select the folder or server where the
trend log is located.
2. Select the trend log you want to disable
3. On the Actions menu, point to Activation, and then click Disable trend log
log.

The trend log is now disabled.

System 04-13005-02-en, October 2012


914
33 Trend Log Introduction
33.8 Editing the Activation Method in a Trend Log

33.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.
For more information, see section 35.3 “Activation Methods” on page 999.

To edit the activation method in a trend log


1. In WorkStation, in the System tree pane, select the folder or server where the
trend log is located.
2. Select the trend log you want to configure.
3. On the File menu, click Properties
Properties.

4.
In the Activation method box, select the new activation method.
5. Click OK.

04-13005-02-en, October 2012 System


915
34 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
34 Trend Log Types
34.1 Trend Log Types

34.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 33.1 “Trend Overview” on page 903.

04-13005-02-en, October 2012 System


919
34 Trend Log Types
34.1 Trend Log Types

Figure: Trend wizard flow chart

System 04-13005-02-en, October 2012


920
34 Trend Log Types
34.1 Trend Log Types

34.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 34.2 “Interval Trend Logs ” on page 923.

34.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 34.8 “Meter Trend Logs” on page 940.

34.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 34.14 “Change of Value Trend Logs” on page
969.

34.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 34.17 “Variable Triggered Trend Logs” on page
978.

34.1.5 Manual Trend Log


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 34.20 “Manual Trend Logs” on page 985.

04-13005-02-en, October 2012 System


921
34 Trend Log Types
34.1 Trend Log Types

34.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 34.24 “Implicit Trend Logs ” on page 993.

System 04-13005-02-en, October 2012


922
34 Trend Log Types
34.2 Interval Trend Logs

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

04-13005-02-en, October 2012 System


923
34 Trend Log Types
34.2 Interval Trend Logs

System 04-13005-02-en, October 2012


924
34 Trend Log Types
34.2 Interval Trend Logs

Figure: Interval trend log schematic.


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 35.3 “Activation Methods” on page 999.
An interval log 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.
For example, in the figure below, the interval trend log records a variable every
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.

04-13005-02-en, October 2012 System


925
34 Trend Log Types
34.2 Interval Trend Logs

Figure: Interval trend log with delta schematic.

System 04-13005-02-en, October 2012


926
34 Trend Log Types
34.2 Interval Trend Logs

An interval trend log with delta can reduce the storage of similar records, and may
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.

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.

04-13005-02-en, October 2012 System


927
34 Trend Log Types
34.3 Interval Trend Log Delta

34.3 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.
For example, in the figure below, the interval trend log records a variable every
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.

System 04-13005-02-en, October 2012


928
34 Trend Log Types
34.3 Interval Trend Log Delta

Figure: Interval trend log delta schematic

04-13005-02-en, October 2012 System


929
34 Trend Log Types
34.3 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 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
• 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.

System 04-13005-02-en, October 2012


930
34 Trend Log Types
34.4 Creating an Interval Trend Log

34.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.
For more information, see section 34.2 “Interval Trend Logs ” on page 923.

To create an interval trend log


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the trend log.
2. On the File menu, point to New and then click Trend
Trend.
3. In the object type list, select Interval Trend Log
Log.

4. In the Name box, type a name for the trend log.


Continued on next page

04-13005-02-en, October 2012 System


931
34 Trend Log Types
34.4 Creating an Interval Trend Log

5. In the Description box, type a description for the trend log.

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


Continued on next page

System 04-13005-02-en, October 2012


932
34 Trend Log Types
34.4 Creating an Interval Trend Log

10. Select a unit for the trend log values.

11. In the Prefix box, select the prefix of the unit.


12. Click Select
Select.
13. In the Interval box, type the log frequency.
Continued on next page

04-13005-02-en, October 2012 System


933
34 Trend Log Types
34.4 Creating an Interval Trend Log

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

System 04-13005-02-en, October 2012


934
34 Trend Log Types
34.4 Creating an Interval Trend Log

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


Next.
Continued on next page

04-13005-02-en, October 2012 System


935
34 Trend Log Types
34.4 Creating an Interval Trend Log

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

System 04-13005-02-en, October 2012


936
34 Trend Log Types
34.5 Configuring an Interval Trend Log

34.5 Configuring an Interval Trend Log


You configure the properties of an interval trend log to meet the unique needs of
your site.
For more information, see section 34.17 “Variable Triggered Trend Logs” on page
978.

To configure an interval trend Log


1. In WorkStation, in the System Tree pane, select the interval trend log you
want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the properties:
Property Description

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
35.3 “Activation Methods” on page 999.

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.

04-13005-02-en, October 2012 System


937
34 Trend Log Types
34.6 Editing the Interval of an Interval Trend Log

34.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 34.4 “Creating an Interval Trend Log ” on page
931.

To edit the interval of an interval trend log


1. In WorkStation, in the System Tree pane, select the folder or server where the
trend log is located.
2. Select the trend log you want to configure.
3. On the File menu, click Properties
Properties.
4. In the Interval box, type the new value.

5. Click OK.

System 04-13005-02-en, October 2012


938
34 Trend Log Types
34.7 Editing the Delta in an Interval Trend Log

34.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.
For more information, see section 34.2 “Interval Trend Logs ” on page 923.

To edit the delta in an interval trend log


1. In WorkStation, in the System tree pane, select the folder or server where the
trend log is located.
2. Select the trend log you want to configure.
3. On the File menu, click Properties
Properties.
4. In the Delta box, edit the value.

5. Click OK.

04-13005-02-en, October 2012 System


939
34 Trend Log Types
34.8 Meter Trend Logs

34.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.
For more information, see section 34.17 “Variable Triggered Trend Logs” on page
978.
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.

System 04-13005-02-en, October 2012


940
34 Trend Log Types
34.8 Meter Trend Logs

04-13005-02-en, October 2012 System


941
34 Trend Log Types
34.8 Meter Trend Logs

Figure: Meter trend log


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 38.15 “Manage Replacement of
Meter Dialog Box” on page 1115.

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 34.11 “Managing
Replacement of a Meter ” on page 965.

System 04-13005-02-en, October 2012


942
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

34.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.
For more information, see section 34.8 “Meter Trend Logs” on page 940.

To create a meter trend log and associated objects


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the trend log.
2. On the File menu, point to New and then click Trend
Trend.
3. In the object type list, select Meter Trend Log
Log.

4. In the Name box, type a name for the trend log.


Continued on next page

04-13005-02-en, October 2012 System


943
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

5. In the Description box, type a description for the trend log.

6. Click Next
Next.
7. In the Logged variable box, enter the variable that you want to log.

8. In the Trigger variable box, enter the variable that triggers the log.

9. In the Unit box, click the browse button .


Continued on next page

System 04-13005-02-en, October 2012


944
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

10. Select a unit for the trend log values.

11. In the Prefix box, select the prefix of the unit.


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

04-13005-02-en, October 2012 System


945
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

15. In the Clear when enabled box, select True to clear the trend log every time
the trend log is enabled.

16. Click Next


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

System 04-13005-02-en, October 2012


946
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

21. In the Max value box, enter the last value of the meter before it rolls over.

22. Click Next


Next.

23. In the Extended Trend Log box, click the browse button to create an
extended trend log and connect it to the trend log.

Continued on next page

04-13005-02-en, October 2012 System


947
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

24. Click Create


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

System 04-13005-02-en, October 2012


948
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

27. In the Description box, type a description for the extended trend log.

28. Click Next


Next.
29. In the Monitored trend log box, make sure that the meter log is entered.

Continued on next page

04-13005-02-en, October 2012 System


949
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

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 transfer rate.
32. In the Log records box, enter the number of records to be stored before old
ones are overwritten.
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 35.4 “Extended
Trend Logs” on page 1003.

Continued on next page

System 04-13005-02-en, October 2012


950
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

35. Click Create


Create.

36. In the Trend Log List box, click the browse button to create a trend log
list and connect it to the trend log.
37. Click Create
Create.

Continued on next page

04-13005-02-en, October 2012 System


951
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

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


Next.
Continued on next page

System 04-13005-02-en, October 2012


952
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

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.

Continued on next page

04-13005-02-en, October 2012 System


953
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

44. Click Create


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

Continued on next page

System 04-13005-02-en, October 2012


954
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

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


Next.
Continued on next page

04-13005-02-en, October 2012 System


955
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

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
36.8 “Trend Chart Axes” on page 1039.
• 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
36.8 “Trend Chart Axes” on page 1039.

Continued on next page

System 04-13005-02-en, October 2012


956
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

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

55. In the Name box, type a name for the series.


Continued on next page

04-13005-02-en, October 2012 System


957
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

56. In the Description box, type a description for the series.

57. Click Next


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

System 04-13005-02-en, October 2012


958
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

60. In the Show markers box, select True to display a marker for each recorded
value.

61. Click Create


Create.

Continued on next page

04-13005-02-en, October 2012 System


959
34 Trend Log Types
34.9 Creating a Meter Trend Log and Associated Objects

62. Click Create


Create.

63. Click Create


Create.
The meter trend log is now connected to an extended trend log, a trend log list, and
a trend chart.

System 04-13005-02-en, October 2012


960
34 Trend Log Types
34.10 Creating a Meter Trend Log

34.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.
For more information, see section 34.8 “Meter Trend Logs” on page 940.

To create a meter trend log


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the trend log.
2. On the File menu, point to New
New, and then click Trend
Trend.
3. Select Meter Trend Log
Log.

4. In the Name box, type a name for the trend log.


5. In the Description box, type a description.
6. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


961
34 Trend Log Types
34.10 Creating a Meter Trend Log

7. In the Logged variable box, enter the variable that you want to log.

8. In the Trigger variable box, enter the variable that triggers the log.

9. In the Unit box, click the browse button .


10. Select a unit for the trend log values.

Continued on next page

System 04-13005-02-en, October 2012


962
34 Trend Log Types
34.10 Creating a Meter Trend Log

11. In the Prefix box, select the prefix of the unit.


12. Click Select
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 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.
15. In the Clear when enabled box, select True to clear the trend log every time
the trend log is enabled.
16. Click Next
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
Next.
Continued on next page

04-13005-02-en, October 2012 System


963
34 Trend Log Types
34.10 Creating a Meter Trend Log

23. In the Extended Trend Log box, click the Browse button to create an
extended trend log and connect it to the trend log.

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

System 04-13005-02-en, October 2012


964
34 Trend Log Types
34.11 Managing Replacement of a Meter

34.11 Managing Replacement of a Meter


You have to manage the meter settings each time a meter is replaced.
For more information, see section 34.8 “Meter Trend Logs” on page 940.

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

04-13005-02-en, October 2012 System


965
34 Trend Log Types
34.11 Managing Replacement of a Meter

9. In the Max value box, type the last value of the new meter before it rolls over.

10. Click OK
OK.

System 04-13005-02-en, October 2012


966
34 Trend Log Types
34.12 Configuring a Meter Trend Log

34.12 Configuring a Meter Trend Log


You configure the properties of a meter trend log to meet the unique needs of your
site.
For more information, see section 34.8 “Meter Trend Logs” on page 940.

To configure a meter trend log


1. In WorkStation, in the System Tree pane, select the meter trend log you want
to configure.
2. On the File menu, click Properties
Properties.
3. Edit the properties:
Component Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is enabled.

Clear when enabled Select True to clear the trend log when it
is enabled.

Delta Select the minimum value change that


triggers a new record.

Logged variable Enter the variable that you want to log.

Trigger variable Enter the variable that triggers the trend


log to start recording.

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 34.17
“Variable Triggered Trend Logs” on page
978.

Log size Select the log size to store before old


records are overwritten.

4. Click OK
OK.

04-13005-02-en, October 2012 System


967
34 Trend Log Types
34.13 Displaying Meter Change History

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

For more information, see section 34.8 “Meter Trend Logs” on page 940.

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
OK, to close the dialog box.
It is important that all meter changes are registered in the Manage replacement of
meter dialog box.

System 04-13005-02-en, October 2012


968
34 Trend Log Types
34.14 Change of Value Trend Logs

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

04-13005-02-en, October 2012 System


969
34 Trend Log Types
34.14 Change of Value Trend Logs

System 04-13005-02-en, October 2012


970
34 Trend Log Types
34.14 Change of Value Trend Logs

Figure: Change of value trend log schematic.


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 35.3 “Activation Methods” on page 999.

04-13005-02-en, October 2012 System


971
34 Trend Log Types
34.15 Creating a Change of Value Trend Log

34.15 Creating a Change of Value Trend Log


You create a change of value trend log to record the changes of a variable.
For more information, see section 34.14 “Change of Value Trend Logs” on page
969.

To create a change of value trend log


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the trend log.
2. On the File menu, point to New
New, and then click Trend
Trend.
3. In the object type list, select Change of Value Trend Log
Log.

4. In the Name box, type a name for the trend log.


Continued on next page

System 04-13005-02-en, October 2012


972
34 Trend Log Types
34.15 Creating a Change of Value Trend Log

5. In the Description box, type a description for the trend log.

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

9. In the Unit box, click the browse button .


Continued on next page

04-13005-02-en, October 2012 System


973
34 Trend Log Types
34.15 Creating a Change of Value Trend Log

10. Select a unit for the trend log values.

11. In the Prefix box, select the prefix of the unit.


12. Click Select
Select.
13. In the Log size box, enter the number of records to be stored before old
values are overwritten.
14. In the Clear when enabled box, select True to clear the trend log every time
the trend log is enabled.
Continued on next page

System 04-13005-02-en, October 2012


974
34 Trend Log Types
34.15 Creating a Change of Value Trend Log

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


Next.
Continued on next page

04-13005-02-en, October 2012 System


975
34 Trend Log Types
34.15 Creating a Change of Value Trend Log

17. In the Extended Trend Log box, click the browse button to create an
extended trend log and connect it to the trend log.

18. In the Trend Log List box, click the browse button to create a trend log
list and connect it to the trend log.
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
Create.

System 04-13005-02-en, October 2012


976
34 Trend Log Types
34.16 Configuring a Change of Value Trend Log

34.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.
For more information, see section 34.14 “Change of Value Trend Logs” on page
969.

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.
2. On the File menu, click Properties
Properties.
3. Edit the properties:
Property Description

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
35.3 “Activation Methods” on page 999.

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.

Delta Select the minimum value change that


triggers a new record.

Log size Select the log size to store before old


records are overwritten.

4. Click OK
OK.

04-13005-02-en, October 2012 System


977
34 Trend Log Types
34.17 Variable Triggered Trend Logs

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

System 04-13005-02-en, October 2012


978
34 Trend Log Types
34.17 Variable Triggered Trend Logs

04-13005-02-en, October 2012 System


979
34 Trend Log Types
34.17 Variable Triggered Trend Logs

Figure: Variable triggered trend log schematic


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

System 04-13005-02-en, October 2012


980
34 Trend Log Types
34.18 Creating a Variable Triggered Trend Log

34.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.
For more information, see section 34.2 “Interval Trend Logs ” on page 923.

To create a variable triggered trend log


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the trend log.
2. On the File menu, point to New
New, and then click Trend
Trend.
3. Select Variable Triggered Trend Log
Log.

4. In the Name box, type a name for the trend log.


5. In the Description box, type a description.
6. Click Next
Next.
Continued on next page

04-13005-02-en, October 2012 System


981
34 Trend Log Types
34.18 Creating a Variable Triggered Trend Log

7. In the Logged variable box, enter the variable you want to log.

8. In the Trigger variable box, enter the variable that triggers the log.

9. In the Unit box, click browse button .


10. Select a unit for the trend log values.

Continued on next page

System 04-13005-02-en, October 2012


982
34 Trend Log Types
34.18 Creating a Variable Triggered Trend Log

11. In the Prefix box, select the prefix of the unit.


12. Click Select
Select.
13. In the Trigger when box, select Change to true to log the variable when the
trigger variable changes to true.
14. In the Log records box, select the number of records to be stored before old
ones are overwritten.
15. In the Clear when enabled box, select True to clear the trend log every time
the trend log is enabled.
16. Click Next
Next.

17. In the Extended Trend Log box, click the Browse button to create an
extended trend log and connect it to the trend log.

18. In the Trend Log List box, click the Browse button to create a trend log
list and connect it to the trend log.

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
Create.
The variable triggered trend log is created in the selected folder.

04-13005-02-en, October 2012 System


983
34 Trend Log Types
34.19 Configuring a Variable Triggered Trend Log

34.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.
For more information, see section 34.17 “Variable Triggered Trend Logs” on page
978.

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.
2. On the File menu, click Properties
Properties.
3. Edit the properties:
Component Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is enabled.

Clear when enabled Select True to clear the trend log when it
is enabled.

Delta Select the minimum value change that


triggers a new record.

Logged variable Enter the variable that you want to log.

Trigger variable Enter the variable that triggers the trend


log to start recording.

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 34.17
“Variable Triggered Trend Logs” on page
978.

Log size Select the log size to store before old


records are overwritten.

4. Click OK.

System 04-13005-02-en, October 2012


984
34 Trend Log Types
34.20 Manual Trend Logs

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

04-13005-02-en, October 2012 System


985
34 Trend Log Types
34.20 Manual Trend Logs

System 04-13005-02-en, October 2012


986
34 Trend Log Types
34.20 Manual Trend Logs

Figure: Manual trend log schematic.

04-13005-02-en, October 2012 System


987
34 Trend Log Types
34.21 Creating a Manual Trend Log

34.21 Creating a Manual Trend Log


You create a manual trend log that records data that you manually enter.
For more information, see section 34.20 “Manual Trend Logs” on page 985.

To create a manual trend log


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the trend log.
2. On the File menu, point to New
New, and then click Trend
Trend.
3. Select Manual Trend Log.

4. In the Name box, type a name for the trend log.


5. In the Description box, type a description.
6. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


988
34 Trend Log Types
34.21 Creating a Manual Trend Log

7. In the Unit box, click browse button .

8. Select a unit for the trend log values.

9. In the Prefix box, select the prefix of the unit.


10. Click Select
Select.
Continued on next page

04-13005-02-en, October 2012 System


989
34 Trend Log Types
34.21 Creating a Manual Trend Log

11. Click Next


Next.

12. In the Extended Trend Log box, click the Browse button to create an
extended trend log and connect it to the trend log.

13. In the Trend Log List box, click the Browse button to create a trend log
list and connect it to the trend log.

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
Create.
The manual trend log is created in the selected folder. You have to manually add
the records to the manual trend log.

System 04-13005-02-en, October 2012


990
34 Trend Log Types
34.22 Configuring a Manual Trend Log

34.22 Configuring a Manual Trend Log


You configure the properties of a manual trend log to meet the unique needs of your
site.
For more information, see section 34.20 “Manual Trend Logs” on page 985.

To configure a manual trend log


1. In WorkStation, in the System Tree pane, select the manual trend log you
want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the properties:
Component Description

Log data Enter the unit the trend log stores the
records in.

4. Click OK
OK.

04-13005-02-en, October 2012 System


991
34 Trend Log Types
34.23 Adding a Trend Log Record to a Manual Trend Log

34.23 Adding a Trend Log Record to a Manual


Trend Log
You have to manually add records to a manual trend log.
For more information, see section 34.20 “Manual Trend Logs” on page 985.

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


1. In WorkStation, in the System Tree pane, select the folder or server where the
trend log is located.
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
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
record.
9. Click Close
Close.
The record is now added to the trend log.

System 04-13005-02-en, October 2012


992
34 Trend Log Types
34.24 Implicit Trend Logs

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

04-13005-02-en, October 2012 System


993
35 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
35 Trend Log Functions
35.1 Trend Log Functions

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

35.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 35.2 “Log Record Storage” on page 998.

35.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.
For more information, see section 35.3 “Activation Methods” on page 999.

35.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 35.4 “Extended Trend Logs” on page 1003.

04-13005-02-en, October 2012 System


997
35 Trend Log Functions
35.2 Log Record Storage

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

System 04-13005-02-en, October 2012


998
35 Trend Log Functions
35.3 Activation Methods

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

35.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: Start condition, Always active

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

04-13005-02-en, October 2012 System


999
35 Trend Log Functions
35.3 Activation Methods

Figure: Start condition, 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.

System 04-13005-02-en, October 2012


1000
35 Trend Log Functions
35.3 Activation Methods

Figure: Start condition, Variable controlled that follows the start variable.

35.3.3 Start at activation time


Use start at activation time to have the trend log start recording values at a specified
time.

04-13005-02-en, October 2012 System


1001
35 Trend Log Functions
35.3 Activation Methods

Figure: Start condition, Start at activation time

System 04-13005-02-en, October 2012


1002
35 Trend Log Functions
35.4 Extended Trend Logs

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

04-13005-02-en, October 2012 System


1003
35 Trend Log Functions
35.4 Extended Trend Logs

Figure: Never connect more than one extended trend log to a trend log or extended trend
log.
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 set


percentage threshold of records on the trend
log is reached.

Maximum transfer interval Transfers records at a set 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.

System 04-13005-02-en, October 2012


1004
35 Trend Log Functions
35.4 Extended Trend Logs

04-13005-02-en, October 2012 System


1005
35 Trend Log Functions
35.4 Extended Trend Logs

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.
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 in 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, all references to the log point are lost.

System 04-13005-02-en, October 2012


1006
35 Trend Log Functions
35.5 Creating an Extended Trend Log

35.5 Creating an Extended Trend Log


You create an extended trend log to store log records for a longer period of time
without over consuming the memory in the Automation Server. Extended trend logs
are also required for generating reports using Building Operation WebReports.
For more information, see section 35.4 “Extended Trend Logs” on page 1003.

To create an extended trend log


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the extended trend log.
2. On the File menu, point to New and then click Trend
Trend.
3. In the object type list, select Extended Trend Log
Log.

4. In the Name box, type a name for the extended trend log.
Continued on next page

04-13005-02-en, October 2012 System


1007
35 Trend Log Functions
35.5 Creating an Extended Trend Log

5. In the Description box, type a description for the extended log.

6. Click Next
Next.
7. In the Monitored trend log box, enter the trend log that you want to transfer
records from.

Continued on next page

System 04-13005-02-en, October 2012


1008
35 Trend Log Functions
35.5 Creating an Extended Trend Log

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 transfer rate.
10. In the Log records box, enter the number of records to be stored before old
ones are overwritten.
11. 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.
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 example, to
generate a complete report. For more information, see section 35.4 “Extended
Trend Logs” on page 1003.

13. Click Create


Create.
The extended trend log is created and transfers and stores records from a trend
log.

04-13005-02-en, October 2012 System


1009
35 Trend Log Functions
35.6 Configuring an Extended Trend Log

35.6 Configuring an Extended Trend Log


You configure the properties of an extended trend log to meet the unique needs of
your site.
For more information, see section 35.4 “Extended Trend Logs” on page 1003.

To configure an extended trend log


1. In WorkStation, in the System Tree pane, select the extended trend log you
want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the basic properties:
Component Description

Monitored trend log Enter the trend log that you want to
transfer records from.

Log data Enter the unit the trend log stores the
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 interva


interval Select the maximum transfer rate of 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 35.4 “Extended
Trend Logs” on page 1003.

4. Click OK
OK.

System 04-13005-02-en, October 2012


1010
35 Trend Log Functions
35.7 Editing the Threshold Property of an Extended Trend Log

35.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.
For more information, see section 35.4 “Extended Trend Logs” on page 1003.

To edit the treshold property of an extended trend log


1. In WorkStation, in the System tree pane, select the folder or server where the
trend log is located.
2. Select the extended trend log you want to configure.
3. On the File menu, click Properties
Properties.
4. In the Treshold box, select the new value.

5. Click OK
OK.

04-13005-02-en, October 2012 System


1011
35 Trend Log Functions
35.8 Editing the Maximum Transfer Interval Property of an Extended Trend Log

35.8 Editing the Maximum Transfer Interval


Property of an Extended Trend Log
You edit the maximum transfer interval property to set a time interval between two
transfers.
For more information, see section 35.4 “Extended Trend Logs” on page 1003.

To edit the maximum transfer interval property of an extended


trend log
1. In WorkStation, in the System tree pane, select the folder or server where the
trend log is located.
2. Select the extended trend log you want to configure.
3. On the File menu, click Properties
Properties.
4. In the Maximum transfer interval box, select the new value.

5. Click OK
OK.

System 04-13005-02-en, October 2012


1012
35 Trend Log Functions
35.9 Editing the Number of Log Records for a Trend Log

35.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
records are overwritten.
For more information, see section 35.2 “Log Record Storage” on page 998.

To edit the number of log records for a trend log


1. In WorkStation, in the System Tree pane, select the folder or server where the
trend log is located.
2. Select the trend log you want to configure.
3. On the File menu, click Properties
Properties.
4. In the Log records box, enter the new value.

5. Click OK
OK.

04-13005-02-en, October 2012 System


1013
35 Trend Log Functions
35.10 Editing an Extended Trend Log to be Included in Reports

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

To edit an extended trend log to be included in reports


1. In WorkStation, in the System tree pane, select the folder or server where the
trend log is located.
2. Select the extended trend log you want to configure.
3. On the File menu, click Properties
Properties.
4. In the Include in Reports? box, select True
True.
The extended trend log is set up to be included in reports.

System 04-13005-02-en, October 2012


1014
35 Trend Log Functions
35.11 Manually Transferring Records to the Extended Trend Log

35.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.
For more information, see section 35.4 “Extended Trend Logs” on page 1003.

To manually transfer records to the extended trend log


1. In WorkStation, in the System Tree pane, select the folder or server where 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
Activation, and then click Force transfer
transfer.

The monitored trend log is now transferred to the extended trend log.

04-13005-02-en, October 2012 System


1015
36 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 Mode
Temporary Trend Log Lists and Trend Charts
Opening a Trend Log in a Temporary Trend Chart
Saving a Temporary Trend Chart
36 Trend Charts
36.1 Trend Charts

36.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 in local time 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.

04-13005-02-en, October 2012 System


1019
36 Trend Charts
36.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.

System 04-13005-02-en, October 2012


1020
36 Trend Charts
36.1 Trend Charts

04-13005-02-en, October 2012 System


1021
36 Trend Charts
36.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.
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.

System 04-13005-02-en, October 2012


1022
36 Trend Charts
36.1 Trend Charts

04-13005-02-en, October 2012 System


1023
36 Trend Charts
36.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.

System 04-13005-02-en, October 2012


1024
36 Trend Charts
36.1 Trend Charts

36.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 36.18 “Trend Chart Series” on page 1054.

36.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 36.8 “Trend Chart Axes” on page 1039.

36.1.3 Trend Chart Axes in WebStation


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

36.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. A real-
time plot has to be displayed in local time mode because the variable is displayed in
real time.
For more information, see section 36.15 “Real-time Plotting” on page 1047.

36.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 zone, server time zone, and UTC time zone.
For more information, see section 36.21 “Time Zone Modes in a Trend Chart” on
page 1062.

36.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 37.7 “Calculation Methods” on page 1083.

04-13005-02-en, October 2012 System


1025
36 Trend Charts
36.1 Trend Charts

36.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.9 “Temporary Trend Log Lists and Trend
Charts” on page 1090.

System 04-13005-02-en, October 2012


1026
36 Trend Charts
36.2 Configuring a Trend Chart

36.2 Configuring a Trend Chart


You configure the properties of a trend chart to meet the unique needs of your site.
For more information, see section 36.1 “Trend Charts” on page 1019.

To configure a trend chart


1. In WorkStation, in the System Tree pane, select the trend chart you want to
configure.
2. On the File menu, click Properties
Properties.
3. Click the Basic tab.
Continued on next page

04-13005-02-en, October 2012 System


1027
36 Trend Charts
36.2 Configuring a Trend Chart

4. Edit the basic properties:


Property Description

Time mode Select the time mode of the x-axis.

Start time Enter the absolute start time when Time


mode is set to Absolute
Absolute. This time is the
leftmost point of the x-axis.

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 series Select True to show information on every
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 more information, see section 50.20
“Create Object Wizard – Naming the
Object Page” on page 1434.

Edit Click to edit a selected series. For more


information, see section 38.25 “Trend
Chart Series Properties” on page 1131.

Remove Click to remove a selected series.

5. Click the Series tab.


Continued on next page

System 04-13005-02-en, October 2012


1028
36 Trend Charts
36.2 Configuring a Trend Chart

6. Edit the series properties:


7. Click OK
OK.

04-13005-02-en, October 2012 System


1029
36 Trend Charts
36.3 Showing Trend Chart Grid Lines

36.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 38.22 “Trend Chart Settings Dialog Box – Axes
Tab” on page 1127.

To show trend chart grid lines


1. In WorkStation, in the System Tree pane, select the trend chart you want to
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
OK.
Grid lines are now shown in the trend chart. Repeat the procedure to hide the grid
lines.

System 04-13005-02-en, October 2012


1030
36 Trend Charts
36.3 Showing Trend Chart Grid Lines

04-13005-02-en, October 2012 System


1031
36 Trend Charts
36.4 Adding a Trend Log Series to a Trend Chart

36.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.
For more information, see section 36.18 “Trend Chart Series” on page 1054.

To add a trend log series to a trend chart


1. In WorkStation, in the System Tree pane, select the trend chart you want to
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
Save.

System 04-13005-02-en, October 2012


1032
36 Trend Charts
36.5 Adding a Real-time Trend Series to a Trend Chart

36.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.
For more information, see section 36.18 “Trend Chart Series” on page 1054.

To add a real-time trend series to a trend chart


1. In WorkStation, in the System Tree pane, select the trend chart you want to
add a trend series to.
2. On the File menu, click Properties
Properties.
3. Under Series Configuration Settings
Settings, click Add
Add.

Continued on next page

04-13005-02-en, October 2012 System


1033
36 Trend Charts
36.5 Adding a Real-time Trend Series to a Trend Chart

4. In the object type list, select Real Time Trend Series


Series.

5. In the Name box, type a name for the series.


6. In the Description box, type a description for the series.

7. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


1034
36 Trend Charts
36.5 Adding a Real-time Trend Series to a Trend Chart

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.


10. In the Show markers box, select True to display a marker for each recorded
value.

Continued on next page

04-13005-02-en, October 2012 System


1035
36 Trend Charts
36.5 Adding a Real-time Trend Series to a Trend Chart

11. Click Create


Create.

12. Click OK
OK.

System 04-13005-02-en, October 2012


1036
36 Trend Charts
36.6 Editing the Trend Chart Settings

36.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.
For more information, see section 36.8 “Trend Chart Axes” on page 1039.

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

04-13005-02-en, October 2012 System


1037
36 Trend Charts
36.7 Activating Trend Chart Live Update

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

Note
To activate the live update requires that the trend chart is configured to local time
zone mode and presents a Building Operation trend log.

For more information, see section 36.1 “Trend Charts” on page 1019.

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

System 04-13005-02-en, October 2012


1038
36 Trend Charts
36.8 Trend Chart Axes

36.8 Trend Chart Axes


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.

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.

04-13005-02-en, October 2012 System


1039
36 Trend Charts
36.8 Trend Chart Axes

Figure: Grid lines, schematic

System 04-13005-02-en, October 2012


1040
36 Trend Charts
36.9 Scroll the Trend Chart X-Axis to the Current Time

36.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.
For more information, see section 36.8 “Trend Chart Axes” on page 1039.

To scoll the trend chart x-axis to current time


1. In WorkStation, in the System Tree pane, select the trend chart you want to
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.

04-13005-02-en, October 2012 System


1041
36 Trend Charts
36.10 Configuring the X-Axis with a Relative Time Span

36.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.
For more information, see section 36.8 “Trend Chart Axes” on page 1039.

To configure the x-axis with a relative time span


1. In WorkStation, in the System Tree pane, select the trend chart you want to
configure.

2. On the Trend Chart toolbar, click Open trend chart settings button .
3. In the Time mode box, select Relative (to current time)
time).

4. In the Time span box, type the length of the x-axis to display before the
current time.
5. Click OK
OK.
The x-axis is now configured with a relative time span.

System 04-13005-02-en, October 2012


1042
36 Trend Charts
36.11 Configuring the X-Axis with an Absolute Time Span

36.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.
For more information, see section 36.8 “Trend Chart Axes” on page 1039.

To configure the x-axis with an absolute time span


1. In WorkStation, in the System Tree pane, select the trend chart you want to
configure.

2. On the Trend Chart toolbar, click the Open trend chart settings button .
3. In the Time mode box, select Absolute (start and end time)
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
OK.
The x-axis is now configured with an absolute time span.

04-13005-02-en, October 2012 System


1043
36 Trend Charts
36.12 Manually Configuring the Y-Axis Scale

36.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.
For more information, see section 36.8 “Trend Chart Axes” on page 1039.

To manually configure the y-axis scale


1. In WorkStation, in the System Tree pane, select the trend chart you want to
configure.

2. On the Trend Chart toolbar, click the Open trend chart settings button .
3. Clear Auto scale left y-axis and Auto scale right y-axis
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
OK.
The y-axis is now set with a fixed scale.

System 04-13005-02-en, October 2012


1044
36 Trend Charts
36.13 Automatically Configuring the Y-Axis Scale

36.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.
For more information, see section 36.8 “Trend Chart Axes” on page 1039.

To automatically configure the y-axis scale


1. In WorkStation, in the System Tree pane, select the trend chart you want to
configure.

2. On the Trend Chart toolbar, click the Open trend chart settings button .
3. Select Auto Scale left y-axis and Auto Scale right y-axis
y-axis.

4. Click OK
OK.
The y-axis scale is now set automatically and updated with the presented series.

04-13005-02-en, October 2012 System


1045
36 Trend Charts
36.14 Assigning a Series to a Y-Axis

36.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.
For more information, see section 36.8 “Trend Chart Axes” on page 1039.

To assign a series to a y-axis


1. In WorkStation, in the System Tree pane, select the trend chart you want to
configure.
2. On the Trend Chart toolbar, click the Open trend chart settings button

.
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
OK.
The series is now assigned to the left or right y-axis.

System 04-13005-02-en, October 2012


1046
36 Trend Charts
36.15 Real-time Plotting

36.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. A real-
time plot has to be displayed in local time mode because the variable is displayed in
real time.

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 plotting trend chart, a trend chart object is created that
you can reach from the system tree.

04-13005-02-en, October 2012 System


1047
36 Trend Charts
36.15 Real-time Plotting

Note
• A real-time plot can only be displayed in a trend chart and not in a trend log
list

System 04-13005-02-en, October 2012


1048
36 Trend Charts
36.16 Creating a Real-time Plot Trend Chart

36.16 Creating a Real-time Plot Trend Chart


You create a real-time plot trend chart to display a variable in real time.
For more information, see section 36.15 “Real-time Plotting” on page 1047.

To create a real-time plot trend chart


1. In WorkStation, in the System Tree
Tree, select the variable you want to display in
a real-time plot trend chart.
2. On the Actions menu, point to View
View, point to Trend charts
charts, and then click
New Trend chart.

3. Click the Save button .


4. Browse to where you want to save the real-time plot trend chart.
5. Click Save
Save.
By saving the real-time plot trend chart, a trend chart object is created in the
System Tree pane.

04-13005-02-en, October 2012 System


1049
36 Trend Charts
36.17 Creating a Trend Chart that Monitors a Variable in Real-Time

36.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.
For more information, see section 36.15 “Real-time Plotting” on page 1047.

To create a trend chart that monitors a variable in real-time


1. In WorkStation, in the System Tree pane, select the folder or Building
Operation server where you want to create the trend chart.
2. On the File menu, point to New
New, and then click Trend
Trend.
3. Select Trend Chart
Chart.

4. In the Name box, type a name for the trend chart.


5. In the Description box, type a description.
6. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


1050
36 Trend Charts
36.17 Creating a Trend Chart that Monitors a Variable in Real-Time

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

04-13005-02-en, October 2012 System


1051
36 Trend Charts
36.17 Creating a Trend Chart that Monitors a Variable in Real-Time

12. Select Real Time Trend Series


Series.

13. In the Name box, type a name for the series.


14. In the Description box, type a description.
15. Click Next
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.


Continued on next page

System 04-13005-02-en, October 2012


1052
36 Trend Charts
36.17 Creating a Trend Chart that Monitors a Variable in Real-Time

18. In the Show markers box, select True to display a marker for each recorded.
19. Click Create
Create.
20. In the Configure real-time trend series dialog box, click Create
Create.
The real-time trend series trend chart is created in the selected folder.

04-13005-02-en, October 2012 System


1053
36 Trend Charts
36.18 Trend Chart Series

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

System 04-13005-02-en, October 2012


1054
36 Trend Charts
36.18 Trend Chart Series

Figure: Presentation with markers, schematic

04-13005-02-en, October 2012 System


1055
36 Trend Charts
36.19 Creating a Trend Chart that Monitors a Trend Log Series

36.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.
For more information, see section 36.1 “Trend Charts” on page 1019.

To Create a trend chart that monitors a trend log series


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the trend chart.
2. On the File menu, point to New
New, and then click Trend
Trend.
3. In the object type list, select Trend Chart.

4. In the Name box, type a name for the trend chart.


5. In the Description box, type a description for the trend chart.
6. Click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


1056
36 Trend Charts
36.19 Creating a Trend Chart that Monitors a Trend Log Series

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

04-13005-02-en, October 2012 System


1057
36 Trend Charts
36.19 Creating a Trend Chart that Monitors a Trend Log Series

12. In the object type list, select Trend Log Series


Series.

13. In the Name box, type a name for the series.


14. In the Description box, type a description for the series.
15. Click Next
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.


Continued on next page

System 04-13005-02-en, October 2012


1058
36 Trend Charts
36.19 Creating a Trend Chart that Monitors a Trend Log Series

18. In the Show markers box, select True to display a marker for each recorded
value.
19. In the Show events box, select True to display event symbols.
20. Click Create
Create.
21. In the Configure Trend Chart dialog box, click Create.
The trend log series trend chart is created in the selected folder.

04-13005-02-en, October 2012 System


1059
36 Trend Charts
36.20 Attaching a Calculation Method to a Trend Chart Series

36.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.
For more information, see section 37.7 “Calculation Methods” on page 1083.

To attach a calculation method to a trend chart series


1. In WorkStation, in the System Tree pane, select the trend chart you want to
attach a calculation method to.

2. On the Trend Chart toolbar, click Open trend chart settings button .
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.
Continued on next page

System 04-13005-02-en, October 2012


1060
36 Trend Charts
36.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
OK.
A calculation method is now attached to the series.

04-13005-02-en, October 2012 System


1061
36 Trend Charts
36.21 Time Zone Modes in a Trend Chart

36.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 zone, server time zone, and UTC 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.
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.
To adjust the Automation Server time, time zone, and DST, you have to access the
Automation Server through a WorkStation. In WorkStation, you configure the time
settings in the Date & Time view of the Automation Server.

36.21.1 Local Time Zone


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.

Figure: Local time zone, schematic

System 04-13005-02-en, October 2012


1062
36 Trend Charts
36.21 Time Zone Modes in a Trend Chart

36.21.2 Server Time Zone


A trend chart presented in Server time displays trend logs in local time from the
server perspective.
The same variable logged on servers in different time zones is displayed with server
time zone adjusted time stamps for corresponding values. The local times of the
servers are UTC ± correction for the time zone including DST. For example, if the
server is located in Copenhagen the presentation time is UTC + 1 hour.

Figure: Server time zone, schematic

36.21.3 UTC Time Zone


A trend chart presented in UTC displays trend logs in UTC regardless of where the
server is located.
The same variable logged on servers in different time zones are displayed with UTC
adjusted time stamps for corresponding values. UTC time zone mode can be useful
when you need to compare trend logs on servers located in different time zones.

04-13005-02-en, October 2012 System


1063
36 Trend Charts
36.21 Time Zone Modes in a Trend Chart

Figure: UTC time zone, schematic

System 04-13005-02-en, October 2012


1064
36 Trend Charts
36.22 Configuring the Trend Chart Time Zone Mode

36.22 Configuring the Trend Chart Time Zone


Mode
You display the time of the records in local time, server time, or in UTC. By
changing the time zone settings you make it easier to interpret the time stamp.
For more information, see section 36.21 “Time Zone Modes in a Trend Chart” on
page 1062.

To configure the trend chart time zone mode


1. In WorkStation, in the System Tree pane, select the trend chart you want to
configure.

2. On the Trend Chart toolbar, click the Open trend chart settings button .
3. In the Time zone box, select a time zone to display the trend chart 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 real time from the perspective of
UTC.

4. Click OK
OK.
The x-axis is now set according to the selected time zone mode.

04-13005-02-en, October 2012 System


1065
36 Trend Charts
36.23 Temporary Trend Log Lists and Trend Charts

36.23 Temporary Trend Log Lists and 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.

Figure: Trend log displayed in a temporary trend log list and temporary trend chart.

Note
• The trend log list must be manually refreshed.

System 04-13005-02-en, October 2012


1066
36 Trend Charts
36.24 Opening a Trend Log in a Temporary Trend Chart

36.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 37.9 “Temporary Trend Log Lists and Trend
Charts” on page 1090.

To open a trend log in a temporary trend chart


1. In WorkStation, in the System Tree pane, select the folder or server where the
trend log is located.
2. Select the trend log you want to open as a temporary trend chart.
3. On the Actions menu, point to View
View, point to Trend charts
charts, and then click
New Trend chart
chart.

The trend chart is displayed in the work area under a generic name.

04-13005-02-en, October 2012 System


1067
36 Trend Charts
36.25 Saving a Temporary Trend Chart

36.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.
3. In the Name box, type a name for the trend chart.
4. Click Save
Save.

System 04-13005-02-en, October 2012


1068
37 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 and Trend Charts
Saving a Temporary Trend Log List
37 Trend Log Lists
37.1 Trend Log Lists

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

04-13005-02-en, October 2012 System


1071
37 Trend Log Lists
37.1 Trend Log Lists

Figure: Trend log list, schematic

System 04-13005-02-en, October 2012


1072
37 Trend Log Lists
37.1 Trend Log Lists

37.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 37.4 “Time Zone Modes in a Trend Log List” on
page 1078.

37.1.2 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 37.7 “Calculation Methods” on page 1083.

37.1.3 Temporary Trend Log Lists


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.9 “Temporary Trend Log Lists and Trend
Charts” on page 1090.

04-13005-02-en, October 2012 System


1073
37 Trend Log Lists
37.2 Creating a Trend Log List

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

For more information, see section 37.1 “Trend Log Lists” on page 1071.

To create a trend log list


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the trend log list.
2. On the File menu, point to New and then click Trend
Trend.
3. In the object list, select Trend Log List
List.

4. In the Name box, type a name for the trend log list.
Continued on next page

System 04-13005-02-en, October 2012


1074
37 Trend Log Lists
37.2 Creating a Trend Log List

5. In the Description box, type a description for the trend log list.

6. Click Next
Next.
7. In the Display trend log box, enter the trend log you want to display in the
trend log list.

Continued on next page

04-13005-02-en, October 2012 System


1075
37 Trend Log Lists
37.2 Creating a Trend Log List

8. In the Log space (records) box, enter the maximum number of rows to
display in the trend log.

9. Click Create
Create.

System 04-13005-02-en, October 2012


1076
37 Trend Log Lists
37.3 Configuring a Trend Log List

37.3 Configuring a Trend Log List


You configure the properties of a trend log list to meet the unique needs of your
site.
For more information, see section 37.1 “Trend Log Lists” on page 1071.

To configure a trend log list


1. In WorkStation, in the System Tree pane, select the trend log list you want to
configure.
2. On the File menu, click Properties
Properties.
3. Edit the properties:
Component Description

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 37.4 “Time Zone Modes in a
Trend Log List” on page 1078.

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


calculation method is to be executed.

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.

4. Click OK
OK.

04-13005-02-en, October 2012 System


1077
37 Trend Log Lists
37.4 Time Zone Modes in a Trend Log List

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

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

37.4.2 Server Time Zone


Use server time zone to display in real time from the perspective of the server.
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 and this is how it is displayed in the
client trend log list.

System 04-13005-02-en, October 2012


1078
37 Trend Log Lists
37.4 Time Zone Modes in a Trend Log List

Figure: Trend log list displayed on a client with server time zone.

37.4.3 UTC Time Zone


Use UTC time zone to display the trend logs in the perspective of UTC.
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. 8:00 Moscow time is 5:00 UTC time,
so the Tiblisi displays 5:00-10:00 in the trend log list.

04-13005-02-en, October 2012 System


1079
37 Trend Log Lists
37.4 Time Zone Modes in a Trend Log List

Figure: Trend log list displayed on a client with UTC time zone.

System 04-13005-02-en, October 2012


1080
37 Trend Log Lists
37.5 Displaying the Trend Log List Time Stamps with Fractions

37.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.
For more information, see section 37.1 “Trend Log Lists” on page 1071.

To display time stamps with fractions


1. In WorkStation, in the System Tree pane, select the trend log list you want to
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.

04-13005-02-en, October 2012 System


1081
37 Trend Log Lists
37.6 Configuring the Trend Log List Time Zone

37.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 37.4 “Time Zone Modes in a Trend Log List” on
page 1078.

To configure the trend log list time zone


1. In WorkStation, in the System Tree pane, select the trend log list you want to
configure.
2. On the Trend log list toolbar, click the Open trend log list settings button

.
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
OK.
The records in the trend log are now displayed in the selected time zone mode.

System 04-13005-02-en, October 2012


1082
37 Trend Log Lists
37.7 Calculation Methods

37.7 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.
The following calculation methods are available:
• Maximum
• Minimum
• Average
• Summary
• Delta
• Delta over period
• Meter consumption

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.

37.7.1 Maximum
The maximum value of each period is presented.

Figure: Maximum calculation method, schematic

04-13005-02-en, October 2012 System


1083
37 Trend Log Lists
37.7 Calculation Methods

Important
If the log point is offline or no value is produced during the interval, no value is
displayed.

37.7.2 Minimum
The minimum value of each period is presented.

Figure: Minimum calculation method, schematic

Important
If the log point is offline or no value is produced during the interval, no value is
displayed.

37.7.3 Average
The average of the values in each period is calculated and presented.

System 04-13005-02-en, October 2012


1084
37 Trend Log Lists
37.7 Calculation Methods

Figure: Average calculation method, schematic

Important
If the log point is offline or no value is produced during the interval, no value is
displayed.

37.7.4 Summary
The sum of the values in each period is calculated and presented.

04-13005-02-en, October 2012 System


1085
37 Trend Log Lists
37.7 Calculation Methods

Figure: Summary calculation method, schematic

37.7.5 Delta
The change to the previous value is calculated and presented.

Figure: Delta calculation method, schematic

System 04-13005-02-en, October 2012


1086
37 Trend Log Lists
37.7 Calculation Methods

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

37.7.7 Meter Consumption


Meter consumption is a delta over period calculation with meter functionality. For
more information, see section 34.8 “Meter Trend Logs” on page 940.

04-13005-02-en, October 2012 System


1087
37 Trend Log Lists
37.8 Attaching a Calculation Method to a Trend Log List

37.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.
For more information, see section 37.7 “Calculation Methods” on page 1083.

To attach a calculation method to a trend log list


1. In WorkStation, in the System Tree pane, select the trend log list you want to
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.
Continued on next page

System 04-13005-02-en, October 2012


1088
37 Trend Log Lists
37.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 calculation
method is to be executed.
7. In the Custom period alignment boxes, enter the time when you want the
custom period to start.
8. Click OK
OK.
A calculation method is now attached to the trend log list.

04-13005-02-en, October 2012 System


1089
37 Trend Log Lists
37.9 Temporary Trend Log Lists and Trend Charts

37.9 Temporary Trend Log Lists and 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.

Figure: Trend log displayed in a temporary trend log list and temporary trend chart.

Note
• The trend log list must be manually refreshed.

System 04-13005-02-en, October 2012


1090
37 Trend Log Lists
37.10 Saving a Temporary Trend Log List

37.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.
3. In the Name box, type a name for the trend chart.
4. Click Save
Save.

04-13005-02-en, October 2012 System


1091
38 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
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
38 Trends User interface
38.1 Trend Log System Tree Icons

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

Trend chart
Indicates the object is a trend chart. For
more information, see section 36.1 “Trend
Charts” on page 1019.

Trend log list


Indicates the object is a trend log list. For
more information, see section 37.1 “Trend
Log Lists” on page 1071.

04-13005-02-en, October 2012 System


1095
38 Trends User interface
38.2 Actions Menu – Activation Submenu

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

System 04-13005-02-en, October 2012


1096
38 Trends User interface
38.3 Actions Menu – View Submenu

38.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
more information, see section 32.1 “Object
Specific Event View” on page 891.

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 38.4 “Actions Menu - View
Submenu - Trend Charts Submenu” on
page 1098.

Trend log lists Use the Trend log lists submenu to open or
create a trend list. For more information, see
section 38.5 “Actions Menu - View Submenu
- Trend Log Lists Submenu” on page 1099.

Watch pane Use the Watch pane submenu to select the


property of the variable you want to monitor.
For more information, see section 50.11
“Actions Menu - View Submenu - Watch
Submenu” on page 1422.

04-13005-02-en, October 2012 System


1097
38 Trends User interface
38.4 Actions Menu - View Submenu - Trend Charts Submenu

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


For more information, see section 38.17
“Trend Chart View” on page 1119.

New Trend chart Click to create a new trend chart. For more
information, see section 36.1 “Trend Charts”
on page 1019.

System 04-13005-02-en, October 2012


1098
38 Trends User interface
38.5 Actions Menu - View Submenu - Trend Log Lists Submenu

38.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 in the
menu. For more information, see section
37.1 “Trend Log Lists” on page 1071.

New Trend log list Click to create a new trend log list. For more
information, see WebHelp.

04-13005-02-en, October 2012 System


1099
38 Trends User interface
38.6 Actions Menu – Modification Submenu

38.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 34.23 “Adding a Trend Log Record
to a Manual Trend Log” on page 992.

System 04-13005-02-en, October 2012


1100
38 Trends User interface
38.7 Interval Trend Log Properties

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


Property Description

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 35.3
“Activation Methods” on page 999.

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.

04-13005-02-en, October 2012 System


1101
38 Trends User interface
38.7 Interval Trend Log Properties

Continued
Property Description

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.

System 04-13005-02-en, October 2012


1102
38 Trends User interface
38.8 Meter Trend Log Properties

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


Component Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is enabled.

Clear when enabled Select True to clear the trend log when it is
enabled.

Delta Select the minimum value change that


triggers a new record.

Logged variable Enter the variable that you want to log.

Trigger variable Enter the variable that triggers the trend log
to start recording.

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 34.17 “Variable
Triggered Trend Logs” on page 978.

Log size Select the log size to store before old


records are overwritten.

04-13005-02-en, October 2012 System


1103
38 Trends User interface
38.9 Change of Value Trend Log Properties

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


Property Description

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 35.3
“Activation Methods” on page 999.

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.

Delta Select the minimum value change that


triggers a new record.

System 04-13005-02-en, October 2012


1104
38 Trends User interface
38.9 Change of Value Trend Log Properties

Continued
Property Description

Log size Select the log size to store before old


records are overwritten.

04-13005-02-en, October 2012 System


1105
38 Trends User interface
38.10 Variable Triggered Trend Log Properties

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


Component Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is enabled.

Clear when enabled Select True to clear the trend log when it is
enabled.

Delta Select the minimum value change that


triggers a new record.

Logged variable Enter the variable that you want to log.

Trigger variable Enter the variable that triggers the trend log
to start recording.

System 04-13005-02-en, October 2012


1106
38 Trends User interface
38.10 Variable Triggered Trend Log Properties

Continued
Component Description

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 34.17 “Variable
Triggered Trend Logs” on page 978.

Log size Select the log size to store before old


records are overwritten.

04-13005-02-en, October 2012 System


1107
38 Trends User interface
38.11 Manual Trend Log Properties

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


Component Description

Log data Enter the unit the trend log stores the
records in.

System 04-13005-02-en, October 2012


1108
38 Trends User interface
38.12 Extended Trend Log Properties

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


Component Description

Monitored trend log Enter the trend log that you want to transfer
records from.

Log data Enter the unit the trend log stores the
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 interva


interval Select the maximum transfer rate of 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.

04-13005-02-en, October 2012 System


1109
38 Trends User interface
38.12 Extended Trend Log Properties

Continued
Component Description

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 35.4 “Extended Trend Logs” on
page 1003.

System 04-13005-02-en, October 2012


1110
38 Trends User interface
38.13 Trend Chart Properties

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


Property Description

Time mode Select the time mode of the x-axis.

Start time Enter the absolute start time when Time


mode is set to Absolute
Absolute. This time is the
leftmost point of the x-axis.

04-13005-02-en, October 2012 System


1111
38 Trends User interface
38.13 Trend Chart Properties

Continued
Property Description

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 series Select True to show information on every
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


more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit Click to edit a selected series. For more


information, see section 38.25 “Trend Chart
Series Properties” on page 1131.

Remove Click to remove a selected series.

System 04-13005-02-en, October 2012


1112
38 Trends User interface
38.14 Trend Log List Properties

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


Component Description

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 37.4 “Time Zone Modes in a Trend
Log List” on page 1078.

Calculation method Select a calculation method.

Delta over period Select True to apply a period to the delta


calculation method.

04-13005-02-en, October 2012 System


1113
38 Trends User interface
38.14 Trend Log List Properties

Continued
Component Description

Period Select the time span for which the


calculation method is to be executed.

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.

System 04-13005-02-en, October 2012


1114
38 Trends User interface
38.15 Manage Replacement of Meter Dialog Box

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


Component Description

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.

04-13005-02-en, October 2012 System


1115
38 Trends User interface
38.15 Manage Replacement of Meter Dialog Box

Continued
Component Description

Max value Type the last value of the new meter before
roll-over.

System 04-13005-02-en, October 2012


1116
38 Trends User interface
38.16 Meter Change History Dialog Box

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


Component Description

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.

04-13005-02-en, October 2012 System


1117
38 Trends User interface
38.16 Meter Change History Dialog Box

Continued
Component Description

Max value Displays the last value of the new meter


before roll-over.

System 04-13005-02-en, October 2012


1118
38 Trends User interface
38.17 Trend Chart View

38.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
information, see section 38.18 “Trend Chart
Toolbar” on page 1121.

Use the Series tab shortcut menu to


manage the appearance of a trend log
series. For more information, see section
38.21 “Series Tab Shortcut Menu” on page
1126.

Use the trend log event icons to get


information about a specific record. For
more information, see section 38.19 “Trend
Chart Event Icons” on page 1123.

04-13005-02-en, October 2012 System


1119
38 Trends User interface
38.17 Trend Chart View

Continued
Number Description

Use the navigation bar to horizontally adjust


the visible trend chart area. For more
information, see section 38.20 “Trend Chart
Navigation Bar” on page 1125.

System 04-13005-02-en, October 2012


1120
38 Trends User interface
38.18 Trend Chart Toolbar

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


Click to set the scale of the x-axis to one
day.

Show one week


Click to set the scale of the x-axis to one
week.

Show one month


Click to set the scale of the x-axis to one
month.

Show one year


Click to set the scale of the x-axis to one
year.

Show nearest information on every series


Click to show values of every trend chart
series at a specific time.

04-13005-02-en, October 2012 System


1121
38 Trends User interface
38.18 Trend Chart Toolbar

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.
For more information, see section 38.22
“Trend Chart Settings Dialog Box – Axes
Tab” on page 1127.
For more information, see WebHelp.

Save current settings


Click to save the settings you have done in
the trend chart in WebStation.

System 04-13005-02-en, October 2012


1122
38 Trends User interface
38.19 Trend Chart Event Icons

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

04-13005-02-en, October 2012 System


1123
38 Trends User interface
38.19 Trend Chart Event Icons

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 16.1 “Time and Time Zone” on page
309.

Override
Indicates that the recorded value is
overridden by the hardware and is not the
measured value. For more information, see
WebHelp.
Forced
Indicates that the recorded value is forced by
the software and is not the measured value.
For more information, see 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.

System 04-13005-02-en, October 2012


1124
38 Trends User interface
38.20 Trend Chart Navigation Bar

38.20 Trend Chart Navigation Bar


Use the Trend Chart navigation bar to horizontally scroll the trend chart.

Table: Trend Chart Navigation Bar


Component Description

Scroll to the first value


Click to scroll back to the first value of the
trend chart in WorkStation.

Scroll fast backwards


Click to scroll fast backward.

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

Scroll forwards
Click to scroll forward.

Scroll fast forwards


Click to scroll fast forward.

Scroll to current client time


Click to scroll forward to the latest value of
the trend chart in WorkStation.

04-13005-02-en, October 2012 System


1125
38 Trends User interface
38.21 Series Tab Shortcut Menu

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


Component Description

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.

Open trend chart settings Click to open the property dialog box for the
trend chart and its series.

System 04-13005-02-en, October 2012


1126
38 Trends User interface
38.22 Trend Chart Settings Dialog Box – Axes Tab

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


Component Description

Time mode Select the time mode of the x-axis.

Start time Enter the absolute start time when Time


mode is set to Absolute. This time is the
leftmost point of the x-axis.

End time Enter the absolute end time when Time


mode is set to Absolute (start time and
end time)
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)
time). The rightmost point of the x-
axis is the current time.

Time zone Select time zone mode of the trend chart.


The time zone mode is the perspective that
the trend log is displayed with.

Show grid lines Select to show horizontal grid lines.

04-13005-02-en, October 2012 System


1127
38 Trends User interface
38.22 Trend Chart Settings Dialog Box – Axes Tab

Continued
Component Description

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.

System 04-13005-02-en, October 2012


1128
38 Trends User interface
38.23 Trend Chart Settings Dialog Box – Series Tab

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


Component Description

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.

Color Enter the color of the series.

04-13005-02-en, October 2012 System


1129
38 Trends User interface
38.24 Trend Chart Settings Dialog Box – Calculation Tab

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


Component Description

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.

Period Select the time span for which the


calculation method is to be executed.

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.

System 04-13005-02-en, October 2012


1130
38 Trends User interface
38.25 Trend Chart Series Properties

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


Component Description

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.

04-13005-02-en, October 2012 System


1131
38 Trends User interface
38.25 Trend Chart Series Properties

Continued
Component Description

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.

Delta over period Select True to apply a period to the delta


calculation method.

Period Select the time span for which the


calculation method is to be executed.

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.

System 04-13005-02-en, October 2012


1132
38 Trends User interface
38.26 Real Time Trend Series Properties

38.26 Real Time Trend Series Properties


Use the Basic tab to configure and view real time trend properties. For more
information, see section 50.26 “General and References Properties” on page 1441.

Figure: Real Time Series Properties - Basic tab

04-13005-02-en, October 2012 System


1133
38 Trends User interface
38.27 Trend Log List View

38.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 38.28 “Trend Log
List Toolbar” on page 1136.

Use the log info to get detailed information


about the trend log list. For more
information, see section 38.30 “Trend Log
List – Log Info View” on page 1140.

Use the trend log list columns to sort the


trend log records. For more information, see
section 50.42 “Add/Remove Columns Dialog
Box ” on page 1464.

System 04-13005-02-en, October 2012


1134
38 Trends User interface
38.27 Trend Log List View

Continued
Number Description

Use the trend log list shortcut menu to edit,


add, or show the history of trend log
records. For more information, see section
38.31 “Trend Log List Shortcut Menu” on
page 1141.

Use the trend log event icons to get


information about a specific record. For
more information, see section 38.29 “Trend
Log List Event Icons” on page 1138.

04-13005-02-en, October 2012 System


1135
38 Trends User interface
38.28 Trend Log List Toolbar

38.28 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 addedadded, Record was edited,
and Record was commented
commented. For more
information, see section 38.29 “Trend Log
List Event Icons” on page 1138.

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.

System 04-13005-02-en, October 2012


1136
38 Trends User interface
38.28 Trend Log List Toolbar

Continued
Button Description

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 38.32 “Add Trend
Log Record Dialog Box” on page 1142.

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
information, see section 38.33
“Edit/Comment Trend Log Record Dialog
Box” on page 1143.

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 38.16 “Meter Change History Dialog
Box” on page 1117.

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 38.14 “Trend Log List Properties” on
page 1113.

04-13005-02-en, October 2012 System


1137
38 Trends User interface
38.29 Trend Log List Event Icons

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

System 04-13005-02-en, October 2012


1138
38 Trends User interface
38.29 Trend Log List Event Icons

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
16.1 “Time and Time Zone” on page 309.

Override
Indicates that the recorded value is
overridden by the hardware and is not the
measured value. For more information, see
WebHelp.
Forced
Indicates that the recorded value is forced by
the software and is not the measured value.
For more information, see 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.

04-13005-02-en, October 2012 System


1139
38 Trends User interface
38.30 Trend Log List – Log Info View

38.30 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


Component Description

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


old records are overwritten.

System 04-13005-02-en, October 2012


1140
38 Trends User interface
38.31 Trend Log List Shortcut Menu

38.31 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


Component Description

Edit record Click to open the Edit/Comment trend log


record value dialog box where you can edit
values or add comments. For more
information, see section 38.32 “Add Trend
Log Record Dialog Box” on page 1142.

Show history Click to open the Edit/Comment trend log


value dialog box where you can edit values
or add comments. For more information, see
section 38.32 “Add Trend Log Record
Dialog Box” on page 1142.

Copy Click to copy the list data to the clipboard.

04-13005-02-en, October 2012 System


1141
38 Trends User interface
38.32 Add Trend Log Record Dialog Box

38.32 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


Component Description

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.

System 04-13005-02-en, October 2012


1142
38 Trends User interface
38.33 Edit/Comment Trend Log Record Dialog Box

38.33 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


Component Description

Time stamp Displays the time the value was recorded.

Value Type the new value of the record.

Comment Type a comment for the value.

04-13005-02-en, October 2012 System


1143
38 Trends User interface
38.34 Create Trend Log Wizard – Configure Interval Trend Log Page

38.34 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


Component Description

Logged variable Enter the variable that you want to log.

Delta Select the minimum value change that


triggers a new record.

Unit Enter the unit of the records in the trend log


list. For more information, see section 33.5
“Trend Units” on page 910.

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.

Clear when enabled Select True to clear the trend log when it is
enabled.

Start condition Select the method of starting the trend log.


For more information, see section 35.3
“Activation Methods” on page 999.

System 04-13005-02-en, October 2012


1144
38 Trends User interface
38.35 Create Trend Log Wizard – Configure Meter Trend Log Page

38.35 Create Trend Log Wizard – Configure


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


Component Description

Logged variable Enter the variable that you want to log.

Trigger variable Enter the variable that triggers the trend log
to start recording.

Unit Enter the unit of the records in the trend log


list. For more information, see section 33.5
“Trend Units” on page 910.

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 34.17 “Variable
Triggered Trend Logs” on page 978.

Log size Select the log size to store before old


records are overwritten.

Clear when enabled Select True to clear the trend log when it is
enabled.

04-13005-02-en, October 2012 System


1145
38 Trends User interface
38.36 Create Trend Log Wizard – Configure Change of Value Trend Log Page

38.36 Create Trend Log Wizard – Configure


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


Component Description

Logged variable Enter the variable that you want to log.

Delta Select the minimum value change that


triggers a new record.

Unit Enter the unit of the records in the trend log


list. For more information, see section 33.5
“Trend Units” on page 910.

Log size Select the log size to store before old


records are overwritten.

Clear when enabled Select True to clear the trend log when it is
enabled.

Activation method Select the method for starting the trend log.
For more information, see section 35.3
“Activation Methods” on page 999.

Activation time Type the start time of the trend log.

Activation variable Enter the variable that is to start the trend


log.

System 04-13005-02-en, October 2012


1146
38 Trends User interface
38.37 Create Trend Log Wizard – Configure Variable Triggered Trend Log

38.37 Create Trend Log Wizard – Configure


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


Component Description

Logged variable Enter the variable that you want to log.

Trigger variable Enter the variable that triggers the trend log
to start recording.

Unit Enter the unit of the records in the trend log


list. For more information, see section 33.5
“Trend Units” on page 910.

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 34.17 “Variable
Triggered Trend Logs” on page 978.

Log size Select the log size to store before old


records are overwritten.

Clear when enabled Select True to clear the trend log when it is
enabled.

04-13005-02-en, October 2012 System


1147
38 Trends User interface
38.38 Create Trend Log Wizard – Configure Manual Log Page

38.38 Create Trend Log Wizard – Configure


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


Component Description

Unit Enter the unit of the records in the trend log


list. For more information, see section 33.5
“Trend Units” on page 910.

System 04-13005-02-en, October 2012


1148
38 Trends User interface
38.39 Create Trend Log Wizard – Configure Extended Trend Log Page

38.39 Create Trend Log Wizard – Configure


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


Component Description

Monitored trend log Enter the trend log that you want to transfer
records from.

Smart log Select True to optimize the transfer of the


monitored trend log to the extended trend
log.

Maximum transfer interval Select the maximum transfer rate of 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 35.4 “Extended Trend Logs” on
page 1003.

04-13005-02-en, October 2012 System


1149
38 Trends User interface
38.40 Create Trend Log Wizard – Configure Trend Chart Page

38.40 Create Trend Log Wizard – Configure


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


Component Description

Time mode Select the time mode of the x-axis.

Start time Enter the absolute start time when Time


mode is set to Absolute. This time is the
leftmost point of the x-axis.

Stop time Enter the absolute stop time when Time


mode is set to Absolute. This time is the
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
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.

System 04-13005-02-en, October 2012


1150
38 Trends User interface
38.40 Create Trend Log Wizard – Configure Trend Chart Page

Continued
Component Description

Add Click to add a series to the trend chart. For


more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Edit Click to edit a selected series. For more


information, see section 38.25 “Trend Chart
Series Properties” on page 1131.

Remove Click to remove a selected series.

04-13005-02-en, October 2012 System


1151
38 Trends User interface
38.41 Create Trend Log Wizard – Configure Real-Time Trend Series Page

38.41 Create Trend Log Wizard – Configure


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


Component Description

Display variable Enter the variable you want to present as a


series in the trend chart.

Weight Type the weight of the line. The value is a


value without correlation to any unit of
measure.

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.

System 04-13005-02-en, October 2012


1152
38 Trends User interface
38.42 Create Trend Log Wizard – Configure Trend Log Series Page

38.42 Create Trend Log Wizard – Configure


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


Component Description

Display trend log Enter the trend log you want to present as a
series in the trend chart.

Weight Type the weight of the line. The value is a


value without correlation to any unit of
measure.

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.

04-13005-02-en, October 2012 System


1153
38 Trends User interface
38.43 Create Trend Log Wizard – Configure Trend Log List Page

38.43 Create Trend Log Wizard – Configure


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


Component Description

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.

System 04-13005-02-en, October 2012


1154
38 Trends User interface
38.44 Create Trend Log Wizard – Connect Objects to the Trend Log Page

38.44 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


Component Description

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.

04-13005-02-en, October 2012 System


1155
38 Trends User interface
38.45 Trend Log Wizard – Initial Meter Settings Page

38.45 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


Property Description

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.

Max value Displays the last value of the new meter


before roll-over.

System 04-13005-02-en, October 2012


1156
39 Mass Create Alarms and
Trends

Topics
Mass Create
Mass Create Unit Managing
Object or Property Variable Type
Suffix and Prefix
Mass Create Resulting Location
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
39 Mass Create Alarms and Trends
39.1 Mass Create

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

39.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 39.3 “Object or Property Variable Type” on page
1162.

04-13005-02-en, October 2012 System


1159
39 Mass Create Alarms and Trends
39.1 Mass Create

39.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 39.4 “Suffix and Prefix” on page 1164.

39.1.3 Mass Create Unit Managing


When you mass create alarms or trend logs from objects or properties with no unit,
you can define any unit. If all objects or properties have the same unit you can
define another unit for the alarms and trend logs that is within the same unit
category.
For more information, see section 39.2 “Mass Create Unit Managing ” on page
1161.

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

39.1.5 Mass Create Resulting Location


You have two options when deciding where to locate new alarms, trend logs, and
extended trend logs.
• Absolute path
• Relative path
The default location for alarms, trend logs, and extended trend logs is the root
folder of the System Tree pane.
By selecting absolute path you can specify the folder in which you want to locate all
the alarms, trend logs, and extended trend. By selecting relative path you can
specify the location for the new alarms and trend logs compared to the location of
the connected variable.

System 04-13005-02-en, October 2012


1160
39 Mass Create Alarms and Trends
39.2 Mass Create Unit Managing

39.2 Mass Create Unit Managing


When you mass create alarms or trend logs from objects or properties with no unit,
you can define any unit. If all objects or properties have the same unit you can
define another unit for the alarms and trend logs that is within the same unit
category.
When you mass create alarms or trend logs from objects where some have the
same unit and other do not have any defined unit, all alarms and trend logs are
given the unit that is defined for the objects. For example, you have four objects, A1
to A4. All objects have m/s as unit, beside the object A2 which does not have a
defined unit. When mass creating the alarms the Alarm A2 is given the unit m/s,
corresponding to the other alarms unit.

Figure: Objects and properties with no unit are given the unit that is defined for the other
objects.

Note
You can not mass create alarms or trend logs from objects or properties that
have different units.

04-13005-02-en, October 2012 System


1161
39 Mass Create Alarms and Trends
39.3 Object or Property Variable Type

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

System 04-13005-02-en, October 2012


1162
39 Mass Create Alarms and Trends
39.3 Object or Property Variable Type

Note
A trend log that monitors an enumeration records the enumeration value and not
the enumeration definition.
For more information, see section 48.15 “Event and Alarm Enumerations” on
page 1361.
For more information, see section 48.16 “Trend Log Enumerations” on page
1368.

04-13005-02-en, October 2012 System


1163
39 Mass Create Alarms and Trends
39.4 Suffix and Prefix

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

System 04-13005-02-en, October 2012


1164
39 Mass Create Alarms and Trends
39.5 Mass Create Resulting Location

39.5 Mass Create Resulting Location


You have two options when deciding where to locate new alarms, trend logs, and
extended trend logs.
• Absolute path
• Relative path
The default location for alarms, trend logs, and extended trend logs is the root
folder of the System Tree pane.
By selecting absolute path you can specify the folder in which you want to locate all
the alarms, trend logs, and extended trend. By selecting relative path you can
specify the location for the new alarms and trend logs compared to the location of
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.

04-13005-02-en, October 2012 System


1165
39 Mass Create Alarms and Trends
39.6 Mass Creating Alarms

39.6 Mass Creating Alarms


You mass create alarms to create identical alarms for different objects, instead of
creating the alarms one by one.
For more information, see section 39.1 “Mass Create ” on page 1159.

To mass create alarms


1. In Workstation, in the List View, select the objects that you want to create
alarms for.

2. On the File menu, point to New and then click Alarm


Alarm.

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

System 04-13005-02-en, October 2012


1166
39 Mass Create Alarms and Trends
39.6 Mass Creating Alarms

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


Next.
See the alarm procedures for detailed information on how to create and set up your
specific alarm type:
• For more information, see section 27.5 “Creating a Multistate Alarm” on page
618.
• For more information, see section 27.9 “Creating a Variable Status Alarm” on
page 633.
• For more information, see section 27.17 “Creating an Enumeration Alarm” on
page 665.
• For more information, see section 27.7 “Creating a Matching Text String Alarm”
on page 626.
• For more information, see section 27.11 “Creating an Out of Range Alarm” on
page 640.
• For more information, see section 27.13 “Creating an Out of Reference Range
Alarm” on page 649.
• For more information, see section 27.3 “Creating a Change of State Alarm ” on
page 610.

04-13005-02-en, October 2012 System


1167
39 Mass Create Alarms and Trends
39.7 Mass Creating Alarms Using the Search Method

39.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.
For more information, see section 39.1 “Mass Create ” on page 1159.

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.

2. Click the Search button .


3. In the Search view, select the objects or properties you want to create alarms
for.

Continued on next page

System 04-13005-02-en, October 2012


1168
39 Mass Create Alarms and Trends
39.7 Mass Creating Alarms Using the Search Method

4. On the File menu, point to New and then click Alarm


Alarm.

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
respective objects with the same pattern of relative path addressing.
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
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.

Continued on next page

04-13005-02-en, October 2012 System


1169
39 Mass Create Alarms and Trends
39.7 Mass Creating Alarms Using the Search Method

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


Next.
See the alarm procedures for detailed information on how to create and set up your
specific alarm type:
• For more information, see section 27.5 “Creating a Multistate Alarm” on page
618.
• For more information, see section 27.9 “Creating a Variable Status Alarm” on
page 633.
• For more information, see section 27.17 “Creating an Enumeration Alarm” on
page 665.
• For more information, see section 27.7 “Creating a Matching Text String Alarm”
on page 626.
• For more information, see section 27.11 “Creating an Out of Range Alarm” on
page 640.
• For more information, see section 27.13 “Creating an Out of Reference Range
Alarm” on page 649.
• For more information, see section 27.3 “Creating a Change of State Alarm ” on
page 610.

System 04-13005-02-en, October 2012


1170
39 Mass Create Alarms and Trends
39.8 Mass Creating Trend Logs

39.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.
For more information, see section 39.1 “Mass Create ” on page 1159.

To mass create trend logs


1. In Workstation, in the List View, select the objects that you want to create
trend logs for.

2. On the File menu, point to New and then click Trend


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

04-13005-02-en, October 2012 System


1171
39 Mass Create Alarms and Trends
39.8 Mass Creating 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
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create are disabled.

9. Click Next
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 34.4 “Creating an Interval Trend Log ” on
page 931.
• For more information, see section 34.15 “Creating a Change of Value Trend
Log ” on page 972.
• For more information, see section 34.10 “Creating a Meter Trend Log ” on
page 961.
• For more information, see section 34.18 “Creating a Variable Triggered Trend
Log” on page 981.

System 04-13005-02-en, October 2012


1172
39 Mass Create Alarms and Trends
39.9 Mass Creating Trend Logs Using the Search Method

39.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.
For more information, see section 39.1 “Mass Create ” on page 1159.

To mass create trend logs using the search method


1. In WorkStation, in the Search box, type the name or the property that the
objects have in common.

2. Click the Search button .


Continued on next page

04-13005-02-en, October 2012 System


1173
39 Mass Create Alarms and Trends
39.9 Mass Creating Trend Logs Using the Search Method

3. In the Search view, select the objects or properties you want to create trend
logs for.

4. On the File menu, point to New and then click Trend


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

System 04-13005-02-en, October 2012


1174
39 Mass Create Alarms and Trends
39.9 Mass Creating Trend Logs Using the Search Method

9. 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 path addressing.
10. 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
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create are disabled.

11. Click Next


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 34.4 “Creating an Interval Trend Log ” on
page 931.
• For more information, see section 34.15 “Creating a Change of Value Trend
Log ” on page 972.
• For more information, see section 34.10 “Creating a Meter Trend Log ” on
page 961.
• For more information, see section 34.18 “Creating a Variable Triggered Trend
Log” on page 981.

04-13005-02-en, October 2012 System


1175
39 Mass Create Alarms and Trends
39.10 Mass Creating Extended Trend Logs

39.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.
For more information, see section 39.1 “Mass Create ” on page 1159.

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
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.
5. In the Description box, type a description for the extended trend logs.
Continued on next page

System 04-13005-02-en, October 2012


1176
39 Mass Create Alarms and Trends
39.10 Mass Creating Extended Trend Logs

6. 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 path addressing.
7. 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
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create are disabled.

8. Click Next
Next.
• For more information, see section 35.5 “Creating an Extended Trend Log” on
page 1007.

04-13005-02-en, October 2012 System


1177
39 Mass Create Alarms and Trends
39.11 Mass Creating Extended Trend Logs Using the Search Method

39.11 Mass Creating Extended Trend Logs


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.
For more information, see section 39.1 “Mass Create ” on page 1159.

To mass create extended trend logs using the search method


1. In WorkStation, in the Search box, type the name or the property that the
trend logs have in common.

2. Click the Search button .


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

System 04-13005-02-en, October 2012


1178
39 Mass Create Alarms and Trends
39.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.
8. 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.
9. 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
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create are disabled.

10. Click Next


Next.
• For more information, see section 35.5 “Creating an Extended Trend Log” on
page 1007.

04-13005-02-en, October 2012 System


1179
39 Mass Create Alarms and Trends
39.12 Mass Create Object Wizard – Name Page

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


Property Description

Object type list Select the type of object you want to mass
create. For more information, see section
47.1 “Object Types” on page 1327.

Prefix Type a label that is added in front of the


object name. For more information, see
section 39.4 “Suffix and Prefix” on page
1164.

Suffix Type a label that is added after the object


name. For more information, see section
39.4 “Suffix and Prefix” on page 1164.

Description Type a description that explains what the


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.

System 04-13005-02-en, October 2012


1180
39 Mass Create Alarms and Trends
39.12 Mass Create Object Wizard – Name Page

Continued
Property Description

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.

04-13005-02-en, October 2012 System


1181
40 Schedules Introduction

Topics
Schedules Overview
Schedule Bindings
Configuring a Schedule as a Shadow
40 Schedules Introduction
40.1 Schedules Overview

40.1 Schedules Overview


A schedule is a sequence of events that determines when essential events occur in
a building automation system:
• Doors lock or unlock
• Heat and lights turn on and off
• Equipment operates
• Personnel have access to an area
For example, the lights to a building need to switch on at 07:00 and switch off at
20:00 each week day. Prior to 07:00 and after 20:00, the lights are off. On
weekends, the lights remain off. You can arrange for these events to take place on
a regular basis by setting up a schedule.
Lights turning on and off are weekly events. Weekly events happen within a
specified time period unless scheduled otherwise. Exception events are when the
schedule deviates from the weekly schedule, such as holidays. An exception event
defines either a one time or a recurring change that overrides the standard weekly
events.

40.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 41.1 “Schedule Editor Overview” on page 1193.

40.1.2 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 42.1 “Schedule Types ” on page 1209.

40.1.3 Schedule Events


A schedule can have two types of events: weekly events and exception
events. Weekly events occur every week at a specified time. Exception
events occur when the schedule deviates from the weekly schedule, such as during
holidays. Exception events occur instead of the weekly events.
For more information, see section 43.1 “Schedule Events” on page 1223.

04-13005-02-en, October 2012 System


1185
40 Schedules Introduction
40.1 Schedules Overview

40.1.4 Calendars
A calendar is a list of exception events. Rather than entering several exception
events in a schedule, you can reference a single calendar. The calendar provides
the schedule with the dates when the exception events shall occur.
For more information, see section 44.2 “Calendars in WorkStation” on page 1254.

40.1.5 Schedule and Calendar Synchronization


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

40.1.6 Schedule Bindings


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 section 40.2 “Schedule Bindings” on page 1187.

System 04-13005-02-en, October 2012


1186
40 Schedules Introduction
40.2 Schedule Bindings

40.2 Schedule Bindings


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.

Figure: The source supplies the value to the destination.


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.
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 different uses of schedules and bindings:
You bind an analog schedule to an analog point such as a thermostat setpoint.
When the schedule dictates a change in temperature, the schedule will send the
output information to the setpoint for the thermostat to act on.

04-13005-02-en, October 2012 System


1187
40 Schedules Introduction
40.2 Schedule Bindings

Figure: Analog Schedule binding properties


You bind a digital schedule to a digital light switch. The schedule will switch the light
on or off depending on the value set in the schedule.

System 04-13005-02-en, October 2012


1188
40 Schedules Introduction
40.2 Schedule Bindings

Figure: Digital Schedule binding properties

04-13005-02-en, October 2012 System


1189
40 Schedules Introduction
40.3 Configuring a Schedule as a Shadow

40.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.
For more information, see section 44.13 “Schedule and Calendar Synchronization”
on page 1274.

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.
2. On the File menu, click Properties
Properties.
3. In the Lead object box, enter the schedule that you want to synchronize the
shadow schedule with.

4. Click OK
OK.

System 04-13005-02-en, October 2012


1190
41 Schedule Editor

Topics
Schedule Editor Overview
Schedule Editor in WorkStation
Advanced View of the Schedule Editor
Time Zones
Priorities
Editing an Event Priority
Schedule Colors in WorkStation
41 Schedule Editor
41.1 Schedule Editor Overview

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

41.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 41.2 “Schedule Editor in WorkStation” on page
1194.

41.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 41.3 “Advanced View of the Schedule Editor ” on
page 1195.

41.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 41.7 “Schedule Colors in WorkStation” on page
1204.

04-13005-02-en, October 2012 System


1193
41 Schedule Editor
41.2 Schedule Editor in WorkStation

41.2 Schedule Editor in WorkStation


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.
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 19 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 Schedule Editor

System 04-13005-02-en, October 2012


1194
41 Schedule Editor
41.3 Advanced View of the Schedule Editor

41.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.
The Advanced view shows the following elements of a schedule that are not
available in the Basic view:
• Combined view of any selected date that shows both weekly and exception
events for the day
• Exception events and associated priorities listed in a tree

Figure: Advanced Schedule Editor


The following table describes the combined view and explains the priorities of the
exception events.
Number Description

Default value
The default value takes control of the value
when there are no events scheduled.

Combined view includes study hour


The Study hour is an exception event that
takes control of the value of the schedule at
07:00 and passes control to the Book club
event at 13:00.

04-13005-02-en, October 2012 System


1195
41 Schedule Editor
41.3 Advanced View of the Schedule Editor

Continued
Number Description

Book club event has a lower priority than


the Study hour event
Although the Book club event is scheduled
to begin at 11:00, the event does not take
control of the schedule until 13:00. Study
hour is set to a priority 14 which overrides
the Book club event priority of 15.

Weekly scheduled event takes control of


schedule
Since there are no exception events
scheduled, the regular weekly scheduled
event takes control of the schedule until
20:00.

Default value takes control


The default value is in effect until the first
scheduled event of the next day, week or
exception.

View of default value in combined view


Whenever the default value takes control of
this schedule, the value of the event is 55.

Book club and Study hour exceptions


In this example, the exceptions are displayed
in the combined view in numbers 2 and 3.

Priority in the event tree for Study hour


The event tree displays the priority for Study
hour, and Study hour has a higher priority
than Book club.

Priority in the event tree for Book club


The event tree displays the events listed
higher to lower priority, so the Book club
event does not begin until the Study hour
event ends.

41.3.1 Text View


You can use the Text View to select and display a weekly event or an exception
event. Advanced users can use Text View to be more specific with time sequences
and break down a time value into hundreths of a second.

System 04-13005-02-en, October 2012


1196
41 Schedule Editor
41.3 Advanced View of the Schedule Editor

Figure: Text View

41.3.2 Event Preview


You can view the events of a day in the Combined View. The events include
exception events, weekly events, and the default value. You can view events in
Graphic View or Text View.
The example shows the combined events of a single day in Graphic View.

Figure: Combined Events in Graphic View


The example shows the events of the same day in Text View.

Figure: Combined Events in Text View

04-13005-02-en, October 2012 System


1197
41 Schedule Editor
41.4 Time Zones

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

System 04-13005-02-en, October 2012


1198
41 Schedule Editor
41.5 Priorities

41.5 Priorities
Priority is a number that corresponds to a preassigned level of importance. When
used in schedules, priority numbers include 1 through 16. 1 is the most important
and highest priority. Exception events always take precedence over weekly events.
When two exception events conflict, there is a specific way to determine which
event takes precedence. For exception events you can assign priorities to
determine the order of their precedence. By default, all exception events have a
priority of 16, which is the lowest priority. You can change that number to a higher
priority from 1 to 15.
There are two possible scenarios with the priority of events:
• Two events can have different priority numbers. In this case, the highest priority
takes control of the schedule.
• Two exception events can have the same priority number. In this case, the
position in the exception list determines the order of priority.
Each exception event is associated with a value assigned to the event. If the time
periods of exception events overlap, event execution is determined by the priority
number. For example, a priority 13 event has a higher priority than a priority 14
event.
For example, two coinciding events are scheduled for Friday. The priority of each
event determines the event that takes control of the schedule. In the schedule, the
fan in the room is set to 0 for all day at a priority 14. However, from 09:00 to 11:00 a
scheduled meeting needs the fan to be at 2 and has a priority 12. The schedule
adjusts the fan for the meeting and ignores the priority 14 event until the priority 12
event ends.

Figure: Conflicting priority events


The Event Tree in the Advanced Schedule Editor displays the exception events
according to priority in separate folders. For example, a priority 10 exception event
is contained in a folder called Priority 10. If you do not specify a priority for an
exception event, Building Operation places the event in the Priority 16 default folder.
No event folders are displayed if all exception events use the default priority 16.

04-13005-02-en, October 2012 System


1199
41 Schedule Editor
41.5 Priorities

Figure: Event tree and priority event folders


When you select an exception event in the Schedule Event tree, all the days for
which the event is valid are highlighted in the Calendar Overview.
If you create multiple events that occur on the same day, time, and priority level,
alphabetical order determines the sequence of event execution. For example, you
create an event called Meeting at priority 10 that lasts from 08:00 to 10:00 on all
Tuesdays. You create another event called Content and Planning at priority 10 that
lasts from 08:00 to 09:00 on all Tuesdays. The first event would control the
schedule from 08:00 to 10:00 because you created that event first.
The Advanced Schedule Editor displays a view of schedule and exception events.
The following figure and table describe the combined view of the Advanced
Schedule Editor and explains the priorities of the exception events.

Figure: Advanced Schedule Editor

Table: Advanced Schedule Editor Priorities


Number Description

Default value
The default value takes control of the value
when there are no events scheduled.

System 04-13005-02-en, October 2012


1200
41 Schedule Editor
41.5 Priorities

Continued
Number Description

Combined view includes study hour


The Study hour is an exception event that
takes control of the value of the schedule at
07:00 and passes control to the Book club
event at 13:00.

Book club event has a lower priority than


the Study hour event
Although the Book club event is scheduled
to begin at 11:00, the event does not take
control of the schedule until 13:00. Study
hour is set to a priority 14 which overrides
the Book club event priority of 15.

Weekly scheduled event takes control of


schedule
Since there are no exception events
scheduled, the regular weekly scheduled
event takes control of the schedule until
20:00.

Default value takes control


The default value is in effect until the first
scheduled event of the next day, week or
exception.

View of default value in combined view


Whenever the default value takes control of
this schedule, the value of the event is 55.

Book club and Study hour exceptions


In this example, the exceptions are displayed
in the combined view in numbers 2 and 3.

Priority in the event tree for Study hour


The event tree displays the priority for Study
hour, and Study hour has a higher priority
than Book club.

Priority in the event tree for Book club


The event tree displays the events listed
higher to lower priority, so the Book club
event does not begin until the Study hour
event ends.

04-13005-02-en, October 2012 System


1201
41 Schedule Editor
41.6 Editing an Event Priority

41.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, select the schedule you want to
edit.
2. In the Work area, click the Basic view.
3. In the Event grid, select the exception event you want to

edit.

4. On the Basic toolbar, click the Edit schedule event button .


Continued on next page

System 04-13005-02-en, October 2012


1202
41 Schedule Editor
41.6 Editing an Event Priority

5. Edit the priority.

6. Click Ok
Ok.

04-13005-02-en, October 2012 System


1203
41 Schedule Editor
41.7 Schedule Colors in WorkStation

41.7 Schedule Colors in WorkStation


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.

41.7.1 Colors in the Basic View


Weekly events and exception events are presented in different colors so you can
easily identify the type of events at a glance.
Color Description

Cream Default value

Green Weekly events

Blue Exception events

Events of the same type that are next to each other in the schedule are presented in
different intensities of the color so you can easily see the start and stop time of
these events. For example, the weekly event Drawing from 7:00 to 11:00 is dark
green and the weekly event Painting from 11:00 to 15:15 is in light green.

Figure: Basic Schedule Editor weekly event colors

System 04-13005-02-en, October 2012


1204
41 Schedule Editor
41.7 Schedule Colors in WorkStation

Colors in the Calendar Overview are significant in the following ways:


• Light blue in the calendar overview represents exception events.
• Black in the calendar overview represents a selected day or today.

Figure: Calendar overview color code

41.7.2 Colors in the Advanced View


Weekly and exception events are both green in the Advanced view. 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.

Figure: Weekly event color code


Colors in the Calendar Overview are significant in the following ways:
• Light blue in the calendar overview represents exception events.
• Dark blue in the calendar overview represents an exception event that is
selected in the event tree.

04-13005-02-en, October 2012 System


1205
41 Schedule Editor
41.7 Schedule Colors in WorkStation

Figure: Advanced View color codes

System 04-13005-02-en, October 2012


1206
42 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
42 Schedule Types
42.1 Schedule Types

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

42.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 example, a thermostat controls the temperature in a room. To regulate the
temperature, you can adjust a thermostat by tenths of a degree to accommodate
the needs of the people occupying the room.
For more information, see section 42.8 “Analog Schedules” on page 1217.

42.1.2 Digital Schedules


A digital schedule controls a device that has an on output state and an off output
state. If you want to create a schedule for lights to turn on and off at specified times,
create a digital schedule. You select the value Off at the time you want the lights to
be inactive, and you select the value On at the time you want the lights to be active.
For more information, see section 42.2 “Digital Schedules” on page 1210.

42.1.3 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 set a fan in a room to
off, low, medium, or high. To regulate the fan in the room, you can assign whole
numbers 0, 1, 2, and 3 to represent the states in the room.
For more information, see section 42.5 “Multistate Schedules” on page 1214.

04-13005-02-en, October 2012 System


1209
42 Schedule Types
42.2 Digital Schedules

42.2 Digital Schedules


A digital schedule controls a device that has an on output state and an off output
state. If you want to create a schedule for lights to turn on and off at specified times,
create a digital schedule. You select the value Off at the time you want the lights to
be inactive, and you select the value On at the time you want the lights to be active.
For example, you can create a digital weekly schedule that activates the lights at
07:00 and switches them off at 20:00 Monday through Friday.

Figure: Digital schedule


You create schedules using WorkStation.

System 04-13005-02-en, October 2012


1210
42 Schedule Types
42.3 Creating a Digital Schedule

42.3 Creating a Digital Schedule


You create a digital schedule to control the state of a digital value.
For more information, see section 42.2 “Digital Schedules” on page 1210.

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
Schedule.
3. In the object type list, select Digital Schedule
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
Create.
Now you can add events to the digital schedule and bind it to a digital value.

04-13005-02-en, October 2012 System


1211
42 Schedule Types
42.4 Binding a Digital Value to a Digital Schedule

42.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.
For more information, see section 40.2 “Schedule Bindings” on page 1187.

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

System 04-13005-02-en, October 2012


1212
42 Schedule Types
42.4 Binding a Digital Value to a Digital Schedule

5. Drag the digital schedule to the Binding column for the digital value.

6. On the File menu, click Save


Save.

04-13005-02-en, October 2012 System


1213
42 Schedule Types
42.5 Multistate Schedules

42.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 set a fan in a room to
off, low, medium, or high. To regulate the fan in the room, you can assign whole
numbers 0, 1, 2, and 3 to represent the states in the room.
For example, you can create a multistate weekly schedule that adjusts the room fan
to medium (2) from 08:00 to 18:00 Monday through Friday.

Figure: Multistate schedule


You create schedules using WorkStation.

System 04-13005-02-en, October 2012


1214
42 Schedule Types
42.6 Creating a Multistate Schedule

42.6 Creating a Multistate Schedule


You create a multistate schedule to control the state of a multistate value.
For more information, see section 42.5 “Multistate Schedules” on page 1214.

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.
2. On the File menu, point to New and then click Schedule
Schedule.
3. In the object type list, select Multistate Schedule
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
Create.
Now you can add events to the multistate schedule and bind it to a multistate value.

04-13005-02-en, October 2012 System


1215
42 Schedule Types
42.7 Binding a Multistate Value to a Multistate Schedule

42.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.
For more information, see section 40.2 “Schedule Bindings” on page 1187.

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

System 04-13005-02-en, October 2012


1216
42 Schedule Types
42.8 Analog Schedules

42.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, a thermostat controls the temperature in a room. To regulate the
temperature, you can adjust a thermostat by tenths of a degree to accommodate
the needs of the people occupying the room.
For example, you can create an analog weekly schedule that adjusts the room
temperature to 20.3 °C (68.5 °F) from 08:00 to 17:00 Monday through Friday.

Figure: Analog schedule


You create schedules using WorkStation.

04-13005-02-en, October 2012 System


1217
42 Schedule Types
42.9 Creating an Analog Schedule

42.9 Creating an Analog Schedule


You create an analog schedule to control the state of an analog value.
For more information, see section 42.8 “Analog Schedules” on page 1217.

To create an analog schedule


1. In WorkStation, in the System Tree pane, select the server or the folder.
2. On the File menu, point to New and then click Schedule
Schedule.
3. In the object type list, select Analog Schedule
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
Create.
Now you can add events to the analog schedule and bind it to an analog value.

System 04-13005-02-en, October 2012


1218
42 Schedule Types
42.10 Binding an Analog Value to an Analog Schedule

42.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.
For more information, see section 40.2 “Schedule Bindings” on page 1187.

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

04-13005-02-en, October 2012 System


1219
43 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
43 Schedule Events
43.1 Schedule Events

43.1 Schedule Events


A schedule can have two types of events: weekly events and exception
events. Weekly events occur every week at a specified time. Exception
events occur when the schedule deviates from the weekly schedule, such as during
holidays. Exception events occur instead of the weekly events.
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

43.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 43.4 “Weekly Events in WorkStation” on page
1227.

43.1.2 Weekly Events in WebStation


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

43.1.3 Exception Events in WorkStation


An exception event occurs instead of the scheduled weekly events for either a
single date, a date range, a calculated date, or a calendar reference.
For more information, see section 43.5 “Exception Events in WorkStation” on page
1228.

43.1.4 Exception Events in WebStation


An exception event occurs instead of the scheduled weekly events for either a
single date, a date range, a calculated date, or a calendar reference.
For more information, see WebHelp.

04-13005-02-en, October 2012 System


1223
43 Schedule Events
43.1 Schedule Events

43.1.5 Priorities
Priority is a number that corresponds to a preassigned level of importance. When
used in schedules, priority numbers include 1 through 16. 1 is the most important
and highest priority. Exception events always take precedence over weekly events.
When two exception events conflict, there is a specific way to determine which
event takes precedence. For exception events you can assign priorities to
determine the order of their precedence. By default, all exception events have a
priority of 16, which is the lowest priority. You can change that number to a higher
priority from 1 to 15.
For more information, see section 41.5 “Priorities” on page 1199.

43.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 41.4 “Time Zones” on page 1198.

System 04-13005-02-en, October 2012


1224
43 Schedule Events
43.2 Displaying Client Time and Server Time in a Schedule

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


zone.
5. Click Show client time zone again to display the server time zone only.

04-13005-02-en, October 2012 System


1225
43 Schedule Events
43.3 Deleting a Date List Entry from a Calendar

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


List, select an entry.

4. On the Calendar Editor toolbar, click the Delete button .


Repeat the procedure to delete additional date list entries.

System 04-13005-02-en, October 2012


1226
43 Schedule Events
43.4 Weekly Events in WorkStation

43.4 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 example, in an analog schedule, for Monday, you schedule an air vent in a gym
to open to 40 % at 08:00 for a yoga class. For a more intense class at 10:00, you
schedule the air vent to open to 100 % until 13:00. Finally, at 13:00, you schedule
the air vent to close to 60 % until 20:00.

Figure: Example weekly events for a Monday


These events occur every Monday unless an exception event overrides the weekly
event.

04-13005-02-en, October 2012 System


1227
43 Schedule Events
43.5 Exception Events in WorkStation

43.5 Exception Events in WorkStation


An exception event occurs instead of the scheduled weekly events for either a
single date, a date range, a calculated date, or a calendar reference.
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.

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

43.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 Even, or Any month
month, and Any day
or Last day
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
• Day of week: Any day

End Date
• Year: Any year
• Month: April
• Day of month: Last day
• Day of week: Any day

System 04-13005-02-en, October 2012


1228
43 Schedule Events
43.5 Exception Events in WorkStation

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

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

04-13005-02-en, October 2012 System


1229
43 Schedule Events
43.6 Editing a Date Exception Event

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


1. In WorkStation, in the System Tree pane, select the schedule you want to
edit.
2. In the Work area, click the Basic view.
3. In the Event grid, select the date exception event you want to edit.

4. On the Basic toolbar, click the Edit schedule event button .


Continued on next page

System 04-13005-02-en, October 2012


1230
43 Schedule Events
43.6 Editing a Date Exception Event

5. Edit the properties.

Component Description

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
month, Even month
month, Any month
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.

04-13005-02-en, October 2012 System


1231
43 Schedule Events
43.6 Editing a Date Exception Event

6. Click Ok
Ok.

System 04-13005-02-en, October 2012


1232
43 Schedule Events
43.7 Editing a Date Range Exception Event

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


1. In WorkStation, in the System Tree pane, select the schedule you want to
edit.
2. In the Work area, click the Basic view.
3. In the Event grid, select the date range exception event you want to edit.

4. On the Basic toolbar, click the Edit schedule event button .


Continued on next page

04-13005-02-en, October 2012 System


1233
43 Schedule Events
43.7 Editing a Date Range Exception Event

5. Edit the properties.

Property Description

Event type Click Exception to display the exception


types.

Exception type Select Date range for the exception 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 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
month, Even month
month, Any month
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.

System 04-13005-02-en, October 2012


1234
43 Schedule Events
43.7 Editing a Date Range Exception Event

6. Click Ok
Ok.

04-13005-02-en, October 2012 System


1235
43 Schedule Events
43.8 Editing a Calculated Exception Event

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


1. In WorkStation, in the System Tree pane, select the schedule you want to
edit.
2. In the Work area, click the Basic view.

3. In the Event grid, select the calculated exception event you want to edit.

4. On the Basic toolbar, click the Edit schedule event button .


Continued on next page

System 04-13005-02-en, October 2012


1236
43 Schedule Events
43.8 Editing a Calculated Exception Event

5. Edit the properties.

Property Description

Event type Click Exception to display the exception


types.

Exception type Select Calculated for an exception type


to apply 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 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
month, Even month
month, Any month
month.

Week of month Select a week of the month for the


exception event or First week, Second
week, Third week
week, Fourth week, Last
week, Any week
week.

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.

04-13005-02-en, October 2012 System


1237
43 Schedule Events
43.8 Editing a Calculated Exception Event

6. Click Ok
Ok.

System 04-13005-02-en, October 2012


1238
43 Schedule Events
43.9 Adding a Date Range Exception Event

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


1. In WorkStation, in the System Tree pane, select the schedule you want to
add the date range exception event to.
2. Click the Basic view.

3. On the Basic toolbar, click the New Schedule Event button .


Continued on next page

04-13005-02-en, October 2012 System


1239
43 Schedule Events
43.9 Adding a Date Range Exception Event

4. Under Event type


type, click Exception
Exception.

5. Under Exception type


type, click Date range
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.
Continued on next page

System 04-13005-02-en, October 2012


1240
43 Schedule Events
43.9 Adding a Date Range Exception Event

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

04-13005-02-en, October 2012 System


1241
43 Schedule Events
43.10 Adding a Calculated Exception Event

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


1. In WorkStation, in the System Tree pane, select the schedule you want to
add the calculated exception event to.
2. Click the Basic tab.

3. On the Basic toolbar, click the New Schedule Event button .


Continued on next page

System 04-13005-02-en, October 2012


1242
43 Schedule Events
43.10 Adding a Calculated Exception Event

4. Under Event type


type, click Exception
Exception.

5. Under Exception type


type, click Calculated
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
OK.

04-13005-02-en, October 2012 System


1243
43 Schedule Events
43.11 Adding a Weekly Event

43.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 43.4 “Weekly Events in WorkStation” on page
1227.

To add a weekly event


1. In WorkStation, in the System Tree pane, select the schedule you want to
add the weekly event to.
2. Click the Basic tab.
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.

5. On the File menu, click Save


Save.

System 04-13005-02-en, October 2012


1244
43 Schedule Events
43.12 Adding a Calendar Exception Event

43.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.
For more information, see section 44.2 “Calendars in WorkStation” on page 1254.

To add a calendar exception event


1. In WorkStation, in the System Tree pane, select the schedule you want to
add the calendar to.
2. Click the Basic tab.
3. On the Basic Schedule Editor toolbar, click the New Schedule Event button

.
Continued on next page

04-13005-02-en, October 2012 System


1245
43 Schedule Events
43.12 Adding a Calendar Exception Event

4. Click Exception
Exception.

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

System 04-13005-02-en, October 2012


1246
43 Schedule Events
43.12 Adding a Calendar Exception Event

12. In the Calendar box, enter the calendar that you want to add.

13. Click OK
OK.
14. On the File menu, click Save
Save.

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.

04-13005-02-en, October 2012 System


1247
43 Schedule Events
43.13 Adding a Date Exception Event

43.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 43.5 “Exception Events in WorkStation” on page
1228.

To add a date exception event


1. In WorkStation, in the System Tree pane, select the schedule you want to
add the single date exception event to.
2. Click the Basic tab.
3. On the Basic Schedule Editor toolbar, click the New Schedule Event button

.
Continued on next page

System 04-13005-02-en, October 2012


1248
43 Schedule Events
43.13 Adding a Date Exception Event

4. Click Exception
Exception.

5. In the Exception type box, click Single date


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

04-13005-02-en, October 2012 System


1249
43 Schedule Events
43.13 Adding a Date Exception Event

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
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
OK.
17. On the File menu, click Save
Save.

System 04-13005-02-en, October 2012


1250
44 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
44 Calendars
44.1 Calendar Editor Overview

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

04-13005-02-en, October 2012 System


1253
44 Calendars
44.2 Calendars in WorkStation

44.2 Calendars in WorkStation


A calendar is a list of exception events. Rather than entering several exception
events in a schedule, you can reference a single calendar. The calendar provides
the schedule with the dates when the exception events shall occur.

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.

44.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 44.1 “Calendar Editor Overview” on page 1253.

System 04-13005-02-en, October 2012


1254
44 Calendars
44.2 Calendars in WorkStation

44.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
• Date range: a fixed period with a set start and stop date
• Calculated date: a fixed period that repeats
For more information, see section 44.3 “Calendar Events” on page 1256.

04-13005-02-en, October 2012 System


1255
44 Calendars
44.3 Calendar Events

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

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

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

System 04-13005-02-en, October 2012


1256
44 Calendars
44.3 Calendar Events

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

04-13005-02-en, October 2012 System


1257
44 Calendars
44.4 Creating a Calendar

44.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.
For more information, see section 44.2 “Calendars in WorkStation” on page 1254.

To create a calendar
1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the calendar.
2. On the File menu, point to New and then click Schedule
Schedule.
3. In the object type list, select Calendar
Calendar.

4. In the Name box, type a name for the calendar.


Continued on next page

System 04-13005-02-en, October 2012


1258
44 Calendars
44.4 Creating a Calendar

5. In the Description box, type a description for the calendar.

6. Click Create
Create.
Now you can add dates, date ranges, or calculated dates to the calendar.

04-13005-02-en, October 2012 System


1259
44 Calendars
44.5 Adding a Date Calendar Event

44.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.
For more information, see section 44.3 “Calendar Events” on page 1256.

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

System 04-13005-02-en, October 2012


1260
44 Calendars
44.5 Adding a Date Calendar Event

8. In the Day of week box, select the weekday for the date.

9. Click OK
OK.
10. On the File menu, click Save
Save.

04-13005-02-en, October 2012 System


1261
44 Calendars
44.6 Adding a Date Range Calendar Event

44.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.
For more information, see section 44.3 “Calendar Events” on page 1256.

To add a date range 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 Range button .
4. In the Entry name box, type the name that you want to display on the date
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.
Continued on next page

System 04-13005-02-en, October 2012


1262
44 Calendars
44.6 Adding a Date Range Calendar Event

12. In the Day of week box, select the weekday for the end date.

13. Click OK
OK.
14. On the File menu, click Save
Save.

04-13005-02-en, October 2012 System


1263
44 Calendars
44.7 Adding a Calculated Date Calendar Event

44.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.
For more information, see section 44.3 “Calendar Events” on page 1256.

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.
2. Click the Calendar Editor tab.

3. On the Calendar Editor toolbar, click the Add Calculated button .


4. In the Entry name box, type the name that you want to display on the date
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.
Continued on next page

System 04-13005-02-en, October 2012


1264
44 Calendars
44.7 Adding a Calculated Date Calendar Event

7. In the Day of week box, select a weekday for the calculated date.

8. Click OK
OK.
9. On the File menu, click Save
Save.

04-13005-02-en, October 2012 System


1265
44 Calendars
44.8 Configuring a Calendar as a Shadow

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

For more information, see section 44.13 “Schedule and Calendar Synchronization”
on page 1274.

To configure a calendar as a shadow


1. In WorkStation, in the System Tree pane, select the calendar you want to
configure as a shadow.
2. On the File menu, click Properties
Properties.
3. In the Lead object box, enter the calendar that you want to synchronize the
shadow calendar with.

4. Click OK
OK.

System 04-13005-02-en, October 2012


1266
44 Calendars
44.9 Storing Expired Calendar Events

44.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
Properties.
3. In the Remove past events box, select False to store events after they
expire.

4. Click the Save button .

04-13005-02-en, October 2012 System


1267
44 Calendars
44.10 Editing a Date Calendar Event

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


1. In WorkStation, in the System Tree pane, select the calendar you want to
edit.
2. Click the Calendar Editor tab.

3. In the date list, right-click the date calendar event you want to edit and click
Properties
Properties.
Continued on next page

System 04-13005-02-en, October 2012


1268
44 Calendars
44.10 Editing a Date Calendar Event

4. Edit the properties.

Component Description

Entry name Type an entry name for the calendar


entry.

Year Select a year. You can use Any year as a


valid entry.

Month Select a month for the exception event or


Odd month
month, Even month
month, Any month
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.

04-13005-02-en, October 2012 System


1269
44 Calendars
44.11 Editing a Date Range Calendar Event

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


1. In WorkStation, in the System Tree pane, select the calendar you want to
edit.
2. In Calendar Editor
Editor, select the date range calendar.

3. Right-click the date range calendar.


Continued on next page

System 04-13005-02-en, October 2012


1270
44 Calendars
44.11 Editing a Date Range Calendar Event

4. Edit the properties.

Component Description

Entry name Type an entry name for the calendar


entry.

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
month, Even month
month, Any month
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.

Year Select a year. You can use Any year as a


valid entry.

Month Select a month for the exception event or


Odd month
month, Even month
month, Any month
month.

5. Click OK
OK.

04-13005-02-en, October 2012 System


1271
44 Calendars
44.12 Editing a Calculated Date Calendar Event

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


1. In WorkStation, in the System Tree pane, select the calendar you want to
edit.
2. In Calendar Editor
Editor, select the calculated date calendar.

3. Right-click the calculated date calendar.


Continued on next page

System 04-13005-02-en, October 2012


1272
44 Calendars
44.12 Editing a Calculated Date Calendar Event

4. Edit the properties.

Component Description

Entry name Type an entry name for the calendar


entry.

Month Select a month for the exception event or


Odd month
month, Even month
month, Any month
month.

Week of month Select a week of the month for the


exception event or First week, Second
week, Third week
week, Fourth week, Last
week, Any week
week.

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

04-13005-02-en, October 2012 System


1273
44 Calendars
44.13 Schedule and Calendar Synchronization

44.13 Schedule and Calendar Synchronization


When you configure a schedule that controls events in a single part of a building,
you might want the same events to also occur in other areas of the building. You
can establish a lead and shadow relationship to synchronize the events in
schedules and calendars.
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.

System 04-13005-02-en, October 2012


1274
44 Calendars
44.13 Schedule and Calendar Synchronization

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.

04-13005-02-en, October 2012 System


1275
45 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
45 Schedules User Interface
45.1 Schedule Editor – Basic View

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

Basic View toolbar


Displays the toolbar to manage schedules.

Event grid
Displays weekly and exception events in
Graphic view.

04-13005-02-en, October 2012 System


1279
45 Schedules User Interface
45.2 Basic Schedule Editor Toolbar

45.2 Basic Schedule Editor Toolbar


Use the Basic Schedule Editor toolbar to manage schedules.
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.

System 04-13005-02-en, October 2012


1280
45 Schedules User Interface
45.3 Advanced Schedule Editor – Graphic View

45.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 45.4
“Advanced Schedule Editor Toolbar ” on
page 1283.

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.

04-13005-02-en, October 2012 System


1281
45 Schedules User Interface
45.3 Advanced Schedule Editor – Graphic View

Continued
Number Description

Calendar overview
Displays in blue the dates that contain
exception events.

System 04-13005-02-en, October 2012


1282
45 Schedules User Interface
45.4 Advanced Schedule Editor Toolbar

45.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
Click to delete events in the schedule.

Graphic View
Click to configure events in graphic mode.

Text View
Click to configure events in the textual mode.

04-13005-02-en, October 2012 System


1283
45 Schedules User Interface
45.5 Edit Effective Period Dialog Box

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


Component Description

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.

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.

Year Select a year. You can use Any year as a


valid entry.

Month Select a month for the exception event or


Odd month
month, Even month
month, Any month
month.

System 04-13005-02-en, October 2012


1284
45 Schedules User Interface
45.6 Edit Exception Dialog Box

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


Component Description

Exception name Type a name for the exception event.

Exception priority Select a priority for the exception event. Valid


values are from 1-16, 1 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.

04-13005-02-en, October 2012 System


1285
45 Schedules User Interface
45.7 Edit Time Value Period Dialog Box

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


Component Description

Value The value associated with an event.

Start Time Select hour, minutes, and seconds for your


start time.

No End Time Select to have the event last all day.

End Time Select hour, minutes, and seconds for your


end time.

System 04-13005-02-en, October 2012


1286
45 Schedules User Interface
45.8 Snap To Menu

45.8 Snap To Menu


Use the Snap To menu to select the time increments to display in ToolTips 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

04-13005-02-en, October 2012 System


1287
45 Schedules User Interface
45.9 Show Client Time Zone

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

System 04-13005-02-en, October 2012


1288
45 Schedules User Interface
45.10 Schedule Properties – Basic Tab

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


Component Description

Value The value associated with an event.

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.

Time to next transition (min) Displays the amount of time in minutes


before the value changes.

04-13005-02-en, October 2012 System


1289
45 Schedules User Interface
45.10 Schedule Properties – Basic Tab

Continued
Component Description

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.

System 04-13005-02-en, October 2012


1290
45 Schedules User Interface
45.11 Schedule Event Properties Dialog Box – Weekly View

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


Component Description

Event type Click Weekly to select a weekly event type.

04-13005-02-en, October 2012 System


1291
45 Schedules User Interface
45.11 Schedule Event Properties Dialog Box – Weekly View

Continued
Component Description

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.

Delete Entry Click to delete an entry from the Times and


values box.

System 04-13005-02-en, October 2012


1292
45 Schedules User Interface
45.12 Schedule Event Properties Dialog Box – Single Date Exception View

45.12 Schedule Event Properties Dialog Box –


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
Component Description

Event type Click Exception to display the exception


types.

04-13005-02-en, October 2012 System


1293
45 Schedules User Interface
45.12 Schedule Event Properties Dialog Box – Single Date Exception View

Continued
Component Description

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
month, Even month
month, Any month
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.

System 04-13005-02-en, October 2012


1294
45 Schedules User Interface
45.13 Schedule Event Properties Dialog Box – Date Range Exception View

45.13 Schedule Event Properties Dialog Box –


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
Component Description

Event type Click Exception to display the exception


types.

04-13005-02-en, October 2012 System


1295
45 Schedules User Interface
45.13 Schedule Event Properties Dialog Box – Date Range Exception View

Continued
Component Description

Exception type Select Date range as an 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 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
month, Even month
month, Any month
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.

System 04-13005-02-en, October 2012


1296
45 Schedules User Interface
45.14 Schedule Event Properties Dialog Box – Calculated Exception View

45.14 Schedule Event Properties Dialog Box –


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


Component Description

Event type Click Exception to display the exception


types.

04-13005-02-en, October 2012 System


1297
45 Schedules User Interface
45.14 Schedule Event Properties Dialog Box – Calculated Exception View

Continued
Component Description

Exception type Select Calculated for an exception type to


apply to the schedule.

All Day Select All Day for an all day event.

Name Type a name for the event.

Priority Select a priority number between 1 (highest


priority) and 16 (lowest priority).

Year Displays Any Year which is the default for


the calculated exception view.

Month Select a month for the exception event or


Odd month
month, Even month
month, Any month
month.

Week of month Select a week of the month for the exception


event or First week, Second week, Third
week
week, Fourth week, Last week, Any week
week.

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.

System 04-13005-02-en, October 2012


1298
45 Schedules User Interface
45.15 Schedule Event Properties Dialog Box – Calendar Reference View

45.15 Schedule Event Properties Dialog Box –


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


Component Description

Event type Click Exception to display the exception


types.

04-13005-02-en, October 2012 System


1299
45 Schedules User Interface
45.15 Schedule Event Properties Dialog Box – Calendar Reference View

Continued
Component Description

Exception type Select Calendar to initiate a calendar


reference.

All Day Select All Day for an all day event.

Name Type a name for the event.

Priority Select a priority number between 1 (highest


priority) and 16 (lowest priority).

Calendar Select a calendar to reference.

System 04-13005-02-en, October 2012


1300
45 Schedules User Interface
45.16 Calendar Editor View

45.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. For more
information, see section 44.3 “Calendar
Events” on page 1256.

Use the Calendar Editor toolbar to add and


delete calendar events. For more
information, see section 45.17 “Calendar
Editor Toolbar” on page 1302.

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 44.1 “Calendar
Editor Overview” on page 1253.

04-13005-02-en, October 2012 System


1301
45 Schedules User Interface
45.17 Calendar Editor Toolbar

45.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 45.19
“Edit Calendar Entry Dialog Box – Add Date”
on page 1304.

Add Date Range


Click to add an event that contains a date
range. For more information, see section
45.20 “Edit Calendar Entry Dialog Box –
Date Range ” on page 1305.

Add Calculated Date


Click to add an event that recurs on a regular
basis. For more information, see section
45.21 “Edit Calendar Entry Dialog Box –
Calculated Date ” on page 1307.

Delete
Click to delete events in the schedule.

System 04-13005-02-en, October 2012


1302
45 Schedules User Interface
45.18 Calendar Properties – Basic Tab

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


Component Description

Value Displays True when the current date


matches the date specified in the calendar
entry in the Date List
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.

04-13005-02-en, October 2012 System


1303
45 Schedules User Interface
45.19 Edit Calendar Entry Dialog Box – Add Date

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


Component Description

Entry name Type an entry name for the calendar entry.

Year Select a Year for the date calendar entry.


You can also use Any Year as a valid entry.

Month Select a month for the exception event or


Odd month
month, Even month
month, Any month
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.

System 04-13005-02-en, October 2012


1304
45 Schedules User Interface
45.20 Edit Calendar Entry Dialog Box – Date Range

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


Component Description

Entry name Type an entry name for the calendar entry.

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
month, Even month
month, Any month
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.

Year Select a year. You can use Any year as a


valid entry.

04-13005-02-en, October 2012 System


1305
45 Schedules User Interface
45.20 Edit Calendar Entry Dialog Box – Date Range

Continued
Component Description

Month Select a month for the exception event or


Odd month
month, Even month
month, Any month
month.

System 04-13005-02-en, October 2012


1306
45 Schedules User Interface
45.21 Edit Calendar Entry Dialog Box – Calculated Date

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


Component Description

Entry name Type an entry name for the calendar entry.

Month Select a month for the exception event or


Odd month
month, Even month
month, Any month
month.

Week of month Select a week of the month for the exception


event or First week, Second week, Third
week
week, Fourth week, Last week, Any week
week.

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.

04-13005-02-en, October 2012 System


1307
46 WorkStation

Topics
WorkStation
System Tree Pane
List View
Control Panel
Opening Control Panel
Quick Filter
Hyperlinks
Creating a Hyperlink
Utilities
46 WorkStation
46.1 WorkStation

46.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 9.6
“Licenses” on page 181.

Figure: WorkStation and Building Operation Server

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

04-13005-02-en, October 2012 System


1311
46 WorkStation
46.1 WorkStation

Figure: Different workspaces in WorkStation

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

System 04-13005-02-en, October 2012


1312
46 WorkStation
46.2 System Tree Pane

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

04-13005-02-en, October 2012 System


1313
46 WorkStation
46.2 System Tree Pane

All other objects are non-presentation objects.

System 04-13005-02-en, October 2012


1314
46 WorkStation
46.3 List View

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

04-13005-02-en, October 2012 System


1315
46 WorkStation
46.4 Control Panel

46.4 Control Panel


The Control Panel gives you easy access to some of the most used 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

System 04-13005-02-en, October 2012


1316
46 WorkStation
46.5 Opening Control Panel

46.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 46.4 “Control Panel” on page 1316.

To open Control Panel


1. In WorkStation, on the Tools menu, click Control Panel
Panel.

04-13005-02-en, October 2012 System


1317
46 WorkStation
46.6 Quick Filter

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

System 04-13005-02-en, October 2012


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

04-13005-02-en, October 2012 System


1319
46 WorkStation
46.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).

System 04-13005-02-en, October 2012


1320
46 WorkStation
46.7 Hyperlinks

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

04-13005-02-en, October 2012 System


1321
46 WorkStation
46.8 Creating a Hyperlink

46.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 46.7 “Hyperlinks” on page 1321.

To crate a hyperlink
1. In WorkStation, in the System Tree pane, select the folder where you want to
create the hyperlink.
2. On the File menu, point to New and then click Hyperlink
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
Next.
6. In the URL box, enter the URL for the hyperlink.
7. Click OK
OK.

System 04-13005-02-en, October 2012


1322
46 WorkStation
46.9 Utilities

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

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

46.9.2 Simple Math Operators


Simple Math Operator is used to add, subtract, multiply and divide a one value from
another.

04-13005-02-en, October 2012 System


1323
47 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, Rename, and Delete
Deleting an Object
Renaming a Folder or Object
Creating a Folder
Copying a Folder or Object
47 Building Operation Objects
47.1 Object Types

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

04-13005-02-en, October 2012 System


1327
47 Building Operation Objects
47.2 Object Names

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

System 04-13005-02-en, October 2012


1328
47 Building Operation Objects
47.3 Object Properties

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

04-13005-02-en, October 2012 System


1329
47 Building Operation Objects
47.3 Object 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.
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.

System 04-13005-02-en, October 2012


1330
47 Building Operation Objects
47.4 Opening an Object in a New Window

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

04-13005-02-en, October 2012 System


1331
47 Building Operation Objects
47.5 Object Tab Display

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

System 04-13005-02-en, October 2012


1332
47 Building Operation Objects
47.6 Showing the Same Tab While Navigating Between Objects

47.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 47.6 “Showing the Same Tab While Navigating
Between Objects” on page 1333.

To show the same tab while navigating between objects


1. In WorkStation, on the Tools menu, click Options
Options.
2. Select Show same tab while navigating between objects
objects.
3. Click OK
OK.

04-13005-02-en, October 2012 System


1333
47 Building Operation Objects
47.7 Showing Non-Presentation Objects in the System Tree Pane

47.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 46.2 “System Tree Pane” on page 1313.

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

System 04-13005-02-en, October 2012


1334
47 Building Operation Objects
47.8 Multi-edit

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

04-13005-02-en, October 2012 System


1335
47 Building Operation Objects
47.9 Editing Multiple Objects

47.9 Editing Multiple Objects


You can edit more than one object at the same time to save time.
For more information, see section 47.8 “Multi-edit” on page 1335.

To edit multiple objects


1. In WorkStation, in the List View
View, select the objects you want to edit.
2. On the List View toolbar, click Show/Hide Property Grid
Grid.
3. In the Property Grid
Grid, edit the property you want to change for all selected
objects.

4. Click the Save button .

System 04-13005-02-en, October 2012


1336
47 Building Operation Objects
47.10 Move, Rename, and Delete

47.10 Move, Rename, and Delete


You can move, rename, and delete objects from the Building Operation database at
any time. 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. However, this is true only if the object
is online.
To help you identify the object references that are affected when you move,
rename, or delete an object, Building Operation displays a dialog box with
information about references.
If some of the objects are offline during a rename or delete, the system cannot
update the references. In this case the Confirm dialog box informs you about the
references that cannot be updated. You can still complete the procedure but you
have to keep track of the reference that is not updated. You can repair the
references when the offline object is online again.
To help you keep track of references not updated, you use the Copy to clipboard
function in the Confirm dialog box.
When the object is online again, select the object with the reference not updated
and click Repair reference in the Action menu to repair the reference.

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 21.4 “Path Permissions” on page 434.

04-13005-02-en, October 2012 System


1337
47 Building Operation Objects
47.11 Deleting an Object

47.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 47.10 “Move, Rename, and Delete” on page
1337.

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
Delete.
3. In the Confirm Delete dialog box, click Yes
Yes.

System 04-13005-02-en, October 2012


1338
47 Building Operation Objects
47.12 Renaming a Folder or Object

47.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 21.4 “Path Permissions” on page 434.

Note
You cannot change the name of a domain that is shared between servers.

For more information, see section 47.10 “Move, Rename, and Delete” on page
1337.

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
Rename.
3. In the Rename object dialog box, type the new name.
4. Click OK
OK.
5. In the Confirm Rename dialog box, click Yes
Yes.

04-13005-02-en, October 2012 System


1339
47 Building Operation Objects
47.13 Creating a Folder

47.13 Creating a Folder


You create folders to organize your Building Operation database.
For more information, see 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
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
Create.

System 04-13005-02-en, October 2012


1340
47 Building Operation Objects
47.14 Copying a Folder or Object

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

04-13005-02-en, October 2012 System


1341
48 Archive

Topics
Archiving Overview
Manually Creating an Archive
Creating a Scheduled Archive
Selecting an Archive File Format
Including Trend Logs in the Archive
Removing Trend Logs from the Archive
Including Alarm Events in the Archive
Including User Events in the Archive
Including System Events in the Archive
Event Archive and Trend Log Archive
Archiving Formats
Archive Folders, Files, and Names
Enabling the Archiving Function and Defining the Archive
Folder
Manual and Scheduled Archiving
Event and Alarm Enumerations
Trend Log Enumerations
48 Archive
48.1 Archiving Overview

48.1 Archiving Overview


Archiving is used to archive historical data. Archiving is not a backup function
because the archive data cannot be imported back into the system.
Archiving is performed on an Enterprise Server that is part of an Enterprise network.

Important
Archiving is performed only on an Enterprise Server. If you want to archive a
Trend Log on an Automation Server, use an Extended Trend Log in the Enterprise
Server to collect data from the Trend Log in the Automation Server. Archiving
cannot be performed on a standalone Automation Server.
The Enterprise Server service runs under the local system account in Windows.
To be able to access the network drives for archiving, you need to change the
account for the services.

You can include the following types of data in an archive:


• Trend Logs and Extended Trend Logs
• Alarm events
• User activity
• System events
The system archives the selected data in two ways: Trend Log and Event Log.
• Trend Log. Each Trend Log is archived in a separate file.
• Event Log. All alarm events, user activity, and system events are archived into
one file.

48.1.1 Manual and Scheduled Archiving


You can generate an archive in two ways: manual or scheduled. Manual archiving is
performed by a user on an as-needed basis. Scheduled archiving is an automated
process performed by the system at regularly scheduled intervals.
For more information, see section 48.14 “Manual and Scheduled Archiving” on
page 1360.

48.1.2 Archiving Formats


You can make an archive using two formats, csv and .xml.
For more information, see section 48.11 “Archiving Formats” on page 1356.

48.1.3 Archiving Configuration


Before creating an archive, you need to enable Archiving and define a path where
the archive is stored (Control Panel, Archiving). You can save the archive to your
hard disk, an external memory device, or a server on your network.

04-13005-02-en, October 2012 System


1345
48 Archive
48.1 Archiving Overview

48.1.4 Archive Folders, Files, and Names


As part of the archive process, the system creates uniquely named archive files and
associated folders that identify the type of archive (manual or scheduled) and the
date on which the archive was performed. By default, these folders are located in
the Logs directory where the Enterprise Server is installed. However, you can
change the directory to another location.
For more information, see section 48.12 “Archive Folders, Files, and Names” on
page 1357.

48.1.5 Read Event Archive and Trend Log Archive


When you open an event archive or Trend Log archive in an editor that supports
structured data, the information is presented in columns. The columns may contain
text strings, paths, identities, or enumeration values.
For more information, see section 48.10 “ Event Archive and Trend Log Archive” on
page 1355.

48.1.6 Archiving System Alarms


The system generates an alarm if some conditions of the archiving process are not
met, for example, if the defined folder path is not valid. Generally, these system
alarms use default settings that are non-configurable.

System 04-13005-02-en, October 2012


1346
48 Archive
48.2 Manually Creating an Archive

48.2 Manually Creating an Archive


You create an archive manually on an as-needed basis. Afer you define a path, you
can perform a manual archive.
For more information, see section 48.1 “Archiving Overview” on page 1345.

To manually create an archive


1. In WorkStation, on the Tools menu, click Control Panel
Panel, and then click
Archiving
Archiving.
2. In the Path box, type a location where you want to store the archive files.
3. On the the Action menu, point to Actions
Actions, and then click Create archive(s)
now
now.
The archive is saved at the path defined in the Archive Settings.

04-13005-02-en, October 2012 System


1347
48 Archive
48.3 Creating a Scheduled Archive

48.3 Creating a Scheduled Archive


You create a scheduled archive to automate the process of archiving historical
data. After you define a path and set the interval, you can create an regularly
scheduled archive process managed by the system.

To create a scheduled archive


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Control Panel
Panel, click Archiving
Archiving.
3. Click the Basic tab.
4. In the Path box, define the location where you want to store the archived files.
5. In the Period box, select the schedule interval you want to use, such as
Monthly
Monthly.
6. In the Day box, select the delay time to ensure that all the values are included
in the archive, for example, 1 day.
7. Click Save
Save.

System 04-13005-02-en, October 2012


1348
48 Archive
48.4 Selecting an Archive File Format

48.4 Selecting an Archive File Format


You choose between .xml or .csv format when creating an archive.
For more information, see section 48.11 “Archiving Formats” on page 1356.

To select an archive file format


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. Click Archiving
Archiving.
3. Click the Basic tab.
4. In the Output format box, select CSV or XML
XML.
5. Click Save
Save.

04-13005-02-en, October 2012 System


1349
48 Archive
48.5 Including Trend Logs in the Archive

48.5 Including Trend Logs in the Archive


You are able to archive trend logs if you include them in the archive using the
Properties dialog box.
For more information, see section 48.1 “Archiving Overview” on page 1345.

To include trend logs in the archive


1. In WorkStation, on the Tools menu, click Control Pane.
2. Click Archiving
Archiving.
3. Click the Properties tab.
4. Click the Content tab.
5. In the Include trend log
log, click Add
Add.
6. Browse to the trend log you want to include and click Select
Select.
7. Click Save
Save.

System 04-13005-02-en, October 2012


1350
48 Archive
48.6 Removing Trend Logs from the Archive

48.6 Removing Trend Logs from the Archive


You remove trend logs that you do not want to include in the archive using the
Properties dialog box.
For more information, see section 48.1 “Archiving Overview” on page 1345.

To remove a trend log from the archive


1. In WorkStation, on the Tools menu, click Control Panel.
2. Click Archiving
Archiving.
3. Click the Properties tab.b
4. Click the Content tab.
5. In the Log box, clear the logs you want to remove.
6. Click Save
Save.

04-13005-02-en, October 2012 System


1351
48 Archive
48.7 Including Alarm Events in the Archive

48.7 Including Alarm Events in the Archive


You select alarms events to include them in the archive.
For more information, see section 48.1 “Archiving Overview” on page 1345.

To include alarm events in the archive


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. Click Archiving
Archiving.
3. Click the Properties tab.
4. Click the Content tab.
5. In the Alarm box, select True
True.
6. Click Save
Save.

System 04-13005-02-en, October 2012


1352
48 Archive
48.8 Including User Events in the Archive

48.8 Including User Events in the Archive


You select user events to include them in the archive.
For more information, see section 48.1 “Archiving Overview” on page 1345.

To include user events in the archive


1. In WorkStation, on the Tool menu, click Control Panel
Panel.
2. Click Archiving
Archiving.
3. Click the Properties tab.
4. Click the Content tab.
5. In the User box, select True
True.
6. Click Save
Save.

04-13005-02-en, October 2012 System


1353
48 Archive
48.9 Including System Events in the Archive

48.9 Including System Events in the Archive


You select system events to include them in the archive.
For more information, see section 48.1 “Archiving Overview” on page 1345.

To include system events in the archive


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. Click Archiving
Archiving.
3. Click the Properties tab.
4. Click the Content tab.
5. In the System box, select True
True.
6. Click Save
Save.

System 04-13005-02-en, October 2012


1354
48 Archive
48.10 Event Archive and Trend Log Archive

48.10 Event Archive and Trend Log Archive


When you open an event archive or Trend Log archive in an editor that supports
structured data, the information is presented in columns. The columns may contain
text strings, paths, identities, or enumeration values.

48.10.1 Event and Alarm Enumerations


An enumeration is a range of values that represent a specific command or event.
The following alarm and event properties use enumeration values:
• Alarm State
• Assigned State
• BACnet Event Type
• Basic Evaluation State
• Disabled Cause
• Evaluation State
• Hidden
• Previous Alarm State
• Server Offline
• System Alarm ID
• System Event ID
For more information, see section 48.15 “Event and Alarm Enumerations” on page
1361.

48.10.2 Trend Log Enumerations


An enumeration is a range of values that represents a specific command or event.
Trend log properties use two enumeration values: Events and Status.

04-13005-02-en, October 2012 System


1355
48 Archive
48.11 Archiving Formats

48.11 Archiving Formats


You can make an archive using two formats, csv and .xml.

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

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

System 04-13005-02-en, October 2012


1356
48 Archive
48.12 Archive Folders, Files, and Names

48.12 Archive Folders, Files, and Names


As part of the archive process, the system creates uniquely named archive files and
associated folders that identify the type of archive (manual or scheduled) and the
date on which the archive was performed. By default, these folders are located in
the Logs directory where the Enterprise Server is installed. However, you can
change the directory to another location.

Figure: Archive folders listed in the specified directory on the file system

48.12.1 Archive Folder Names


As part of the archive process, the system creates a new folder in the directory of
the path specified in the Archive Settings. The CSV or XML files generated for the
archive are placed in 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 June 1, 2009, the system creates
a folder named Manual_2009-06-01. If you generate an archive the following day,
the system creates a new folder with the new date.

48.12.2 File Names for Trend Log Archives


The system names the Trend Log archives using the Method_(Address)_date.file
extension format. For example, if you manually generate an archive on July 1, 2009
for the Temperature Building A Trend Log, the system creates a Building A folder
containing the trend log under the Enterprise Server (Server 1) in the System Tree.
The system names the archive file
Manual_(Server_1_Building_A_Temperature_Building_A)_2009-07-01.csv because
the Trend Log monitored a value called Temperature in an Automation Server.

48.12.3 File Names for Events Log Archives


The system names the Events log archives using the Method_(EventLog)_date.file
extension format. For example, if you manually generate an archive on July 1, 2009
for the Alarm, User, and System events, the system names the archive file
Manual_(Server_1_System_Events_EventLog_EventRecords)_2009-07-01.csv.

04-13005-02-en, October 2012 System


1357
48 Archive
48.12 Archive Folders, Files, and Names

48.12.4 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_Building_A_Temperature_Building_A)_2009-06-30.csv and
immediately generate another identical archive, the system names the second
archive, Manual_(Server_1_Building_A_Temperature_Building_A)_2009-06-
30_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.

System 04-13005-02-en, October 2012


1358
48 Archive
48.13 Enabling the Archiving Function and Defining the Archive Folder

48.13 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 the system stores the archives.
For more information, see section 48.1 “Archiving Overview” on page 1345.

To enable the archiving function and define the archive folder


1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Control Panel
Panel, click Archiving
Archiving.
3. Click Properties
Properties.
4. Click the Basic tab.
5. In the Enabled box, select True
True.

6. In the Path box, type the path to the directory where you plan to store the
archive files.
7. Click Save
Save.
You designate a different archive directory by typing a new address in the Path box.

04-13005-02-en, October 2012 System


1359
48 Archive
48.14 Manual and Scheduled Archiving

48.14 Manual and Scheduled Archiving


You can generate an archive in two ways: manual or scheduled. Manual archiving is
performed by a user on an as-needed basis. Scheduled archiving is an automated
process performed by the system at regularly scheduled intervals.

48.14.1 Manual Archiving


You can create a new archive manually at any time. The created archive contains
data from the last time an archive was created to the time that you create the new
archive. For example, if the system automatically generates an archive on the first
day of every month, you can manually create an archive on the fifteenth to archive
all the data between the first and the fifteenth. For more information, see section
48.2 “Manually Creating an Archive” on page 1347.

48.14.2 Scheduled Archiving


You can set up the system to generate archives automatically at predefined
intervals, such as weekly.
Archiving can be set up in the following intervals:
• Weekly
Weekly. Creates an archive on a weekly basis, Monday to Sunday.
• Monthly
Monthly. Creates an archive on a one-month basis, such as January.
• Bi-monthly
Bi-monthly. Creates an archive on a two calendar-month basis: January-
February, March-April, May-June, July-August, September-October, or
November-December.
• Quarterly
Quarterly. Creates an archive on a quarterly basis: January-March, April-June,
July-September, or October-December.
• Yearly
Yearly. Creates an archive on a yearly basis, such as 2011.

Tip
Use the Day (delay) function when you set up a new scheduled archive to ensure
that all values of a log are included. The delay can be set from 1 to 7 days.

For more information, see section 48.3 “Creating a Scheduled Archive” on page
1348.

48.14.3 About Trend Logs and Event Archives


Creation
Regardless of the selected archiving method (manual or scheduled), the trend log
and event archives are created at the same time.

System 04-13005-02-en, October 2012


1360
48 Archive
48.15 Event and Alarm Enumerations

48.15 Event and Alarm Enumerations


An enumeration is a range of values that represent a specific command or event.
The following alarm and event properties use enumeration values:
• Alarm State
• Assigned State
• BACnet Event Type
• Basic Evaluation State
• Disabled Cause
• Evaluation State
• Hidden
• Previous Alarm State
• Server Offline
• System Alarm ID
• System Event ID
The following tables list the enumeration values for each property.

Table: Alarm State


Enumeration value Enumeration definition

0 Normal

1 Alarm

2 Acknowledged

3 Reset

4 Disabled

5 Fault

Table: Assigned State


Enumeration value Enumeration definition

0 Unassigned

1 Assigned

2 Accepted

Table: Bacnet Event Type


Enumeration Value Enumeration definition

0 Change of bitstring

04-13005-02-en, October 2012 System


1361
48 Archive
48.15 Event and Alarm Enumerations

Continued
Enumeration Value Enumeration definition

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

Table: Basic Evaluation State


Enumeration value Enumeration definition

0 False

1 True

Table: Disabled Cause


Enumeration value Enumeration definition

1 Shunt variable

2 Command

4 System

Table: Evaluation State


Enumeration value Enumeration definition

0 Normal

1 Off-normal alarm

2 Upper limit alarm

3 Lower limit alarm

System 04-13005-02-en, October 2012


1362
48 Archive
48.15 Event and Alarm Enumerations

Continued
Enumeration value Enumeration definition

4 Life safety alarm

5 Faulty alarm

Table: Hidden
Enumeration value Enumeration definition

0 False

1 True

Table: Previous Alarm State


Enumeration value Enumeration definition

0 Normal

1 Alarm

2 Acknowledged

3 Reset

4 Disabled

5 Fault

Table: Server Offline


Enumeration value Enumeration definition

0 False

1 True

Table: System Alarm ID


Enumeration value Enumeration definition

0 Server restarted

1 IO module offline

2 Remote server offline

4 E-mail service failed to connect to SMTP server

04-13005-02-en, October 2012 System


1363
48 Archive
48.15 Event and Alarm Enumerations

Continued
Enumeration value Enumeration definition

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

10 Signal alarm

11 Cannot verify lead object status

12 Duplicate of local network

13 Duplicate network identifier

14 Duplicate device identifier

15 Invalid device identifier

16 Duplicate device address

17 Duplicate device name

18 Defective protocol implementation

19 BACnet did not start

20 Failed to create object

21 Failed to initialize references

22 Database update failed

23 A log sample was missed

24 A log data transfer was missed

25 File I/O error

26 Server configuration error

27 Network offline

28 IP connection offline

29 Signal event

30 New application program

31 Parser failed

32 Unit is locked

System 04-13005-02-en, October 2012


1364
48 Archive
48.15 Event and Alarm Enumerations

Continued
Enumeration value Enumeration definition

33 Unit is unlocked

34 Logging started

35 Logging stopped

36 Log stopped because it is full

37 Log full

38 Not enough RAM memory for log

39 Too many log definitions

40 Error in log definition

41 Not enough flash memory for log

42 Log variable error

43 No valid Blueprint File

44 Unhandled buffer ready notification

45 Alarm signal trigger buffer full

46 Bad lead object reference

47 Bad lead object type

48 Shadow update failed

49 Unable to access lead object

50 Incorrect lead object back-reference

51 Unable to access shadow object

52 Server not restarted Backup in process

53 Server not restarted Restore in process

54 Server not restarted Other

55 Failure retrieving backup set from remote server

56 Failure restoring server database

57 Failure backing up server database

58 E-mail service fail to send message

59 E-mail service configuration error

256 Communication failed Configuration error

04-13005-02-en, October 2012 System


1365
48 Archive
48.15 Event and Alarm Enumerations

Continued
Enumeration value Enumeration definition

257 Communication failed Unexpected Server fullpath

258 Communication failed Unexpected Server type

259 Communication failed Authentication error

260 Communication failed Authorization error

261 Communication failed Domain is not available

Table: System Event ID


Enumeration value Enumeration description

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 - account expired

9 Log on failed - no permissions

10 Password changed

11 Property changed

12 Command executed

13 IO module offline

14 IO module online

15 Object created

16 Object deleted

17 Objects imported

18 Objects deployed

19 Object moved

System 04-13005-02-en, October 2012


1366
48 Archive
48.15 Event and Alarm Enumerations

Continued
Enumeration value Enumeration description

20 Object renamed

21 File notification sent

22 Email notification sent

23 Object changed

24 Log on failed - user not associated with a group

25 Server database backed up

26 Server database restored

04-13005-02-en, October 2012 System


1367
48 Archive
48.16 Trend Log Enumerations

48.16 Trend Log Enumerations


An enumeration is a range of values that represents a specific command or event.
Trend log properties use two enumeration values: Events and Status.

Table: Event
Enumeration value Enumeration definition

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

Table: Status
Enumeration value Enumeration definition

0 None

1 Offline

2 Forced

4 Invalid

8 Override

16 In alarm

32 Fault

64 Out of service

System 04-13005-02-en, October 2012


1368
49 Search

Topics
Search Overview
Simple Search
Performing a Search Using Simple Search
Saving a Search
Search View
Advanced Search
Search for Objects Using Advanced Search
Setpoint Search Example
Non-Validated Programs Search Example
49 Search
49.1 Search Overview

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

49.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 49.2 “Simple Search” on page 1373.

49.1.2 Search View


Search View is the interface where you do the settings for an Advanced search. The
result of a search is presented in the Search result list in the Search View.

For more information, see section 49.5 “Search View” on page 1377.

49.1.3 Saved Search


Frequently used searches including the settings can be saved and reused.
A Saved search is displayed in the System Tee 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).

04-13005-02-en, October 2012 System


1371
49 Search
49.1 Search Overview

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.

System 04-13005-02-en, October 2012


1372
49 Search
49.2 Simple Search

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

49.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 two main wildcards:
• Asterisk (*) represents any combination of characters including white space.
• 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.
The square brackets [] are used when searching for characters already used by
search. If you want to search for an “[“ you have to place it inside square brackets
like this [[].

04-13005-02-en, October 2012 System


1373
49 Search
49.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 (*).

49.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 46.3 “List
View” on page 1315.

System 04-13005-02-en, October 2012


1374
49 Search
49.3 Performing a Search Using Simple Search

49.3 Performing a Search Using Simple


Search
You use Simple search to search for an object by its name.
For more information, see section 49.5 “Search View” on page 1377.

To perform a search using simple search


1. In WorkStation, in the Search box, enter the text you want to search for.

2. Click the Search button .


The search result is presented in the Search view list.

04-13005-02-en, October 2012 System


1375
49 Search
49.4 Saving a Search

49.4 Saving a Search


You save a search so you can reuse it later.
For more information, see section 49.1 “Search Overview” on page 1371.

To save a search

1. In WorkStation, on the Search toolbar, click the Save Search button .


2. Enter the location where you want to save the search.
3. In the Name box, type a name.
4. Click Save
Save.
The Search is now saved in the System Tree pane.

System 04-13005-02-en, October 2012


1376
49 Search
49.5 Search View

49.5 Search View


Search View is the interface where you do the settings for an Advanced search. The
result of a search is presented in the Search result list in the Search View.

49.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 two main wildcards:
• Asterisk (*) represents any combination of characters including white space.
• 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.
The square brackets [] are used when searching for characters already used by
search. If you want to search for an “[“ you have to place it inside square brackets
like this [[].

04-13005-02-en, October 2012 System


1377
49 Search
49.5 Search View

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

49.5.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 46.3 “List
View” on page 1315.

49.5.3 Subserver Search


Use subserver search to include subservers in the search. The setting is done using
Include subservers checkbox in the Search view. Subserver search is selected by
default.

Figure: Include subservers checkbox in the Search view


A multiserver search is likely to require more time to execute than a single server
search.

49.5.4 Advanced Search


Use the advanced search to filter and refine a search so you don’t get too many
irrelevant results.

System 04-13005-02-en, October 2012


1378
49 Search
49.5 Search View

For more information, see section 49.6 “Advanced Search” on page 1380.

04-13005-02-en, October 2012 System


1379
49 Search
49.6 Advanced Search

49.6 Advanced Search


Use the advanced search to filter and refine a search so you don’t get too many
irrelevant results.
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.

Figure: Advanced Search

49.6.1 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".
You include types in the search by selecting them in the Select types dialog box in
the Search view.
If you know the name of a specific object type you want to include, you can use the
Find type box to find the object type.

System 04-13005-02-en, October 2012


1380
49 Search
49.6 Advanced Search

Figure: Select types dialog box

49.6.2 Properties Conditions Search


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.

04-13005-02-en, October 2012 System


1381
49 Search
49.6 Advanced Search

If you choose to include one or more object types in the Select types dialog you get
the common properties for these object types. If no object types is selected in the
Select types dialog box, only the general properties for all objects types is available
in the Select Conditions dialog box.
Search is performed with “AND” between different types of properties but with “OR”
between properties of the same kind.
If you include only one object in the Select type dialog box you can choose between
all the properties for that objects. For example if you choose Alarm in the Select
types dialog you can choose 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.

System 04-13005-02-en, October 2012


1382
49 Search
49.6 Advanced Search

Figure: The properties available in the Select Conditions dialog box when alarm is
selected in the Include types dialog box.
There are different condition formats depending on property type:
• Enumeric values (optional non-exclusive)
• Textual matching (wildcard support)
• Date interval
• Boolean (true or false)
• Numeric range

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

49.6.3 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”, “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 49.8 “Setpoint Search Example” on page 1386.

49.6.4 Non-Validated Programs Search Example


You want to find the programs that are not validated in your system. So you
searcdh for all programs that have validation set to None or Failed.
For more information, see section 49.9 “Non-Validated Programs Search Example”
on page 1389.

04-13005-02-en, October 2012 System


1383
49 Search
49.7 Search for Objects Using Advanced Search

49.7 Search for Objects Using Advanced


Search
You use this procedure to find objects in the database.
For more information, see section 49.1 “Search Overview” on page 1371.

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

System 04-13005-02-en, October 2012


1384
49 Search
49.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
OK.
11. In the Conditions box, click the brows button if you want to add conditions
for the search.

12. Click OK
OK.

13. Click the Search button .


Search results are displayed in the Search result area.

04-13005-02-en, October 2012 System


1385
49 Search
49.8 Setpoint Search Example

49.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”, “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.
You only want to search in University X, not in University Y, therefore you limit the
search to University X. To do this right-click the folder University X and then click
Search.
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”.

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.

System 04-13005-02-en, October 2012


1386
49 Search
49.8 Setpoint Search Example

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 between 22 and 100.

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.

04-13005-02-en, October 2012 System


1387
49 Search
49.8 Setpoint Search Example

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

System 04-13005-02-en, October 2012


1388
49 Search
49.9 Non-Validated Programs Search Example

49.9 Non-Validated Programs Search


Example
You want to find the programs that are not validated in your system. So you
searcdh 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 there
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, Plain English or Function Block is found
you have to add Programs in the Select types dialog box.

04-13005-02-en, October 2012 System


1389
49 Search
49.9 Non-Validated Programs Search Example

Figure: The Select types dialog box when all objet types of the categoires 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 nad Failed is selected in the Select Condition
dialog box.
Then we perform the search.

System 04-13005-02-en, October 2012


1390
49 Search
49.9 Non-Validated Programs Search Example

Figure: The search result for all program in University X that are not validated sucessfully.
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".

04-13005-02-en, October 2012 System


1391
50 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
Watch Select Property Dialog Box
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
Confirm Rename Dialog Box
Rename Object Dialog Box
General and References Properties
Retain Level
Configure Dialog Box - Configuration Tab
Configure Dialog Box – Operation Tab
Archive Settings Icon
Archiving Settings Properties – Basic Tab
Archiving Settings Properties – Content Tab
Search Icons
Search View
Search View Toolbar
Search Toolbar
Select Folder Dialog Box
Select Types Dialog Box
Select Conditions Dialog Box
Event Archive File
Trend Log Archive File
Add/Remove Columns Dialog Box
Analog Value Properties
Digital Value Properties
Multistate Value Properties
String Value Properties
Signal Generator Dialog Box
Simple Math Operator Dialog Box
Create Hyperlink Wizard – URL Page
Path Type
Select Object Dialog Box
Select Object and Properties Dialog Box
Progress View
System Object Properties
System Control Panel Properties
Commit Page
50 WorkStation User Interface
50.1 Basic Functionality Icons in the System Tree Pane

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

System
Indicates the System folder in a server. For
more information, see WebHelp.

Tasks
Indicates a Task that is used to run a Script
program of a Function Block program. For
more information, see WebHelp.

Archive settings
Archive setting icon as it is displayed in the
System Tree pane. For more information,
see section 48.1 “Archiving Overview” on
page 1345.

Search query
Indicates a saved search in the System Tree
and in the List View. For more information,
see section 49.1 “Search Overview” on page
1371.

System Control Panel


Indicates System Control Panel. For more
information, see section 46.4 “Control Panel”
on page 1316.

04-13005-02-en, October 2012 System


1397
50 WorkStation User Interface
50.2 File Menu

50.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 50.3 “File Menu – New
Submenu” on page 1400.

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
account. For more information, see section
25.7 “Building Operation WorkStation
Window” on page 532.

Change Password Click to open the Change Password dialog


box where you change your password. For
more information, see section 25.11
“Change Password Dialog Box” on page
539.

System 04-13005-02-en, October 2012


1398
50 WorkStation User Interface
50.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 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 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 50.26 “General and References
Properties” on page 1441.

Shortcut Properties Displays the Properties dialog box for the


currently selected shortcut.

Exit Click to quit WorkStation.

04-13005-02-en, October 2012 System


1399
50 WorkStation User Interface
50.3 File Menu – New Submenu

50.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
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
An alarm monitors a variable and alerts you if
the monitored variable matches the
configured alarm conditions. For more
information, see section 26.1 “Alarm
Overview” on page 587.

Assignment Click to open the Create Object wizard


where you create an assignment. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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
28.26 “Automatic Assignment” on page 715.

Application Click to open the Create Object wizard


where you create an application folder for a
hosted BACnet device. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

System 04-13005-02-en, October 2012


1400
50 WorkStation User Interface
50.3 File Menu – New Submenu

Continued
Command Description

b3 device Click to open the Create Object wizard


where you create a b3 device on the MSTP
network. For more information, see section
50.20 “Create Object Wizard – Naming the
Object Page” on page 1434.
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 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
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

BACnet loop Click to open the Create Object wizard


where you create a BACnet loop that
represents a feedback control loop. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
You use a BACnet loop to create a feedback
system without manually creating or editing
Script code. For more information, see
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
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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 WebHelp.

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
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
For more information, see 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
50.20 “Create Object Wizard – Naming the
Object Page” on page 1434.

04-13005-02-en, October 2012 System


1401
50 WorkStation User Interface
50.3 File Menu – New Submenu

Continued
Command Description

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 50.20 “Create Object Wizard –
Naming the Object Page” on page 1434.
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 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.
For more information, see section 50.20
“Create Object Wizard – Naming the Object
Page” on page 1434.
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.
For more information, see section 50.20
“Create Object Wizard – Naming the Object
Page” on page 1434.
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
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Document Click to open the Create Object wizard


where you create a document. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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
more information, see section 53.1
“Documents” on page 1503.

System 04-13005-02-en, October 2012


1402
50 WorkStation User Interface
50.3 File Menu – New Submenu

Continued
Command Description

Extended trend log Click to open the Create Object wizard


where you create an extended trend log. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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 35.4 “Extended Trend Logs” on
page 1003.

Folder Click to open the Create Object wizard


where you create a folder. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Function Block Click to open the Create Object wizard


where you create a Function Block program.
For more information, see section 50.20
“Create Object Wizard – Naming the Object
Page” on page 1434.
For more information, see WebHelp.

Graphic Click to open the Create Object wizard


where you create a graphic. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
The created graphic is empty and has to be
edited. For more information, see WebHelp.

Hyperlink Click to open the Create Object wizard


where you create a hyperlink. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Hyperlinks are used to acces web pages on
the Internet. For more information, see
section 46.7 “Hyperlinks” on page 1321.

04-13005-02-en, October 2012 System


1403
50 WorkStation User Interface
50.3 File Menu – New Submenu

Continued
Command Description

Interface Click to open the Create Object wizard


where you create an interface. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
The created interface can be a BACnet
interface, LonWorks interface, MicroNet
network, or Modbus interface/network.
For more information, see WebHelp.
For more information, see WebHelp.
For more information, see WebHelp.
For more information, see WebHelp.
For more information, see WebHelp.

IP network Click to open the Create Object wizard


where you create an IP network. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

LonWorks Network Opens the Create Object wizard


wizard, where
you create a LonWorks network. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

MicroNet Click to open the Create Object wizard,


where you create any one of three MicroNet
network types. For more information, see
section 50.20 “Create Object Wizard –
Naming the Object Page” on page 1434.
MicroNet is a moderate-to-large scale
Building Management System. For more
information, see WebHelp.

MicroNet ARCNET Network Click to open the Create Object wizard,


where you create a MicroNet ARCNET
network. For more information, see section
50.20 “Create Object Wizard – Naming the
Object Page” on page 1434.
An ARCNET network contains ARCNET
variant MicroNet devices. For more
information, see WebHelp.

MicroNet NCP Network Click to open the Create Object wizard,


where you create a MicroNet NCP network.
For more information, see section 50.20
“Create Object Wizard – Naming the Object
Page” on page 1434.
An NCP network is the Satchwell Native
Communications Protocol proprietary
network, containing NCP variant MicroNet
devices. For more information, see
WebHelp.

System 04-13005-02-en, October 2012


1404
50 WorkStation User Interface
50.3 File Menu – New Submenu

Continued
Command Description

MicroNet SNP Network Click to open the Create Object wizard,


where you create a MicroNet SNP network.
For more information, see section 50.20
“Create Object Wizard – Naming the Object
Page” on page 1434.
An SNP network is the Satchwell SatchNet
Pro proprietary network, containing SNP
variant MicroNet devices. For more
information, see 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
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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
WebHelp.

Modbus Points Click to open the Create Object wizard


where you create a Modbus point within an
external device. For more information, see
section 50.20 “Create Object Wizard –
Naming the Object Page” on page 1434.
A Modbus point is an analog, digital or
multistate input (or output) at a Modbus
device. For more information, see WebHelp.

Modbus TCP Device Click to open the Create Object wizard


where you create a Modbus TCP device. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
A Modbus TCP device is any Modbus device
on a Modbus TCP network. For more
information, see WebHelp.

Modbus Register Group Click to open the Create Object wizard


where you create a Modbus register group
within a Modbus device. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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 WebHelp.

04-13005-02-en, October 2012 System


1405
50 WorkStation User Interface
50.3 File Menu – New Submenu

Continued
Command Description

Modbus Value Click to open the Create Object wizard


where you create a Modbus value in a
Modbus interface. For more information, see
section 50.20 “Create Object Wizard –
Naming the Object Page” on page 1434.
A Modbus value is an analog, digital or
multistate input (or output) at a Modbus
interface. For more information, see
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
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Building Operation supports BACnet IP
networks and MS/TP networks. For more
information, see WebHelp.

Network Variable Click to open the Create Object wizard


where you create a network variable. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

Notification Click to open the Create Object wizard


where you create a notification. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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
information, see section 28.21
“Notifications” on page 700.

Panel Click to open the Create Object wizard


where you create a panel. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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 23.6 “Panel Components” on page
475.

System 04-13005-02-en, October 2012


1406
50 WorkStation User Interface
50.3 File Menu – New Submenu

Continued
Command Description

Point Click to open the Create Object wizard


where you create a BACnet input or output
point. For more information, see section
50.20 “Create Object Wizard – Naming the
Object Page” on page 1434.
You can create BACnet points in a server
and in a hosted BACnet device. For more
information, see WebHelp.

Program Click to open the Create Object wizard


where you create a program. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
For more information, see WebHelp.
For more information, see WebHelp.

Report Click to open the Create Object wizard


where you create a report. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Click to create a report. For more
information, see WebHelp.

Schedule Click to open the Create Object wizard


where you create a schedule. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Schedules are used to determine when
essential events occur in a building
automation system. For more information,
see section 40.1 “Schedules Overview” on
page 1185.

Search Click to open the Create Object wizard


where you create a search. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Search is used for searching for objects and
properties of objects in Building Operation.
For more information, see section 49.1
“Search Overview” on page 1371.

Server Click to open the Create Object wizard


where you create a server. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

04-13005-02-en, October 2012 System


1407
50 WorkStation User Interface
50.3 File Menu – New Submenu

Continued
Command Description

Shortcut Click to open the Create Object wizard


where you create a shortcut. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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 51.7 “Shortcut
Creation” on page 1491.

User Account Click to open the Create Object wizard


where you create a user account. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
A user account uniquely identifies a user to
the system. For more information, see
section 18.3 “User Accounts and User
Account Groups” on page 351.

Domain Click to open the Create Object wizard


where you create a domain. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
A domain contains of user accounts, user
account groups, software permissions,
workspaces and one or several Building
Operation servers. For more information, see
section 20.1 “Domains” on page 405.

Text report Opens the Create Object wizard


wizard, where
you create a text report. For more
information, see WebHelp.

Trend Click to open the Create Object wizard


where you create trend logs, trend log lists,
or trend charts. For more information, see
section 50.20 “Create Object Wizard –
Naming the Object Page” on page 1434.
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
33.1 “Trend Overview” on page 903.

Trend log Click to open the Create Object wizard


where you create a trend log. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
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
33.1 “Trend Overview” on page 903.

System 04-13005-02-en, October 2012


1408
50 WorkStation User Interface
50.3 File Menu – New Submenu

Continued
Command Description

User account group Click to open the Create Object wizard


where you create a user account group. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
A user account group can contain both user
accounts and other user account groups.
For more information, see section 18.3 “User
Accounts and User Account Groups” on
page 351.

Utility Click to open the Create Object wizard


where you create a utility. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
The utilities Signal Gererator and Simple
Math Operator are used for testing the
system. For more information, see section
46.9 “Utilities” on page 1323.

Value Click to open the Create Object wizard


where you create a value. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.

View Click to open the Create Object wizard


where you create an Event view or Alarm
view. For more information, see section
50.20 “Create Object Wizard – Naming the
Object Page” on page 1434.
Views are used to display information in a
easy way. For more information, see section
26.1 “Alarm Overview” on page 587.

Workspace Click to open the Create Object wizard


where you create a workspace. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
A workspace is a configured layout and
selection of components that display in
WorkStation. For more information, see
section 23.3 “Workspace Components and
Customization” on page 470.

04-13005-02-en, October 2012 System


1409
50 WorkStation User Interface
50.4 Edit Menu

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

Move Click to move an object to another location.


For more information, see section 47.10
“Move, Rename, and Delete” on page 1337.

Delete Click to open the Confirm delete dialog box


where you delete the selected object. For
more information, see section 50.23
“Confirm Delete Dialog Box” on page 1438.

Rename Click to rename the selected object. For


more information, see section 50.24
“Confirm Rename Dialog Box” on page
1439.

Create shortcut Creates a new shortcut to a selected folder


or object into the same folder as the target.

System 04-13005-02-en, October 2012


1410
50 WorkStation User Interface
50.5 Actions Menu

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

Activation Use the Activation submenu to enable,


disable, force transfer, or clear a trend log.
For more information, see section 50.6
“Actions Menu – Activation Submenu” on
page 1417.

Advanced Use the Advanced submenu to repair


references or communication after a server
has been offline. For more information, see
section 50.7 “Actions Menu – Advanced
Submenu” on page 1418.

Advanced commands Use the Advanced commands submenu to


execute commands for a device. For more
information, see section 50.8 “Actions
Menu – Advanced Commands Submenu”
on page 1419.

Alarm Refresh Transfers all alarms buffered in the Xenta


device to the server. For more information,
see 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 WebHelp.

Backup Click to open the Backup Options dialog


box where you back up the selected server.
For more information, see WebHelp.

Clear Status Clears the diagnostic data for the device or


local node. For more information, see
WebHelp.

Cold start Restarts the device and clears the RAM


memory. For more information, see
WebHelp.

04-13005-02-en, October 2012 System


1411
50 WorkStation User Interface
50.5 Actions Menu

Continued
Command Description

Cold start device Cold starts a hosted BACnet device. For


more information, see WebHelp.

Convert graphics Click to open the graphics conversion tool,


where you convert I/NET graphics to TGML.
For more information, see WebHelp.

Data Import Click to import the MicroNet update file. For


more information, see WebHelp.

Decommission Deactivates the device in the network.

Device Use the Device submenu where you


manage your devices. For more information,
see 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 WebHelp.

Discover Devices Identifies the devices and objects on a


particular BACnet network, or an entire
BACnet internetwork. For more information,
see WebHelp.

Download Downloads the application from the Building


Operation server database to the device.

Download Configuration Downloads the parameters from the Building


Operation server database to the device.

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 30.75 “Select Conditions Dialog
Box – Alarm Filter Properties” on page 856.

Edit Assignment Condition Click to open the Select conditions dialog


box, where you define when to send the
assignment. For more information, see
section 30.75 “Select Conditions Dialog
Box – Alarm Filter Properties” on page 856.

Edit bindings Click to open the Edit Bindings dialog box.


For more information, see 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
32.4 “Select Conditions Dialog Box – Events
Filter Properties” on page 894.

System 04-13005-02-en, October 2012


1412
50 WorkStation User Interface
50.5 Actions Menu

Continued
Command Description

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 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
section 30.75 “Select Conditions Dialog
Box – Alarm Filter Properties” on page 856.

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
30.75 “Select Conditions Dialog Box – Alarm
Filter Properties” on page 856.

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 32.2 “Event Styles
Dialog Box” on page 892.

Host EWS Objects Click to host a remote EcoStruxure Web


Service object. For more information, see
WebHelp.

I/A Series Use the I/A Series submenu to open


WorkPlace Tech Monitor, to monitor or
perform a task on an MNL LonWorks device.
For more information, see WebHelp.

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

Launch INET Click to open the I/NET Seven application.


For more information, see WebHelp.

Launch VisiSat Click to start VisiSat. For more information,


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

Learn LCM Learns the blocks in the LCM. For more


information, see WebHelp.

LCM sync date time Sends the server's date and time to each
LCM device on the LCM network. For more
information, see WebHelp.

04-13005-02-en, October 2012 System


1413
50 WorkStation User Interface
50.5 Actions Menu

Continued
Command Description

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
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
38.15 “Manage Replacement of Meter
Dialog Box” on page 1115.

Modification Use the Modification submenu to modify a


trend log. For more information, see section
50.9 “Actions Menu – Modification
Submenu” on page 1420.

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

Proxy Update Reads the configuration properties of the


block in the LCM. For more information, see
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 WebHelp.

Reset IO module Resets the I/O module with its old


configuration. For more information, see
WebHelp.

Restore Click to open the Restore Options dialog


box where you restore the selected server or
the previously saved local copy of the
selected I/NET device's database, or upload
the configurations properties of an external
BACnet device to a device proxy.

Save To Save the selected backup to another


location in the Building Operation server
database. For more information, see
WebHelp.

Send ServicePin Sends service pin for the local node, so


other devices can identify the local node on
the network. For more information, see
WebHelp.

Send time sync now Triggers a time synchronization of all the


BACnet devices listed in the BACnet
Interface.

System 04-13005-02-en, October 2012


1414
50 WorkStation User Interface
50.5 Actions Menu

Continued
Command Description

Teach Sends the selected BBMD configuration to


all other BBMDs in the system. For more
information, see WebHelp.

Time sync Synchronizes the time between a hosted


device and the local server. For more
information, see WebHelp.

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 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 firmware Click to open an I/NET native editor, where


you can restore the programming in the
selected I/NET device. For more information,
see WebHelp.

Update Object list Updates the list of BACnet device objects.

Update SubLAN device firmware Click to open an I/NET native editor, where
you can restore the programming in a device
that is connected to the selected I/NET
device' subLAN. For more information, see
WebHelp.

Warm start Restarts a device without clearing the RAM


memory. For more information, see
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 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 50.10 “Actions Menu – View
Submenu” on page 1421.

View Action Notes Click to open an Events pane that displays


all events where an action note has been
added to the alarm. For more information,
see WebHelp.

View Cause Notes Click to open an Events pane that displays


all events where a cause note has been
added to the alarm. For more information,
see WebHelp.

04-13005-02-en, October 2012 System


1415
50 WorkStation User Interface
50.5 Actions Menu

Continued
Command Description

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

View History Click to open an Events pane where all


history events of an alarm are displayed. For
more information, see 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.

System 04-13005-02-en, October 2012


1416
50 WorkStation User Interface
50.6 Actions Menu – Activation Submenu

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

04-13005-02-en, October 2012 System


1417
50 WorkStation User Interface
50.7 Actions Menu – Advanced Submenu

50.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 47.10 “Move,
Rename, and Delete” on page 1337.

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

System 04-13005-02-en, October 2012


1418
50 WorkStation User Interface
50.8 Actions Menu – Advanced Commands Submenu

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

Warm Start Click to restart the device without clearing


the RAM memory. For more information, see
WebHelp.

Cold Start Click to restart the device and clear the RAM
memory. For more information, see
WebHelp.

Alarm Refresh Click to transfer all alarms buffered in the


physical Xenta device to Building Operation.
For more information, see 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 WebHelp.

04-13005-02-en, October 2012 System


1419
50 WorkStation User Interface
50.9 Actions Menu – Modification Submenu

50.9 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 34.23 “Adding a Trend Log Record
to a Manual Trend Log” on page 992.

System 04-13005-02-en, October 2012


1420
50 WorkStation User Interface
50.10 Actions Menu – View Submenu

50.10 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
more information, see section 32.1 “Object
Specific Event View” on page 891.

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 38.4 “Actions Menu - View
Submenu - Trend Charts Submenu” on
page 1098.

Trend log lists Use the Trend log lists submenu to open or
create a trend list. For more information, see
section 38.5 “Actions Menu - View Submenu
- Trend Log Lists Submenu” on page 1099.

Watch pane Use the Watch pane submenu to select the


property of the variable you want to monitor.
For more information, see section 50.11
“Actions Menu - View Submenu - Watch
Submenu” on page 1422.

04-13005-02-en, October 2012 System


1421
50 WorkStation User Interface
50.11 Actions Menu - View Submenu - Watch Submenu

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

System 04-13005-02-en, October 2012


1422
50 WorkStation User Interface
50.12 Watch Select Property Dialog Box

50.12 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

Component Description

Quick filter Enter a word or a character to filter on. For


more information, see section 46.6 “Quick
Filter ” on page 1318.

04-13005-02-en, October 2012 System


1423
50 WorkStation User Interface
50.13 Tools Menu

50.13 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 50.15 “Control Panel View” on page
1426.

Options Click to open the Options dialog box where


you manage some local user settings. For
more information, see section 50.14
“Options Dialog Box” on page 1425.

System 04-13005-02-en, October 2012


1424
50 WorkStation User Interface
50.14 Options Dialog Box

50.14 Options Dialog Box


Use the Options dialog box to manage some local user settings.

Figure: Options dialog box

Table: Options Dialog Box


Component Description

Show same tab while navigating between Click to open the same tab at all times when
objects you navigate between objects. For more
information, see section 47.5 “Object Tab
Display” on page 1332.

Reset all user settings Click to reset your locally saved user setting.
For more information, see WebHelp.

04-13005-02-en, October 2012 System


1425
50 WorkStation User Interface
50.15 Control Panel View

50.15 Control Panel View


Use the Control Panel to access some of the most used functions in Building
Operation.

Figure: Control Panel

Table: Control Panel


Component Description

Server Select the server you want to work with.

Action notes Click to open Action notes. For more


information, see section 29.6 “Action Notes”
on page 732.

Categories Cick to open Categories. For more


information, see section 28.10 “Categories”
on page 686.

Cause notes Click to open Cause notes. For more


information, see section 29.2 “Cause Notes”
on page 726.

Checklists Click to open Checklists. For more


information, see section 29.10 “Checklists”
on page 738.

Domain Click to open Domain. For more information,


see section 20.1 “Domains” on page 405.

System 04-13005-02-en, October 2012


1426
50 WorkStation User Interface
50.15 Control Panel View

Continued
Component Description

Alarm appearances Click to open Alarm appearances. For more


information, see section 30.42 “Alarm Styles
View” on page 821.

Account management Click to open Account management. For


more information, see section 18.3 “User
Accounts and User Account Groups” on
page 351.

Network time and time zones Click to open Network time and time zones.
For more information, see section 16.1
“Time and Time Zone” on page 309.

Communication Click to open Server Communication. For


more information, see WebHelp.

Device discovery Click to open the Device discovery. For more


information, see WebHelp.

Variable connectors Click to open Variable connectors. For more


information, see WebHelp.

Binding Templates Click to open Binding Templates. For more


information, see WebHelp.

WorkPlace Tech Editor Click to open WorkPlace Tech Editor. For


more information, see WebHelp.

Backup Rules Click to open Backup Rules. For more


information, see WebHelp.

Backup Sets Click to open Backup Sets. For more


information, see WebHelp.

Backup and Restore Manager Click to open Backup and Restore Manager.
For more information, see WebHelp.

Archiving Click to open Archive Settings. For more


information, see section 48.1 “Archiving
Overview” on page 1345.

EWS Server Configuration Click to open the EcoStruxure Web Service


server configuration. For more information,
see WebHelp.

04-13005-02-en, October 2012 System


1427
50 WorkStation User Interface
50.16 Progress View – Advanced

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

50.16.1 Detail View


The detailed information in the Progress view helps you to identify problems during
any operation.

System 04-13005-02-en, October 2012


1428
50 WorkStation User Interface
50.16 Progress View – Advanced

Figure: Detailed information is displayed in the Error dialog.

04-13005-02-en, October 2012 System


1429
50 WorkStation User Interface
50.17 Progress View – Simple

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

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

50.17.2 Detail View


The detailed information in the Progress view helps you to identify problems during
any operation.

System 04-13005-02-en, October 2012


1430
50 WorkStation User Interface
50.17 Progress View – Simple

Figure: Detailed information is displayed in the Error dialog.

04-13005-02-en, October 2012 System


1431
50 WorkStation User Interface
50.18 Operation Details Dialog Box

50.18 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


Component Description

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.

Copy to clipboard Click to copy the information to the


clipboard.

System 04-13005-02-en, October 2012


1432
50 WorkStation User Interface
50.19 Error Details – Progress View

50.19 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


Component Description

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.

04-13005-02-en, October 2012 System


1433
50 WorkStation User Interface
50.20 Create Object Wizard – Naming the Object Page

50.20 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


Component Description

(Object type list) Select the type of object you want to create.
For more information, see section 47.1
“Object Types” on page 1327.

Name Type the name of the object. For more


information, see section 47.2 “Object
Names” on page 1328.

Prefix Type a label that is added in front of the


object name. For more information, see
section 39.4 “Suffix and Prefix” on page
1164.

Suffix Type a label that is added after the object


name. For more information, see section
39.4 “Suffix and Prefix” on page 1164.

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.

System 04-13005-02-en, October 2012


1434
50 WorkStation User Interface
50.20 Create Object Wizard – Naming the Object Page

Continued
Component Description

Description Type a description that explains what the


object is used for.

04-13005-02-en, October 2012 System


1435
50 WorkStation User Interface
50.21 List View Toolbar

50.21 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


Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.

Show/Hide Property Grid


Click to display the Properties of a selected
object. For more information, see section
47.3 “Object Properties” on page 1329.

Quick filter Enter a word or a character to filter on. For


more information, see section 46.6 “Quick
Filter ” on page 1318.

System 04-13005-02-en, October 2012


1436
50 WorkStation User Interface
50.22 System Tree Pane Toolbar

50.22 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 46.2 “System
Tree Pane” on page 1313.

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.

04-13005-02-en, October 2012 System


1437
50 WorkStation User Interface
50.23 Confirm Delete Dialog Box

50.23 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


Component Description

Object name Displays the name of the objects that is


affected by the object you want to delete.

Object path Displays the path to the objects that is


affected by the object you want to delete.

Reference name Displays the reference name to the object


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.

Validate Click to validate the objects that are affected


by the object you want to delete.

System 04-13005-02-en, October 2012


1438
50 WorkStation User Interface
50.24 Confirm Rename Dialog Box

50.24 Confirm Rename Dialog Box


Use the Confirm Rename dialog box to confirm that you want to rename an object
and to see objects that will be affected by the renaming.

Figure: Confirm Rename dialog box

Component Description

Object name Displays the name of the objects that is


affected by the object you want to rename.

Object path Displays the path to the objects that is


affected by the renaming.

Reference name Displays the reference name to the object


that is affected by the object you want to
rename.

Copy to clipboard Click to copy the information about the


affected references to the clipboard.

Yes Click to rename the object.

No Click to close the dialog box without remaing


the object.

Validate Click to validate the objects that are affected


by the object you want to rename.

04-13005-02-en, October 2012 System


1439
50 WorkStation User Interface
50.25 Rename Object Dialog Box

50.25 Rename Object Dialog Box


Use the Rename object dialog box to rename an object.

Figure: Rename object dialog box

Table: Rename Object Dialog Box


Component Description

Object Name Type the new name of the object.

System 04-13005-02-en, October 2012


1440
50 WorkStation User Interface
50.26 General and References Properties

50.26 General and References Properties


Use the General and References properties to configure and view the general
properties and references.

Figure: General and references properties

Table: General and References Properties


Component Description

Name Displays the name of the object.

Description Type a description that explains what the


object is used for.

Type Displays the object type that defines the


properties of the object.

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 want to display in a


graphic or use when searching for the
object.

Note 2 Type text that you want to 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.

04-13005-02-en, October 2012 System


1441
50 WorkStation User Interface
50.26 General and References Properties

Continued
Component Description

References Displays the objects that refer to this object.

System 04-13005-02-en, October 2012


1442
50 WorkStation User Interface
50.27 Retain Level

50.27 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 and No Cold start Warm start
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
database

Backup & Restore Default value 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.

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


last value set by value set by a user or
either a user or an default if never set by
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.

04-13005-02-en, October 2012 System


1443
50 WorkStation User Interface
50.28 Configure Dialog Box - Configuration Tab

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

Component Description

Type Displays the object type. Read-only

Unit Displays the Unit. Select to change the unit.


For more information, see section 15.8
“Units” on page 298.

Init value Read-only.

Reference Read-only.

Forceable Select to make the value forcible. For more


information, see WebHelp.

Retain level Select how to handle values for warm start,


cold start, system events, and system
activities. For more information, see section
50.27 “Retain Level ” on page 1443.

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.

System 04-13005-02-en, October 2012


1444
50 WorkStation User Interface
50.28 Configure Dialog Box - Configuration Tab

Values can be forced to a certain value. The true value from the system is displayed
in the Unforced value box.

04-13005-02-en, October 2012 System


1445
50 WorkStation User Interface
50.29 Configure Dialog Box – Operation Tab

50.29 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

Component Description

Value Enter the value that you want to use to


override the value of the property. For more
information, see WebHelp.

Force value Click Force value to force a value. For more


information, see WebHelp.

Unforced Value Displays the actual value that the point


would have if the value had not been forced.
For more information, see WebHelp.

System 04-13005-02-en, October 2012


1446
50 WorkStation User Interface
50.30 Archive Settings Icon

50.30 Archive Settings Icon


The Archive setting icon as it appears in the System Tree pane.

Table: Archive Settings Icon


Icon Description

Archive setting icon as it is displayed in the


System Tree pane.

04-13005-02-en, October 2012 System


1447
50 WorkStation User Interface
50.31 Archiving Settings Properties – Basic Tab

50.31 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


Component Description

Name Displays the name of the object.

Description Type a description that explains what the


object is used for.

System 04-13005-02-en, October 2012


1448
50 WorkStation User Interface
50.31 Archiving Settings Properties – Basic Tab

Continued
Component Description

Type Displays the object type that defines the


properties of the object.

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.

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.

References Displays the objects that refer to this object.

Enabled Select True to activate the archiving


function.

Path Type the path to the location where you


want to create your archive.

Period Select a period for the archiving.

Day Select the delay time.

Next Displays the date when the next periodical


archive is created.

Start time Displays the date when the archiving


function was enabled.

Output format Select the output format of the archive.

04-13005-02-en, October 2012 System


1449
50 WorkStation User Interface
50.32 Archiving Settings Properties – Content Tab

50.32 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 – Content Tab


Component Description

Alarm Select True if you want to include Alarm


events in the archive.

User Select True if you want to include User


events in the archive.

System Select True if you want 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.

System 04-13005-02-en, October 2012


1450
50 WorkStation User Interface
50.33 Search Icons

50.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 49.1 “Search
Overview” on page 1371.

04-13005-02-en, October 2012 System


1451
50 WorkStation User Interface
50.34 Search View

50.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 result
exceed 1000.

System 04-13005-02-en, October 2012


1452
50 WorkStation User Interface
50.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.

04-13005-02-en, October 2012 System


1453
50 WorkStation User Interface
50.35 Search View Toolbar

50.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
Click to save the search for future use.

Save Search as
Click to save the search with a new name for
future use.

Show/Hide Group Box


Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.

Show/Hide Property Grid


Click to display the Properties of a selected
object. For more information, see section
47.3 “Object Properties” on page 1329.

Clear search criteria


Click to clear all settings in the Search view.

System 04-13005-02-en, October 2012


1454
50 WorkStation User Interface
50.36 Search Toolbar

50.36 Search Toolbar


Use the Search basic toolbar to make a simple search on all objects.

Figure: Search basic toolbar

04-13005-02-en, October 2012 System


1455
50 WorkStation User Interface
50.37 Select Folder Dialog Box

50.37 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


Component Description

Path Displays the path to the selected folder.

System Tree Select the folder where you want to search.

System 04-13005-02-en, October 2012


1456
50 WorkStation User Interface
50.38 Select Types Dialog Box

50.38 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


Component Description

Object type tree Select the object type to search for.

Add type
Click to add the selected object type 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.

04-13005-02-en, October 2012 System


1457
50 WorkStation User Interface
50.39 Select Conditions Dialog Box

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

System 04-13005-02-en, October 2012


1458
50 WorkStation User Interface
50.40 Event Archive File

50.40 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
48.15 “Event and Alarm Enumerations” on
page 1361.

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


generated the event.

ValueBefore Displays the value of an object before it was


changed.

04-13005-02-en, October 2012 System


1459
50 WorkStation User Interface
50.40 Event Archive File

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 48.15 “Event
and Alarm Enumerations” on page 1361.

MonitoredVariable Displays the path of the monitored variable

PreviousAlarmState Displays the previous alarm state. For more


information, see section 48.15 “Event and
Alarm Enumerations” on page 1361.

AlarmState Displays the present state of the alarm. For


more information, see section 48.15 “Event
and Alarm Enumerations” on page 1361.

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
48.15 “Event and Alarm Enumerations” on
page 1361.

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
information, see section 48.15 “Event and
Alarm Enumerations” on page 1361.

Hidden Displays False if the object is shown. For


more information, see section 48.15 “Event
and Alarm Enumerations” on page 1361.

Category Displays the category name of the alarm.

DisabledCause Displays the cause of the disabled alarm. For


more information, see section 48.15 “Event
and Alarm Enumerations” on page 1361.

ServerOffline Displays the online status of the server. For


more information, see section 48.15 “Event
and Alarm Enumerations” on page 1361.

UniqueAlarmId Displays the unique identity of the alarm.

System 04-13005-02-en, October 2012


1460
50 WorkStation User Interface
50.40 Event Archive File

Continued
Column Description

AlarmText Displays the alarm messages that are added


to the alarm.

Command Displays the executed command that


generated the event.

AssignedToDomain Displays the domain the user or group that


the alarm is assigned to.

AssignedToName Displays the name of the user or group that


the alarm is assigned to.

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


information, see section 48.15 “Event and
Alarm Enumerations” on page 1361.

SystemAlarmId Displays the alarm ID generated by the


system when an alarm is triggered. For more
information, see section 48.15 “Event and
Alarm Enumerations” on page 1361.

Comment Displays the comment that has been added


to an alarm.

04-13005-02-en, October 2012 System


1461
50 WorkStation User Interface
50.41 Trend Log Archive File

50.41 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


properties of the object.

SEQNO Displays the event sequence number.

TimeStamp Displays the date and time when a record or


event was generated.

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
information, see section 48.16 “Trend Log
Enumerations” on page 1368.

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.

System 04-13005-02-en, October 2012


1462
50 WorkStation User Interface
50.41 Trend Log Archive File

Continued
Column Description

StartValue Displays the value of the new meter when it


was installed.

MeterConstant Displays the constant of the new meter. If


the meter counts in kilo (103), the constant is
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


information, see section 48.16 “Trend Log
Enumerations” on page 1368.

04-13005-02-en, October 2012 System


1463
50 WorkStation User Interface
50.42 Add/Remove Columns Dialog Box

50.42 Add/Remove Columns Dialog Box


Use the Add/Remove columns dialog box to add or remove columns from a list,
such as the trend log list or Events pane.

Figure: Add /Remove column

Table: Add/Remove Columns


Component Description

Acknowledge time Select to display the time and date when the
alarm was acknowledged. For more
information, see section 28.14
“Acknowledgement” on page 692.

Alarm state Select to display the alarm state. For more


information, see section 26.2 “Alarm States”
on page 589.

Alarm text Select to display the alarm message that


was added to the alarm. For more
information, see section 28.6 “Alarm
Messages” on page 682.

Assigned state Select to display the assigned state the


alarm had. For more information, see
WebHelp.

Assigned to domain Select to display the domain of the user or


group that an alarm was assigned to. For
more information, see section 20.1
“Domains” on page 405.

Assigned to ID Select to display the ID of the user or group


that an alarm was assigned to.

System 04-13005-02-en, October 2012


1464
50 WorkStation User Interface
50.42 Add/Remove Columns Dialog Box

Continued
Component Description

Assigned to name Select to display the name of the user or


group that an alarm was assigned to. For
more information, see section 26.3 “Alarm
Functions” on page 590.

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

Description Select to display the event description. For


more information, see section 50.26
“General and References Properties” on
page 1441.

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 20.1 “Domains” on page 405.

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.

EWS ID Select to display the EcoStruxure Web


Service identification of the event on the
external system.

04-13005-02-en, October 2012 System


1465
50 WorkStation User Interface
50.42 Add/Remove Columns Dialog Box

Continued
Component Description

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


individual whose key/card was used at 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


individual whose key/card was used at 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


individual whose key/card was used at 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


number on the present server.

Source Select to display the path of the source


object.

System 04-13005-02-en, October 2012


1466
50 WorkStation User Interface
50.42 Add/Remove Columns Dialog Box

Continued
Component Description

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


individual whose key/card was used at the
I/NET door point.

Text Select to display the text messages in the E-


mail in a E-mail notification. For more
information, see section 28.21
“Notifications” on page 700.

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 50.26 “General and
References Properties” on page 1441.

Unique alarm ID Select to display the ID of the alarm that


generated the event.

Unique user ID Select to display the ID of the user that


generated the event.

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 31.2 “Events Pane and Event
View Customization” on page 876.

Value after Select to display the value of an object after


it was changed.

Value at change Select to display the value the monitored


variable had when the alarm was triggered.

04-13005-02-en, October 2012 System


1467
50 WorkStation User Interface
50.42 Add/Remove Columns Dialog Box

Continued
Component Description

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

System 04-13005-02-en, October 2012


1468
50 WorkStation User Interface
50.43 Analog Value Properties

50.43 Analog Value Properties


Use the Analog Value properties dialog box to view or configure an analog value.

Figure: Analog value

Table: Analog Value


Property Description

Force value Click to force a value. For more information,


see WebHelp.

04-13005-02-en, October 2012 System


1469
50 WorkStation User Interface
50.44 Digital Value Properties

50.44 Digital Value Properties


Use the Digital Value properties dialog box to view or configure a digital value.

Figure: Digital value

Table: Digital Value


Property Description

Force value Click to force a value. For more information,


see WebHelp.

System 04-13005-02-en, October 2012


1470
50 WorkStation User Interface
50.45 Multistate Value Properties

50.45 Multistate Value Properties


Use the Multistate Value properties dialog box to view or configure a multistate
value.

Figure: Multistate value

Table: Multistate Value


Property Description

Force value Click to force a value. For more information,


see WebHelp.

04-13005-02-en, October 2012 System


1471
50 WorkStation User Interface
50.46 String Value Properties

50.46 String Value Properties


Use the String Value properties dialog box to view or configure a string value.

Figure: String value

Table: String Value


Property Description

Force value Click to force a value. For more information,


see WebHelp.

System 04-13005-02-en, October 2012


1472
50 WorkStation User Interface
50.47 Signal Generator Dialog Box

50.47 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

Component Description

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.

04-13005-02-en, October 2012 System


1473
50 WorkStation User Interface
50.48 Simple Math Operator Dialog Box

50.48 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

Component Description

Operator Select the operator, add, subtract, multiply,


or divide.

In1 Input value 1.

In2 Input value 2.

System 04-13005-02-en, October 2012


1474
50 WorkStation User Interface
50.49 Create Hyperlink Wizard – URL Page

50.49 Create Hyperlink Wizard – URL Page


Use the URL page to type the URL.

Figure: URL page

Table: URL Page


Component Description

URL Type the URL of the website.

04-13005-02-en, October 2012 System


1475
50 WorkStation User Interface
50.50 Path Type

50.50 Path Type


When you create a reference in Building Operation using the Select Object and
Select Object and Properties dialog box, you can choose between three path
types:
• System absolute creates a path that refers to a specific object or properties 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/Out of Range Alarm/BasicEvaluationState refers to a state in an
Out of range alarm in the folder Building A at Server 1.
• Server absolute creates a path that refers to a specific object or properties on
a server. The address to the server is enclosed in the path and the path starts
from the root level of the server and the system is not specified. For example,
the reference ~/University X/Building A/Out of Range
Alarm/BasicEvaluationState refers to a state in an Out of range alarm in the
folder Building A at any server.
• Relative creates a path that is relative to the target. The path starts from the
current location and is relative to this location. Relative paths are particularly
useful when you want to copy a lot of folders that look the same and contain
references to other object inside the folder. For example, the
path ../Temp/Value refers to the value of an analog value on the same folder
level.

System 04-13005-02-en, October 2012


1476
50 WorkStation User Interface
50.51 Select Object Dialog Box

50.51 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

Object List Click to select an object from the list.

Path Displays the path to the selected object.

Path Type Select the path type. For more information,


see section 50.50 “Path Type” on page
1476.

04-13005-02-en, October 2012 System


1477
50 WorkStation User Interface
50.52 Select Object and Properties Dialog Box

50.52 Select Object and Properties Dialog Box


Use the Select Object and Properties dialog box to select an object and its
properties.

Figure: Selectt object and properties dialog box

Table: Select Object and Properties Dialog Box


Component Description

Object list Click to select an object from the list.

Properties Click to select an object from the list.

Path Displays the path to the selected object.

Path Type Select the path type. For more information,


see section 50.50 “Path Type” on page
1476.

System 04-13005-02-en, October 2012


1478
50 WorkStation User Interface
50.53 Progress View

50.53 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


Component Description

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.

04-13005-02-en, October 2012 System


1479
50 WorkStation User Interface
50.54 System Object Properties

50.54 System Object Properties


Use the System Object Properties view or dialog box to configure and view the
general and object-reference properties. For more information, see section 50.26
“General and References Properties” on page 1441.

Figure: System Object Properties

System 04-13005-02-en, October 2012


1480
50 WorkStation User Interface
50.55 System Control Panel Properties

50.55 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
50.26 “General and References Properties” on page 1441.

Figure: System Control Panel Properties

04-13005-02-en, October 2012 System


1481
50 WorkStation User Interface
50.56 Commit Page

50.56 Commit Page


The Commit Page displays the progress indication.

Figure: Commit page

Table: Commit Page


Component Description

[Progress
Progress bar
bar] Displays the progress indication.

System 04-13005-02-en, October 2012


1482
51 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
51 Shortcuts
51.1 Shortcuts Overview

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

04-13005-02-en, October 2012 System


1485
51 Shortcuts
51.2 Shortcut Functionality

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

System 04-13005-02-en, October 2012


1486
51 Shortcuts
51.3 User Access to Shortcuts and Targets

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

04-13005-02-en, October 2012 System


1487
51 Shortcuts
51.4 Shortcut Presentation

51.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 51.5 “Viewing Shortcuts” on page
1489.
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 52.3 “Shortcut Properties –
Basic Tab” on page 1499.
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.

System 04-13005-02-en, October 2012


1488
51 Shortcuts
51.5 Viewing Shortcuts

51.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 51.4 “Shortcut Presentation” on page 1488.

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
objects.
You can now view the properties of the shortcut(s).

04-13005-02-en, October 2012 System


1489
51 Shortcuts
51.6 Viewing Shortcut Properties

51.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 51.10 “Editing Shortcuts” on page 1494.

To view the properties of a shortcut


1. In the System Tree pane, right-click the shortcut and then click Shortcut
Properties
Properties.

Note
• You cannot view the properties of a shortcut by selecting the Properties
command. You must select the Shortcut Properties command.

System 04-13005-02-en, October 2012


1490
51 Shortcuts
51.7 Shortcut Creation

51.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-New Context Context Context Edit Edit Other
submenu (right- (right- (right- menu menu
mouse) mouse) mouse)
menu menu menu

Comman Shortcut New- Create Paste as Create Paste as Drag-


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

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

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

04-13005-02-en, October 2012 System


1491
51 Shortcuts
51.8 Creating a Shortcut

51.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 51.7 “Shortcut Creation” on page 1491.

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

System 04-13005-02-en, October 2012


1492
51 Shortcuts
51.9 Configuring the Target of a Shortcut

51.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 51.10 “Editing Shortcuts” on page 1494.

To configure the target of a shortcut


1. In WorkStation, in the System Tree pane, right-click the shortcut object and
select Shortcut Properties
Properties.
2. Click the Basic tab.
3. Edit the basic properties:
Component Description

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
Select.
6. Click OK
OK.

04-13005-02-en, October 2012 System


1493
51 Shortcuts
51.10 Editing Shortcuts

51.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 51.9 “Configuring the Target of a Shortcut” on page
1493.

System 04-13005-02-en, October 2012


1494
52 Shortcuts User Interface

Topics
Shortcuts Icon
Create Shortcut Wizard – Shortcut Target Page
Shortcut Properties – Basic Tab
52 Shortcuts User Interface
52.1 Shortcuts Icon

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

04-13005-02-en, October 2012 System


1497
52 Shortcuts User Interface
52.2 Create Shortcut Wizard – Shortcut Target Page

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

System 04-13005-02-en, October 2012


1498
52 Shortcuts User Interface
52.3 Shortcut Properties – Basic Tab

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


Component Description

Target Enter the path of the target server, folder or


object.

04-13005-02-en, October 2012 System


1499
53 Documents

Topics
Documents
Creating a Document in WorkStation
53 Documents
53.1 Documents

53.1 Documents
A Document is a container in which you can upload (copy) a file for use in Building
Operation. You can upload all types of files including reports, forms, images, and
video clips. When you open an uploaded document, Building Operation invokes the
installed editor or viewer associated with the file type. For example, you can open,
edit, and save documents associated with Microsoft Office Word.

Document creation
Creating a Document is a two-step process: creating the object and then uploading
the file. First, you create a Document in WorkStation. Second, you upload a file into
a Document container, which is stored on the Automation Server to which you are
logged onto in WorkStation. You can view and edit Documents in WorkStation.

Table: Document Read and Write Permissions


Building Read Write Description
Operation

WorkStation X X You can view, modify, and save documents. For


more information, see WebHelp.

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 27.20 “Configuring
Attachments of an Alarm” on page 673.
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.

04-13005-02-en, October 2012 System


1503
53 Documents
53.2 Creating a Document in WorkStation

53.2 Creating a Document in WorkStation


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 like alarms.
For more information, see section 53.1 “Documents” on page 1503.

To create a document in WorkStation


1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create a document.
2. On the File menu, point to New and then click Document
Document.
3. In the Naming the object dialog box, type a name for the document.

4. In the Location box, enter a location for the document.


5. In the Description box, type a description and click Next
Next.
Continued on next page

System 04-13005-02-en, October 2012


1504
53 Documents
53.2 Creating a Document in WorkStation

6. In the File box, locate the file you want to import.

7. In the Open dialog box, select the file and click Open
Open.
8. In the Import document dialog box, click Create
Create.

Important
• You can import any file type, including .doc, .jpg, .pdf, or text,
without size restrictions. However, importing files larger than 17
MB to an Automation Server can produce an Insufficient Memory
error.

04-13005-02-en, October 2012 System


1505
54 Documents User Interface

Topics
Document Properties – Basic Tab
New Document Wizard – Import Document Page
54 Documents User Interface
54.1 Document Properties – Basic Tab

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


Property Description

File Enter the file that you want to import to WorkStation.

04-13005-02-en, October 2012 System


1509
54 Documents User Interface
54.2 New Document Wizard – Import Document Page

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


Component Description

File Enter the file that you want to import to WorkStation.

System 04-13005-02-en, October 2012


1510
Schneider Electric | Buildings Division
www.schneider-electric.com/buildings

© 2012 Schneider Electric. All rights reserved.

04-13005-02-en
October 2012

S-ar putea să vă placă și